interactions

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewInteractionsPaginator() *InteractionsPaginator
  • func (c *Client) NewInteractionsPaginatorWithOptions(options *InteractionsPageOptions) *InteractionsPaginator
  • func (c Client) Page(options *InteractionsPageOptions) (*InteractionsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *InteractionsPageOptions) (*InteractionsPageResponse, error)
• type ClientProperties
• type InteractionsPage
• type InteractionsPageOptions
• type InteractionsPageResponse
• type InteractionsPaginator
  • func (p *InteractionsPaginator) CurrentPage() *InteractionsPageResponse
  • func (p *InteractionsPaginator) Error() error
  • func (p *InteractionsPaginator) Next() bool
  • func (p *InteractionsPaginator) NextWithContext(context context.Context) bool
• type PageInteractionResponse
• type PageMetaResponse

Types

type Client

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

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

func New

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

New creates a new instance of the interactions client

func (*Client) NewInteractionsPaginator

func (c *Client) NewInteractionsPaginator() *InteractionsPaginator

NewInteractionsPaginator creates a new instance of the paginator for Page.

func (*Client) NewInteractionsPaginatorWithOptions

func (c *Client) NewInteractionsPaginatorWithOptions(options *InteractionsPageOptions) *InteractionsPaginator

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

func (Client) Page

func (c Client) Page(options *InteractionsPageOptions) (*InteractionsPageResponse, error)

Page retrieves a page of interactions See https://www.twilio.com/docs/proxy/api/interaction#read-multiple-interaction-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 *InteractionsPageOptions) (*InteractionsPageResponse, error)

PageWithContext retrieves a page of interactions See https://www.twilio.com/docs/proxy/api/interaction#read-multiple-interaction-resources for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	SessionSid string
}

ClientProperties are the properties required to manage the interactions resources

type InteractionsPage

type InteractionsPage struct {
	CurrentPage *InteractionsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type InteractionsPageOptions

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

InteractionsPageOptions defines the query options for the api operation

type InteractionsPageResponse

type InteractionsPageResponse struct {
	Interactions []PageInteractionResponse `json:"interactions"`
	Meta         PageMetaResponse          `json:"meta"`
}

InteractionsPageResponse defines the response fields for the interactions page

type InteractionsPaginator

type InteractionsPaginator struct {
	Page         *InteractionsPage
	Interactions []PageInteractionResponse
	// contains filtered or unexported fields
}

InteractionsPaginator defines the fields for makings paginated api calls Interactions is an array of interactions that have been returned from all of the page calls

func (*InteractionsPaginator) CurrentPage

func (p *InteractionsPaginator) CurrentPage() *InteractionsPageResponse

CurrentPage retrieves the results for the current page

func (*InteractionsPaginator) Error

func (p *InteractionsPaginator) Error() error

Error retrieves the error returned from the page

func (*InteractionsPaginator) Next

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

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

type PageInteractionResponse struct {
	AccountSid             string     `json:"account_sid"`
	Data                   *string    `json:"data,omitempty"`
	DateCreated            time.Time  `json:"date_created"`
	DateUpdated            *time.Time `json:"date_updated,omitempty"`
	InboundParticipantSid  *string    `json:"inbound_participant_sid,omitempty"`
	InboundResourceSid     *string    `json:"inbound_resource_sid,omitempty"`
	InboundResourceStatus  *string    `json:"inbound_resource_status,omitempty"`
	InboundResourceType    *string    `json:"inbound_resource_type,omitempty"`
	InboundResourceURL     *string    `json:"inbound_resource_url,omitempty"`
	OutboundParticipantSid *string    `json:"outbound_participant_sid,omitempty"`
	OutboundResourceSid    *string    `json:"outbound_resource_sid,omitempty"`
	OutboundResourceStatus *string    `json:"outbound_resource_status,omitempty"`
	OutboundResourceType   *string    `json:"outbound_resource_type,omitempty"`
	OutboundResourceURL    *string    `json:"outbound_resource_url,omitempty"`
	ServiceSid             string     `json:"service_sid"`
	SessionSid             string     `json:"session_sid"`
	Sid                    string     `json:"sid"`
	Type                   *string    `json:"type,omitempty"`
	URL                    string     `json:"url"`
}

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