github.com/twilio/twilio-go@v1.20.1/rest/supersim/v1/docs/ESimProfilesApi.md (about)

     1  # ESimProfilesApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateEsimProfile**](ESimProfilesApi.md#CreateEsimProfile) | **Post** /v1/ESimProfiles | 
     8  [**FetchEsimProfile**](ESimProfilesApi.md#FetchEsimProfile) | **Get** /v1/ESimProfiles/{Sid} | 
     9  [**ListEsimProfile**](ESimProfilesApi.md#ListEsimProfile) | **Get** /v1/ESimProfiles | 
    10  
    11  
    12  
    13  ## CreateEsimProfile
    14  
    15  > SupersimV1EsimProfile CreateEsimProfile(ctx, optional)
    16  
    17  
    18  
    19  Order an eSIM Profile.
    20  
    21  ### Path Parameters
    22  
    23  This endpoint does not need any path parameter.
    24  
    25  ### Other Parameters
    26  
    27  Other parameters are passed through a pointer to a CreateEsimProfileParams struct
    28  
    29  
    30  Name | Type | Description
    31  ------------- | ------------- | -------------
    32  **CallbackUrl** | **string** | The URL we should call using the `callback_method` when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from `reserving` to `available`.
    33  **CallbackMethod** | **string** | The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
    34  **GenerateMatchingId** | **bool** | When set to `true`, a value for `Eid` does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the `matching_id` property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.
    35  **Eid** | **string** | Identifier of the eUICC that will claim the eSIM Profile.
    36  
    37  ### Return type
    38  
    39  [**SupersimV1EsimProfile**](SupersimV1EsimProfile.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: application/x-www-form-urlencoded
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## FetchEsimProfile
    56  
    57  > SupersimV1EsimProfile FetchEsimProfile(ctx, Sid)
    58  
    59  
    60  
    61  Fetch an eSIM Profile.
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **Sid** | **string** | The SID of the eSIM Profile resource to fetch.
    70  
    71  ### Other Parameters
    72  
    73  Other parameters are passed through a pointer to a FetchEsimProfileParams struct
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  
    79  ### Return type
    80  
    81  [**SupersimV1EsimProfile**](SupersimV1EsimProfile.md)
    82  
    83  ### Authorization
    84  
    85  [accountSid_authToken](../README.md#accountSid_authToken)
    86  
    87  ### HTTP request headers
    88  
    89  - **Content-Type**: Not defined
    90  - **Accept**: application/json
    91  
    92  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    93  [[Back to Model list]](../README.md#documentation-for-models)
    94  [[Back to README]](../README.md)
    95  
    96  
    97  ## ListEsimProfile
    98  
    99  > []SupersimV1EsimProfile ListEsimProfile(ctx, optional)
   100  
   101  
   102  
   103  Retrieve a list of eSIM Profiles.
   104  
   105  ### Path Parameters
   106  
   107  This endpoint does not need any path parameter.
   108  
   109  ### Other Parameters
   110  
   111  Other parameters are passed through a pointer to a ListEsimProfileParams struct
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **Eid** | **string** | List the eSIM Profiles that have been associated with an EId.
   117  **SimSid** | **string** | Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
   118  **Status** | **string** | List the eSIM Profiles that are in a given status.
   119  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   120  **Limit** | **int** | Max number of records to return.
   121  
   122  ### Return type
   123  
   124  [**[]SupersimV1EsimProfile**](SupersimV1EsimProfile.md)
   125  
   126  ### Authorization
   127  
   128  [accountSid_authToken](../README.md#accountSid_authToken)
   129  
   130  ### HTTP request headers
   131  
   132  - **Content-Type**: Not defined
   133  - **Accept**: application/json
   134  
   135  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   136  [[Back to Model list]](../README.md#documentation-for-models)
   137  [[Back to README]](../README.md)
   138