workflows

Documentation

Overview

Package workflows contains auto-generated files. DO NOT MODIFY

Package workflows contains auto-generated files. DO NOT MODIFY

Package workflows contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateWorkflowInput) (*CreateWorkflowResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateWorkflowInput) (*CreateWorkflowResponse, error)
  • func (c *Client) NewWorkflowsPaginator() *WorkflowsPaginator
  • func (c *Client) NewWorkflowsPaginatorWithOptions(options *WorkflowsPageOptions) *WorkflowsPaginator
  • func (c Client) Page(options *WorkflowsPageOptions) (*WorkflowsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *WorkflowsPageOptions) (*WorkflowsPageResponse, error)
• type ClientProperties
• type CreateWorkflowInput
• type CreateWorkflowResponse
• type PageMetaResponse
• type PageWorkflowResponse
• type WorkflowsPage
• type WorkflowsPageOptions
• type WorkflowsPageResponse
• type WorkflowsPaginator
  • func (p *WorkflowsPaginator) CurrentPage() *WorkflowsPageResponse
  • func (p *WorkflowsPaginator) Error() error
  • func (p *WorkflowsPaginator) Next() bool
  • func (p *WorkflowsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing workflow resources See https://www.twilio.com/docs/taskrouter/api/workflow for more details

func New

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

New creates a new instance of the workflows client

func (Client) Create

func (c Client) Create(input *CreateWorkflowInput) (*CreateWorkflowResponse, error)

Create creates a new workflow See https://www.twilio.com/docs/taskrouter/api/workflow#create-a-workflow-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 *CreateWorkflowInput) (*CreateWorkflowResponse, error)

CreateWithContext creates a new workflow See https://www.twilio.com/docs/taskrouter/api/workflow#create-a-workflow-resource for more details

func (*Client) NewWorkflowsPaginator

func (c *Client) NewWorkflowsPaginator() *WorkflowsPaginator

NewWorkflowsPaginator creates a new instance of the paginator for Page.

func (*Client) NewWorkflowsPaginatorWithOptions

func (c *Client) NewWorkflowsPaginatorWithOptions(options *WorkflowsPageOptions) *WorkflowsPaginator

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

func (Client) Page

func (c Client) Page(options *WorkflowsPageOptions) (*WorkflowsPageResponse, error)

Page retrieves a page of workflows See https://www.twilio.com/docs/taskrouter/api/workflow#read-multiple-workflow-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 *WorkflowsPageOptions) (*WorkflowsPageResponse, error)

PageWithContext retrieves a page of workflows See https://www.twilio.com/docs/taskrouter/api/workflow#read-multiple-workflow-resources for more details

type ClientProperties

type ClientProperties struct {
	WorkspaceSid string
}

ClientProperties are the properties required to manage the workflows resources

type CreateWorkflowInput

type CreateWorkflowInput struct {
	AssignmentCallbackURL         *string `form:"AssignmentCallbackUrl,omitempty"`
	Configuration                 string  `validate:"required" form:"Configuration"`
	FallbackAssignmentCallbackURL *string `form:"FallbackAssignmentCallbackUrl,omitempty"`
	FriendlyName                  string  `validate:"required" form:"FriendlyName"`
	TaskReservationTimeout        *int    `form:"TaskReservationTimeout,omitempty"`
}

CreateWorkflowInput defines the input fields for creating a new workflow resource

type CreateWorkflowResponse

type CreateWorkflowResponse struct {
	AccountSid                    string     `json:"account_sid"`
	AssignmentCallbackURL         *string    `json:"assignment_callback_url,omitempty"`
	Configuration                 string     `json:"configuration"`
	DateCreated                   time.Time  `json:"date_created"`
	DateUpdated                   *time.Time `json:"date_updated,omitempty"`
	DocumentContentType           string     `json:"document_content_type"`
	FallbackAssignmentCallbackURL *string    `json:"fallback_assignment_callback_url,omitempty"`
	FriendlyName                  string     `json:"friendly_name"`
	Sid                           string     `json:"sid"`
	TaskReservationTimeout        int        `json:"task_reservation_timeout"`
	URL                           string     `json:"url"`
	WorkspaceSid                  string     `json:"workspace_sid"`
}

CreateWorkflowResponse defines the response fields for the created workflow

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"`
}

type PageWorkflowResponse

type PageWorkflowResponse struct {
	AccountSid                    string     `json:"account_sid"`
	AssignmentCallbackURL         *string    `json:"assignment_callback_url,omitempty"`
	Configuration                 string     `json:"configuration"`
	DateCreated                   time.Time  `json:"date_created"`
	DateUpdated                   *time.Time `json:"date_updated,omitempty"`
	DocumentContentType           string     `json:"document_content_type"`
	FallbackAssignmentCallbackURL *string    `json:"fallback_assignment_callback_url,omitempty"`
	FriendlyName                  string     `json:"friendly_name"`
	Sid                           string     `json:"sid"`
	TaskReservationTimeout        int        `json:"task_reservation_timeout"`
	URL                           string     `json:"url"`
	WorkspaceSid                  string     `json:"workspace_sid"`
}

type WorkflowsPage

type WorkflowsPage struct {
	CurrentPage *WorkflowsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type WorkflowsPageOptions

type WorkflowsPageOptions struct {
	PageSize     *int
	Page         *int
	PageToken    *string
	FriendlyName *string
}

WorkflowsPageOptions defines the query options for the api operation

type WorkflowsPageResponse

type WorkflowsPageResponse struct {
	Meta      PageMetaResponse       `json:"meta"`
	Workflows []PageWorkflowResponse `json:"workflows"`
}

WorkflowsPageResponse defines the response fields for the workflows page

type WorkflowsPaginator

type WorkflowsPaginator struct {
	Page      *WorkflowsPage
	Workflows []PageWorkflowResponse
	// contains filtered or unexported fields
}

WorkflowsPaginator defines the fields for makings paginated api calls Workflows is an array of workflows that have been returned from all of the page calls

func (*WorkflowsPaginator) CurrentPage

func (p *WorkflowsPaginator) CurrentPage() *WorkflowsPageResponse

CurrentPage retrieves the results for the current page

func (*WorkflowsPaginator) Error

func (p *WorkflowsPaginator) Error() error

Error retrieves the error returned from the page

func (*WorkflowsPaginator) Next

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

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