github.com/twilio/twilio-go@v1.20.1/rest/numbers/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://numbers.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *HostedNumberEligibilityApi* | [**CreateEligibility**](docs/HostedNumberEligibilityApi.md#createeligibility) | **Post** /v1/HostedNumber/Eligibility | 
    35  *HostedNumberEligibilityBulkApi* | [**CreateBulkEligibility**](docs/HostedNumberEligibilityBulkApi.md#createbulkeligibility) | **Post** /v1/HostedNumber/Eligibility/Bulk | 
    36  *HostedNumberEligibilityBulkApi* | [**FetchBulkEligibility**](docs/HostedNumberEligibilityBulkApi.md#fetchbulkeligibility) | **Get** /v1/HostedNumber/Eligibility/Bulk/{RequestId} | 
    37  *PortingPortInApi* | [**CreatePortingPortIn**](docs/PortingPortInApi.md#createportingportin) | **Post** /v1/Porting/PortIn | 
    38  *PortingPortInApi* | [**DeletePortingPortIn**](docs/PortingPortInApi.md#deleteportingportin) | **Delete** /v1/Porting/PortIn/{PortInRequestSid} | 
    39  *PortingPortInApi* | [**FetchPortingPortInFetch**](docs/PortingPortInApi.md#fetchportingportinfetch) | **Get** /v1/Porting/PortIn/{PortInRequestSid} | 
    40  *PortingPortInPhoneNumberApi* | [**DeletePortingPortInPhoneNumber**](docs/PortingPortInPhoneNumberApi.md#deleteportingportinphonenumber) | **Delete** /v1/Porting/PortIn/{PortInRequestSid}/PhoneNumber/{PhoneNumberSid} | 
    41  *PortingPortabilityApi* | [**CreatePortingBulkPortability**](docs/PortingPortabilityApi.md#createportingbulkportability) | **Post** /v1/Porting/Portability | 
    42  *PortingPortabilityApi* | [**FetchPortingBulkPortability**](docs/PortingPortabilityApi.md#fetchportingbulkportability) | **Get** /v1/Porting/Portability/{Sid} | 
    43  *PortingPortabilityPhoneNumberApi* | [**FetchPortingPortability**](docs/PortingPortabilityPhoneNumberApi.md#fetchportingportability) | **Get** /v1/Porting/Portability/PhoneNumber/{PhoneNumber} | 
    44  
    45  
    46  ## Documentation For Models
    47  
    48   - [NumbersV1PortingPortability](docs/NumbersV1PortingPortability.md)
    49   - [NumbersV1BulkEligibility](docs/NumbersV1BulkEligibility.md)
    50   - [NumbersV1PortingPortInFetch](docs/NumbersV1PortingPortInFetch.md)
    51   - [NumbersV1Eligibility](docs/NumbersV1Eligibility.md)
    52   - [NumbersV1PortingPortInPhoneNumber](docs/NumbersV1PortingPortInPhoneNumber.md)
    53   - [NumbersV1PortingBulkPortability](docs/NumbersV1PortingBulkPortability.md)
    54   - [NumbersV1PortingPortIn](docs/NumbersV1PortingPortIn.md)
    55  
    56  
    57  ## Documentation For Authorization
    58  
    59  
    60  
    61  ## accountSid_authToken
    62  
    63  - **Type**: HTTP basic authentication
    64  
    65  Example
    66  
    67  ```golang
    68  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    69      UserName: "username",
    70      Password: "password",
    71  })
    72  r, err := client.Service.Operation(auth, args)
    73  ```
    74