delivery_receipts

Documentation

Overview

Package delivery_receipts contains auto-generated files. DO NOT MODIFY

Package delivery_receipts contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewDeliveryReceiptsPaginator() *DeliveryReceiptsPaginator
  • func (c *Client) NewDeliveryReceiptsPaginatorWithOptions(options *DeliveryReceiptsPageOptions) *DeliveryReceiptsPaginator
  • func (c Client) Page(options *DeliveryReceiptsPageOptions) (*DeliveryReceiptsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *DeliveryReceiptsPageOptions) (*DeliveryReceiptsPageResponse, error)
• type ClientProperties
• type DeliveryReceiptsPage
• type DeliveryReceiptsPageOptions
• type DeliveryReceiptsPageResponse
• type DeliveryReceiptsPaginator
  • func (p *DeliveryReceiptsPaginator) CurrentPage() *DeliveryReceiptsPageResponse
  • func (p *DeliveryReceiptsPaginator) Error() error
  • func (p *DeliveryReceiptsPaginator) Next() bool
  • func (p *DeliveryReceiptsPaginator) NextWithContext(context context.Context) bool
• type PageDeliveryReceiptResponse
• type PageMetaResponse

Types

type Client

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

Client for managing delivery receipt resources See https://www.twilio.com/docs/conversations/api/receipt-resource for more details

func New

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

New creates a new instance of the delivery receipts client

func (*Client) NewDeliveryReceiptsPaginator

func (c *Client) NewDeliveryReceiptsPaginator() *DeliveryReceiptsPaginator

NewDeliveryReceiptsPaginator creates a new instance of the paginator for Page.

func (*Client) NewDeliveryReceiptsPaginatorWithOptions

func (c *Client) NewDeliveryReceiptsPaginatorWithOptions(options *DeliveryReceiptsPageOptions) *DeliveryReceiptsPaginator

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

func (Client) Page

func (c Client) Page(options *DeliveryReceiptsPageOptions) (*DeliveryReceiptsPageResponse, error)

Page retrieves a page of delivery receipts See https://www.twilio.com/docs/conversations/api/receipt-resource#read-multiple-conversationmessagereceipt-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 *DeliveryReceiptsPageOptions) (*DeliveryReceiptsPageResponse, error)

PageWithContext retrieves a page of delivery receipts See https://www.twilio.com/docs/conversations/api/receipt-resource#read-multiple-conversationmessagereceipt-resources for more details

type ClientProperties

type ClientProperties struct {
	ConversationSid string
	MessageSid      string
	ServiceSid      string
}

ClientProperties are the properties required to manage the delivery receipts resources

type DeliveryReceiptsPage

type DeliveryReceiptsPage struct {
	CurrentPage *DeliveryReceiptsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type DeliveryReceiptsPageOptions

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

DeliveryReceiptsPageOptions defines the query options for the api operation

type DeliveryReceiptsPageResponse

type DeliveryReceiptsPageResponse struct {
	DeliveryReceipts []PageDeliveryReceiptResponse `json:"delivery_receipts"`
	Meta             PageMetaResponse              `json:"meta"`
}

DeliveryReceiptsPageResponse defines the response fields for the delivery receipts page

type DeliveryReceiptsPaginator

type DeliveryReceiptsPaginator struct {
	Page             *DeliveryReceiptsPage
	DeliveryReceipts []PageDeliveryReceiptResponse
	// contains filtered or unexported fields
}

DeliveryReceiptsPaginator defines the fields for makings paginated api calls DeliveryReceipts is an array of deliveryreceipts that have been returned from all of the page calls

func (*DeliveryReceiptsPaginator) CurrentPage

func (p *DeliveryReceiptsPaginator) CurrentPage() *DeliveryReceiptsPageResponse

CurrentPage retrieves the results for the current page

func (*DeliveryReceiptsPaginator) Error

func (p *DeliveryReceiptsPaginator) Error() error

Error retrieves the error returned from the page

func (*DeliveryReceiptsPaginator) Next

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

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

type PageDeliveryReceiptResponse struct {
	AccountSid        *string    `json:"account_sid,omitempty"`
	ChannelMessageSid string     `json:"channel_message_sid"`
	ChatServiceSid    string     `json:"chat_service_sid"`
	ConversationSid   string     `json:"conversation_sid"`
	DateCreated       time.Time  `json:"date_created"`
	DateUpdated       *time.Time `json:"date_updated,omitempty"`
	ErrorCode         *int       `json:"error_code,omitempty"`
	MessageSid        string     `json:"message_sid"`
	ParticipantSid    string     `json:"participant_sid"`
	Sid               string     `json:"sid"`
	Status            string     `json:"status"`
	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"`
}