openapi

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 28, 2021 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.19.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://studio.twilio.com

Class Method HTTP request Description
FlowsApi DeleteFlow Delete /v1/Flows/{Sid}
FlowsApi FetchFlow Get /v1/Flows/{Sid}
FlowsApi ListFlow Get /v1/Flows
FlowsEngagementsApi CreateEngagement Post /v1/Flows/{FlowSid}/Engagements
FlowsEngagementsApi DeleteEngagement Delete /v1/Flows/{FlowSid}/Engagements/{Sid}
FlowsEngagementsApi FetchEngagement Get /v1/Flows/{FlowSid}/Engagements/{Sid}
FlowsEngagementsApi ListEngagement Get /v1/Flows/{FlowSid}/Engagements
FlowsEngagementsContextApi FetchEngagementContext Get /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context
FlowsEngagementsStepsApi FetchStep Get /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}
FlowsEngagementsStepsApi ListStep Get /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps
FlowsEngagementsStepsContextApi FetchStepContext Get /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context
FlowsExecutionsApi CreateExecution Post /v1/Flows/{FlowSid}/Executions
FlowsExecutionsApi DeleteExecution Delete /v1/Flows/{FlowSid}/Executions/{Sid}
FlowsExecutionsApi FetchExecution Get /v1/Flows/{FlowSid}/Executions/{Sid}
FlowsExecutionsApi ListExecution Get /v1/Flows/{FlowSid}/Executions
FlowsExecutionsApi UpdateExecution Post /v1/Flows/{FlowSid}/Executions/{Sid}
FlowsExecutionsContextApi FetchExecutionContext Get /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context
FlowsExecutionsStepsApi FetchExecutionStep Get /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}
FlowsExecutionsStepsApi ListExecutionStep Get /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps
FlowsExecutionsStepsContextApi FetchExecutionStepContext Get /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateEngagement added in v0.11.0 

func (c *ApiService) CreateEngagement(FlowSid string, params *CreateEngagementParams) (*StudioV1FlowEngagement, error)

Triggers a new Engagement for the Flow

func (*ApiService) CreateExecution added in v0.11.0 

func (c *ApiService) CreateExecution(FlowSid string, params *CreateExecutionParams) (*StudioV1FlowExecution, error)

Triggers a new Execution for the Flow

func (*ApiService) DeleteEngagement added in v0.11.0 

func (c *ApiService) DeleteEngagement(FlowSid string, Sid string) error

Delete this Engagement and all Steps relating to it.

func (*ApiService) DeleteExecution added in v0.11.0 

func (c *ApiService) DeleteExecution(FlowSid string, Sid string) error

Delete the Execution and all Steps relating to it.

func (*ApiService) DeleteFlow added in v0.11.0 

func (c *ApiService) DeleteFlow(Sid string) error

Delete a specific Flow.

func (*ApiService) FetchEngagement added in v0.11.0 

func (c *ApiService) FetchEngagement(FlowSid string, Sid string) (*StudioV1FlowEngagement, error)

Retrieve an Engagement

func (*ApiService) FetchEngagementContext added in v0.11.0 

func (c *ApiService) FetchEngagementContext(FlowSid string, EngagementSid string) (*StudioV1FlowEngagementEngagementContext, error)

Retrieve the most recent context for an Engagement.

func (*ApiService) FetchExecution added in v0.11.0 

func (c *ApiService) FetchExecution(FlowSid string, Sid string) (*StudioV1FlowExecution, error)

Retrieve an Execution

func (*ApiService) FetchExecutionContext added in v0.11.0 

func (c *ApiService) FetchExecutionContext(FlowSid string, ExecutionSid string) (*StudioV1FlowExecutionExecutionContext, error)

Retrieve the most recent context for an Execution.

func (*ApiService) FetchExecutionStep added in v0.11.0 

func (c *ApiService) FetchExecutionStep(FlowSid string, ExecutionSid string, Sid string) (*StudioV1FlowExecutionExecutionStep, error)

Retrieve a Step.

func (*ApiService) FetchExecutionStepContext added in v0.11.0 

func (c *ApiService) FetchExecutionStepContext(FlowSid string, ExecutionSid string, StepSid string) (*StudioV1FlowExecutionExecutionStepExecutionStepContext, error)

Retrieve the context for an Execution Step.

func (*ApiService) FetchFlow added in v0.11.0 

func (c *ApiService) FetchFlow(Sid string) (*StudioV1Flow, error)

Retrieve a specific Flow.

func (*ApiService) FetchStep added in v0.11.0 

