github.com/twilio/twilio-go@v1.20.1/rest/proxy/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://proxy.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v1/Services | 
    35  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v1/Services/{Sid} | 
    36  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v1/Services/{Sid} | 
    37  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v1/Services | 
    38  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v1/Services/{Sid} | 
    39  *ServicesPhoneNumbersApi* | [**CreatePhoneNumber**](docs/ServicesPhoneNumbersApi.md#createphonenumber) | **Post** /v1/Services/{ServiceSid}/PhoneNumbers | 
    40  *ServicesPhoneNumbersApi* | [**DeletePhoneNumber**](docs/ServicesPhoneNumbersApi.md#deletephonenumber) | **Delete** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    41  *ServicesPhoneNumbersApi* | [**FetchPhoneNumber**](docs/ServicesPhoneNumbersApi.md#fetchphonenumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    42  *ServicesPhoneNumbersApi* | [**ListPhoneNumber**](docs/ServicesPhoneNumbersApi.md#listphonenumber) | **Get** /v1/Services/{ServiceSid}/PhoneNumbers | 
    43  *ServicesPhoneNumbersApi* | [**UpdatePhoneNumber**](docs/ServicesPhoneNumbersApi.md#updatephonenumber) | **Post** /v1/Services/{ServiceSid}/PhoneNumbers/{Sid} | 
    44  *ServicesSessionsApi* | [**CreateSession**](docs/ServicesSessionsApi.md#createsession) | **Post** /v1/Services/{ServiceSid}/Sessions | 
    45  *ServicesSessionsApi* | [**DeleteSession**](docs/ServicesSessionsApi.md#deletesession) | **Delete** /v1/Services/{ServiceSid}/Sessions/{Sid} | 
    46  *ServicesSessionsApi* | [**FetchSession**](docs/ServicesSessionsApi.md#fetchsession) | **Get** /v1/Services/{ServiceSid}/Sessions/{Sid} | 
    47  *ServicesSessionsApi* | [**ListSession**](docs/ServicesSessionsApi.md#listsession) | **Get** /v1/Services/{ServiceSid}/Sessions | 
    48  *ServicesSessionsApi* | [**UpdateSession**](docs/ServicesSessionsApi.md#updatesession) | **Post** /v1/Services/{ServiceSid}/Sessions/{Sid} | 
    49  *ServicesSessionsInteractionsApi* | [**DeleteInteraction**](docs/ServicesSessionsInteractionsApi.md#deleteinteraction) | **Delete** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid} | 
    50  *ServicesSessionsInteractionsApi* | [**FetchInteraction**](docs/ServicesSessionsInteractionsApi.md#fetchinteraction) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid} | 
    51  *ServicesSessionsInteractionsApi* | [**ListInteraction**](docs/ServicesSessionsInteractionsApi.md#listinteraction) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions | 
    52  *ServicesSessionsParticipantsApi* | [**CreateParticipant**](docs/ServicesSessionsParticipantsApi.md#createparticipant) | **Post** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants | 
    53  *ServicesSessionsParticipantsApi* | [**DeleteParticipant**](docs/ServicesSessionsParticipantsApi.md#deleteparticipant) | **Delete** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} | 
    54  *ServicesSessionsParticipantsApi* | [**FetchParticipant**](docs/ServicesSessionsParticipantsApi.md#fetchparticipant) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} | 
    55  *ServicesSessionsParticipantsApi* | [**ListParticipant**](docs/ServicesSessionsParticipantsApi.md#listparticipant) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants | 
    56  *ServicesSessionsParticipantsMessageInteractionsApi* | [**CreateMessageInteraction**](docs/ServicesSessionsParticipantsMessageInteractionsApi.md#createmessageinteraction) | **Post** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions | 
    57  *ServicesSessionsParticipantsMessageInteractionsApi* | [**FetchMessageInteraction**](docs/ServicesSessionsParticipantsMessageInteractionsApi.md#fetchmessageinteraction) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid} | 
    58  *ServicesSessionsParticipantsMessageInteractionsApi* | [**ListMessageInteraction**](docs/ServicesSessionsParticipantsMessageInteractionsApi.md#listmessageinteraction) | **Get** /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions | 
    59  *ServicesShortCodesApi* | [**CreateShortCode**](docs/ServicesShortCodesApi.md#createshortcode) | **Post** /v1/Services/{ServiceSid}/ShortCodes | 
    60  *ServicesShortCodesApi* | [**DeleteShortCode**](docs/ServicesShortCodesApi.md#deleteshortcode) | **Delete** /v1/Services/{ServiceSid}/ShortCodes/{Sid} | 
    61  *ServicesShortCodesApi* | [**FetchShortCode**](docs/ServicesShortCodesApi.md#fetchshortcode) | **Get** /v1/Services/{ServiceSid}/ShortCodes/{Sid} | 
    62  *ServicesShortCodesApi* | [**ListShortCode**](docs/ServicesShortCodesApi.md#listshortcode) | **Get** /v1/Services/{ServiceSid}/ShortCodes | 
    63  *ServicesShortCodesApi* | [**UpdateShortCode**](docs/ServicesShortCodesApi.md#updateshortcode) | **Post** /v1/Services/{ServiceSid}/ShortCodes/{Sid} | 
    64  
    65  
    66  ## Documentation For Models
    67  
    68   - [ProxyV1ServiceShortCodeCapabilities](docs/ProxyV1ServiceShortCodeCapabilities.md)
    69   - [ProxyV1PhoneNumber](docs/ProxyV1PhoneNumber.md)
    70   - [ListSessionResponse](docs/ListSessionResponse.md)
    71   - [ProxyV1Session](docs/ProxyV1Session.md)
    72   - [ListInteractionResponse](docs/ListInteractionResponse.md)
    73   - [ListPhoneNumberResponse](docs/ListPhoneNumberResponse.md)
    74   - [ListServiceResponse](docs/ListServiceResponse.md)
    75   - [ProxyV1Interaction](docs/ProxyV1Interaction.md)
    76   - [ProxyV1ServicePhoneNumberCapabilities](docs/ProxyV1ServicePhoneNumberCapabilities.md)
    77   - [ProxyV1MessageInteraction](docs/ProxyV1MessageInteraction.md)
    78   - [ListParticipantResponse](docs/ListParticipantResponse.md)
    79   - [ListInteractionResponseMeta](docs/ListInteractionResponseMeta.md)
    80   - [ListMessageInteractionResponse](docs/ListMessageInteractionResponse.md)
    81   - [ProxyV1Service](docs/ProxyV1Service.md)
    82   - [ProxyV1Participant](docs/ProxyV1Participant.md)
    83   - [ListShortCodeResponse](docs/ListShortCodeResponse.md)
    84   - [ProxyV1ShortCode](docs/ProxyV1ShortCode.md)
    85  
    86  
    87  ## Documentation For Authorization
    88  
    89  
    90  
    91  ## accountSid_authToken
    92  
    93  - **Type**: HTTP basic authentication
    94  
    95  Example
    96  
    97  ```golang
    98  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    99      UserName: "username",
   100      Password: "password",
   101  })
   102  r, err := client.Service.Operation(auth, args)
   103  ```
   104