member

Documentation

Overview

Package member contains auto-generated files. DO NOT MODIFY

Package member contains auto-generated files. DO NOT MODIFY

Package member contains auto-generated files. DO NOT MODIFY

Package member 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() (*FetchChannelMemberResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChannelMemberResponse, error)
  • func (c Client) Update(input *UpdateChannelMemberInput) (*UpdateChannelMemberResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateChannelMemberInput) (*UpdateChannelMemberResponse, error)
• type ClientProperties
• type FetchChannelMemberResponse
• type UpdateChannelMemberInput
• type UpdateChannelMemberResponse

Types

type Client

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

Client for managing a specific member resource See https://www.twilio.com/docs/chat/rest/member-resource for more details

func New

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

New creates a new instance of the member client

func (Client) Delete

func (c Client) Delete() error

Delete removes a member resource from the account See https://www.twilio.com/docs/chat/rest/member-resource#delete-a-member-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 member resource from the account See https://www.twilio.com/docs/chat/rest/member-resource#delete-a-member-resource for more details

func (Client) Fetch

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

Fetch retrieves a member resource See https://www.twilio.com/docs/chat/rest/member-resource#fetch-a-member-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) (*FetchChannelMemberResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateChannelMemberInput) (*UpdateChannelMemberResponse, error)

Update modifies a member resource See https://www.twilio.com/docs/chat/rest/member-resource#update-a-member-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateChannelMemberInput) (*UpdateChannelMemberResponse, error)

UpdateWithContext modifies a member resource See https://www.twilio.com/docs/chat/rest/member-resource#update-a-member-resource for more details

type ClientProperties

type ClientProperties struct {
	ChannelSid string
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the member resources

type FetchChannelMemberResponse

type FetchChannelMemberResponse struct {
	AccountSid               string     `json:"account_sid"`
	Attributes               *string    `json:"attributes,omitempty"`
	ChannelSid               string     `json:"channel_sid"`
	DateCreated              time.Time  `json:"date_created"`
	DateUpdated              *time.Time `json:"date_updated,omitempty"`
	Identity                 string     `json:"identity"`
	LastConsumedMessageIndex *int       `json:"last_consumed_message_index,omitempty"`
	LastConsumedTimestamp    *time.Time `json:"last_consumption_timestamp,omitempty"`
	RoleSid                  *string    `json:"role_sid,omitempty"`
	ServiceSid               string     `json:"service_sid"`
	Sid                      string     `json:"sid"`
	URL                      string     `json:"url"`
}

FetchChannelMemberResponse defines the response fields for the retrieved member

type UpdateChannelMemberInput

type UpdateChannelMemberInput struct {
	Attributes               *string    `form:"Attributes,omitempty"`
	DateCreated              *time.Time `form:"DateCreated,omitempty"`
	DateUpdated              *time.Time `form:"DateUpdated,omitempty"`
	LastConsumedMessageIndex *int       `form:"LastConsumedMessageIndex,omitempty"`
	LastConsumptionTimestamp *time.Time `form:"LastConsumptionTimestamp,omitempty"`
	RoleSid                  *string    `form:"RoleSid,omitempty"`
}

UpdateChannelMemberInput defines input fields for updating a member resource

type UpdateChannelMemberResponse

type UpdateChannelMemberResponse struct {
	AccountSid               string     `json:"account_sid"`
	Attributes               *string    `json:"attributes,omitempty"`
	ChannelSid               string     `json:"channel_sid"`
	DateCreated              time.Time  `json:"date_created"`
	DateUpdated              *time.Time `json:"date_updated,omitempty"`
	Identity                 string     `json:"identity"`
	LastConsumedMessageIndex *int       `json:"last_consumed_message_index,omitempty"`
	LastConsumedTimestamp    *time.Time `json:"last_consumption_timestamp,omitempty"`
	RoleSid                  *string    `json:"role_sid,omitempty"`
	ServiceSid               string     `json:"service_sid"`
	Sid                      string     `json:"sid"`
	URL                      string     `json:"url"`
}

UpdateChannelMemberResponse defines the response fields for the updated member