invites

Documentation

Overview

Package invites contains auto-generated files. DO NOT MODIFY

Package invites contains auto-generated files. DO NOT MODIFY

Package invites contains auto-generated files. DO NOT MODIFY

Index

• type ChannelInvitesPage
• type ChannelInvitesPageOptions
• type ChannelInvitesPageResponse
• type ChannelInvitesPaginator
  • func (p *ChannelInvitesPaginator) CurrentPage() *ChannelInvitesPageResponse
  • func (p *ChannelInvitesPaginator) Error() error
  • func (p *ChannelInvitesPaginator) Next() bool
  • func (p *ChannelInvitesPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateChannelInviteInput) (*CreateChannelInviteResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateChannelInviteInput) (*CreateChannelInviteResponse, error)
  • func (c *Client) NewChannelInvitesPaginator() *ChannelInvitesPaginator
  • func (c *Client) NewChannelInvitesPaginatorWithOptions(options *ChannelInvitesPageOptions) *ChannelInvitesPaginator
  • func (c Client) Page(options *ChannelInvitesPageOptions) (*ChannelInvitesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ChannelInvitesPageOptions) (*ChannelInvitesPageResponse, error)
• type ClientProperties
• type CreateChannelInviteInput
• type CreateChannelInviteResponse
• type PageChannelInviteResponse
• type PageMetaResponse

Types

type ChannelInvitesPage

type ChannelInvitesPage struct {
	CurrentPage *ChannelInvitesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ChannelInvitesPageOptions

type ChannelInvitesPageOptions struct {
	Identity  *[]string
	PageSize  *int
	Page      *int
	PageToken *string
}

ChannelInvitesPageOptions defines the query options for the api operation

type ChannelInvitesPageResponse

type ChannelInvitesPageResponse struct {
	Invites []PageChannelInviteResponse `json:"invites"`
	Meta    PageMetaResponse            `json:"meta"`
}

ChannelInvitesPageResponse defines the response fields for the channel invites page

type ChannelInvitesPaginator

type ChannelInvitesPaginator struct {
	Page    *ChannelInvitesPage
	Invites []PageChannelInviteResponse
	// contains filtered or unexported fields
}

ChannelInvitesPaginator defines the fields for makings paginated api calls Invites is an array of invites that have been returned from all of the page calls

func (*ChannelInvitesPaginator) CurrentPage

func (p *ChannelInvitesPaginator) CurrentPage() *ChannelInvitesPageResponse

CurrentPage retrieves the results for the current page

func (*ChannelInvitesPaginator) Error

func (p *ChannelInvitesPaginator) Error() error

Error retrieves the error returned from the page

func (*ChannelInvitesPaginator) Next

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

func (p *ChannelInvitesPaginator) 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 invite resources See twilio.com/docs/chat/rest/invite-resource for more details

func New

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

New creates a new instance of the invites client

func (Client) Create

func (c Client) Create(input *CreateChannelInviteInput) (*CreateChannelInviteResponse, error)

Create creates a new invite See https://www.twilio.com/docs/chat/rest/invite-resource#create-an-invite-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 *CreateChannelInviteInput) (*CreateChannelInviteResponse, error)

CreateWithContext creates a new invite See https://www.twilio.com/docs/chat/rest/invite-resource#create-an-invite-resource for more details

func (*Client) NewChannelInvitesPaginator

func (c *Client) NewChannelInvitesPaginator() *ChannelInvitesPaginator

NewChannelInvitesPaginator creates a new instance of the paginator for Page.

func (*Client) NewChannelInvitesPaginatorWithOptions

func (c *Client) NewChannelInvitesPaginatorWithOptions(options *ChannelInvitesPageOptions) *ChannelInvitesPaginator

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

func (Client) Page

func (c Client) Page(options *ChannelInvitesPageOptions) (*ChannelInvitesPageResponse, error)

Page retrieves a page of channel invites See https://www.twilio.com/docs/chat/rest/invite-resource#read-multiple-invite-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 *ChannelInvitesPageOptions) (*ChannelInvitesPageResponse, error)

PageWithContext retrieves a page of channel invites See https://www.twilio.com/docs/chat/rest/invite-resource#read-multiple-invite-resources for more details

type ClientProperties

type ClientProperties struct {
	ChannelSid string
	ServiceSid string
}

ClientProperties are the properties required to manage the invites resources

type CreateChannelInviteInput

type CreateChannelInviteInput struct {
	Identity string  `validate:"required" form:"Identity"`
	RoleSid  *string `form:"RoleSid,omitempty"`
}

CreateChannelInviteInput defines the input fields for creating a new invite resource

type CreateChannelInviteResponse

type CreateChannelInviteResponse struct {
	AccountSid  string     `json:"account_sid"`
	ChannelSid  string     `json:"channel_sid"`
	CreatedBy   *string    `json:"created_by,omitempty"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Identity    string     `json:"identity"`
	RoleSid     *string    `json:"role_sid,omitempty"`
	ServiceSid  string     `json:"service_sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
}

CreateChannelInviteResponse defines the response fields for the created invite

type PageChannelInviteResponse

type PageChannelInviteResponse struct {
	AccountSid  string     `json:"account_sid"`
	ChannelSid  string     `json:"channel_sid"`
	CreatedBy   *string    `json:"created_by,omitempty"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Identity    string     `json:"identity"`
	RoleSid     *string    `json:"role_sid,omitempty"`
	ServiceSid  string     `json:"service_sid"`
	Sid         string     `json:"sid"`
	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"`
}