github.com/twilio/twilio-go@v1.20.1/rest/routes/v2/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://routes.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *PhoneNumbersApi* | [**FetchPhoneNumber**](docs/PhoneNumbersApi.md#fetchphonenumber) | **Get** /v2/PhoneNumbers/{PhoneNumber} | 
    35  *PhoneNumbersApi* | [**UpdatePhoneNumber**](docs/PhoneNumbersApi.md#updatephonenumber) | **Post** /v2/PhoneNumbers/{PhoneNumber} | 
    36  *SipDomainsApi* | [**FetchSipDomain**](docs/SipDomainsApi.md#fetchsipdomain) | **Get** /v2/SipDomains/{SipDomain} | 
    37  *SipDomainsApi* | [**UpdateSipDomain**](docs/SipDomainsApi.md#updatesipdomain) | **Post** /v2/SipDomains/{SipDomain} | 
    38  *TrunksApi* | [**FetchTrunks**](docs/TrunksApi.md#fetchtrunks) | **Get** /v2/Trunks/{SipTrunkDomain} | 
    39  *TrunksApi* | [**UpdateTrunks**](docs/TrunksApi.md#updatetrunks) | **Post** /v2/Trunks/{SipTrunkDomain} | 
    40  
    41  
    42  ## Documentation For Models
    43  
    44   - [RoutesV2Trunks](docs/RoutesV2Trunks.md)
    45   - [RoutesV2SipDomain](docs/RoutesV2SipDomain.md)
    46   - [RoutesV2PhoneNumber](docs/RoutesV2PhoneNumber.md)
    47  
    48  
    49  ## Documentation For Authorization
    50  
    51  
    52  
    53  ## accountSid_authToken
    54  
    55  - **Type**: HTTP basic authentication
    56  
    57  Example
    58  
    59  ```golang
    60  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    61      UserName: "username",
    62      Password: "password",
    63  })
    64  r, err := client.Service.Operation(auth, args)
    65  ```
    66