github.com/twilio/twilio-go@v1.20.1/rest/studio/v2/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://studio.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *FlowsApi* | [**CreateFlow**](docs/FlowsApi.md#createflow) | **Post** /v2/Flows | 
    35  *FlowsApi* | [**DeleteFlow**](docs/FlowsApi.md#deleteflow) | **Delete** /v2/Flows/{Sid} | 
    36  *FlowsApi* | [**FetchFlow**](docs/FlowsApi.md#fetchflow) | **Get** /v2/Flows/{Sid} | 
    37  *FlowsApi* | [**ListFlow**](docs/FlowsApi.md#listflow) | **Get** /v2/Flows | 
    38  *FlowsApi* | [**UpdateFlow**](docs/FlowsApi.md#updateflow) | **Post** /v2/Flows/{Sid} | 
    39  *FlowsExecutionsApi* | [**CreateExecution**](docs/FlowsExecutionsApi.md#createexecution) | **Post** /v2/Flows/{FlowSid}/Executions | 
    40  *FlowsExecutionsApi* | [**DeleteExecution**](docs/FlowsExecutionsApi.md#deleteexecution) | **Delete** /v2/Flows/{FlowSid}/Executions/{Sid} | 
    41  *FlowsExecutionsApi* | [**FetchExecution**](docs/FlowsExecutionsApi.md#fetchexecution) | **Get** /v2/Flows/{FlowSid}/Executions/{Sid} | 
    42  *FlowsExecutionsApi* | [**ListExecution**](docs/FlowsExecutionsApi.md#listexecution) | **Get** /v2/Flows/{FlowSid}/Executions | 
    43  *FlowsExecutionsApi* | [**UpdateExecution**](docs/FlowsExecutionsApi.md#updateexecution) | **Post** /v2/Flows/{FlowSid}/Executions/{Sid} | 
    44  *FlowsExecutionsContextApi* | [**FetchExecutionContext**](docs/FlowsExecutionsContextApi.md#fetchexecutioncontext) | **Get** /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context | 
    45  *FlowsExecutionsStepsApi* | [**FetchExecutionStep**](docs/FlowsExecutionsStepsApi.md#fetchexecutionstep) | **Get** /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} | 
    46  *FlowsExecutionsStepsApi* | [**ListExecutionStep**](docs/FlowsExecutionsStepsApi.md#listexecutionstep) | **Get** /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps | 
    47  *FlowsExecutionsStepsContextApi* | [**FetchExecutionStepContext**](docs/FlowsExecutionsStepsContextApi.md#fetchexecutionstepcontext) | **Get** /v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context | 
    48  *FlowsRevisionsApi* | [**FetchFlowRevision**](docs/FlowsRevisionsApi.md#fetchflowrevision) | **Get** /v2/Flows/{Sid}/Revisions/{Revision} | 
    49  *FlowsRevisionsApi* | [**ListFlowRevision**](docs/FlowsRevisionsApi.md#listflowrevision) | **Get** /v2/Flows/{Sid}/Revisions | 
    50  *FlowsTestUsersApi* | [**FetchTestUser**](docs/FlowsTestUsersApi.md#fetchtestuser) | **Get** /v2/Flows/{Sid}/TestUsers | 
    51  *FlowsTestUsersApi* | [**UpdateTestUser**](docs/FlowsTestUsersApi.md#updatetestuser) | **Post** /v2/Flows/{Sid}/TestUsers | 
    52  *FlowsValidateApi* | [**UpdateFlowValidate**](docs/FlowsValidateApi.md#updateflowvalidate) | **Post** /v2/Flows/Validate | 
    53  
    54  
    55  ## Documentation For Models
    56  
    57   - [StudioV2TestUser](docs/StudioV2TestUser.md)
    58   - [StudioV2ExecutionStepContext](docs/StudioV2ExecutionStepContext.md)
    59   - [StudioV2ExecutionContext](docs/StudioV2ExecutionContext.md)
    60   - [StudioV2Execution](docs/StudioV2Execution.md)
    61   - [StudioV2FlowRevision](docs/StudioV2FlowRevision.md)
    62   - [StudioV2FlowValidate](docs/StudioV2FlowValidate.md)
    63   - [ListExecutionResponse](docs/ListExecutionResponse.md)
    64   - [ListFlowResponse](docs/ListFlowResponse.md)
    65   - [StudioV2Flow](docs/StudioV2Flow.md)
    66   - [ListExecutionResponseMeta](docs/ListExecutionResponseMeta.md)
    67   - [ListExecutionStepResponse](docs/ListExecutionStepResponse.md)
    68   - [StudioV2ExecutionStep](docs/StudioV2ExecutionStep.md)
    69   - [ListFlowRevisionResponse](docs/ListFlowRevisionResponse.md)
    70  
    71  
    72  ## Documentation For Authorization
    73  
    74  
    75  
    76  ## accountSid_authToken
    77  
    78  - **Type**: HTTP basic authentication
    79  
    80  Example
    81  
    82  ```golang
    83  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    84      UserName: "username",
    85      Password: "password",
    86  })
    87  r, err := client.Service.Operation(auth, args)
    88  ```
    89