field_types

Documentation

Overview

Package field_types contains auto-generated files. DO NOT MODIFY

Package field_types contains auto-generated files. DO NOT MODIFY

Package field_types contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateFieldTypeInput) (*CreateFieldTypeResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateFieldTypeInput) (*CreateFieldTypeResponse, error)
  • func (c *Client) NewFieldTypesPaginator() *FieldTypesPaginator
  • func (c *Client) NewFieldTypesPaginatorWithOptions(options *FieldTypesPageOptions) *FieldTypesPaginator
  • func (c Client) Page(options *FieldTypesPageOptions) (*FieldTypesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *FieldTypesPageOptions) (*FieldTypesPageResponse, error)
• type ClientProperties
• type CreateFieldTypeInput
• type CreateFieldTypeResponse
• type FieldTypesPage
• type FieldTypesPageOptions
• type FieldTypesPageResponse
• type FieldTypesPaginator
  • func (p *FieldTypesPaginator) CurrentPage() *FieldTypesPageResponse
  • func (p *FieldTypesPaginator) Error() error
  • func (p *FieldTypesPaginator) Next() bool
  • func (p *FieldTypesPaginator) NextWithContext(context context.Context) bool
• type PageFieldTypeResponse
• type PageMetaResponse

Types

type Client

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

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

func New

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

New creates a new instance of the field types client

func (Client) Create

func (c Client) Create(input *CreateFieldTypeInput) (*CreateFieldTypeResponse, error)

Create creates a new field type See https://www.twilio.com/docs/autopilot/api/field-type#create-a-fieldtype-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 *CreateFieldTypeInput) (*CreateFieldTypeResponse, error)

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

func (*Client) NewFieldTypesPaginator

func (c *Client) NewFieldTypesPaginator() *FieldTypesPaginator

NewFieldTypesPaginator creates a new instance of the paginator for Page.

func (*Client) NewFieldTypesPaginatorWithOptions

func (c *Client) NewFieldTypesPaginatorWithOptions(options *FieldTypesPageOptions) *FieldTypesPaginator

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

func (Client) Page

func (c Client) Page(options *FieldTypesPageOptions) (*FieldTypesPageResponse, error)

Page retrieves a page of field types See https://www.twilio.com/docs/autopilot/api/field-type#read-multiple-fieldtype-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 *FieldTypesPageOptions) (*FieldTypesPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	AssistantSid string
}

ClientProperties are the properties required to manage the field types resources

type CreateFieldTypeInput

type CreateFieldTypeInput struct {
	FriendlyName *string `form:"FriendlyName,omitempty"`
	UniqueName   string  `validate:"required" form:"UniqueName"`
}

CreateFieldTypeInput defines the input fields for creating a new field type resource

type CreateFieldTypeResponse

type CreateFieldTypeResponse struct {
	AccountSid   string     `json:"account_sid"`
	AssistantSid string     `json:"assistant_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName *string    `json:"friendly_name,omitempty"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	UniqueName   string     `json:"unique_name"`
}

CreateFieldTypeResponse defines the response fields for the created field type

type FieldTypesPage

type FieldTypesPage struct {
	CurrentPage *FieldTypesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type FieldTypesPageOptions

type FieldTypesPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

FieldTypesPageOptions defines the query options for the api operation

type FieldTypesPageResponse

type FieldTypesPageResponse struct {
	FieldTypes []PageFieldTypeResponse `json:"field_types"`
	Meta       PageMetaResponse        `json:"meta"`
}

FieldTypesPageResponse defines the response fields for the field types page

type FieldTypesPaginator

type FieldTypesPaginator struct {
	Page       *FieldTypesPage
	FieldTypes []PageFieldTypeResponse
	// contains filtered or unexported fields
}

FieldTypesPaginator defines the fields for makings paginated api calls FieldTypes is an array of fieldtypes that have been returned from all of the page calls

func (*FieldTypesPaginator) CurrentPage

func (p *FieldTypesPaginator) CurrentPage() *FieldTypesPageResponse

CurrentPage retrieves the results for the current page

func (*FieldTypesPaginator) Error

func (p *FieldTypesPaginator) Error() error

Error retrieves the error returned from the page

func (*FieldTypesPaginator) Next

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

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

type PageFieldTypeResponse struct {
	AccountSid   string     `json:"account_sid"`
	AssistantSid string     `json:"assistant_sid"`
	DateCreated  time.Time  `json:"date_created"`
	DateUpdated  *time.Time `json:"date_updated,omitempty"`
	FriendlyName *string    `json:"friendly_name,omitempty"`
	Sid          string     `json:"sid"`
	URL          string     `json:"url"`
	UniqueName   string     `json:"unique_name"`
}

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