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

     1  # SimsApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSim**](SimsApi.md#CreateSim) | **Post** /v1/Sims | 
     8  [**FetchSim**](SimsApi.md#FetchSim) | **Get** /v1/Sims/{Sid} | 
     9  [**ListSim**](SimsApi.md#ListSim) | **Get** /v1/Sims | 
    10  [**UpdateSim**](SimsApi.md#UpdateSim) | **Post** /v1/Sims/{Sid} | 
    11  
    12  
    13  
    14  ## CreateSim
    15  
    16  > SupersimV1Sim CreateSim(ctx, optional)
    17  
    18  
    19  
    20  Register a Super SIM to your Account
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreateSimParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **Iccid** | **string** | The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the Super SIM to be added to your Account.
    34  **RegistrationCode** | **string** | The 10-digit code required to claim the Super SIM for your Account.
    35  
    36  ### Return type
    37  
    38  [**SupersimV1Sim**](SupersimV1Sim.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: application/x-www-form-urlencoded
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## FetchSim
    55  
    56  > SupersimV1Sim FetchSim(ctx, Sid)
    57  
    58  
    59  
    60  Fetch a Super SIM instance from your account.
    61  
    62  ### Path Parameters
    63  
    64  
    65  Name | Type | Description
    66  ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **Sid** | **string** | The SID of the Sim resource to fetch.
    69  
    70  ### Other Parameters
    71  
    72  Other parameters are passed through a pointer to a FetchSimParams struct
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  
    78  ### Return type
    79  
    80  [**SupersimV1Sim**](SupersimV1Sim.md)
    81  
    82  ### Authorization
    83  
    84  [accountSid_authToken](../README.md#accountSid_authToken)
    85  
    86  ### HTTP request headers
    87  
    88  - **Content-Type**: Not defined
    89  - **Accept**: application/json
    90  
    91  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    92  [[Back to Model list]](../README.md#documentation-for-models)
    93  [[Back to README]](../README.md)
    94  
    95  
    96  ## ListSim
    97  
    98  > []SupersimV1Sim ListSim(ctx, optional)
    99  
   100  
   101  
   102  Retrieve a list of Super SIMs from your account.
   103  
   104  ### Path Parameters
   105  
   106  This endpoint does not need any path parameter.
   107  
   108  ### Other Parameters
   109  
   110  Other parameters are passed through a pointer to a ListSimParams struct
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **Status** | **string** | The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.
   116  **Fleet** | **string** | The SID or unique name of the Fleet to which a list of Sims are assigned.
   117  **Iccid** | **string** | The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.
   118  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   119  **Limit** | **int** | Max number of records to return.
   120  
   121  ### Return type
   122  
   123  [**[]SupersimV1Sim**](SupersimV1Sim.md)
   124  
   125  ### Authorization
   126  
   127  [accountSid_authToken](../README.md#accountSid_authToken)
   128  
   129  ### HTTP request headers
   130  
   131  - **Content-Type**: Not defined
   132  - **Accept**: application/json
   133  
   134  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   135  [[Back to Model list]](../README.md#documentation-for-models)
   136  [[Back to README]](../README.md)
   137  
   138  
   139  ## UpdateSim
   140  
   141  > SupersimV1Sim UpdateSim(ctx, Sidoptional)
   142  
   143  
   144  
   145  Updates the given properties of a Super SIM instance from your account.
   146  
   147  ### Path Parameters
   148  
   149  
   150  Name | Type | Description
   151  ------------- | ------------- | -------------
   152  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   153  **Sid** | **string** | The SID of the Sim resource to update.
   154  
   155  ### Other Parameters
   156  
   157  Other parameters are passed through a pointer to a UpdateSimParams struct
   158  
   159  
   160  Name | Type | Description
   161  ------------- | ------------- | -------------
   162  **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
   163  **Status** | **string** | 
   164  **Fleet** | **string** | The SID or unique name of the Fleet to which the SIM resource should be assigned.
   165  **CallbackUrl** | **string** | The URL we should call using the `callback_method` after an asynchronous update has finished.
   166  **CallbackMethod** | **string** | The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
   167  **AccountSid** | **string** | The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new.
   168  
   169  ### Return type
   170  
   171  [**SupersimV1Sim**](SupersimV1Sim.md)
   172  
   173  ### Authorization
   174  
   175  [accountSid_authToken](../README.md#accountSid_authToken)
   176  
   177  ### HTTP request headers
   178  
   179  - **Content-Type**: application/x-www-form-urlencoded
   180  - **Accept**: application/json
   181  
   182  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   183  [[Back to Model list]](../README.md#documentation-for-models)
   184  [[Back to README]](../README.md)
   185