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

     1  # FleetsApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateFleet**](FleetsApi.md#CreateFleet) | **Post** /v1/Fleets | 
     8  [**FetchFleet**](FleetsApi.md#FetchFleet) | **Get** /v1/Fleets/{Sid} | 
     9  [**ListFleet**](FleetsApi.md#ListFleet) | **Get** /v1/Fleets | 
    10  [**UpdateFleet**](FleetsApi.md#UpdateFleet) | **Post** /v1/Fleets/{Sid} | 
    11  
    12  
    13  
    14  ## CreateFleet
    15  
    16  > SupersimV1Fleet CreateFleet(ctx, optional)
    17  
    18  
    19  
    20  Create a Fleet
    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 CreateFleetParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **NetworkAccessProfile** | **string** | The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
    34  **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.
    35  **DataEnabled** | **bool** | Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`.
    36  **DataLimit** | **int** | The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
    37  **IpCommandsUrl** | **string** | The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
    38  **IpCommandsMethod** | **string** | A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
    39  **SmsCommandsEnabled** | **bool** | Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.
    40  **SmsCommandsUrl** | **string** | The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
    41  **SmsCommandsMethod** | **string** | A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
    42  
    43  ### Return type
    44  
    45  [**SupersimV1Fleet**](SupersimV1Fleet.md)
    46  
    47  ### Authorization
    48  
    49  [accountSid_authToken](../README.md#accountSid_authToken)
    50  
    51  ### HTTP request headers
    52  
    53  - **Content-Type**: application/x-www-form-urlencoded
    54  - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    57  [[Back to Model list]](../README.md#documentation-for-models)
    58  [[Back to README]](../README.md)
    59  
    60  
    61  ## FetchFleet
    62  
    63  > SupersimV1Fleet FetchFleet(ctx, Sid)
    64  
    65  
    66  
    67  Fetch a Fleet instance from your account.
    68  
    69  ### Path Parameters
    70  
    71  
    72  Name | Type | Description
    73  ------------- | ------------- | -------------
    74  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    75  **Sid** | **string** | The SID of the Fleet resource to fetch.
    76  
    77  ### Other Parameters
    78  
    79  Other parameters are passed through a pointer to a FetchFleetParams struct
    80  
    81  
    82  Name | Type | Description
    83  ------------- | ------------- | -------------
    84  
    85  ### Return type
    86  
    87  [**SupersimV1Fleet**](SupersimV1Fleet.md)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: application/json
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## ListFleet
   104  
   105  > []SupersimV1Fleet ListFleet(ctx, optional)
   106  
   107  
   108  
   109  Retrieve a list of Fleets from your account.
   110  
   111  ### Path Parameters
   112  
   113  This endpoint does not need any path parameter.
   114  
   115  ### Other Parameters
   116  
   117  Other parameters are passed through a pointer to a ListFleetParams struct
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  **NetworkAccessProfile** | **string** | The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
   123  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   124  **Limit** | **int** | Max number of records to return.
   125  
   126  ### Return type
   127  
   128  [**[]SupersimV1Fleet**](SupersimV1Fleet.md)
   129  
   130  ### Authorization
   131  
   132  [accountSid_authToken](../README.md#accountSid_authToken)
   133  
   134  ### HTTP request headers
   135  
   136  - **Content-Type**: Not defined
   137  - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   140  [[Back to Model list]](../README.md#documentation-for-models)
   141  [[Back to README]](../README.md)
   142  
   143  
   144  ## UpdateFleet
   145  
   146  > SupersimV1Fleet UpdateFleet(ctx, Sidoptional)
   147  
   148  
   149  
   150  Updates the given properties of a Super SIM Fleet instance from your account.
   151  
   152  ### Path Parameters
   153  
   154  
   155  Name | Type | Description
   156  ------------- | ------------- | -------------
   157  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   158  **Sid** | **string** | The SID of the Fleet resource to update.
   159  
   160  ### Other Parameters
   161  
   162  Other parameters are passed through a pointer to a UpdateFleetParams struct
   163  
   164  
   165  Name | Type | Description
   166  ------------- | ------------- | -------------
   167  **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.
   168  **NetworkAccessProfile** | **string** | The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
   169  **IpCommandsUrl** | **string** | The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
   170  **IpCommandsMethod** | **string** | A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
   171  **SmsCommandsUrl** | **string** | The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
   172  **SmsCommandsMethod** | **string** | A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
   173  **DataLimit** | **int** | The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
   174  
   175  ### Return type
   176  
   177  [**SupersimV1Fleet**](SupersimV1Fleet.md)
   178  
   179  ### Authorization
   180  
   181  [accountSid_authToken](../README.md#accountSid_authToken)
   182  
   183  ### HTTP request headers
   184  
   185  - **Content-Type**: application/x-www-form-urlencoded
   186  - **Accept**: application/json
   187  
   188  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   189  [[Back to Model list]](../README.md#documentation-for-models)
   190  [[Back to README]](../README.md)
   191