github.com/twilio/twilio-go@v1.20.1/rest/messaging/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://messaging.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *A2pBrandRegistrationsApi* | [**CreateBrandRegistrations**](docs/A2pBrandRegistrationsApi.md#createbrandregistrations) | **Post** /v1/a2p/BrandRegistrations | 
    35  *A2pBrandRegistrationsApi* | [**FetchBrandRegistrations**](docs/A2pBrandRegistrationsApi.md#fetchbrandregistrations) | **Get** /v1/a2p/BrandRegistrations/{Sid} | 
    36  *A2pBrandRegistrationsApi* | [**ListBrandRegistrations**](docs/A2pBrandRegistrationsApi.md#listbrandregistrations) | **Get** /v1/a2p/BrandRegistrations | 
    37  *A2pBrandRegistrationsApi* | [**UpdateBrandRegistrations**](docs/A2pBrandRegistrationsApi.md#updatebrandregistrations) | **Post** /v1/a2p/BrandRegistrations/{Sid} | 
    38  *A2pBrandRegistrationsSmsOtpApi* | [**CreateBrandRegistrationOtp**](docs/A2pBrandRegistrationsSmsOtpApi.md#createbrandregistrationotp) | **Post** /v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp | 
    39  *A2pBrandRegistrationsVettingsApi* | [**CreateBrandVetting**](docs/A2pBrandRegistrationsVettingsApi.md#createbrandvetting) | **Post** /v1/a2p/BrandRegistrations/{BrandSid}/Vettings | 
    40  *A2pBrandRegistrationsVettingsApi* | [**FetchBrandVetting**](docs/A2pBrandRegistrationsVettingsApi.md#fetchbrandvetting) | **Get** /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid} | 
    41  *A2pBrandRegistrationsVettingsApi* | [**ListBrandVetting**](docs/A2pBrandRegistrationsVettingsApi.md#listbrandvetting) | **Get** /v1/a2p/BrandRegistrations/{BrandSid}/Vettings | 
    42  *DeactivationsApi* | [**FetchDeactivation**](docs/DeactivationsApi.md#fetchdeactivation) | **Get** /v1/Deactivations | 
    43  *LinkShorteningDomainsCertificateApi* | [**DeleteDomainCertV4**](docs/LinkShorteningDomainsCertificateApi.md#deletedomaincertv4) | **Delete** /v1/LinkShortening/Domains/{DomainSid}/Certificate | 
    44  *LinkShorteningDomainsCertificateApi* | [**FetchDomainCertV4**](docs/LinkShorteningDomainsCertificateApi.md#fetchdomaincertv4) | **Get** /v1/LinkShortening/Domains/{DomainSid}/Certificate | 
    45  *LinkShorteningDomainsCertificateApi* | [**UpdateDomainCertV4**](docs/LinkShorteningDomainsCertificateApi.md#updatedomaincertv4) | **Post** /v1/LinkShortening/Domains/{DomainSid}/Certificate | 
    46  *LinkShorteningDomainsConfigApi* | [**FetchDomainConfig**](docs/LinkShorteningDomainsConfigApi.md#fetchdomainconfig) | **Get** /v1/LinkShortening/Domains/{DomainSid}/Config | 
    47  *LinkShorteningDomainsConfigApi* | [**UpdateDomainConfig**](docs/LinkShorteningDomainsConfigApi.md#updatedomainconfig) | **Post** /v1/LinkShortening/Domains/{DomainSid}/Config | 
    48  *LinkShorteningDomainsMessagingServicesApi* | [**CreateLinkshorteningMessagingService**](docs/LinkShorteningDomainsMessagingServicesApi.md#createlinkshorteningmessagingservice) | **Post** /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid} | 
    49  *LinkShorteningDomainsMessagingServicesApi* | [**DeleteLinkshorteningMessagingService**](docs/LinkShorteningDomainsMessagingServicesApi.md#deletelinkshorteningmessagingservice) | **Delete** /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid} | 
    50  *LinkShorteningMessagingServiceDomainConfigApi* | [**FetchDomainConfigMessagingService**](docs/LinkShorteningMessagingServiceDomainConfigApi.md#fetchdomainconfigmessagingservice) | **Get** /v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig | 
    51  *LinkShorteningMessagingServicesDomainApi* | [**FetchLinkshorteningMessagingServiceDomainAssociation**](docs/LinkShorteningMessagingServicesDomainApi.md#fetchlinkshorteningmessagingservicedomainassociation) | **Get** /v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain | 
    52  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v1/Services | 
    53  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v1/Services/{Sid} | 
    54  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v1/Services/{Sid} | 
    55  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v1/Services | 
    56  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v1/Services/{Sid} | 
    57  *ServicesAlphaSendersApi* | [**CreateAlphaSender**](docs/ServicesAlphaSendersApi.md#createalphasender) | **Post** /v1/Services/{ServiceSid}/AlphaSenders | 
    58  *ServicesAlphaSendersApi* | [**DeleteAlphaSender**](docs/ServicesAlphaSendersApi.md#deletealphasender) | **Delete** /v1/Services/{ServiceSid}/AlphaSenders/{Sid} | 
    59  *ServicesAlphaSendersApi* | [**FetchAlphaSender**](docs/ServicesAlphaSendersApi.md#fetchalphasender) | **Get** /v1/Services/{ServiceSid}/AlphaSenders/{Sid} | 
    60  *ServicesAlphaSendersApi* | [**ListAlphaSender**](docs/ServicesAlphaSendersApi.md#listalphasender) | **Get** /v1/Services/{ServiceSid}/AlphaSenders | 
    61  *ServicesChannelSendersApi* | [**FetchChannelSender**](docs/ServicesChannelSendersApi.md#fetchchannelsender) | **Get** /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid} | 
    62  *ServicesChannelSendersApi* | [**ListChannelSender**](docs/ServicesChannelSendersApi.md#listchannelsender) | **Get** /v1/Services/{MessagingServiceSid}/ChannelSenders | 
    63  *ServicesComplianceUsa2pApi* | [**CreateUsAppToPerson**](docs/ServicesComplianceUsa2pApi.md#createusapptoperson) | **Post** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p | 
    64  *ServicesComplianceUsa2pApi* | [**DeleteUsAppToPerson**](docs/ServicesComplianceUsa2pApi.md#deleteusapptoperson) | **Delete** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 
    65  *ServicesComplianceUsa2pApi* | [**FetchUsAppToPerson**](docs/ServicesComplianceUsa2pApi.md#fetchusapptoperson) | **Get** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 
    66  *ServicesComplianceUsa2pApi* | [**ListUsAppToPerson**](docs/ServicesComplianceUsa2pApi.md#listusapptoperson) | **Get** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p | 
    67  *ServicesComplianceUsa2pApi* | [**UpdateUsAppToPerson**](docs/ServicesComplianceUsa2pApi.md#updateusapptoperson) | **Post** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 
    68  *ServicesComplianceUsa2pUsecasesApi* | [**FetchUsAppToPersonUsecase**](docs/ServicesComplianceUsa2pUsecasesApi.md#fetchusapptopersonusecase) | **Get** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases | 
    69  *ServicesPhoneNumbersApi* | [**CreatePhoneNumber**](docs/ServicesPhoneNumbersApi.md#createphonenumber) | **Post** /v1/Services/{ServiceSid}/PhoneNumbers | 
    70  *ServicesPhoneNumbersApi* | [**DeletePhoneNumber**](docs/ServicesPhoneNumbersApi.md#deletephonenumber) | **Delete** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    71  *ServicesPhoneNumbersApi* | [**FetchPhoneNumber**](docs/ServicesPhoneNumbersApi.md#fetchphonenumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    72  *ServicesPhoneNumbersApi* | [**ListPhoneNumber**](docs/ServicesPhoneNumbersApi.md#listphonenumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers | 
    73  *ServicesPreregisteredUsa2pApi* | [**CreateExternalCampaign**](docs/ServicesPreregisteredUsa2pApi.md#createexternalcampaign) | **Post** /v1/Services/PreregisteredUsa2p | 
    74  *ServicesShortCodesApi* | [**CreateShortCode**](docs/ServicesShortCodesApi.md#createshortcode) | **Post** /v1/Services/{ServiceSid}/ShortCodes | 
    75  *ServicesShortCodesApi* | [**DeleteShortCode**](docs/ServicesShortCodesApi.md#deleteshortcode) | **Delete** /v1/Services/{ServiceSid}/ShortCodes/{Sid} | 
    76  *ServicesShortCodesApi* | [**FetchShortCode**](docs/ServicesShortCodesApi.md#fetchshortcode) | **Get** /v1/Services/{ServiceSid}/ShortCodes/{Sid} | 
    77  *ServicesShortCodesApi* | [**ListShortCode**](docs/ServicesShortCodesApi.md#listshortcode) | **Get** /v1/Services/{ServiceSid}/ShortCodes | 
    78  *ServicesUsecasesApi* | [**FetchUsecase**](docs/ServicesUsecasesApi.md#fetchusecase) | **Get** /v1/Services/Usecases | 
    79  *TollfreeVerificationsApi* | [**CreateTollfreeVerification**](docs/TollfreeVerificationsApi.md#createtollfreeverification) | **Post** /v1/Tollfree/Verifications | 
    80  *TollfreeVerificationsApi* | [**DeleteTollfreeVerification**](docs/TollfreeVerificationsApi.md#deletetollfreeverification) | **Delete** /v1/Tollfree/Verifications/{Sid} | 
    81  *TollfreeVerificationsApi* | [**FetchTollfreeVerification**](docs/TollfreeVerificationsApi.md#fetchtollfreeverification) | **Get** /v1/Tollfree/Verifications/{Sid} | 
    82  *TollfreeVerificationsApi* | [**ListTollfreeVerification**](docs/TollfreeVerificationsApi.md#listtollfreeverification) | **Get** /v1/Tollfree/Verifications | 
    83  *TollfreeVerificationsApi* | [**UpdateTollfreeVerification**](docs/TollfreeVerificationsApi.md#updatetollfreeverification) | **Post** /v1/Tollfree/Verifications/{Sid} | 
    84  
    85  
    86  ## Documentation For Models
    87  
    88   - [MessagingV1DomainCertV4](docs/MessagingV1DomainCertV4.md)
    89   - [MessagingV1LinkshorteningMessagingServiceDomainAssociation](docs/MessagingV1LinkshorteningMessagingServiceDomainAssociation.md)
    90   - [MessagingV1ExternalCampaign](docs/MessagingV1ExternalCampaign.md)
    91   - [MessagingV1UsAppToPersonUsecase](docs/MessagingV1UsAppToPersonUsecase.md)
    92   - [MessagingV1LinkshorteningMessagingService](docs/MessagingV1LinkshorteningMessagingService.md)
    93   - [MessagingV1TollfreeVerification](docs/MessagingV1TollfreeVerification.md)
    94   - [MessagingV1DomainConfig](docs/MessagingV1DomainConfig.md)
    95   - [MessagingV1UsAppToPerson](docs/MessagingV1UsAppToPerson.md)
    96   - [ListServiceResponse](docs/ListServiceResponse.md)
    97   - [MessagingV1BrandRegistrationOtp](docs/MessagingV1BrandRegistrationOtp.md)
    98   - [MessagingV1BrandRegistrations](docs/MessagingV1BrandRegistrations.md)
    99   - [MessagingV1ChannelSender](docs/MessagingV1ChannelSender.md)
   100   - [MessagingV1ShortCode](docs/MessagingV1ShortCode.md)
   101   - [MessagingV1Usecase](docs/MessagingV1Usecase.md)
   102   - [ListBrandVettingResponse](docs/ListBrandVettingResponse.md)
   103   - [ListAlphaSenderResponse](docs/ListAlphaSenderResponse.md)
   104   - [ListUsAppToPersonResponse](docs/ListUsAppToPersonResponse.md)
   105   - [ListChannelSenderResponse](docs/ListChannelSenderResponse.md)
   106   - [MessagingV1DomainConfigMessagingService](docs/MessagingV1DomainConfigMessagingService.md)
   107   - [MessagingV1Service](docs/MessagingV1Service.md)
   108   - [MessagingV1Deactivation](docs/MessagingV1Deactivation.md)
   109   - [MessagingV1PhoneNumber](docs/MessagingV1PhoneNumber.md)
   110   - [ListBrandRegistrationsResponse](docs/ListBrandRegistrationsResponse.md)
   111   - [ListPhoneNumberResponse](docs/ListPhoneNumberResponse.md)
   112   - [ListTollfreeVerificationResponse](docs/ListTollfreeVerificationResponse.md)
   113   - [MessagingV1AlphaSender](docs/MessagingV1AlphaSender.md)
   114   - [ListAlphaSenderResponseMeta](docs/ListAlphaSenderResponseMeta.md)
   115   - [MessagingV1BrandVetting](docs/MessagingV1BrandVetting.md)
   116   - [ListShortCodeResponse](docs/ListShortCodeResponse.md)
   117  
   118  
   119  ## Documentation For Authorization
   120  
   121  
   122  
   123  ## accountSid_authToken
   124  
   125  - **Type**: HTTP basic authentication
   126  
   127  Example
   128  
   129  ```golang
   130  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   131      UserName: "username",
   132      Password: "password",
   133  })
   134  r, err := client.Service.Operation(auth, args)
   135  ```
   136