github.com/twilio/twilio-go@v1.20.1/rest/voice/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://voice.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ArchivesCallsApi* | [**DeleteArchivedCall**](docs/ArchivesCallsApi.md#deletearchivedcall) | **Delete** /v1/Archives/{Date}/Calls/{Sid} | 
    35  *ByocTrunksApi* | [**CreateByocTrunk**](docs/ByocTrunksApi.md#createbyoctrunk) | **Post** /v1/ByocTrunks | 
    36  *ByocTrunksApi* | [**DeleteByocTrunk**](docs/ByocTrunksApi.md#deletebyoctrunk) | **Delete** /v1/ByocTrunks/{Sid} | 
    37  *ByocTrunksApi* | [**FetchByocTrunk**](docs/ByocTrunksApi.md#fetchbyoctrunk) | **Get** /v1/ByocTrunks/{Sid} | 
    38  *ByocTrunksApi* | [**ListByocTrunk**](docs/ByocTrunksApi.md#listbyoctrunk) | **Get** /v1/ByocTrunks | 
    39  *ByocTrunksApi* | [**UpdateByocTrunk**](docs/ByocTrunksApi.md#updatebyoctrunk) | **Post** /v1/ByocTrunks/{Sid} | 
    40  *ConnectionPoliciesApi* | [**CreateConnectionPolicy**](docs/ConnectionPoliciesApi.md#createconnectionpolicy) | **Post** /v1/ConnectionPolicies | 
    41  *ConnectionPoliciesApi* | [**DeleteConnectionPolicy**](docs/ConnectionPoliciesApi.md#deleteconnectionpolicy) | **Delete** /v1/ConnectionPolicies/{Sid} | 
    42  *ConnectionPoliciesApi* | [**FetchConnectionPolicy**](docs/ConnectionPoliciesApi.md#fetchconnectionpolicy) | **Get** /v1/ConnectionPolicies/{Sid} | 
    43  *ConnectionPoliciesApi* | [**ListConnectionPolicy**](docs/ConnectionPoliciesApi.md#listconnectionpolicy) | **Get** /v1/ConnectionPolicies | 
    44  *ConnectionPoliciesApi* | [**UpdateConnectionPolicy**](docs/ConnectionPoliciesApi.md#updateconnectionpolicy) | **Post** /v1/ConnectionPolicies/{Sid} | 
    45  *ConnectionPoliciesTargetsApi* | [**CreateConnectionPolicyTarget**](docs/ConnectionPoliciesTargetsApi.md#createconnectionpolicytarget) | **Post** /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets | 
    46  *ConnectionPoliciesTargetsApi* | [**DeleteConnectionPolicyTarget**](docs/ConnectionPoliciesTargetsApi.md#deleteconnectionpolicytarget) | **Delete** /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid} | 
    47  *ConnectionPoliciesTargetsApi* | [**FetchConnectionPolicyTarget**](docs/ConnectionPoliciesTargetsApi.md#fetchconnectionpolicytarget) | **Get** /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid} | 
    48  *ConnectionPoliciesTargetsApi* | [**ListConnectionPolicyTarget**](docs/ConnectionPoliciesTargetsApi.md#listconnectionpolicytarget) | **Get** /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets | 
    49  *ConnectionPoliciesTargetsApi* | [**UpdateConnectionPolicyTarget**](docs/ConnectionPoliciesTargetsApi.md#updateconnectionpolicytarget) | **Post** /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid} | 
    50  *DialingPermissionsBulkCountryUpdatesApi* | [**CreateDialingPermissionsCountryBulkUpdate**](docs/DialingPermissionsBulkCountryUpdatesApi.md#createdialingpermissionscountrybulkupdate) | **Post** /v1/DialingPermissions/BulkCountryUpdates | 
    51  *DialingPermissionsCountriesApi* | [**FetchDialingPermissionsCountry**](docs/DialingPermissionsCountriesApi.md#fetchdialingpermissionscountry) | **Get** /v1/DialingPermissions/Countries/{IsoCode} | 
    52  *DialingPermissionsCountriesApi* | [**ListDialingPermissionsCountry**](docs/DialingPermissionsCountriesApi.md#listdialingpermissionscountry) | **Get** /v1/DialingPermissions/Countries | 
    53  *DialingPermissionsCountriesHighRiskSpecialPrefixesApi* | [**ListDialingPermissionsHrsPrefixes**](docs/DialingPermissionsCountriesHighRiskSpecialPrefixesApi.md#listdialingpermissionshrsprefixes) | **Get** /v1/DialingPermissions/Countries/{IsoCode}/HighRiskSpecialPrefixes | 
    54  *IpRecordsApi* | [**CreateIpRecord**](docs/IpRecordsApi.md#createiprecord) | **Post** /v1/IpRecords | 
    55  *IpRecordsApi* | [**DeleteIpRecord**](docs/IpRecordsApi.md#deleteiprecord) | **Delete** /v1/IpRecords/{Sid} | 
    56  *IpRecordsApi* | [**FetchIpRecord**](docs/IpRecordsApi.md#fetchiprecord) | **Get** /v1/IpRecords/{Sid} | 
    57  *IpRecordsApi* | [**ListIpRecord**](docs/IpRecordsApi.md#listiprecord) | **Get** /v1/IpRecords | 
    58  *IpRecordsApi* | [**UpdateIpRecord**](docs/IpRecordsApi.md#updateiprecord) | **Post** /v1/IpRecords/{Sid} | 
    59  *SettingsApi* | [**FetchDialingPermissionsSettings**](docs/SettingsApi.md#fetchdialingpermissionssettings) | **Get** /v1/Settings | 
    60  *SettingsApi* | [**UpdateDialingPermissionsSettings**](docs/SettingsApi.md#updatedialingpermissionssettings) | **Post** /v1/Settings | 
    61  *SourceIpMappingsApi* | [**CreateSourceIpMapping**](docs/SourceIpMappingsApi.md#createsourceipmapping) | **Post** /v1/SourceIpMappings | 
    62  *SourceIpMappingsApi* | [**DeleteSourceIpMapping**](docs/SourceIpMappingsApi.md#deletesourceipmapping) | **Delete** /v1/SourceIpMappings/{Sid} | 
    63  *SourceIpMappingsApi* | [**FetchSourceIpMapping**](docs/SourceIpMappingsApi.md#fetchsourceipmapping) | **Get** /v1/SourceIpMappings/{Sid} | 
    64  *SourceIpMappingsApi* | [**ListSourceIpMapping**](docs/SourceIpMappingsApi.md#listsourceipmapping) | **Get** /v1/SourceIpMappings | 
    65  *SourceIpMappingsApi* | [**UpdateSourceIpMapping**](docs/SourceIpMappingsApi.md#updatesourceipmapping) | **Post** /v1/SourceIpMappings/{Sid} | 
    66  
    67  
    68  ## Documentation For Models
    69  
    70   - [ListByocTrunkResponse](docs/ListByocTrunkResponse.md)
    71   - [VoiceV1DialingPermissionsHrsPrefixes](docs/VoiceV1DialingPermissionsHrsPrefixes.md)
    72   - [VoiceV1DialingPermissionsCountryInstance](docs/VoiceV1DialingPermissionsCountryInstance.md)
    73   - [ListIpRecordResponse](docs/ListIpRecordResponse.md)
    74   - [VoiceV1ArchivedCall](docs/VoiceV1ArchivedCall.md)
    75   - [VoiceV1ByocTrunk](docs/VoiceV1ByocTrunk.md)
    76   - [ListConnectionPolicyResponse](docs/ListConnectionPolicyResponse.md)
    77   - [VoiceV1DialingPermissionsSettings](docs/VoiceV1DialingPermissionsSettings.md)
    78   - [ListSourceIpMappingResponse](docs/ListSourceIpMappingResponse.md)
    79   - [VoiceV1ConnectionPolicyTarget](docs/VoiceV1ConnectionPolicyTarget.md)
    80   - [VoiceV1ConnectionPolicy](docs/VoiceV1ConnectionPolicy.md)
    81   - [ListByocTrunkResponseMeta](docs/ListByocTrunkResponseMeta.md)
    82   - [VoiceV1IpRecord](docs/VoiceV1IpRecord.md)
    83   - [VoiceV1DialingPermissionsCountry](docs/VoiceV1DialingPermissionsCountry.md)
    84   - [ListDialingPermissionsCountryResponse](docs/ListDialingPermissionsCountryResponse.md)
    85   - [ListConnectionPolicyTargetResponse](docs/ListConnectionPolicyTargetResponse.md)
    86   - [VoiceV1SourceIpMapping](docs/VoiceV1SourceIpMapping.md)
    87   - [VoiceV1DialingPermissionsCountryBulkUpdate](docs/VoiceV1DialingPermissionsCountryBulkUpdate.md)
    88   - [ListDialingPermissionsHrsPrefixesResponse](docs/ListDialingPermissionsHrsPrefixesResponse.md)
    89  
    90  
    91  ## Documentation For Authorization
    92  
    93  
    94  
    95  ## accountSid_authToken
    96  
    97  - **Type**: HTTP basic authentication
    98  
    99  Example
   100  
   101  ```golang
   102  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   103      UserName: "username",
   104      Password: "password",
   105  })
   106  r, err := client.Service.Operation(auth, args)
   107  ```
   108