sample

Documentation

Overview

Package sample contains auto-generated files. DO NOT MODIFY

Package sample contains auto-generated files. DO NOT MODIFY

Package sample contains auto-generated files. DO NOT MODIFY

Package sample 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() (*FetchSampleResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSampleResponse, error)
  • func (c Client) Update(input *UpdateSampleInput) (*UpdateSampleResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSampleInput) (*UpdateSampleResponse, error)
• type ClientProperties
• type FetchSampleResponse
• type UpdateSampleInput
• type UpdateSampleResponse

Types

type Client

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

Client for managing a specific task sample resource See https://www.twilio.com/docs/autopilot/api/task-sample for more details

func New

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

New creates a new instance of the sample client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

Fetch retrieves a task sample resource See https://www.twilio.com/docs/autopilot/api/task-sample#fetch-a-sample-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) (*FetchSampleResponse, error)

FetchWithContext retrieves a task sample resource See https://www.twilio.com/docs/autopilot/api/task-sample#fetch-a-sample-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateSampleInput) (*UpdateSampleResponse, error)

Update modifies a task sample resource See https://www.twilio.com/docs/autopilot/api/task-sample#update-a-sample-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 *UpdateSampleInput) (*UpdateSampleResponse, error)

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

type ClientProperties

type ClientProperties struct {
	AssistantSid string
	Sid          string
	TaskSid      string
}

ClientProperties are the properties required to manage the sample resources

type FetchSampleResponse

type FetchSampleResponse struct {
	AccountSid    string     `json:"account_sid"`
	AssistantSid  string     `json:"assistant_sid"`
	DateCreated   time.Time  `json:"date_created"`
	DateUpdated   *time.Time `json:"date_updated,omitempty"`
	Language      string     `json:"language"`
	Sid           string     `json:"sid"`
	SourceChannel *string    `json:"source_channel,omitempty"`
	TaggedText    string     `json:"tagged_text"`
	TaskSid       string     `json:"task_sid"`
	URL           string     `json:"url"`
}

FetchSampleResponse defines the response fields for the retrieved task sample

type UpdateSampleInput

type UpdateSampleInput struct {
	Language      *string `form:"Language,omitempty"`
	SourceChannel *string `form:"SourceChannel,omitempty"`
	TaggedText    *string `form:"TaggedText,omitempty"`
}

UpdateSampleInput defines the input fields for updating a task sample

type UpdateSampleResponse

type UpdateSampleResponse struct {
	AccountSid    string     `json:"account_sid"`
	AssistantSid  string     `json:"assistant_sid"`
	DateCreated   time.Time  `json:"date_created"`
	DateUpdated   *time.Time `json:"date_updated,omitempty"`
	Language      string     `json:"language"`
	Sid           string     `json:"sid"`
	SourceChannel *string    `json:"source_channel,omitempty"`
	TaggedText    string     `json:"tagged_text"`
	TaskSid       string     `json:"task_sid"`
	URL           string     `json:"url"`
}

UpdateSampleResponse defines the response fields for the updated task sample