executions

Documentation

Overview

Package executions contains auto-generated files. DO NOT MODIFY

Package executions contains auto-generated files. DO NOT MODIFY

Package executions contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateExecutionInput) (*CreateExecutionResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateExecutionInput) (*CreateExecutionResponse, error)
  • func (c *Client) NewExecutionsPaginator() *ExecutionsPaginator
  • func (c *Client) NewExecutionsPaginatorWithOptions(options *ExecutionsPageOptions) *ExecutionsPaginator
  • func (c Client) Page(options *ExecutionsPageOptions) (*ExecutionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ExecutionsPageOptions) (*ExecutionsPageResponse, error)
• type ClientProperties
• type CreateExecutionInput
• type CreateExecutionResponse
• type ExecutionsPage
• type ExecutionsPageOptions
• type ExecutionsPageResponse
• type ExecutionsPaginator
  • func (p *ExecutionsPaginator) CurrentPage() *ExecutionsPageResponse
  • func (p *ExecutionsPaginator) Error() error
  • func (p *ExecutionsPaginator) Next() bool
  • func (p *ExecutionsPaginator) NextWithContext(context context.Context) bool
• type PageExecutionResponse
• type PageMetaResponse

Types

type Client

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

Client for managing execution resources See https://www.twilio.com/docs/studio/rest-api/v2/execution for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the executions client

func (Client) Create

func (c Client) Create(input *CreateExecutionInput) (*CreateExecutionResponse, error)

Create creates a new execution See https://www.twilio.com/docs/studio/rest-api/v2/execution#create-a-new-execution for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateExecutionInput) (*CreateExecutionResponse, error)

CreateWithContext creates a new execution See https://www.twilio.com/docs/studio/rest-api/v2/execution#create-a-new-execution for more details

func (*Client) NewExecutionsPaginator

func (c *Client) NewExecutionsPaginator() *ExecutionsPaginator

NewExecutionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewExecutionsPaginatorWithOptions

func (c *Client) NewExecutionsPaginatorWithOptions(options *ExecutionsPageOptions) *ExecutionsPaginator

NewExecutionsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *ExecutionsPageOptions) (*ExecutionsPageResponse, error)

Page retrieves a page of executions See https://www.twilio.com/docs/studio/rest-api/v2/execution#read-a-list-of-executions for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *ExecutionsPageOptions) (*ExecutionsPageResponse, error)

PageWithContext retrieves a page of executions See https://www.twilio.com/docs/studio/rest-api/v2/execution#read-a-list-of-executions for more details

type ClientProperties

type ClientProperties struct {
	FlowSid string
}

ClientProperties are the properties required to manage the executions resources

type CreateExecutionInput

type CreateExecutionInput struct {
	From       string  `validate:"required" form:"From"`
	Parameters *string `form:"Parameters,omitempty"`
	To         string  `validate:"required" form:"To"`
}

CreateExecutionInput defines the input fields for creating a new execution resource

type CreateExecutionResponse

type CreateExecutionResponse struct {
	AccountSid            string      `json:"account_sid"`
	ContactChannelAddress string      `json:"contact_channel_address"`
	Context               interface{} `json:"context"`
	DateCreated           time.Time   `json:"date_created"`
	DateUpdated           *time.Time  `json:"date_updated,omitempty"`
	FlowSid               string      `json:"flow_sid"`
	Sid                   string      `json:"sid"`
	Status                string      `json:"status"`
	URL                   string      `json:"url"`
}

CreateExecutionResponse defines the response fields for the created execution

type ExecutionsPage

type ExecutionsPage struct {
	CurrentPage *ExecutionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

ExecutionsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageExecutionResponse or error that is returned from the api call(s)

type ExecutionsPageOptions

type ExecutionsPageOptions struct {
	PageSize        *int
	Page            *int
	PageToken       *string
	DateCreatedFrom *time.Time
	DateCreatedTo   *time.Time
}

ExecutionsPageOptions defines the query options for the api operation

type ExecutionsPageResponse

type ExecutionsPageResponse struct {
	Executions []PageExecutionResponse `json:"executions"`
	Meta       PageMetaResponse        `json:"meta"`
}

ExecutionsPageResponse defines the response fields for the executions page

type ExecutionsPaginator

type ExecutionsPaginator struct {
	Page       *ExecutionsPage
	Executions []PageExecutionResponse
	// contains filtered or unexported fields
}

ExecutionsPaginator defines the fields for makings paginated api calls Executions is an array of executions that have been returned from all of the page calls

func (*ExecutionsPaginator) CurrentPage

func (p *ExecutionsPaginator) CurrentPage() *ExecutionsPageResponse

CurrentPage retrieves the results for the current page

func (*ExecutionsPaginator) Error

func (p *ExecutionsPaginator) Error() error

Error retrieves the error returned from the page

func (*ExecutionsPaginator) Next

func (p *ExecutionsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*ExecutionsPaginator) NextWithContext

func (p *ExecutionsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate

type PageExecutionResponse

type PageExecutionResponse struct {
	AccountSid            string      `json:"account_sid"`
	ContactChannelAddress string      `json:"contact_channel_address"`
	Context               interface{} `json:"context"`
	DateCreated           time.Time   `json:"date_created"`
	DateUpdated           *time.Time  `json:"date_updated,omitempty"`
	FlowSid               string      `json:"flow_sid"`
	Sid                   string      `json:"sid"`
	Status                string      `json:"status"`
	URL                   string      `json:"url"`
}

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}