github.com/twilio/twilio-go@v1.20.1/rest/frontline/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://frontline-api.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *UsersApi* | [**FetchUser**](docs/UsersApi.md#fetchuser) | **Get** /v1/Users/{Sid} | 
    35  *UsersApi* | [**UpdateUser**](docs/UsersApi.md#updateuser) | **Post** /v1/Users/{Sid} | 
    36  
    37  
    38  ## Documentation For Models
    39  
    40   - [FrontlineV1User](docs/FrontlineV1User.md)
    41  
    42  
    43  ## Documentation For Authorization
    44  
    45  
    46  
    47  ## accountSid_authToken
    48  
    49  - **Type**: HTTP basic authentication
    50  
    51  Example
    52  
    53  ```golang
    54  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    55      UserName: "username",
    56      Password: "password",
    57  })
    58  r, err := client.Service.Operation(auth, args)
    59  ```
    60