github.com/twilio/twilio-go@v1.20.1/rest/trunking/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://trunking.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *TrunksApi* | [**CreateTrunk**](docs/TrunksApi.md#createtrunk) | **Post** /v1/Trunks | 
    35  *TrunksApi* | [**DeleteTrunk**](docs/TrunksApi.md#deletetrunk) | **Delete** /v1/Trunks/{Sid} | 
    36  *TrunksApi* | [**FetchTrunk**](docs/TrunksApi.md#fetchtrunk) | **Get** /v1/Trunks/{Sid} | 
    37  *TrunksApi* | [**ListTrunk**](docs/TrunksApi.md#listtrunk) | **Get** /v1/Trunks | 
    38  *TrunksApi* | [**UpdateTrunk**](docs/TrunksApi.md#updatetrunk) | **Post** /v1/Trunks/{Sid} | 
    39  *TrunksCredentialListsApi* | [**CreateCredentialList**](docs/TrunksCredentialListsApi.md#createcredentiallist) | **Post** /v1/Trunks/{TrunkSid}/CredentialLists | 
    40  *TrunksCredentialListsApi* | [**DeleteCredentialList**](docs/TrunksCredentialListsApi.md#deletecredentiallist) | **Delete** /v1/Trunks/{TrunkSid}/CredentialLists/{Sid} | 
    41  *TrunksCredentialListsApi* | [**FetchCredentialList**](docs/TrunksCredentialListsApi.md#fetchcredentiallist) | **Get** /v1/Trunks/{TrunkSid}/CredentialLists/{Sid} | 
    42  *TrunksCredentialListsApi* | [**ListCredentialList**](docs/TrunksCredentialListsApi.md#listcredentiallist) | **Get** /v1/Trunks/{TrunkSid}/CredentialLists | 
    43  *TrunksIpAccessControlListsApi* | [**CreateIpAccessControlList**](docs/TrunksIpAccessControlListsApi.md#createipaccesscontrollist) | **Post** /v1/Trunks/{TrunkSid}/IpAccessControlLists | 
    44  *TrunksIpAccessControlListsApi* | [**DeleteIpAccessControlList**](docs/TrunksIpAccessControlListsApi.md#deleteipaccesscontrollist) | **Delete** /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid} | 
    45  *TrunksIpAccessControlListsApi* | [**FetchIpAccessControlList**](docs/TrunksIpAccessControlListsApi.md#fetchipaccesscontrollist) | **Get** /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid} | 
    46  *TrunksIpAccessControlListsApi* | [**ListIpAccessControlList**](docs/TrunksIpAccessControlListsApi.md#listipaccesscontrollist) | **Get** /v1/Trunks/{TrunkSid}/IpAccessControlLists | 
    47  *TrunksOriginationUrlsApi* | [**CreateOriginationUrl**](docs/TrunksOriginationUrlsApi.md#createoriginationurl) | **Post** /v1/Trunks/{TrunkSid}/OriginationUrls | 
    48  *TrunksOriginationUrlsApi* | [**DeleteOriginationUrl**](docs/TrunksOriginationUrlsApi.md#deleteoriginationurl) | **Delete** /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid} | 
    49  *TrunksOriginationUrlsApi* | [**FetchOriginationUrl**](docs/TrunksOriginationUrlsApi.md#fetchoriginationurl) | **Get** /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid} | 
    50  *TrunksOriginationUrlsApi* | [**ListOriginationUrl**](docs/TrunksOriginationUrlsApi.md#listoriginationurl) | **Get** /v1/Trunks/{TrunkSid}/OriginationUrls | 
    51  *TrunksOriginationUrlsApi* | [**UpdateOriginationUrl**](docs/TrunksOriginationUrlsApi.md#updateoriginationurl) | **Post** /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid} | 
    52  *TrunksPhoneNumbersApi* | [**CreatePhoneNumber**](docs/TrunksPhoneNumbersApi.md#createphonenumber) | **Post** /v1/Trunks/{TrunkSid}/PhoneNumbers | 
    53  *TrunksPhoneNumbersApi* | [**DeletePhoneNumber**](docs/TrunksPhoneNumbersApi.md#deletephonenumber) | **Delete** /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid} | 
    54  *TrunksPhoneNumbersApi* | [**FetchPhoneNumber**](docs/TrunksPhoneNumbersApi.md#fetchphonenumber) | **Get** /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid} | 
    55  *TrunksPhoneNumbersApi* | [**ListPhoneNumber**](docs/TrunksPhoneNumbersApi.md#listphonenumber) | **Get** /v1/Trunks/{TrunkSid}/PhoneNumbers | 
    56  *TrunksRecordingApi* | [**FetchRecording**](docs/TrunksRecordingApi.md#fetchrecording) | **Get** /v1/Trunks/{TrunkSid}/Recording | 
    57  *TrunksRecordingApi* | [**UpdateRecording**](docs/TrunksRecordingApi.md#updaterecording) | **Post** /v1/Trunks/{TrunkSid}/Recording | 
    58  
    59  
    60  ## Documentation For Models
    61  
    62   - [ListCredentialListResponse](docs/ListCredentialListResponse.md)
    63   - [TrunkingV1CredentialList](docs/TrunkingV1CredentialList.md)
    64   - [TrunkingV1PhoneNumber](docs/TrunkingV1PhoneNumber.md)
    65   - [ListCredentialListResponseMeta](docs/ListCredentialListResponseMeta.md)
    66   - [TrunkingV1Trunk](docs/TrunkingV1Trunk.md)
    67   - [TrunkingV1IpAccessControlList](docs/TrunkingV1IpAccessControlList.md)
    68   - [ListIpAccessControlListResponse](docs/ListIpAccessControlListResponse.md)
    69   - [ListOriginationUrlResponse](docs/ListOriginationUrlResponse.md)
    70   - [ListPhoneNumberResponse](docs/ListPhoneNumberResponse.md)
    71   - [ListTrunkResponse](docs/ListTrunkResponse.md)
    72   - [TrunkingV1Recording](docs/TrunkingV1Recording.md)
    73   - [TrunkingV1OriginationUrl](docs/TrunkingV1OriginationUrl.md)
    74  
    75  
    76  ## Documentation For Authorization
    77  
    78  
    79  
    80  ## accountSid_authToken
    81  
    82  - **Type**: HTTP basic authentication
    83  
    84  Example
    85  
    86  ```golang
    87  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    88      UserName: "username",
    89      Password: "password",
    90  })
    91  r, err := client.Service.Operation(auth, args)
    92  ```
    93