github.com/twilio/twilio-go@v1.20.1/rest/numbers/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://numbers.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *HostedNumberAuthorizationDocumentsApi* | [**CreateAuthorizationDocument**](docs/HostedNumberAuthorizationDocumentsApi.md#createauthorizationdocument) | **Post** /v2/HostedNumber/AuthorizationDocuments | 
    35  *HostedNumberAuthorizationDocumentsApi* | [**DeleteAuthorizationDocument**](docs/HostedNumberAuthorizationDocumentsApi.md#deleteauthorizationdocument) | **Delete** /v2/HostedNumber/AuthorizationDocuments/{Sid} | 
    36  *HostedNumberAuthorizationDocumentsApi* | [**FetchAuthorizationDocument**](docs/HostedNumberAuthorizationDocumentsApi.md#fetchauthorizationdocument) | **Get** /v2/HostedNumber/AuthorizationDocuments/{Sid} | 
    37  *HostedNumberAuthorizationDocumentsApi* | [**ListAuthorizationDocument**](docs/HostedNumberAuthorizationDocumentsApi.md#listauthorizationdocument) | **Get** /v2/HostedNumber/AuthorizationDocuments | 
    38  *HostedNumberAuthorizationDocumentsDependentHostedNumberOrdersApi* | [**ListDependentHostedNumberOrder**](docs/HostedNumberAuthorizationDocumentsDependentHostedNumberOrdersApi.md#listdependenthostednumberorder) | **Get** /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders | 
    39  *HostedNumberOrdersApi* | [**CreateHostedNumberOrder**](docs/HostedNumberOrdersApi.md#createhostednumberorder) | **Post** /v2/HostedNumber/Orders | 
    40  *HostedNumberOrdersApi* | [**DeleteHostedNumberOrder**](docs/HostedNumberOrdersApi.md#deletehostednumberorder) | **Delete** /v2/HostedNumber/Orders/{Sid} | 
    41  *HostedNumberOrdersApi* | [**FetchHostedNumberOrder**](docs/HostedNumberOrdersApi.md#fetchhostednumberorder) | **Get** /v2/HostedNumber/Orders/{Sid} | 
    42  *HostedNumberOrdersApi* | [**ListHostedNumberOrder**](docs/HostedNumberOrdersApi.md#listhostednumberorder) | **Get** /v2/HostedNumber/Orders | 
    43  *HostedNumberOrdersBulkApi* | [**CreateBulkHostedNumberOrder**](docs/HostedNumberOrdersBulkApi.md#createbulkhostednumberorder) | **Post** /v2/HostedNumber/Orders/Bulk | 
    44  *HostedNumberOrdersBulkApi* | [**FetchBulkHostedNumberOrder**](docs/HostedNumberOrdersBulkApi.md#fetchbulkhostednumberorder) | **Get** /v2/HostedNumber/Orders/Bulk/{BulkHostingSid} | 
    45  *RegulatoryComplianceBundlesApi* | [**CreateBundle**](docs/RegulatoryComplianceBundlesApi.md#createbundle) | **Post** /v2/RegulatoryCompliance/Bundles | 
    46  *RegulatoryComplianceBundlesApi* | [**DeleteBundle**](docs/RegulatoryComplianceBundlesApi.md#deletebundle) | **Delete** /v2/RegulatoryCompliance/Bundles/{Sid} | 
    47  *RegulatoryComplianceBundlesApi* | [**FetchBundle**](docs/RegulatoryComplianceBundlesApi.md#fetchbundle) | **Get** /v2/RegulatoryCompliance/Bundles/{Sid} | 
    48  *RegulatoryComplianceBundlesApi* | [**ListBundle**](docs/RegulatoryComplianceBundlesApi.md#listbundle) | **Get** /v2/RegulatoryCompliance/Bundles | 
    49  *RegulatoryComplianceBundlesApi* | [**UpdateBundle**](docs/RegulatoryComplianceBundlesApi.md#updatebundle) | **Post** /v2/RegulatoryCompliance/Bundles/{Sid} | 
    50  *RegulatoryComplianceBundlesCopiesApi* | [**CreateBundleCopy**](docs/RegulatoryComplianceBundlesCopiesApi.md#createbundlecopy) | **Post** /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies | 
    51  *RegulatoryComplianceBundlesCopiesApi* | [**ListBundleCopy**](docs/RegulatoryComplianceBundlesCopiesApi.md#listbundlecopy) | **Get** /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies | 
    52  *RegulatoryComplianceBundlesEvaluationsApi* | [**CreateEvaluation**](docs/RegulatoryComplianceBundlesEvaluationsApi.md#createevaluation) | **Post** /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations | 
    53  *RegulatoryComplianceBundlesEvaluationsApi* | [**FetchEvaluation**](docs/RegulatoryComplianceBundlesEvaluationsApi.md#fetchevaluation) | **Get** /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid} | 
    54  *RegulatoryComplianceBundlesEvaluationsApi* | [**ListEvaluation**](docs/RegulatoryComplianceBundlesEvaluationsApi.md#listevaluation) | **Get** /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations | 
    55  *RegulatoryComplianceBundlesItemAssignmentsApi* | [**CreateItemAssignment**](docs/RegulatoryComplianceBundlesItemAssignmentsApi.md#createitemassignment) | **Post** /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments | 
    56  *RegulatoryComplianceBundlesItemAssignmentsApi* | [**DeleteItemAssignment**](docs/RegulatoryComplianceBundlesItemAssignmentsApi.md#deleteitemassignment) | **Delete** /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid} | 
    57  *RegulatoryComplianceBundlesItemAssignmentsApi* | [**FetchItemAssignment**](docs/RegulatoryComplianceBundlesItemAssignmentsApi.md#fetchitemassignment) | **Get** /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid} | 
    58  *RegulatoryComplianceBundlesItemAssignmentsApi* | [**ListItemAssignment**](docs/RegulatoryComplianceBundlesItemAssignmentsApi.md#listitemassignment) | **Get** /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments | 
    59  *RegulatoryComplianceBundlesReplaceItemsApi* | [**CreateReplaceItems**](docs/RegulatoryComplianceBundlesReplaceItemsApi.md#createreplaceitems) | **Post** /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems | 
    60  *RegulatoryComplianceEndUserTypesApi* | [**FetchEndUserType**](docs/RegulatoryComplianceEndUserTypesApi.md#fetchendusertype) | **Get** /v2/RegulatoryCompliance/EndUserTypes/{Sid} | 
    61  *RegulatoryComplianceEndUserTypesApi* | [**ListEndUserType**](docs/RegulatoryComplianceEndUserTypesApi.md#listendusertype) | **Get** /v2/RegulatoryCompliance/EndUserTypes | 
    62  *RegulatoryComplianceEndUsersApi* | [**CreateEndUser**](docs/RegulatoryComplianceEndUsersApi.md#createenduser) | **Post** /v2/RegulatoryCompliance/EndUsers | 
    63  *RegulatoryComplianceEndUsersApi* | [**DeleteEndUser**](docs/RegulatoryComplianceEndUsersApi.md#deleteenduser) | **Delete** /v2/RegulatoryCompliance/EndUsers/{Sid} | 
    64  *RegulatoryComplianceEndUsersApi* | [**FetchEndUser**](docs/RegulatoryComplianceEndUsersApi.md#fetchenduser) | **Get** /v2/RegulatoryCompliance/EndUsers/{Sid} | 
    65  *RegulatoryComplianceEndUsersApi* | [**ListEndUser**](docs/RegulatoryComplianceEndUsersApi.md#listenduser) | **Get** /v2/RegulatoryCompliance/EndUsers | 
    66  *RegulatoryComplianceEndUsersApi* | [**UpdateEndUser**](docs/RegulatoryComplianceEndUsersApi.md#updateenduser) | **Post** /v2/RegulatoryCompliance/EndUsers/{Sid} | 
    67  *RegulatoryComplianceRegulationsApi* | [**FetchRegulation**](docs/RegulatoryComplianceRegulationsApi.md#fetchregulation) | **Get** /v2/RegulatoryCompliance/Regulations/{Sid} | 
    68  *RegulatoryComplianceRegulationsApi* | [**ListRegulation**](docs/RegulatoryComplianceRegulationsApi.md#listregulation) | **Get** /v2/RegulatoryCompliance/Regulations | 
    69  *RegulatoryComplianceSupportingDocumentTypesApi* | [**FetchSupportingDocumentType**](docs/RegulatoryComplianceSupportingDocumentTypesApi.md#fetchsupportingdocumenttype) | **Get** /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid} | 
    70  *RegulatoryComplianceSupportingDocumentTypesApi* | [**ListSupportingDocumentType**](docs/RegulatoryComplianceSupportingDocumentTypesApi.md#listsupportingdocumenttype) | **Get** /v2/RegulatoryCompliance/SupportingDocumentTypes | 
    71  *RegulatoryComplianceSupportingDocumentsApi* | [**CreateSupportingDocument**](docs/RegulatoryComplianceSupportingDocumentsApi.md#createsupportingdocument) | **Post** /v2/RegulatoryCompliance/SupportingDocuments | 
    72  *RegulatoryComplianceSupportingDocumentsApi* | [**DeleteSupportingDocument**](docs/RegulatoryComplianceSupportingDocumentsApi.md#deletesupportingdocument) | **Delete** /v2/RegulatoryCompliance/SupportingDocuments/{Sid} | 
    73  *RegulatoryComplianceSupportingDocumentsApi* | [**FetchSupportingDocument**](docs/RegulatoryComplianceSupportingDocumentsApi.md#fetchsupportingdocument) | **Get** /v2/RegulatoryCompliance/SupportingDocuments/{Sid} | 
    74  *RegulatoryComplianceSupportingDocumentsApi* | [**ListSupportingDocument**](docs/RegulatoryComplianceSupportingDocumentsApi.md#listsupportingdocument) | **Get** /v2/RegulatoryCompliance/SupportingDocuments | 
    75  *RegulatoryComplianceSupportingDocumentsApi* | [**UpdateSupportingDocument**](docs/RegulatoryComplianceSupportingDocumentsApi.md#updatesupportingdocument) | **Post** /v2/RegulatoryCompliance/SupportingDocuments/{Sid} | 
    76  
    77  
    78  ## Documentation For Models
    79  
    80   - [ListItemAssignmentResponse](docs/ListItemAssignmentResponse.md)
    81   - [NumbersV2AuthorizationDocument](docs/NumbersV2AuthorizationDocument.md)
    82   - [NumbersV2HostedNumberOrder](docs/NumbersV2HostedNumberOrder.md)
    83   - [ListHostedNumberOrderResponse](docs/ListHostedNumberOrderResponse.md)
    84   - [ListAuthorizationDocumentResponseMeta](docs/ListAuthorizationDocumentResponseMeta.md)
    85   - [ListRegulationResponse](docs/ListRegulationResponse.md)
    86   - [NumbersV2Regulation](docs/NumbersV2Regulation.md)
    87   - [ListEvaluationResponse](docs/ListEvaluationResponse.md)
    88   - [NumbersV2HostedNumberOrderCapabilities](docs/NumbersV2HostedNumberOrderCapabilities.md)
    89   - [ListAuthorizationDocumentResponse](docs/ListAuthorizationDocumentResponse.md)
    90   - [NumbersV2BulkHostedNumberOrder](docs/NumbersV2BulkHostedNumberOrder.md)
    91   - [NumbersV2ReplaceItems](docs/NumbersV2ReplaceItems.md)
    92   - [ListSupportingDocumentResponse](docs/ListSupportingDocumentResponse.md)
    93   - [ListSupportingDocumentTypeResponse](docs/ListSupportingDocumentTypeResponse.md)
    94   - [ListEndUserTypeResponse](docs/ListEndUserTypeResponse.md)
    95   - [ListEndUserResponse](docs/ListEndUserResponse.md)
    96   - [NumbersV2Evaluation](docs/NumbersV2Evaluation.md)
    97   - [NumbersV2EndUserType](docs/NumbersV2EndUserType.md)
    98   - [NumbersV2DependentHostedNumberOrder](docs/NumbersV2DependentHostedNumberOrder.md)
    99   - [ListDependentHostedNumberOrderResponse](docs/ListDependentHostedNumberOrderResponse.md)
   100   - [NumbersV2Bundle](docs/NumbersV2Bundle.md)
   101   - [NumbersV2ItemAssignment](docs/NumbersV2ItemAssignment.md)
   102   - [NumbersV2SupportingDocumentType](docs/NumbersV2SupportingDocumentType.md)
   103   - [NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities](docs/NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities.md)
   104   - [ListBundleResponse](docs/ListBundleResponse.md)
   105   - [NumbersV2BundleCopy](docs/NumbersV2BundleCopy.md)
   106   - [ListBundleCopyResponse](docs/ListBundleCopyResponse.md)
   107   - [NumbersV2SupportingDocument](docs/NumbersV2SupportingDocument.md)
   108   - [NumbersV2EndUser](docs/NumbersV2EndUser.md)
   109  
   110  
   111  ## Documentation For Authorization
   112  
   113  
   114  
   115  ## accountSid_authToken
   116  
   117  - **Type**: HTTP basic authentication
   118  
   119  Example
   120  
   121  ```golang
   122  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   123      UserName: "username",
   124      Password: "password",
   125  })
   126  r, err := client.Service.Operation(auth, args)
   127  ```
   128