field_values

Documentation

Overview

Package field_values contains auto-generated files. DO NOT MODIFY

Package field_values contains auto-generated files. DO NOT MODIFY

Package field_values contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateFieldValueInput) (*CreateFieldValueResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFieldValueInput) (*CreateFieldValueResponse, error)
  • func (c *Client) NewFieldValuesPaginator() *FieldValuesPaginator
  • func (c *Client) NewFieldValuesPaginatorWithOptions(options *FieldValuesPageOptions) *FieldValuesPaginator
  • func (c Client) Page(options *FieldValuesPageOptions) (*FieldValuesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FieldValuesPageOptions) (*FieldValuesPageResponse, error)
• type ClientProperties
• type CreateFieldValueInput
• type CreateFieldValueResponse
• type FieldValuesPage
• type FieldValuesPageOptions
• type FieldValuesPageResponse
• type FieldValuesPaginator
  • func (p *FieldValuesPaginator) CurrentPage() *FieldValuesPageResponse
  • func (p *FieldValuesPaginator) Error() error
  • func (p *FieldValuesPaginator) Next() bool
  • func (p *FieldValuesPaginator) NextWithContext(context context.Context) bool
• type PageFieldValueResponse
• type PageMetaResponse

Types

type Client

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

Client for managing field value resources See https://www.twilio.com/docs/autopilot/api/field-value for more details

func New

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

New creates a new instance of the field values client

func (Client) Create

func (c Client) Create(input *CreateFieldValueInput) (*CreateFieldValueResponse, error)

Create creates a new field value See https://www.twilio.com/docs/autopilot/api/field-value#create-a-fieldvalue-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 *CreateFieldValueInput) (*CreateFieldValueResponse, error)

CreateWithContext creates a new field value See https://www.twilio.com/docs/autopilot/api/field-value#create-a-fieldvalue-resource for more details

func (*Client) NewFieldValuesPaginator

func (c *Client) NewFieldValuesPaginator() *FieldValuesPaginator

NewFieldValuesPaginator creates a new instance of the paginator for Page.

func (*Client) NewFieldValuesPaginatorWithOptions

func (c *Client) NewFieldValuesPaginatorWithOptions(options *FieldValuesPageOptions) *FieldValuesPaginator

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

func (Client) Page

func (c Client) Page(options *FieldValuesPageOptions) (*FieldValuesPageResponse, error)

Page retrieves a page of field values See https://www.twilio.com/docs/autopilot/api/field-value#read-multiple-fieldvalue-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 *FieldValuesPageOptions) (*FieldValuesPageResponse, error)

PageWithContext retrieves a page of field values See https://www.twilio.com/docs/autopilot/api/field-value#read-multiple-fieldvalue-resources for more details

type ClientProperties

type ClientProperties struct {
	AssistantSid string
	FieldTypeSid string
}

ClientProperties are the properties required to manage the field values resources

type CreateFieldValueInput

type CreateFieldValueInput struct {
	Language  string  `validate:"required" form:"Language"`
	SynonymOf *string `form:"SynonymOf,omitempty"`
	Value     string  `validate:"required" form:"Value"`
}

CreateFieldValueInput defines the input fields for creating a new field value resource

type CreateFieldValueResponse

type CreateFieldValueResponse struct {
	AccountSid   string     `json:"account_sid"`
	AssistantSid string     `json:"assistant_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FieldTypeSid string     `json:"field_type_sid"`
	Language     string     `json:"language"`
	Sid          string     `json:"sid"`
	SynonymOf    *string    `json:"synonym_of,omitempty"`
	URL          string     `json:"url"`
	Value        string     `json:"value"`
}

CreateFieldValueResponse defines the response fields for the created field value

type FieldValuesPage

type FieldValuesPage struct {
	CurrentPage *FieldValuesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FieldValuesPageOptions

type FieldValuesPageOptions struct {
	Language  *string
	PageSize  *int
	Page      *int
	PageToken *string
}

FieldValuesPageOptions defines the query options for the api operation

type FieldValuesPageResponse

type FieldValuesPageResponse struct {
	FieldValues []PageFieldValueResponse `json:"field_values"`
	Meta        PageMetaResponse         `json:"meta"`
}

FieldValuesPageResponse defines the response fields for the field value page

type FieldValuesPaginator

type FieldValuesPaginator struct {
	Page        *FieldValuesPage
	FieldValues []PageFieldValueResponse
	// contains filtered or unexported fields
}

FieldValuesPaginator defines the fields for makings paginated api calls FieldValues is an array of fieldvalues that have been returned from all of the page calls

func (*FieldValuesPaginator) CurrentPage

func (p *FieldValuesPaginator) CurrentPage() *FieldValuesPageResponse

CurrentPage retrieves the results for the current page

func (*FieldValuesPaginator) Error

func (p *FieldValuesPaginator) Error() error

Error retrieves the error returned from the page

func (*FieldValuesPaginator) Next

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

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

type PageFieldValueResponse

type PageFieldValueResponse struct {
	AccountSid   string     `json:"account_sid"`
	AssistantSid string     `json:"assistant_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FieldTypeSid string     `json:"field_type_sid"`
	Language     string     `json:"language"`
	Sid          string     `json:"sid"`
	SynonymOf    *string    `json:"synonym_of,omitempty"`
	URL          string     `json:"url"`
	Value        string     `json:"value"`
}

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