func (c *ApiService) FetchStep(FlowSid string, EngagementSid string, Sid string) (*StudioV1FlowEngagementStep, error)

Retrieve a Step.

func (*ApiService) FetchStepContext added in v0.11.0 

func (c *ApiService) FetchStepContext(FlowSid string, EngagementSid string, StepSid string) (*StudioV1FlowEngagementStepStepContext, error)

Retrieve the context for an Engagement Step.

func (*ApiService) ListEngagement added in v0.11.0 

func (c *ApiService) ListEngagement(FlowSid string, params *ListEngagementParams) ([]StudioV1FlowEngagement, error)

Lists Engagement records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListExecution added in v0.11.0 

func (c *ApiService) ListExecution(FlowSid string, params *ListExecutionParams) ([]StudioV1FlowExecution, error)

Lists Execution records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListExecutionStep added in v0.11.0 

func (c *ApiService) ListExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams) ([]StudioV1FlowExecutionExecutionStep, error)

Lists ExecutionStep records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListFlow added in v0.11.0 

func (c *ApiService) ListFlow(params *ListFlowParams) ([]StudioV1Flow, error)

Lists Flow records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListStep added in v0.11.0 

func (c *ApiService) ListStep(FlowSid string, EngagementSid string, params *ListStepParams) ([]StudioV1FlowEngagementStep, error)

Lists Step records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageEngagement added in v0.13.0 

func (c *ApiService) PageEngagement(FlowSid string, params *ListEngagementParams, pageToken string, pageNumber string) (*ListEngagementResponse, error)

Retrieve a single page of Engagement records from the API. Request is executed immediately.

func (*ApiService) PageExecution added in v0.13.0 

func (c *ApiService) PageExecution(FlowSid string, params *ListExecutionParams, pageToken string, pageNumber string) (*ListExecutionResponse, error)

Retrieve a single page of Execution records from the API. Request is executed immediately.

func (*ApiService) PageExecutionStep added in v0.13.0 

func (c *ApiService) PageExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams, pageToken string, pageNumber string) (*ListExecutionStepResponse, error)

Retrieve a single page of ExecutionStep records from the API. Request is executed immediately.

func (*ApiService) PageFlow added in v0.13.0 

func (c *ApiService) PageFlow(params *ListFlowParams, pageToken string, pageNumber string) (*ListFlowResponse, error)

Retrieve a single page of Flow records from the API. Request is executed immediately.

func (*ApiService) PageStep added in v0.13.0 

func (c *ApiService) PageStep(FlowSid string, EngagementSid string, params *ListStepParams, pageToken string, pageNumber string) (*ListStepResponse, error)

Retrieve a single page of Step records from the API. Request is executed immediately.

func (*ApiService) StreamEngagement added in v0.13.0 

func (c *ApiService) StreamEngagement(FlowSid string, params *ListEngagementParams) (chan StudioV1FlowEngagement, error)

Streams Engagement records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamExecution added in v0.13.0 

func (c *ApiService) StreamExecution(FlowSid string, params *ListExecutionParams) (chan StudioV1FlowExecution, error)

Streams Execution records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamExecutionStep added in v0.13.0 

func (c *ApiService) StreamExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams) (chan StudioV1FlowExecutionExecutionStep, error)

Streams ExecutionStep records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamFlow added in v0.13.0 

func (c *ApiService) StreamFlow(params *ListFlowParams) (chan StudioV1Flow, error)

Streams Flow records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamStep added in v0.13.0 

func (c *ApiService) StreamStep(FlowSid string, EngagementSid string, params *ListStepParams) (chan StudioV1FlowEngagementStep, error)

Streams Step records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateExecution added in v0.11.0 

func (c *ApiService) UpdateExecution(FlowSid string, Sid string, params *UpdateExecutionParams) (*StudioV1FlowExecution, error)

Update the status of an Execution to `ended`.

type CreateEngagementParams 

type CreateEngagementParams struct {
	// The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`
	From *string `json:"From,omitempty"`
	// A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
	Parameters *map[string]interface{} `json:"Parameters,omitempty"`
	// The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.
	To *string `json:"To,omitempty"`
}

Optional parameters for the method 'CreateEngagement'

func (*CreateEngagementParams) SetFrom 

func (params *CreateEngagementParams) SetFrom(From string) *CreateEngagementParams

func (*CreateEngagementParams) SetParameters 

func (params *CreateEngagementParams) SetParameters(Parameters map[string]interface{}) *CreateEngagementParams

func (*CreateEngagementParams) SetTo 

func (params *CreateEngagementParams) SetTo(To string) *CreateEngagementParams

