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

     1  # Go API client for openapi
     2  
     3  This is the public Twilio REST API.
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec).  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
     7  
     8  - API version: 1.0.0
     9  - Package version: 1.0.0
    10  - Build package: com.twilio.oai.TwilioGoGenerator
    11  For more information, please visit [https://support.twilio.com](https://support.twilio.com)
    12  
    13  ## Installation
    14  
    15  Install the following dependencies:
    16  
    17  ```shell
    18  go get github.com/stretchr/testify/assert
    19  go get golang.org/x/net/context
    20  ```
    21  
    22  Put the package under your project folder and add the following in import:
    23  
    24  ```golang
    25  import "./openapi"
    26  ```
    27  
    28  ## Documentation for API Endpoints
    29  
    30  All URIs are relative to *https://supersim.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ESimProfilesApi* | [**CreateEsimProfile**](docs/ESimProfilesApi.md#createesimprofile) | **Post** /v1/ESimProfiles | 
    35  *ESimProfilesApi* | [**FetchEsimProfile**](docs/ESimProfilesApi.md#fetchesimprofile) | **Get** /v1/ESimProfiles/{Sid} | 
    36  *ESimProfilesApi* | [**ListEsimProfile**](docs/ESimProfilesApi.md#listesimprofile) | **Get** /v1/ESimProfiles | 
    37  *FleetsApi* | [**CreateFleet**](docs/FleetsApi.md#createfleet) | **Post** /v1/Fleets | 
    38  *FleetsApi* | [**FetchFleet**](docs/FleetsApi.md#fetchfleet) | **Get** /v1/Fleets/{Sid} | 
    39  *FleetsApi* | [**ListFleet**](docs/FleetsApi.md#listfleet) | **Get** /v1/Fleets | 
    40  *FleetsApi* | [**UpdateFleet**](docs/FleetsApi.md#updatefleet) | **Post** /v1/Fleets/{Sid} | 
    41  *IpCommandsApi* | [**CreateIpCommand**](docs/IpCommandsApi.md#createipcommand) | **Post** /v1/IpCommands | 
    42  *IpCommandsApi* | [**FetchIpCommand**](docs/IpCommandsApi.md#fetchipcommand) | **Get** /v1/IpCommands/{Sid} | 
    43  *IpCommandsApi* | [**ListIpCommand**](docs/IpCommandsApi.md#listipcommand) | **Get** /v1/IpCommands | 
    44  *NetworkAccessProfilesApi* | [**CreateNetworkAccessProfile**](docs/NetworkAccessProfilesApi.md#createnetworkaccessprofile) | **Post** /v1/NetworkAccessProfiles | 
    45  *NetworkAccessProfilesApi* | [**FetchNetworkAccessProfile**](docs/NetworkAccessProfilesApi.md#fetchnetworkaccessprofile) | **Get** /v1/NetworkAccessProfiles/{Sid} | 
    46  *NetworkAccessProfilesApi* | [**ListNetworkAccessProfile**](docs/NetworkAccessProfilesApi.md#listnetworkaccessprofile) | **Get** /v1/NetworkAccessProfiles | 
    47  *NetworkAccessProfilesApi* | [**UpdateNetworkAccessProfile**](docs/NetworkAccessProfilesApi.md#updatenetworkaccessprofile) | **Post** /v1/NetworkAccessProfiles/{Sid} | 
    48  *NetworkAccessProfilesNetworksApi* | [**CreateNetworkAccessProfileNetwork**](docs/NetworkAccessProfilesNetworksApi.md#createnetworkaccessprofilenetwork) | **Post** /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks | 
    49  *NetworkAccessProfilesNetworksApi* | [**DeleteNetworkAccessProfileNetwork**](docs/NetworkAccessProfilesNetworksApi.md#deletenetworkaccessprofilenetwork) | **Delete** /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid} | 
    50  *NetworkAccessProfilesNetworksApi* | [**FetchNetworkAccessProfileNetwork**](docs/NetworkAccessProfilesNetworksApi.md#fetchnetworkaccessprofilenetwork) | **Get** /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid} | 
    51  *NetworkAccessProfilesNetworksApi* | [**ListNetworkAccessProfileNetwork**](docs/NetworkAccessProfilesNetworksApi.md#listnetworkaccessprofilenetwork) | **Get** /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks | 
    52  *NetworksApi* | [**FetchNetwork**](docs/NetworksApi.md#fetchnetwork) | **Get** /v1/Networks/{Sid} | 
    53  *NetworksApi* | [**ListNetwork**](docs/NetworksApi.md#listnetwork) | **Get** /v1/Networks | 
    54  *SettingsUpdatesApi* | [**ListSettingsUpdate**](docs/SettingsUpdatesApi.md#listsettingsupdate) | **Get** /v1/SettingsUpdates | 
    55  *SimsApi* | [**CreateSim**](docs/SimsApi.md#createsim) | **Post** /v1/Sims | 
    56  *SimsApi* | [**FetchSim**](docs/SimsApi.md#fetchsim) | **Get** /v1/Sims/{Sid} | 
    57  *SimsApi* | [**ListSim**](docs/SimsApi.md#listsim) | **Get** /v1/Sims | 
    58  *SimsApi* | [**UpdateSim**](docs/SimsApi.md#updatesim) | **Post** /v1/Sims/{Sid} | 
    59  *SimsBillingPeriodsApi* | [**ListBillingPeriod**](docs/SimsBillingPeriodsApi.md#listbillingperiod) | **Get** /v1/Sims/{SimSid}/BillingPeriods | 
    60  *SimsIpAddressesApi* | [**ListSimIpAddress**](docs/SimsIpAddressesApi.md#listsimipaddress) | **Get** /v1/Sims/{SimSid}/IpAddresses | 
    61  *SmsCommandsApi* | [**CreateSmsCommand**](docs/SmsCommandsApi.md#createsmscommand) | **Post** /v1/SmsCommands | 
    62  *SmsCommandsApi* | [**FetchSmsCommand**](docs/SmsCommandsApi.md#fetchsmscommand) | **Get** /v1/SmsCommands/{Sid} | 
    63  *SmsCommandsApi* | [**ListSmsCommand**](docs/SmsCommandsApi.md#listsmscommand) | **Get** /v1/SmsCommands | 
    64  *UsageRecordsApi* | [**ListUsageRecord**](docs/UsageRecordsApi.md#listusagerecord) | **Get** /v1/UsageRecords | 
    65  
    66  
    67  ## Documentation For Models
    68  
    69   - [SupersimV1Network](docs/SupersimV1Network.md)
    70   - [SupersimV1NetworkAccessProfileNetwork](docs/SupersimV1NetworkAccessProfileNetwork.md)
    71   - [ListFleetResponse](docs/ListFleetResponse.md)
    72   - [ListIpCommandResponse](docs/ListIpCommandResponse.md)
    73   - [ListNetworkAccessProfileNetworkResponse](docs/ListNetworkAccessProfileNetworkResponse.md)
    74   - [SupersimV1SmsCommand](docs/SupersimV1SmsCommand.md)
    75   - [SupersimV1EsimProfile](docs/SupersimV1EsimProfile.md)
    76   - [ListBillingPeriodResponse](docs/ListBillingPeriodResponse.md)
    77   - [ListNetworkResponse](docs/ListNetworkResponse.md)
    78   - [ListEsimProfileResponse](docs/ListEsimProfileResponse.md)
    79   - [ListNetworkAccessProfileResponse](docs/ListNetworkAccessProfileResponse.md)
    80   - [SupersimV1NetworkAccessProfile](docs/SupersimV1NetworkAccessProfile.md)
    81   - [ListSimIpAddressResponse](docs/ListSimIpAddressResponse.md)
    82   - [ListUsageRecordResponse](docs/ListUsageRecordResponse.md)
    83   - [ListSettingsUpdateResponse](docs/ListSettingsUpdateResponse.md)
    84   - [SupersimV1SimIpAddress](docs/SupersimV1SimIpAddress.md)
    85   - [ListSimResponse](docs/ListSimResponse.md)
    86   - [SupersimV1Fleet](docs/SupersimV1Fleet.md)
    87   - [SupersimV1SettingsUpdate](docs/SupersimV1SettingsUpdate.md)
    88   - [SupersimV1IpCommand](docs/SupersimV1IpCommand.md)
    89   - [ListSmsCommandResponse](docs/ListSmsCommandResponse.md)
    90   - [SupersimV1Sim](docs/SupersimV1Sim.md)
    91   - [ListBillingPeriodResponseMeta](docs/ListBillingPeriodResponseMeta.md)
    92   - [SupersimV1UsageRecord](docs/SupersimV1UsageRecord.md)
    93   - [SupersimV1BillingPeriod](docs/SupersimV1BillingPeriod.md)
    94  
    95  
    96  ## Documentation For Authorization
    97  
    98  
    99  
   100  ## accountSid_authToken
   101  
   102  - **Type**: HTTP basic authentication
   103  
   104  Example
   105  
   106  ```golang
   107  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   108      UserName: "username",
   109      Password: "password",
   110  })
   111  r, err := client.Service.Operation(auth, args)
   112  ```
   113