github.com/twilio/twilio-go@v1.20.1/rest/serverless/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://serverless.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  *ServicesAssetsApi* | [**CreateAsset**](docs/ServicesAssetsApi.md#createasset) | **Post** /v1/Services/{ServiceSid}/Assets | 
    40  *ServicesAssetsApi* | [**DeleteAsset**](docs/ServicesAssetsApi.md#deleteasset) | **Delete** /v1/Services/{ServiceSid}/Assets/{Sid} | 
    41  *ServicesAssetsApi* | [**FetchAsset**](docs/ServicesAssetsApi.md#fetchasset) | **Get** /v1/Services/{ServiceSid}/Assets/{Sid} | 
    42  *ServicesAssetsApi* | [**ListAsset**](docs/ServicesAssetsApi.md#listasset) | **Get** /v1/Services/{ServiceSid}/Assets | 
    43  *ServicesAssetsApi* | [**UpdateAsset**](docs/ServicesAssetsApi.md#updateasset) | **Post** /v1/Services/{ServiceSid}/Assets/{Sid} | 
    44  *ServicesAssetsVersionsApi* | [**FetchAssetVersion**](docs/ServicesAssetsVersionsApi.md#fetchassetversion) | **Get** /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid} | 
    45  *ServicesAssetsVersionsApi* | [**ListAssetVersion**](docs/ServicesAssetsVersionsApi.md#listassetversion) | **Get** /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions | 
    46  *ServicesBuildsApi* | [**CreateBuild**](docs/ServicesBuildsApi.md#createbuild) | **Post** /v1/Services/{ServiceSid}/Builds | 
    47  *ServicesBuildsApi* | [**DeleteBuild**](docs/ServicesBuildsApi.md#deletebuild) | **Delete** /v1/Services/{ServiceSid}/Builds/{Sid} | 
    48  *ServicesBuildsApi* | [**FetchBuild**](docs/ServicesBuildsApi.md#fetchbuild) | **Get** /v1/Services/{ServiceSid}/Builds/{Sid} | 
    49  *ServicesBuildsApi* | [**ListBuild**](docs/ServicesBuildsApi.md#listbuild) | **Get** /v1/Services/{ServiceSid}/Builds | 
    50  *ServicesBuildsStatusApi* | [**FetchBuildStatus**](docs/ServicesBuildsStatusApi.md#fetchbuildstatus) | **Get** /v1/Services/{ServiceSid}/Builds/{Sid}/Status | 
    51  *ServicesEnvironmentsApi* | [**CreateEnvironment**](docs/ServicesEnvironmentsApi.md#createenvironment) | **Post** /v1/Services/{ServiceSid}/Environments | 
    52  *ServicesEnvironmentsApi* | [**DeleteEnvironment**](docs/ServicesEnvironmentsApi.md#deleteenvironment) | **Delete** /v1/Services/{ServiceSid}/Environments/{Sid} | 
    53  *ServicesEnvironmentsApi* | [**FetchEnvironment**](docs/ServicesEnvironmentsApi.md#fetchenvironment) | **Get** /v1/Services/{ServiceSid}/Environments/{Sid} | 
    54  *ServicesEnvironmentsApi* | [**ListEnvironment**](docs/ServicesEnvironmentsApi.md#listenvironment) | **Get** /v1/Services/{ServiceSid}/Environments | 
    55  *ServicesEnvironmentsDeploymentsApi* | [**CreateDeployment**](docs/ServicesEnvironmentsDeploymentsApi.md#createdeployment) | **Post** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments | 
    56  *ServicesEnvironmentsDeploymentsApi* | [**FetchDeployment**](docs/ServicesEnvironmentsDeploymentsApi.md#fetchdeployment) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid} | 
    57  *ServicesEnvironmentsDeploymentsApi* | [**ListDeployment**](docs/ServicesEnvironmentsDeploymentsApi.md#listdeployment) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments | 
    58  *ServicesEnvironmentsLogsApi* | [**FetchLog**](docs/ServicesEnvironmentsLogsApi.md#fetchlog) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid} | 
    59  *ServicesEnvironmentsLogsApi* | [**ListLog**](docs/ServicesEnvironmentsLogsApi.md#listlog) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs | 
    60  *ServicesEnvironmentsVariablesApi* | [**CreateVariable**](docs/ServicesEnvironmentsVariablesApi.md#createvariable) | **Post** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables | 
    61  *ServicesEnvironmentsVariablesApi* | [**DeleteVariable**](docs/ServicesEnvironmentsVariablesApi.md#deletevariable) | **Delete** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid} | 
    62  *ServicesEnvironmentsVariablesApi* | [**FetchVariable**](docs/ServicesEnvironmentsVariablesApi.md#fetchvariable) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid} | 
    63  *ServicesEnvironmentsVariablesApi* | [**ListVariable**](docs/ServicesEnvironmentsVariablesApi.md#listvariable) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables | 
    64  *ServicesEnvironmentsVariablesApi* | [**UpdateVariable**](docs/ServicesEnvironmentsVariablesApi.md#updatevariable) | **Post** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid} | 
    65  *ServicesFunctionsApi* | [**CreateFunction**](docs/ServicesFunctionsApi.md#createfunction) | **Post** /v1/Services/{ServiceSid}/Functions | 
    66  *ServicesFunctionsApi* | [**DeleteFunction**](docs/ServicesFunctionsApi.md#deletefunction) | **Delete** /v1/Services/{ServiceSid}/Functions/{Sid} | 
    67  *ServicesFunctionsApi* | [**FetchFunction**](docs/ServicesFunctionsApi.md#fetchfunction) | **Get** /v1/Services/{ServiceSid}/Functions/{Sid} | 
    68  *ServicesFunctionsApi* | [**ListFunction**](docs/ServicesFunctionsApi.md#listfunction) | **Get** /v1/Services/{ServiceSid}/Functions | 
    69  *ServicesFunctionsApi* | [**UpdateFunction**](docs/ServicesFunctionsApi.md#updatefunction) | **Post** /v1/Services/{ServiceSid}/Functions/{Sid} | 
    70  *ServicesFunctionsVersionsApi* | [**FetchFunctionVersion**](docs/ServicesFunctionsVersionsApi.md#fetchfunctionversion) | **Get** /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid} | 
    71  *ServicesFunctionsVersionsApi* | [**ListFunctionVersion**](docs/ServicesFunctionsVersionsApi.md#listfunctionversion) | **Get** /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions | 
    72  *ServicesFunctionsVersionsContentApi* | [**FetchFunctionVersionContent**](docs/ServicesFunctionsVersionsContentApi.md#fetchfunctionversioncontent) | **Get** /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content | 
    73  
    74  
    75  ## Documentation For Models
    76  
    77   - [ServerlessV1FunctionVersion](docs/ServerlessV1FunctionVersion.md)
    78   - [ListAssetResponseMeta](docs/ListAssetResponseMeta.md)
    79   - [ListVariableResponse](docs/ListVariableResponse.md)
    80   - [ServerlessV1BuildStatus](docs/ServerlessV1BuildStatus.md)
    81   - [ServerlessV1FunctionVersionContent](docs/ServerlessV1FunctionVersionContent.md)
    82   - [ServerlessV1Variable](docs/ServerlessV1Variable.md)
    83   - [ListLogResponse](docs/ListLogResponse.md)
    84   - [ServerlessV1Function](docs/ServerlessV1Function.md)
    85   - [ServerlessV1Asset](docs/ServerlessV1Asset.md)
    86   - [ListServiceResponse](docs/ListServiceResponse.md)
    87   - [ServerlessV1AssetVersion](docs/ServerlessV1AssetVersion.md)
    88   - [ListBuildResponse](docs/ListBuildResponse.md)
    89   - [ListEnvironmentResponse](docs/ListEnvironmentResponse.md)
    90   - [ListFunctionVersionResponse](docs/ListFunctionVersionResponse.md)
    91   - [ServerlessV1Environment](docs/ServerlessV1Environment.md)
    92   - [ServerlessV1Service](docs/ServerlessV1Service.md)
    93   - [ListDeploymentResponse](docs/ListDeploymentResponse.md)
    94   - [ServerlessV1Log](docs/ServerlessV1Log.md)
    95   - [ListAssetVersionResponse](docs/ListAssetVersionResponse.md)
    96   - [ListFunctionResponse](docs/ListFunctionResponse.md)
    97   - [ServerlessV1Deployment](docs/ServerlessV1Deployment.md)
    98   - [ListAssetResponse](docs/ListAssetResponse.md)
    99   - [ServerlessV1Build](docs/ServerlessV1Build.md)
   100  
   101  
   102  ## Documentation For Authorization
   103  
   104  
   105  
   106  ## accountSid_authToken
   107  
   108  - **Type**: HTTP basic authentication
   109  
   110  Example
   111  
   112  ```golang
   113  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   114      UserName: "username",
   115      Password: "password",
   116  })
   117  r, err := client.Service.Operation(auth, args)
   118  ```
   119