github.com/twilio/twilio-go@v1.20.1/rest/microvisor/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://microvisor.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *AppsApi* | [**DeleteApp**](docs/AppsApi.md#deleteapp) | **Delete** /v1/Apps/{Sid} | 
    35  *AppsApi* | [**FetchApp**](docs/AppsApi.md#fetchapp) | **Get** /v1/Apps/{Sid} | 
    36  *AppsApi* | [**ListApp**](docs/AppsApi.md#listapp) | **Get** /v1/Apps | 
    37  *AppsManifestApi* | [**FetchAppManifest**](docs/AppsManifestApi.md#fetchappmanifest) | **Get** /v1/Apps/{AppSid}/Manifest | 
    38  *ConfigsApi* | [**CreateAccountConfig**](docs/ConfigsApi.md#createaccountconfig) | **Post** /v1/Configs | 
    39  *ConfigsApi* | [**DeleteAccountConfig**](docs/ConfigsApi.md#deleteaccountconfig) | **Delete** /v1/Configs/{Key} | 
    40  *ConfigsApi* | [**FetchAccountConfig**](docs/ConfigsApi.md#fetchaccountconfig) | **Get** /v1/Configs/{Key} | 
    41  *ConfigsApi* | [**ListAccountConfig**](docs/ConfigsApi.md#listaccountconfig) | **Get** /v1/Configs | 
    42  *ConfigsApi* | [**UpdateAccountConfig**](docs/ConfigsApi.md#updateaccountconfig) | **Post** /v1/Configs/{Key} | 
    43  *DevicesApi* | [**FetchDevice**](docs/DevicesApi.md#fetchdevice) | **Get** /v1/Devices/{Sid} | 
    44  *DevicesApi* | [**ListDevice**](docs/DevicesApi.md#listdevice) | **Get** /v1/Devices | 
    45  *DevicesApi* | [**UpdateDevice**](docs/DevicesApi.md#updatedevice) | **Post** /v1/Devices/{Sid} | 
    46  *DevicesConfigsApi* | [**CreateDeviceConfig**](docs/DevicesConfigsApi.md#createdeviceconfig) | **Post** /v1/Devices/{DeviceSid}/Configs | 
    47  *DevicesConfigsApi* | [**DeleteDeviceConfig**](docs/DevicesConfigsApi.md#deletedeviceconfig) | **Delete** /v1/Devices/{DeviceSid}/Configs/{Key} | 
    48  *DevicesConfigsApi* | [**FetchDeviceConfig**](docs/DevicesConfigsApi.md#fetchdeviceconfig) | **Get** /v1/Devices/{DeviceSid}/Configs/{Key} | 
    49  *DevicesConfigsApi* | [**ListDeviceConfig**](docs/DevicesConfigsApi.md#listdeviceconfig) | **Get** /v1/Devices/{DeviceSid}/Configs | 
    50  *DevicesConfigsApi* | [**UpdateDeviceConfig**](docs/DevicesConfigsApi.md#updatedeviceconfig) | **Post** /v1/Devices/{DeviceSid}/Configs/{Key} | 
    51  *DevicesSecretsApi* | [**CreateDeviceSecret**](docs/DevicesSecretsApi.md#createdevicesecret) | **Post** /v1/Devices/{DeviceSid}/Secrets | 
    52  *DevicesSecretsApi* | [**DeleteDeviceSecret**](docs/DevicesSecretsApi.md#deletedevicesecret) | **Delete** /v1/Devices/{DeviceSid}/Secrets/{Key} | 
    53  *DevicesSecretsApi* | [**FetchDeviceSecret**](docs/DevicesSecretsApi.md#fetchdevicesecret) | **Get** /v1/Devices/{DeviceSid}/Secrets/{Key} | 
    54  *DevicesSecretsApi* | [**ListDeviceSecret**](docs/DevicesSecretsApi.md#listdevicesecret) | **Get** /v1/Devices/{DeviceSid}/Secrets | 
    55  *DevicesSecretsApi* | [**UpdateDeviceSecret**](docs/DevicesSecretsApi.md#updatedevicesecret) | **Post** /v1/Devices/{DeviceSid}/Secrets/{Key} | 
    56  *SecretsApi* | [**CreateAccountSecret**](docs/SecretsApi.md#createaccountsecret) | **Post** /v1/Secrets | 
    57  *SecretsApi* | [**DeleteAccountSecret**](docs/SecretsApi.md#deleteaccountsecret) | **Delete** /v1/Secrets/{Key} | 
    58  *SecretsApi* | [**FetchAccountSecret**](docs/SecretsApi.md#fetchaccountsecret) | **Get** /v1/Secrets/{Key} | 
    59  *SecretsApi* | [**ListAccountSecret**](docs/SecretsApi.md#listaccountsecret) | **Get** /v1/Secrets | 
    60  *SecretsApi* | [**UpdateAccountSecret**](docs/SecretsApi.md#updateaccountsecret) | **Post** /v1/Secrets/{Key} | 
    61  
    62  
    63  ## Documentation For Models
    64  
    65   - [ListAccountConfigResponse](docs/ListAccountConfigResponse.md)
    66   - [ListDeviceConfigResponse](docs/ListDeviceConfigResponse.md)
    67   - [ListDeviceResponse](docs/ListDeviceResponse.md)
    68   - [MicrovisorV1App](docs/MicrovisorV1App.md)
    69   - [MicrovisorV1DeviceConfig](docs/MicrovisorV1DeviceConfig.md)
    70   - [MicrovisorV1AccountSecret](docs/MicrovisorV1AccountSecret.md)
    71   - [MicrovisorV1AppManifest](docs/MicrovisorV1AppManifest.md)
    72   - [ListAppResponse](docs/ListAppResponse.md)
    73   - [MicrovisorV1Device](docs/MicrovisorV1Device.md)
    74   - [MicrovisorV1AccountConfig](docs/MicrovisorV1AccountConfig.md)
    75   - [ListAccountConfigResponseMeta](docs/ListAccountConfigResponseMeta.md)
    76   - [ListAccountSecretResponse](docs/ListAccountSecretResponse.md)
    77   - [MicrovisorV1DeviceSecret](docs/MicrovisorV1DeviceSecret.md)
    78   - [ListDeviceSecretResponse](docs/ListDeviceSecretResponse.md)
    79  
    80  
    81  ## Documentation For Authorization
    82  
    83  
    84  
    85  ## accountSid_authToken
    86  
    87  - **Type**: HTTP basic authentication
    88  
    89  Example
    90  
    91  ```golang
    92  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    93      UserName: "username",
    94      Password: "password",
    95  })
    96  r, err := client.Service.Operation(auth, args)
    97  ```
    98