github.com/twilio/twilio-go@v1.20.1/rest/studio/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://studio.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *FlowsApi* | [**DeleteFlow**](docs/FlowsApi.md#deleteflow) | **Delete** /v1/Flows/{Sid} | 
    35  *FlowsApi* | [**FetchFlow**](docs/FlowsApi.md#fetchflow) | **Get** /v1/Flows/{Sid} | 
    36  *FlowsApi* | [**ListFlow**](docs/FlowsApi.md#listflow) | **Get** /v1/Flows | 
    37  *FlowsEngagementsApi* | [**CreateEngagement**](docs/FlowsEngagementsApi.md#createengagement) | **Post** /v1/Flows/{FlowSid}/Engagements | 
    38  *FlowsEngagementsApi* | [**DeleteEngagement**](docs/FlowsEngagementsApi.md#deleteengagement) | **Delete** /v1/Flows/{FlowSid}/Engagements/{Sid} | 
    39  *FlowsEngagementsApi* | [**FetchEngagement**](docs/FlowsEngagementsApi.md#fetchengagement) | **Get** /v1/Flows/{FlowSid}/Engagements/{Sid} | 
    40  *FlowsEngagementsApi* | [**ListEngagement**](docs/FlowsEngagementsApi.md#listengagement) | **Get** /v1/Flows/{FlowSid}/Engagements | 
    41  *FlowsEngagementsContextApi* | [**FetchEngagementContext**](docs/FlowsEngagementsContextApi.md#fetchengagementcontext) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context | 
    42  *FlowsEngagementsStepsApi* | [**FetchStep**](docs/FlowsEngagementsStepsApi.md#fetchstep) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid} | 
    43  *FlowsEngagementsStepsApi* | [**ListStep**](docs/FlowsEngagementsStepsApi.md#liststep) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps | 
    44  *FlowsEngagementsStepsContextApi* | [**FetchStepContext**](docs/FlowsEngagementsStepsContextApi.md#fetchstepcontext) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context | 
    45  *FlowsExecutionsApi* | [**CreateExecution**](docs/FlowsExecutionsApi.md#createexecution) | **Post** /v1/Flows/{FlowSid}/Executions | 
    46  *FlowsExecutionsApi* | [**DeleteExecution**](docs/FlowsExecutionsApi.md#deleteexecution) | **Delete** /v1/Flows/{FlowSid}/Executions/{Sid} | 
    47  *FlowsExecutionsApi* | [**FetchExecution**](docs/FlowsExecutionsApi.md#fetchexecution) | **Get** /v1/Flows/{FlowSid}/Executions/{Sid} | 
    48  *FlowsExecutionsApi* | [**ListExecution**](docs/FlowsExecutionsApi.md#listexecution) | **Get** /v1/Flows/{FlowSid}/Executions | 
    49  *FlowsExecutionsApi* | [**UpdateExecution**](docs/FlowsExecutionsApi.md#updateexecution) | **Post** /v1/Flows/{FlowSid}/Executions/{Sid} | 
    50  *FlowsExecutionsContextApi* | [**FetchExecutionContext**](docs/FlowsExecutionsContextApi.md#fetchexecutioncontext) | **Get** /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context | 
    51  *FlowsExecutionsStepsApi* | [**FetchExecutionStep**](docs/FlowsExecutionsStepsApi.md#fetchexecutionstep) | **Get** /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} | 
    52  *FlowsExecutionsStepsApi* | [**ListExecutionStep**](docs/FlowsExecutionsStepsApi.md#listexecutionstep) | **Get** /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps | 
    53  *FlowsExecutionsStepsContextApi* | [**FetchExecutionStepContext**](docs/FlowsExecutionsStepsContextApi.md#fetchexecutionstepcontext) | **Get** /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context | 
    54  
    55  
    56  ## Documentation For Models
    57  
    58   - [StudioV1EngagementContext](docs/StudioV1EngagementContext.md)
    59   - [StudioV1ExecutionContext](docs/StudioV1ExecutionContext.md)
    60   - [StudioV1Engagement](docs/StudioV1Engagement.md)
    61   - [StudioV1ExecutionStep](docs/StudioV1ExecutionStep.md)
    62   - [ListStepResponse](docs/ListStepResponse.md)
    63   - [StudioV1StepContext](docs/StudioV1StepContext.md)
    64   - [StudioV1ExecutionStepContext](docs/StudioV1ExecutionStepContext.md)
    65   - [StudioV1Flow](docs/StudioV1Flow.md)
    66   - [ListEngagementResponse](docs/ListEngagementResponse.md)
    67   - [ListExecutionResponse](docs/ListExecutionResponse.md)
    68   - [ListFlowResponse](docs/ListFlowResponse.md)
    69   - [ListEngagementResponseMeta](docs/ListEngagementResponseMeta.md)
    70   - [ListExecutionStepResponse](docs/ListExecutionStepResponse.md)
    71   - [StudioV1Execution](docs/StudioV1Execution.md)
    72   - [StudioV1Step](docs/StudioV1Step.md)
    73  
    74  
    75  ## Documentation For Authorization
    76  
    77  
    78  
    79  ## accountSid_authToken
    80  
    81  - **Type**: HTTP basic authentication
    82  
    83  Example
    84  
    85  ```golang
    86  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    87      UserName: "username",
    88      Password: "password",
    89  })
    90  r, err := client.Service.Operation(auth, args)
    91  ```
    92