type CreateExecutionParams 

type CreateExecutionParams struct {
	// The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID.
	From *string `json:"From,omitempty"`
	// JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\\\"name\\\":\\\"Zeke\\\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \\\"Zeke\\\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.
	Parameters *map[string]interface{} `json:"Parameters,omitempty"`
	// The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.
	To *string `json:"To,omitempty"`
}

Optional parameters for the method 'CreateExecution'

func (*CreateExecutionParams) SetFrom 

func (params *CreateExecutionParams) SetFrom(From string) *CreateExecutionParams

func (*CreateExecutionParams) SetParameters 

func (params *CreateExecutionParams) SetParameters(Parameters map[string]interface{}) *CreateExecutionParams

func (*CreateExecutionParams) SetTo 

func (params *CreateExecutionParams) SetTo(To string) *CreateExecutionParams

type ListEngagementParams 

type ListEngagementParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEngagement'

func (*ListEngagementParams) SetLimit added in v0.13.0 

func (params *ListEngagementParams) SetLimit(Limit int) *ListEngagementParams

func (*ListEngagementParams) SetPageSize 

func (params *ListEngagementParams) SetPageSize(PageSize int) *ListEngagementParams

type ListEngagementResponse 

type ListEngagementResponse struct {
	Engagements []StudioV1FlowEngagement `json:"engagements,omitempty"`
	Meta        ListFlowResponseMeta     `json:"meta,omitempty"`
}

ListEngagementResponse struct for ListEngagementResponse

type ListExecutionParams 

