workflow

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchWorkflowResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchWorkflowResponse, error)
  • func (c Client) Update(input *UpdateWorkflowInput) (*UpdateWorkflowResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateWorkflowInput) (*UpdateWorkflowResponse, error)
• type ClientProperties
• type FetchWorkflowResponse
• type UpdateWorkflowInput
• type UpdateWorkflowResponse

Types

type Client

type Client struct {
	CumulativeStatistics func() *cumulative_statistics.Client
	RealTimeStatistics   func() *real_time_statistics.Client
	Statistics           func() *statistics.Client
	// contains filtered or unexported fields
}

Client for managing a specific workflow resource 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 workflow client

func (Client) Delete

func (c Client) Delete() error

Delete removes a workflow resource from the account See https://www.twilio.com/docs/taskrouter/api/workflow#delete-a-workflow-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a workflow resource from the account See https://www.twilio.com/docs/taskrouter/api/workflow#delete-a-workflow-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchWorkflowResponse, error)

Fetch retrieves an workflow resource See https://www.twilio.com/docs/taskrouter/api/workflow#fetch-a-workflow-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchWorkflowResponse, error)

FetchWithContext retrieves an workflow resource See https://www.twilio.com/docs/taskrouter/api/workflow#fetch-a-workflow-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateWorkflowInput) (*UpdateWorkflowResponse, error)

Update modifies a workflow resource See https://www.twilio.com/docs/taskrouter/api/workflow#update-a-workflow-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateWorkflowInput) (*UpdateWorkflowResponse, error)

UpdateWithContext modifies a workflow resource See https://www.twilio.com/docs/taskrouter/api/workflow#update-a-workflow-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid          string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the workflow resources

type FetchWorkflowResponse

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

FetchWorkflowResponse defines the response fields for the retrieved workflow

type UpdateWorkflowInput

type UpdateWorkflowInput struct {
	AssignmentCallbackURL         *string `form:"AssignmentCallbackUrl,omitempty"`
	Configuration                 *string `form:"Configuration,omitempty"`
	FallbackAssignmentCallbackURL *string `form:"FallbackAssignmentCallbackUrl,omitempty"`
	FriendlyName                  *string `form:"FriendlyName,omitempty"`
	ReEvaluateTasks               *bool   `form:"ReEvaluateTasks,omitempty"`
	TaskReservationTimeout        *int    `form:"TaskReservationTimeout,omitempty"`
}

UpdateWorkflowInput defines input fields for updating a workflow resource

type UpdateWorkflowResponse

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

UpdateWorkflowResponse defines the response fields for the updated workflow