flows

Documentation

Overview

Package flows contains auto-generated files. DO NOT MODIFY

Package flows contains auto-generated files. DO NOT MODIFY

Package flows contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateFlowInput) (*CreateFlowResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFlowInput) (*CreateFlowResponse, error)
  • func (c *Client) NewFlowsPaginator() *FlowsPaginator
  • func (c *Client) NewFlowsPaginatorWithOptions(options *FlowsPageOptions) *FlowsPaginator
  • func (c Client) Page(options *FlowsPageOptions) (*FlowsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FlowsPageOptions) (*FlowsPageResponse, error)
• type CreateFlowInput
• type CreateFlowResponse
• type FlowsPage
• type FlowsPageOptions
• type FlowsPageResponse
• type FlowsPaginator
  • func (p *FlowsPaginator) CurrentPage() *FlowsPageResponse
  • func (p *FlowsPaginator) Error() error
  • func (p *FlowsPaginator) Next() bool
  • func (p *FlowsPaginator) NextWithContext(context context.Context) bool
• type PageFlowResponse
• type PageMetaResponse

Types

type Client

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

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

func New

func New(client *client.Client) *Client

New creates a new instance of the flows client

func (Client) Create

func (c Client) Create(input *CreateFlowInput) (*CreateFlowResponse, error)

Create creates a new flow See https://www.twilio.com/docs/studio/rest-api/v2/flow#create-a-flow-resource 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 *CreateFlowInput) (*CreateFlowResponse, error)

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

func (*Client) NewFlowsPaginator

func (c *Client) NewFlowsPaginator() *FlowsPaginator

NewFlowsPaginator creates a new instance of the paginator for Page.

func (*Client) NewFlowsPaginatorWithOptions

func (c *Client) NewFlowsPaginatorWithOptions(options *FlowsPageOptions) *FlowsPaginator

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

func (Client) Page

func (c Client) Page(options *FlowsPageOptions) (*FlowsPageResponse, error)

Page retrieves a page of flows See https://www.twilio.com/docs/studio/rest-api/v2/flow#read-multiple-flow-resources 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 *FlowsPageOptions) (*FlowsPageResponse, error)

PageWithContext retrieves a page of flows See https://www.twilio.com/docs/studio/rest-api/v2/flow#read-multiple-flow-resources for more details

type CreateFlowInput

type CreateFlowInput struct {
	CommitMessage *string `form:"CommitMessage,omitempty"`
	Definition    string  `validate:"required" form:"Definition"`
	FriendlyName  string  `validate:"required" form:"FriendlyName"`
	Status        string  `validate:"required" form:"Status"`
}

CreateFlowInput defines the input fields for creating a new flow resource

type CreateFlowResponse

type CreateFlowResponse struct {
	AccountSid    string                 `json:"account_sid"`
	CommitMessage *string                `json:"commit_message,omitempty"`
	DateCreated   time.Time              `json:"date_created"`
	DateUpdated   *time.Time             `json:"date_updated,omitempty"`
	Definition    map[string]interface{} `json:"definition"`
	Errors        *[]interface{}         `json:"errors,omitempty"`
	FriendlyName  string                 `json:"friendly_name"`
	Revision      int                    `json:"revision"`
	Sid           string                 `json:"sid"`
	Status        string                 `json:"status"`
	URL           string                 `json:"url"`
	Valid         bool                   `json:"valid"`
	Warnings      *[]interface{}         `json:"warnings,omitempty"`
	WebhookURL    string                 `json:"webhook_url"`
}

CreateFlowResponse defines the response fields for the created flow

type FlowsPage

type FlowsPage struct {
	CurrentPage *FlowsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FlowsPageOptions

type FlowsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

FlowsPageOptions defines the query options for the api operation

type FlowsPageResponse

type FlowsPageResponse struct {
	Flows []PageFlowResponse `json:"flows"`
	Meta  PageMetaResponse   `json:"meta"`
}

FlowsPageResponse defines the response fields for the flows page

type FlowsPaginator

type FlowsPaginator struct {
	Page  *FlowsPage
	Flows []PageFlowResponse
	// contains filtered or unexported fields
}

FlowsPaginator defines the fields for makings paginated api calls Flows is an array of flows that have been returned from all of the page calls

func (*FlowsPaginator) CurrentPage

func (p *FlowsPaginator) CurrentPage() *FlowsPageResponse

CurrentPage retrieves the results for the current page

func (*FlowsPaginator) Error

func (p *FlowsPaginator) Error() error

Error retrieves the error returned from the page

func (*FlowsPaginator) Next

func (p *FlowsPaginator) 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 (*FlowsPaginator) NextWithContext

func (p *FlowsPaginator) 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 PageFlowResponse

type PageFlowResponse struct {
	AccountSid    string                 `json:"account_sid"`
	CommitMessage *string                `json:"commit_message,omitempty"`
	DateCreated   time.Time              `json:"date_created"`
	DateUpdated   *time.Time             `json:"date_updated,omitempty"`
	Definition    map[string]interface{} `json:"definition"`
	Errors        *[]interface{}         `json:"errors,omitempty"`
	FriendlyName  string                 `json:"friendly_name"`
	Revision      int                    `json:"revision"`
	Sid           string                 `json:"sid"`
	Status        string                 `json:"status"`
	URL           string                 `json:"url"`
	Valid         bool                   `json:"valid"`
	Warnings      *[]interface{}         `json:"warnings,omitempty"`
	WebhookURL    string                 `json:"webhook_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"`
}