Documentation ¶
Overview ¶
Package user contains auto-generated files. DO NOT MODIFY
Package user contains auto-generated files. DO NOT MODIFY
Package user contains auto-generated files. DO NOT MODIFY
Package user contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c Client) Delete() error
- func (c Client) DeleteWithContext(context context.Context) error
- func (c Client) Fetch() (*FetchUserResponse, error)
- func (c Client) FetchWithContext(context context.Context) (*FetchUserResponse, error)
- func (c Client) Update(input *UpdateUserInput) (*UpdateUserResponse, error)
- func (c Client) UpdateWithContext(context context.Context, input *UpdateUserInput) (*UpdateUserResponse, error)
- type ClientProperties
- type FetchUserResponse
- type UpdateUserInput
- type UpdateUserResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct { Binding func(string) *binding.Client Bindings *bindings.Client Channel func(string) *channel.Client Channels *channels.Client // contains filtered or unexported fields }
Client for managing a specific user resource See https://www.twilio.com/docs/chat/rest/user-resource for more details
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the user client
func (Client) Delete ¶
Delete removes a user resource from the account See https://www.twilio.com/docs/chat/rest/user-resource#delete-a-user-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) DeleteWithContext ¶
DeleteWithContext removes a user resource from the account See https://www.twilio.com/docs/chat/rest/user-resource#delete-a-user-resource for more details
func (Client) Fetch ¶
func (c Client) Fetch() (*FetchUserResponse, error)
Fetch retrieves a user resource See https://www.twilio.com/docs/chat/rest/user-resource#fetch-a-user-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) (*FetchUserResponse, error)
FetchWithContext retrieves a user resource See https://www.twilio.com/docs/chat/rest/user-resource#fetch-a-user-resource for more details
func (Client) Update ¶
func (c Client) Update(input *UpdateUserInput) (*UpdateUserResponse, error)
Update modifies a user resource See https://www.twilio.com/docs/chat/rest/user-resource#update-a-user-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 *UpdateUserInput) (*UpdateUserResponse, error)
UpdateWithContext modifies a user resource See https://www.twilio.com/docs/chat/rest/user-resource#update-a-user-resource for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the user resources
type FetchUserResponse ¶
type FetchUserResponse struct { AccountSid string `json:"account_sid"` Attributes *string `json:"attributes,omitempty"` DateCreated time.Time `json:"date_created"` DateUpdated *time.Time `json:"date_updated,omitempty"` FriendlyName *string `json:"friendly_name,omitempty"` Identity string `json:"identity"` IsNotifiable *bool `json:"is_notifiable,omitempty"` IsOnline *bool `json:"is_online,omitempty"` JoinedChannelsCount *int `json:"joined_channels_count,omitempty"` RoleSid string `json:"role_sid"` ServiceSid string `json:"service_sid"` Sid string `json:"sid"` URL string `json:"url"` }
FetchUserResponse defines the response fields for the retrieved user
type UpdateUserInput ¶
type UpdateUserInput struct { Attributes *string `form:"Attributes,omitempty"` FriendlyName *string `form:"FriendlyName,omitempty"` RoleSid *string `form:"RoleSid,omitempty"` }
UpdateUserInput defines input fields for updating a user resource
type UpdateUserResponse ¶
type UpdateUserResponse struct { AccountSid string `json:"account_sid"` Attributes *string `json:"attributes,omitempty"` DateCreated time.Time `json:"date_created"` DateUpdated *time.Time `json:"date_updated,omitempty"` FriendlyName *string `json:"friendly_name,omitempty"` Identity string `json:"identity"` IsNotifiable *bool `json:"is_notifiable,omitempty"` IsOnline *bool `json:"is_online,omitempty"` JoinedChannelsCount *int `json:"joined_channels_count,omitempty"` RoleSid string `json:"role_sid"` ServiceSid string `json:"service_sid"` Sid string `json:"sid"` URL string `json:"url"` }
UpdateUserResponse defines the response fields for the updated user
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package binding contains auto-generated files.
|
Package binding contains auto-generated files. |
Package bindings contains auto-generated files.
|
Package bindings contains auto-generated files. |
Package channel contains auto-generated files.
|
Package channel contains auto-generated files. |
Package channels contains auto-generated files.
|
Package channels contains auto-generated files. |