field

Documentation

Overview

Package field contains auto-generated files. DO NOT MODIFY

Package field contains auto-generated files. DO NOT MODIFY

Package field 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() (*FetchFieldResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchFieldResponse, error)
• type ClientProperties
• type FetchFieldResponse

Types

type Client

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

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

func New

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

New creates a new instance of the field client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

type ClientProperties

type ClientProperties struct {
	AssistantSid string
	Sid          string
	TaskSid      string
}

ClientProperties are the properties required to manage the field resources

type FetchFieldResponse

type FetchFieldResponse struct {
	AccountSid   string     `json:"account_sid"`
	AssistantSid string     `json:"assistant_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FieldType    string     `json:"field_type"`
	Sid          string     `json:"sid"`
	TaskSid      string     `json:"task_sid"`
	URL          string     `json:"url"`
	UniqueName   string     `json:"unique_name"`
}

FetchFieldResponse defines the response fields for the retrieved task field