github.com/twilio/twilio-go@v1.20.1/rest/wireless/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://wireless.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *CommandsApi* | [**CreateCommand**](docs/CommandsApi.md#createcommand) | **Post** /v1/Commands | 
    35  *CommandsApi* | [**DeleteCommand**](docs/CommandsApi.md#deletecommand) | **Delete** /v1/Commands/{Sid} | 
    36  *CommandsApi* | [**FetchCommand**](docs/CommandsApi.md#fetchcommand) | **Get** /v1/Commands/{Sid} | 
    37  *CommandsApi* | [**ListCommand**](docs/CommandsApi.md#listcommand) | **Get** /v1/Commands | 
    38  *RatePlansApi* | [**CreateRatePlan**](docs/RatePlansApi.md#createrateplan) | **Post** /v1/RatePlans | 
    39  *RatePlansApi* | [**DeleteRatePlan**](docs/RatePlansApi.md#deleterateplan) | **Delete** /v1/RatePlans/{Sid} | 
    40  *RatePlansApi* | [**FetchRatePlan**](docs/RatePlansApi.md#fetchrateplan) | **Get** /v1/RatePlans/{Sid} | 
    41  *RatePlansApi* | [**ListRatePlan**](docs/RatePlansApi.md#listrateplan) | **Get** /v1/RatePlans | 
    42  *RatePlansApi* | [**UpdateRatePlan**](docs/RatePlansApi.md#updaterateplan) | **Post** /v1/RatePlans/{Sid} | 
    43  *SimsApi* | [**DeleteSim**](docs/SimsApi.md#deletesim) | **Delete** /v1/Sims/{Sid} | 
    44  *SimsApi* | [**FetchSim**](docs/SimsApi.md#fetchsim) | **Get** /v1/Sims/{Sid} | 
    45  *SimsApi* | [**ListSim**](docs/SimsApi.md#listsim) | **Get** /v1/Sims | 
    46  *SimsApi* | [**UpdateSim**](docs/SimsApi.md#updatesim) | **Post** /v1/Sims/{Sid} | 
    47  *SimsDataSessionsApi* | [**ListDataSession**](docs/SimsDataSessionsApi.md#listdatasession) | **Get** /v1/Sims/{SimSid}/DataSessions | 
    48  *SimsUsageRecordsApi* | [**ListUsageRecord**](docs/SimsUsageRecordsApi.md#listusagerecord) | **Get** /v1/Sims/{SimSid}/UsageRecords | 
    49  *UsageRecordsApi* | [**ListAccountUsageRecord**](docs/UsageRecordsApi.md#listaccountusagerecord) | **Get** /v1/UsageRecords | 
    50  
    51  
    52  ## Documentation For Models
    53  
    54   - [ListRatePlanResponse](docs/ListRatePlanResponse.md)
    55   - [WirelessV1UsageRecord](docs/WirelessV1UsageRecord.md)
    56   - [ListUsageRecordResponse](docs/ListUsageRecordResponse.md)
    57   - [ListAccountUsageRecordResponse](docs/ListAccountUsageRecordResponse.md)
    58   - [WirelessV1DataSession](docs/WirelessV1DataSession.md)
    59   - [ListSimResponse](docs/ListSimResponse.md)
    60   - [WirelessV1AccountUsageRecord](docs/WirelessV1AccountUsageRecord.md)
    61   - [ListAccountUsageRecordResponseMeta](docs/ListAccountUsageRecordResponseMeta.md)
    62   - [WirelessV1Command](docs/WirelessV1Command.md)
    63   - [WirelessV1Sim](docs/WirelessV1Sim.md)
    64   - [ListCommandResponse](docs/ListCommandResponse.md)
    65   - [WirelessV1RatePlan](docs/WirelessV1RatePlan.md)
    66   - [ListDataSessionResponse](docs/ListDataSessionResponse.md)
    67  
    68  
    69  ## Documentation For Authorization
    70  
    71  
    72  
    73  ## accountSid_authToken
    74  
    75  - **Type**: HTTP basic authentication
    76  
    77  Example
    78  
    79  ```golang
    80  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    81      UserName: "username",
    82      Password: "password",
    83  })
    84  r, err := client.Service.Operation(auth, args)
    85  ```
    86