activity

Documentation

Overview

Package activity contains auto-generated files. DO NOT MODIFY

Package activity contains auto-generated files. DO NOT MODIFY

Package activity contains auto-generated files. DO NOT MODIFY

Package activity contains auto-generated files. 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() (*FetchActivityResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchActivityResponse, error)
  • func (c Client) Update(input *UpdateActivityInput) (*UpdateActivityResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateActivityInput) (*UpdateActivityResponse, error)
• type ClientProperties
• type FetchActivityResponse
• type UpdateActivityInput
• type UpdateActivityResponse

Types

type Client

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

Client for managing a specific activity resource See https://www.twilio.com/docs/taskrouter/api/activity for more details

func New

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

New creates a new instance of the activity client

func (Client) Delete

func (c Client) Delete() error

Delete removes a activity resource from the account See https://www.twilio.com/docs/taskrouter/api/activity#delete-an-activity-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 activity resource from the account See https://www.twilio.com/docs/taskrouter/api/activity#delete-an-activity-resource for more details

func (Client) Fetch

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

Fetch retrieves an activity resource See https://www.twilio.com/docs/taskrouter/api/activity#fetch-an-activity-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) (*FetchActivityResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateActivityInput) (*UpdateActivityResponse, error)

Update modifies a activity resource See https://www.twilio.com/docs/taskrouter/api/activity#update-an-activity-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 *UpdateActivityInput) (*UpdateActivityResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Sid          string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the activity resources

type FetchActivityResponse

type FetchActivityResponse struct {
	AccountSid   string     `json:"account_sid"`
	Available    bool       `json:"available"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	WorkspaceSid string     `json:"workspace_sid"`
}

FetchActivityResponse defines the response fields for the retrieved activity

type UpdateActivityInput

type UpdateActivityInput struct {
	FriendlyName *string `form:"FriendlyName,omitempty"`
}

UpdateActivityInput defines input fields for updating a activity resource

type UpdateActivityResponse

type UpdateActivityResponse struct {
	AccountSid   string     `json:"account_sid"`
	Available    bool       `json:"available"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName string     `json:"friendly_name"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	WorkspaceSid string     `json:"workspace_sid"`
}

UpdateActivityResponse defines the response fields for the updated activity