user

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 New(client *client.Client, properties ClientProperties) *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

Types

type Client

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

Client for managing a specific user resource See https://www.twilio.com/docs/conversations/api/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

func (c Client) Delete() error

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

func (Client) Fetch

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

Fetch retrieves a user resource 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

func (Client) Update

func (c Client) Update(input *UpdateUserInput) (*UpdateUserResponse, error)

Update modifies a user resource See https://www.twilio.com/docs/conversations/api/user-resource#update-a-conversationuser-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/conversations/api/user-resource#update-a-conversationuser-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the user resources

type FetchUserResponse

type FetchUserResponse struct {
	AccountSid     string     `json:"account_sid"`
	Attributes     string     `json:"attributes"`
	ChatServiceSid string     `json:"chat_service_sid"`
	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"`
	RoleSid        string     `json:"role_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"`
	ChatServiceSid string     `json:"chat_service_sid"`
	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"`
	RoleSid        string     `json:"role_sid"`
	Sid            string     `json:"sid"`
	URL            string     `json:"url"`
}

UpdateUserResponse defines the response fields for the updated user