assistants

Documentation

Overview

Package assistants contains auto-generated files. DO NOT MODIFY

Package assistants contains auto-generated files. DO NOT MODIFY

Package assistants contains auto-generated files. DO NOT MODIFY

Index

• type AssistantsPage
• type AssistantsPageOptions
• type AssistantsPageResponse
• type AssistantsPaginator
  • func (p *AssistantsPaginator) CurrentPage() *AssistantsPageResponse
  • func (p *AssistantsPaginator) Error() error
  • func (p *AssistantsPaginator) Next() bool
  • func (p *AssistantsPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateAssistantInput) (*CreateAssistantResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateAssistantInput) (*CreateAssistantResponse, error)
  • func (c *Client) NewAssistantsPaginator() *AssistantsPaginator
  • func (c *Client) NewAssistantsPaginatorWithOptions(options *AssistantsPageOptions) *AssistantsPaginator
  • func (c Client) Page(options *AssistantsPageOptions) (*AssistantsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *AssistantsPageOptions) (*AssistantsPageResponse, error)
• type CreateAssistantInput
• type CreateAssistantResponse
• type PageAssistantResponse
• type PageMetaResponse

Types

type AssistantsPage

type AssistantsPage struct {
	CurrentPage *AssistantsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type AssistantsPageOptions

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

AssistantsPageOptions defines the query options for the api operation

type AssistantsPageResponse

type AssistantsPageResponse struct {
	Assistants []PageAssistantResponse `json:"assistants"`
	Meta       PageMetaResponse        `json:"meta"`
}

AssistantsPageResponse defines the response fields for the assistants page

type AssistantsPaginator

type AssistantsPaginator struct {
	Page       *AssistantsPage
	Assistants []PageAssistantResponse
	// contains filtered or unexported fields
}

AssistantsPaginator defines the fields for makings paginated api calls Assistants is an array of assistants that have been returned from all of the page calls

func (*AssistantsPaginator) CurrentPage

func (p *AssistantsPaginator) CurrentPage() *AssistantsPageResponse

CurrentPage retrieves the results for the current page

func (*AssistantsPaginator) Error

func (p *AssistantsPaginator) Error() error

Error retrieves the error returned from the page

func (*AssistantsPaginator) Next

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

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

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

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

func New

func New(client *client.Client) *Client

New creates a new instance of the assistants client

func (Client) Create

func (c Client) Create(input *CreateAssistantInput) (*CreateAssistantResponse, error)

Create creates a new assistant See https://www.twilio.com/docs/autopilot/api/assistant#create-an-assistant-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 *CreateAssistantInput) (*CreateAssistantResponse, error)

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

func (*Client) NewAssistantsPaginator

func (c *Client) NewAssistantsPaginator() *AssistantsPaginator

NewAssistantsPaginator creates a new instance of the paginator for Page.

func (*Client) NewAssistantsPaginatorWithOptions

func (c *Client) NewAssistantsPaginatorWithOptions(options *AssistantsPageOptions) *AssistantsPaginator

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

func (Client) Page

func (c Client) Page(options *AssistantsPageOptions) (*AssistantsPageResponse, error)

Page retrieves a page of assistants See https://www.twilio.com/docs/autopilot/api/assistant#read-multiple-assistant-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 *AssistantsPageOptions) (*AssistantsPageResponse, error)

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

type CreateAssistantInput

type CreateAssistantInput struct {
	CallbackEvents *string `form:"CallbackEvents,omitempty"`
	CallbackURL    *string `form:"CallbackUrl,omitempty"`
	Defaults       *string `form:"Defaults,omitempty"`
	FriendlyName   *string `form:"FriendlyName,omitempty"`
	LogQueries     *bool   `form:"LogQueries,omitempty"`
	StyleSheet     *string `form:"StyleSheet,omitempty"`
	UniqueName     *string `form:"UniqueName,omitempty"`
}

CreateAssistantInput defines the input fields for creating a new assistant resource

type CreateAssistantResponse

type CreateAssistantResponse struct {
	AccountSid          string     `json:"account_sid"`
	CallbackEvents      *string    `json:"callback_events,omitempty"`
	CallbackURL         *string    `json:"callback_url,omitempty"`
	DateCreated         time.Time  `json:"date_created"`
	DateUpdated         *time.Time `json:"date_updated,omitempty"`
	DevelopmentStage    string     `json:"development_stage"`
	FriendlyName        *string    `json:"friendly_name,omitempty"`
	LatestModelBuildSid *string    `json:"latest_model_build_sid,omitempty"`
	LogQueries          bool       `json:"log_queries"`
	NeedsModelBuild     *bool      `json:"needs_model_build,omitempty"`
	Sid                 string     `json:"sid"`
	URL                 string     `json:"url"`
	UniqueName          string     `json:"unique_name"`
}

CreateAssistantResponse defines the response fields for the created assistant

type PageAssistantResponse

type PageAssistantResponse struct {
	AccountSid          string     `json:"account_sid"`
	CallbackEvents      *string    `json:"callback_events,omitempty"`
	CallbackURL         *string    `json:"callback_url,omitempty"`
	DateCreated         time.Time  `json:"date_created"`
	DateUpdated         *time.Time `json:"date_updated,omitempty"`
	DevelopmentStage    string     `json:"development_stage"`
	FriendlyName        *string    `json:"friendly_name,omitempty"`
	LatestModelBuildSid *string    `json:"latest_model_build_sid,omitempty"`
	LogQueries          bool       `json:"log_queries"`
	NeedsModelBuild     *bool      `json:"needs_model_build,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"`
}