Documentation ¶
Index ¶
- type ApiService
- func (c *ApiService) CreateEngagement(FlowSid string, params *CreateEngagementParams) (*StudioV1Engagement, error)
- func (c *ApiService) CreateExecution(FlowSid string, params *CreateExecutionParams) (*StudioV1Execution, error)
- func (c *ApiService) DeleteEngagement(FlowSid string, Sid string) error
- func (c *ApiService) DeleteExecution(FlowSid string, Sid string) error
- func (c *ApiService) DeleteFlow(Sid string) error
- func (c *ApiService) FetchEngagement(FlowSid string, Sid string) (*StudioV1Engagement, error)
- func (c *ApiService) FetchEngagementContext(FlowSid string, EngagementSid string) (*StudioV1EngagementContext, error)
- func (c *ApiService) FetchExecution(FlowSid string, Sid string) (*StudioV1Execution, error)
- func (c *ApiService) FetchExecutionContext(FlowSid string, ExecutionSid string) (*StudioV1ExecutionContext, error)
- func (c *ApiService) FetchExecutionStep(FlowSid string, ExecutionSid string, Sid string) (*StudioV1ExecutionStep, error)
- func (c *ApiService) FetchExecutionStepContext(FlowSid string, ExecutionSid string, StepSid string) (*StudioV1ExecutionStepContext, error)
- func (c *ApiService) FetchFlow(Sid string) (*StudioV1Flow, error)
- func (c *ApiService) FetchStep(FlowSid string, EngagementSid string, Sid string) (*StudioV1Step, error)
- func (c *ApiService) FetchStepContext(FlowSid string, EngagementSid string, StepSid string) (*StudioV1StepContext, error)
- func (c *ApiService) ListEngagement(FlowSid string, params *ListEngagementParams) ([]StudioV1Engagement, error)
- func (c *ApiService) ListExecution(FlowSid string, params *ListExecutionParams) ([]StudioV1Execution, error)
- func (c *ApiService) ListExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams) ([]StudioV1ExecutionStep, error)
- func (c *ApiService) ListFlow(params *ListFlowParams) ([]StudioV1Flow, error)
- func (c *ApiService) ListStep(FlowSid string, EngagementSid string, params *ListStepParams) ([]StudioV1Step, error)
- func (c *ApiService) PageEngagement(FlowSid string, params *ListEngagementParams, pageToken, pageNumber string) (*ListEngagementResponse, error)
- func (c *ApiService) PageExecution(FlowSid string, params *ListExecutionParams, pageToken, pageNumber string) (*ListExecutionResponse, error)
- func (c *ApiService) PageExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams, ...) (*ListExecutionStepResponse, error)
- func (c *ApiService) PageFlow(params *ListFlowParams, pageToken, pageNumber string) (*ListFlowResponse, error)
- func (c *ApiService) PageStep(FlowSid string, EngagementSid string, params *ListStepParams, ...) (*ListStepResponse, error)
- func (c *ApiService) StreamEngagement(FlowSid string, params *ListEngagementParams) (chan StudioV1Engagement, chan error)
- func (c *ApiService) StreamExecution(FlowSid string, params *ListExecutionParams) (chan StudioV1Execution, chan error)
- func (c *ApiService) StreamExecutionStep(FlowSid string, ExecutionSid string, params *ListExecutionStepParams) (chan StudioV1ExecutionStep, chan error)
- func (c *ApiService) StreamFlow(params *ListFlowParams) (chan StudioV1Flow, chan error)
- func (c *ApiService) StreamStep(FlowSid string, EngagementSid string, params *ListStepParams) (chan StudioV1Step, chan error)
- func (c *ApiService) UpdateExecution(FlowSid string, Sid string, params *UpdateExecutionParams) (*StudioV1Execution, error)
- type CreateEngagementParams
- type CreateExecutionParams
- type ListEngagementParams
- type ListEngagementResponse
- type ListEngagementResponseMeta
- type ListExecutionParams
- func (params *ListExecutionParams) SetDateCreatedFrom(DateCreatedFrom time.Time) *ListExecutionParams
- func (params *ListExecutionParams) SetDateCreatedTo(DateCreatedTo time.Time) *ListExecutionParams
- func (params *ListExecutionParams) SetLimit(Limit int) *ListExecutionParams
- func (params *ListExecutionParams) SetPageSize(PageSize int) *ListExecutionParams
- type ListExecutionResponse
- type ListExecutionStepParams
- type ListExecutionStepResponse
- type ListFlowParams
- type ListFlowResponse
- type ListStepParams
- type ListStepResponse
- type StudioV1Engagement
- type StudioV1EngagementContext
- type StudioV1Execution
- type StudioV1ExecutionContext
- type StudioV1ExecutionStep
- type StudioV1ExecutionStepContext
- type StudioV1Flow
- type StudioV1Step
- type StudioV1StepContext
- type UpdateExecutionParams
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) (*StudioV1Engagement, error)
Triggers a new Engagement for the Flow
func (*ApiService) CreateExecution ¶ added in v0.11.0
func (c *ApiService) CreateExecution(FlowSid string, params *CreateExecutionParams) (*StudioV1Execution, 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) (*StudioV1Engagement, error)
Retrieve an Engagement
func (*ApiService) FetchEngagementContext ¶ added in v0.11.0
func (c *ApiService) FetchEngagementContext(FlowSid string, EngagementSid string) (*StudioV1EngagementContext, 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) (*StudioV1Execution, error)
Retrieve an Execution
func (*ApiService) FetchExecutionContext ¶ added in v0.11.0
func (c *ApiService) FetchExecutionContext(FlowSid string, ExecutionSid string) (*StudioV1ExecutionContext, 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) (*StudioV1ExecutionStep, error)
Retrieve a Step.
func (*ApiService) FetchExecutionStepContext ¶ added in v0.11.0
func (c *ApiService) FetchExecutionStepContext(FlowSid string, ExecutionSid string, StepSid string) (*StudioV1ExecutionStepContext, 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) (*StudioV1Step, error)
Retrieve a Step.
func (*ApiService) FetchStepContext ¶ added in v0.11.0
func (c *ApiService) FetchStepContext(FlowSid string, EngagementSid string, StepSid string) (*StudioV1StepContext, error)
Retrieve the context for an Engagement Step.
func (*ApiService) ListEngagement ¶ added in v0.11.0
func (c *ApiService) ListEngagement(FlowSid string, params *ListEngagementParams) ([]StudioV1Engagement, 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) ([]StudioV1Execution, 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) ([]StudioV1ExecutionStep, 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) ([]StudioV1Step, 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, 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, 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, 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, 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, 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 StudioV1Engagement, chan 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 StudioV1Execution, chan 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 StudioV1ExecutionStep, chan 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, chan 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 StudioV1Step, chan 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) (*StudioV1Execution, error)
Update the status of an Execution to `ended`.
type CreateEngagementParams ¶
type CreateEngagementParams struct { // The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`. To *string `json:"To,omitempty"` // 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 *interface{} `json:"Parameters,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 interface{}) *CreateEngagementParams
func (*CreateEngagementParams) SetTo ¶
func (params *CreateEngagementParams) SetTo(To string) *CreateEngagementParams
type CreateExecutionParams ¶
type CreateExecutionParams struct { // The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`. To *string `json:"To,omitempty"` // 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 *interface{} `json:"Parameters,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 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 []StudioV1Engagement `json:"engagements,omitempty"` Meta ListEngagementResponseMeta `json:"meta,omitempty"` }
ListEngagementResponse struct for ListEngagementResponse
type ListEngagementResponseMeta ¶ added in v1.0.0
type ListEngagementResponseMeta struct { FirstPageUrl string `json:"first_page_url,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"` Key string `json:"key,omitempty"` }
ListEngagementResponseMeta struct for ListEngagementResponseMeta
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 []StudioV1Execution `json:"executions,omitempty"` Meta ListEngagementResponseMeta `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 { Steps []StudioV1ExecutionStep `json:"steps,omitempty"` Meta ListEngagementResponseMeta `json:"meta,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 ListEngagementResponseMeta `json:"meta,omitempty"` }
ListFlowResponse struct for ListFlowResponse
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 { Steps []StudioV1Step `json:"steps,omitempty"` Meta ListEngagementResponseMeta `json:"meta,omitempty"` }
ListStepResponse struct for ListStepResponse
type StudioV1Engagement ¶ added in v0.14.0
type StudioV1Engagement struct { // The unique string that we created to identify the Engagement resource. Sid *string `json:"sid,omitempty"` // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Engagement resource. AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the Contact. ContactSid *string `json:"contact_sid,omitempty"` // The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. ContactChannelAddress *string `json:"contact_channel_address,omitempty"` // The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,omitempty"` Status *string `json:"status,omitempty"` // The date and time in GMT when the Engagement was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateCreated *time.Time `json:"date_created,omitempty"` // The date and time in GMT when the Engagement was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateUpdated *time.Time `json:"date_updated,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` // The URLs of the Engagement's nested resources. Links *map[string]interface{} `json:"links,omitempty"` }
StudioV1Engagement struct for StudioV1Engagement
type StudioV1EngagementContext ¶ added in v0.14.0
type StudioV1EngagementContext struct { // The SID of the Account. AccountSid *string `json:"account_sid,omitempty"` // As your flow executes, we save the state in what's called the Flow Context. Any data in the flow context can be accessed by your widgets as variables, either in configuration fields or in text areas as variable substitution. Context *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"` // The URL of the resource. Url *string `json:"url,omitempty"` }
StudioV1EngagementContext struct for StudioV1EngagementContext
type StudioV1Execution ¶ added in v0.14.0
type StudioV1Execution struct { // The unique string that we created to identify the Execution resource. Sid *string `json:"sid,omitempty"` // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Execution resource. AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the Contact. ContactSid *string `json:"contact_sid,omitempty"` // The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. ContactChannelAddress *string `json:"contact_channel_address,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,omitempty"` Status *string `json:"status,omitempty"` // The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateCreated *time.Time `json:"date_created,omitempty"` // The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateUpdated *time.Time `json:"date_updated,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` // The URLs of nested resources. Links *map[string]interface{} `json:"links,omitempty"` }
StudioV1Execution struct for StudioV1Execution
type StudioV1ExecutionContext ¶ added in v0.14.0
type StudioV1ExecutionContext struct { // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionContext resource. AccountSid *string `json:"account_sid,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the context's Execution resource. ExecutionSid *string `json:"execution_sid,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` }
StudioV1ExecutionContext struct for StudioV1ExecutionContext
type StudioV1ExecutionStep ¶ added in v0.14.0
type StudioV1ExecutionStep struct { // The unique string that we created to identify the ExecutionStep resource. Sid *string `json:"sid,omitempty"` // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStep resource. AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the Step's Execution resource. ExecutionSid *string `json:"execution_sid,omitempty"` // The event that caused the Flow to transition to the Step. Name *string `json:"name,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,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 date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateCreated *time.Time `json:"date_created,omitempty"` // The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateUpdated *time.Time `json:"date_updated,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` // The URLs of related resources. Links *map[string]interface{} `json:"links,omitempty"` }
StudioV1ExecutionStep struct for StudioV1ExecutionStep
type StudioV1ExecutionStepContext ¶ added in v0.14.0
type StudioV1ExecutionStepContext struct { // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionStepContext resource. AccountSid *string `json:"account_sid,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,omitempty"` // The SID of the context's Execution resource. ExecutionSid *string `json:"execution_sid,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the Step that the context is associated with. StepSid *string `json:"step_sid,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` }
StudioV1ExecutionStepContext struct for StudioV1ExecutionStepContext
type StudioV1Flow ¶
type StudioV1Flow struct { // The unique string that we created to identify the Flow resource. Sid *string `json:"sid,omitempty"` // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flow resource. AccountSid *string `json:"account_sid,omitempty"` // The string that you assigned to describe the Flow. FriendlyName *string `json:"friendly_name,omitempty"` Status *string `json:"status,omitempty"` // The latest version number of the Flow's definition. Version *int `json:"version,omitempty"` // The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateCreated *time.Time `json:"date_created,omitempty"` // The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateUpdated *time.Time `json:"date_updated,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` // The URLs of the Flow's nested resources. Links *map[string]interface{} `json:"links,omitempty"` }
StudioV1Flow struct for StudioV1Flow
type StudioV1Step ¶ added in v0.14.0
type StudioV1Step struct { // The unique string that we created to identify the Step resource. Sid *string `json:"sid,omitempty"` // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Step resource. AccountSid *string `json:"account_sid,omitempty"` // The SID of the Flow. FlowSid *string `json:"flow_sid,omitempty"` // The SID of the Engagement. EngagementSid *string `json:"engagement_sid,omitempty"` // The event that caused the Flow to transition to the Step. Name *string `json:"name,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *interface{} `json:"context,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 date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateCreated *time.Time `json:"date_created,omitempty"` // The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. DateUpdated *time.Time `json:"date_updated,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` // The URLs of related resources. Links *map[string]interface{} `json:"links,omitempty"` }
StudioV1Step struct for StudioV1Step
type StudioV1StepContext ¶ added in v0.14.0
type StudioV1StepContext struct { // The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StepContext resource. AccountSid *string `json:"account_sid,omitempty"` // The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. Context *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"` // The SID of the Step the context is associated with. StepSid *string `json:"step_sid,omitempty"` // The absolute URL of the resource. Url *string `json:"url,omitempty"` }
StudioV1StepContext struct for StudioV1StepContext
type UpdateExecutionParams ¶
type UpdateExecutionParams struct { // Status *string `json:"Status,omitempty"` }
Optional parameters for the method 'UpdateExecution'
func (*UpdateExecutionParams) SetStatus ¶
func (params *UpdateExecutionParams) SetStatus(Status string) *UpdateExecutionParams
Source Files ¶
- api_service.go
- flows.go
- flows_engagements.go
- flows_engagements_context.go
- flows_engagements_steps.go
- flows_engagements_steps_context.go
- flows_executions.go
- flows_executions_context.go
- flows_executions_steps.go
- flows_executions_steps_context.go
- model_list_engagement_response.go
- model_list_engagement_response_meta.go
- model_list_execution_response.go
- model_list_execution_step_response.go
- model_list_flow_response.go
- model_list_step_response.go
- model_studio_v1_engagement.go
- model_studio_v1_engagement_context.go
- model_studio_v1_execution.go
- model_studio_v1_execution_context.go
- model_studio_v1_execution_step.go
- model_studio_v1_execution_step_context.go
- model_studio_v1_flow.go
- model_studio_v1_step.go
- model_studio_v1_step_context.go