type ListExecutionParams struct {
	// Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
	DateCreatedFrom *time.Time `json:"DateCreatedFrom,omitempty"`
	// Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
	DateCreatedTo *time.Time `json:"DateCreatedTo,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListExecution'

func (*ListExecutionParams) SetDateCreatedFrom 

func (params *ListExecutionParams) SetDateCreatedFrom(DateCreatedFrom time.Time) *ListExecutionParams

func (*ListExecutionParams) SetDateCreatedTo 

func (params *ListExecutionParams) SetDateCreatedTo(DateCreatedTo time.Time) *ListExecutionParams

func (*ListExecutionParams) SetLimit added in v0.13.0 

func (params *ListExecutionParams) SetLimit(Limit int) *ListExecutionParams

func (*ListExecutionParams) SetPageSize 

func (params *ListExecutionParams) SetPageSize(PageSize int) *ListExecutionParams

type ListExecutionResponse 

type ListExecutionResponse struct {
	Executions []StudioV1FlowExecution `json:"executions,omitempty"`
	Meta       ListFlowResponseMeta    `json:"meta,omitempty"`
}

ListExecutionResponse struct for ListExecutionResponse

type ListExecutionStepParams 

type ListExecutionStepParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListExecutionStep'

func (*ListExecutionStepParams) SetLimit added in v0.13.0 

func (params *ListExecutionStepParams) SetLimit(Limit int) *ListExecutionStepParams

func (*ListExecutionStepParams) SetPageSize 

func (params *ListExecutionStepParams) SetPageSize(PageSize int) *ListExecutionStepParams

type ListExecutionStepResponse 

type ListExecutionStepResponse struct {
	Meta  ListFlowResponseMeta                 `json:"meta,omitempty"`
	Steps []StudioV1FlowExecutionExecutionStep `json:"steps,omitempty"`
}

ListExecutionStepResponse struct for ListExecutionStepResponse

type ListFlowParams 

type ListFlowParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListFlow'

func (*ListFlowParams) SetLimit added in v0.13.0 

func (params *ListFlowParams) SetLimit(Limit int) *ListFlowParams

func (*ListFlowParams) SetPageSize 

func (params *ListFlowParams) SetPageSize(PageSize int) *ListFlowParams

type ListFlowResponse 

type ListFlowResponse struct {
	Flows []StudioV1Flow       `json:"flows,omitempty"`
	Meta  ListFlowResponseMeta `json:"meta,omitempty"`
}

ListFlowResponse struct for ListFlowResponse

type ListFlowResponseMeta 

type ListFlowResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int    `json:"page,omitempty"`
	PageSize        int    `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListFlowResponseMeta struct for ListFlowResponseMeta

type ListStepParams 

type ListStepParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListStep'

func (*ListStepParams) SetLimit added in v0.13.0 

func (params *ListStepParams) SetLimit(Limit int) *ListStepParams

func (*ListStepParams) SetPageSize 

func (params *ListStepParams) SetPageSize(PageSize int) *ListStepParams

type ListStepResponse 

type ListStepResponse struct {
	Meta  ListFlowResponseMeta         `json:"meta,omitempty"`
	Steps []StudioV1FlowEngagementStep `json:"steps,omitempty"`
}

ListStepResponse struct for ListStepResponse

type StudioV1Flow 

type StudioV1Flow struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the Flow
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Nested resource URLs
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Flow
	Status *string `json:"status,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
	// The latest version number of the Flow's definition
	Version *int `json:"version,omitempty"`
}

StudioV1Flow struct for StudioV1Flow

type StudioV1FlowEngagement 

type StudioV1FlowEngagement struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The phone number, SIP address or Client identifier that triggered this Engagement
	ContactChannelAddress *string `json:"contact_channel_address,omitempty"`
	// The SID of the Contact
	ContactSid *string `json:"contact_sid,omitempty"`
	// The current state of the execution flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The ISO 8601 date and time in GMT when the Engagement was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Engagement was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// The URLs of the Engagement's nested resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Engagement
	Status *string `json:"status,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowEngagement struct for StudioV1FlowEngagement

type StudioV1FlowEngagementEngagementContext 

type StudioV1FlowEngagementEngagementContext struct {
	// Account SID
	AccountSid *string `json:"account_sid,omitempty"`
	// Flow state
	Context *map[string]interface{} `json:"context,omitempty"`
	// Engagement SID
	EngagementSid *string `json:"engagement_sid,omitempty"`
	// Flow SID
	FlowSid *string `json:"flow_sid,omitempty"`
	// The URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowEngagementEngagementContext struct for StudioV1FlowEngagementEngagementContext

type StudioV1FlowEngagementStep 

type StudioV1FlowEngagementStep struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Engagement
	EngagementSid *string `json:"engagement_sid,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The event that caused the Flow to transition to the Step
	Name *string `json:"name,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The Widget that preceded the Widget for the Step
	TransitionedFrom *string `json:"transitioned_from,omitempty"`
	// The Widget that will follow the Widget for the Step
	TransitionedTo *string `json:"transitioned_to,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowEngagementStep struct for StudioV1FlowEngagementStep

type StudioV1FlowEngagementStepStepContext 

type StudioV1FlowEngagementStepStepContext struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The SID of the Engagement
	EngagementSid *string `json:"engagement_sid,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// Step SID
	StepSid *string `json:"step_sid,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowEngagementStepStepContext struct for StudioV1FlowEngagementStepStepContext

type StudioV1FlowExecution 

type StudioV1FlowExecution struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The phone number, SIP address or Client identifier that triggered the Execution
	ContactChannelAddress *string `json:"contact_channel_address,omitempty"`
	// The SID of the Contact
	ContactSid *string `json:"contact_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// Nested resource URLs
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Execution
	Status *string `json:"status,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowExecution struct for StudioV1FlowExecution

type StudioV1FlowExecutionExecutionContext 

type StudioV1FlowExecutionExecutionContext struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The SID of the Execution
	ExecutionSid *string `json:"execution_sid,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowExecutionExecutionContext struct for StudioV1FlowExecutionExecutionContext

type StudioV1FlowExecutionExecutionStep 

type StudioV1FlowExecutionExecutionStep struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Execution
	ExecutionSid *string `json:"execution_sid,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The event that caused the Flow to transition to the Step
	Name *string `json:"name,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The Widget that preceded the Widget for the Step
	TransitionedFrom *string `json:"transitioned_from,omitempty"`
	// The Widget that will follow the Widget for the Step
	TransitionedTo *string `json:"transitioned_to,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowExecutionExecutionStep struct for StudioV1FlowExecutionExecutionStep

type StudioV1FlowExecutionExecutionStepExecutionStepContext 

type StudioV1FlowExecutionExecutionStepExecutionStepContext struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The current state of the flow
	Context *map[string]interface{} `json:"context,omitempty"`
	// The SID of the Execution
	ExecutionSid *string `json:"execution_sid,omitempty"`
	// The SID of the Flow
	FlowSid *string `json:"flow_sid,omitempty"`
	// Step SID
	StepSid *string `json:"step_sid,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

StudioV1FlowExecutionExecutionStepExecutionStepContext struct for StudioV1FlowExecutionExecutionStepExecutionStepContext

type UpdateExecutionParams 

type UpdateExecutionParams struct {
	// The status of the Execution. Can only be `ended`.
	Status *string `json:"Status,omitempty"`
}

Optional parameters for the method 'UpdateExecution'

func (*UpdateExecutionParams) SetStatus 

func (params *UpdateExecutionParams) SetStatus(Status string) *UpdateExecutionParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.