invite

Documentation

Overview

Package invite contains auto-generated files. DO NOT MODIFY

Package invite contains auto-generated files. DO NOT MODIFY

Package invite contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchChannelInviteResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChannelInviteResponse, error)
• type ClientProperties
• type FetchChannelInviteResponse

Types

type Client

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

Client for managing a specific resource See https://www.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 invite client

func (Client) Delete

func (c Client) Delete() error

Delete removes a invite resource from the account See https://www.twilio.com/docs/chat/rest/invite-resource#delete-an-invite-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a invite resource from the account See https://www.twilio.com/docs/chat/rest/invite-resource#delete-an-invite-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchChannelInviteResponse, error)

Fetch retrieves a invite resource See https://www.twilio.com/docs/chat/rest/invite-resource#fetch-an-invite-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchChannelInviteResponse, error)

FetchWithContext retrieves a invite resource See https://www.twilio.com/docs/chat/rest/invite-resource#fetch-an-invite-resource for more details

type ClientProperties

type ClientProperties struct {
	ChannelSid string
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the invite resources

type FetchChannelInviteResponse

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

FetchChannelInviteResponse defines the response fields for the retrieved invite