openapi

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2021 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.17.0
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://chat.twilio.com

Class Method HTTP request Description
DefaultApi CreateChannel Post /v1/Services/{ServiceSid}/Channels
DefaultApi CreateCredential Post /v1/Credentials
DefaultApi CreateInvite Post /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
DefaultApi CreateMember Post /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members
DefaultApi CreateMessage Post /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
DefaultApi CreateRole Post /v1/Services/{ServiceSid}/Roles
DefaultApi CreateService Post /v1/Services
DefaultApi CreateUser Post /v1/Services/{ServiceSid}/Users
DefaultApi DeleteChannel Delete /v1/Services/{ServiceSid}/Channels/{Sid}
DefaultApi DeleteCredential Delete /v1/Credentials/{Sid}
DefaultApi DeleteInvite Delete /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
DefaultApi DeleteMember Delete /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
DefaultApi DeleteMessage Delete /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
DefaultApi DeleteRole Delete /v1/Services/{ServiceSid}/Roles/{Sid}
DefaultApi DeleteService Delete /v1/Services/{Sid}
DefaultApi DeleteUser Delete /v1/Services/{ServiceSid}/Users/{Sid}
DefaultApi FetchChannel Get /v1/Services/{ServiceSid}/Channels/{Sid}
DefaultApi FetchCredential Get /v1/Credentials/{Sid}
DefaultApi FetchInvite Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
DefaultApi FetchMember Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
DefaultApi FetchMessage Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
DefaultApi FetchRole Get /v1/Services/{ServiceSid}/Roles/{Sid}
DefaultApi FetchService Get /v1/Services/{Sid}
DefaultApi FetchUser Get /v1/Services/{ServiceSid}/Users/{Sid}
DefaultApi ListChannel Get /v1/Services/{ServiceSid}/Channels
DefaultApi ListCredential Get /v1/Credentials
DefaultApi ListInvite Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
DefaultApi ListMember Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members
DefaultApi ListMessage Get /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
DefaultApi ListRole Get /v1/Services/{ServiceSid}/Roles
DefaultApi ListService Get /v1/Services
DefaultApi ListUser Get /v1/Services/{ServiceSid}/Users
DefaultApi ListUserChannel Get /v1/Services/{ServiceSid}/Users/{UserSid}/Channels
DefaultApi UpdateChannel Post /v1/Services/{ServiceSid}/Channels/{Sid}
DefaultApi UpdateCredential Post /v1/Credentials/{Sid}
DefaultApi UpdateMember Post /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
DefaultApi UpdateMessage Post /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
DefaultApi UpdateRole Post /v1/Services/{ServiceSid}/Roles/{Sid}
DefaultApi UpdateService Post /v1/Services/{Sid}
DefaultApi UpdateUser Post /v1/Services/{ServiceSid}/Users/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

support@twilio.com

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChatV1Credential 

type ChatV1Credential struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// [APN only] Whether to send the credential to sandbox APNs
	Sandbox *string `json:"sandbox,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The type of push-notification service the credential is for
	Type *string `json:"type,omitempty"`
	// The absolute URL of the Credential resource
	Url *string `json:"url,omitempty"`
}

ChatV1Credential struct for ChatV1Credential

type ChatV1Service 

type ChatV1Service struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// DEPRECATED
	ConsumptionReportInterval *int32 `json:"consumption_report_interval,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The channel role assigned to a channel creator when they join a new channel
	DefaultChannelCreatorRoleSid *string `json:"default_channel_creator_role_sid,omitempty"`
	// The channel role assigned to users when they are added to a channel
	DefaultChannelRoleSid *string `json:"default_channel_role_sid,omitempty"`
	// The service role assigned to users when they are added to the service
	DefaultServiceRoleSid *string `json:"default_service_role_sid,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// An object that describes the limits of the service instance
	Limits *map[string]interface{} `json:"limits,omitempty"`
	// The absolute URLs of the Service's Channels, Roles, and Users
	Links *map[string]interface{} `json:"links,omitempty"`
	// The notification configuration for the Service instance
	Notifications *map[string]interface{} `json:"notifications,omitempty"`
	// The URL for post-event webhooks
	PostWebhookUrl *string `json:"post_webhook_url,omitempty"`
	// The webhook URL for pre-event webhooks
	PreWebhookUrl *string `json:"pre_webhook_url,omitempty"`
	// Whether the Reachability Indicator feature is enabled for this Service instance
	ReachabilityEnabled *bool `json:"reachability_enabled,omitempty"`
	// Whether the Message Consumption Horizon feature is enabled
	ReadStatusEnabled *bool `json:"read_status_enabled,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// How long in seconds to wait before assuming the user is no longer typing
	TypingIndicatorTimeout *int32 `json:"typing_indicator_timeout,omitempty"`
	// The absolute URL of the Service resource
	Url *string `json:"url,omitempty"`
	// The list of WebHook events that are enabled for this Service instance
	WebhookFilters *[]string `json:"webhook_filters,omitempty"`
	// The HTTP method  to use for both PRE and POST webhooks
	WebhookMethod *string `json:"webhook_method,omitempty"`
	// An object that contains information about the webhooks configured for this service
	Webhooks *map[string]interface{} `json:"webhooks,omitempty"`
}

ChatV1Service struct for ChatV1Service

type ChatV1ServiceChannel 

type ChatV1ServiceChannel struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The JSON string that stores application-specific data
	Attributes *string `json:"attributes,omitempty"`
	// The identity of the User that created the channel
	CreatedBy *string `json:"created_by,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
	Links *map[string]interface{} `json:"links,omitempty"`
	// The number of Members in the Channel
	MembersCount *int32 `json:"members_count,omitempty"`
	// The number of Messages in the Channel
	MessagesCount *int32 `json:"messages_count,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The visibility of the channel. Can be: `public` or `private`
	Type *string `json:"type,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Channel resource
	Url *string `json:"url,omitempty"`
}

ChatV1ServiceChannel struct for ChatV1ServiceChannel

type ChatV1ServiceChannelInvite 

type ChatV1ServiceChannelInvite struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Channel the new resource belongs to
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The identity of the User that created the invite
	CreatedBy *string `json:"created_by,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that identifies the resource's User
	Identity *string `json:"identity,omitempty"`
	// The SID of the Role assigned to the member
	RoleSid *string `json:"role_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Invite resource
	Url *string `json:"url,omitempty"`
}

ChatV1ServiceChannelInvite struct for ChatV1ServiceChannelInvite

type ChatV1ServiceChannelMember 

type ChatV1ServiceChannelMember struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique ID of the Channel for the member
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that identifies the resource's User
	Identity *string `json:"identity,omitempty"`
	// The index of the last Message that the Member has read within the Channel
	LastConsumedMessageIndex *int32 `json:"last_consumed_message_index,omitempty"`
	// The ISO 8601 based timestamp string that represents the date-time of the last Message read event for the Member within the Channel
	LastConsumptionTimestamp *time.Time `json:"last_consumption_timestamp,omitempty"`
	// The SID of the Role assigned to the member
	RoleSid *string `json:"role_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Member resource
	Url *string `json:"url,omitempty"`
}

ChatV1ServiceChannelMember struct for ChatV1ServiceChannelMember

type ChatV1ServiceChannelMessage 

type ChatV1ServiceChannelMessage struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The JSON string that stores application-specific data
	Attributes *string `json:"attributes,omitempty"`
	// The content of the message
	Body *string `json:"body,omitempty"`
	// The unique ID of the Channel the Message resource belongs to
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the message's author
	From *string `json:"from,omitempty"`
	// The index of the message within the Channel
	Index *int32 `json:"index,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Channel that the message was sent to
	To *string `json:"to,omitempty"`
	// The absolute URL of the Message resource
	Url *string `json:"url,omitempty"`
	// Whether the message has been edited since  it was created
	WasEdited *bool `json:"was_edited,omitempty"`
}

ChatV1ServiceChannelMessage struct for ChatV1ServiceChannelMessage

type ChatV1ServiceRole 

type ChatV1ServiceRole struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// An array of the permissions the role has been granted
	Permissions *[]string `json:"permissions,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The type of role
	Type *string `json:"type,omitempty"`
	// The absolute URL of the Role resource
	Url *string `json:"url,omitempty"`
}

ChatV1ServiceRole struct for ChatV1ServiceRole

type ChatV1ServiceUser 

type ChatV1ServiceUser struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The JSON string that stores application-specific data
	Attributes *string `json:"attributes,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The string that identifies the resource's User
	Identity *string `json:"identity,omitempty"`
	// Whether the User has a potentially valid Push Notification registration for the Service instance
	IsNotifiable *bool `json:"is_notifiable,omitempty"`
	// Whether the User is actively connected to the Service instance and online
	IsOnline *bool `json:"is_online,omitempty"`
	// The number of Channels this User is a Member of
	JoinedChannelsCount *int32 `json:"joined_channels_count,omitempty"`
	// The absolute URLs of the Channel and Binding resources related to the user
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the assigned to the user
	RoleSid *string `json:"role_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the User resource
	Url *string `json:"url,omitempty"`
}

ChatV1ServiceUser struct for ChatV1ServiceUser

type ChatV1ServiceUserUserChannel 

type ChatV1ServiceUserUserChannel struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Channel the resource belongs to
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The index of the last Message in the Channel the Member has read
	LastConsumedMessageIndex *int32 `json:"last_consumed_message_index,omitempty"`
	// Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the User as a Member in the Channel
	MemberSid *string `json:"member_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The status of the User on the Channel
	Status *string `json:"status,omitempty"`
	// The number of unread Messages in the Channel for the User
	UnreadMessagesCount *int32 `json:"unread_messages_count,omitempty"`
}

ChatV1ServiceUserUserChannel struct for ChatV1ServiceUserUserChannel

type CreateChannelParams 

type CreateChannelParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The visibility of the channel. Can be: `public` or `private` and defaults to `public`.
	Type *string `json:"Type,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateChannel'

func (*CreateChannelParams) SetAttributes 

func (params *CreateChannelParams) SetAttributes(Attributes string) *CreateChannelParams

func (*CreateChannelParams) SetFriendlyName 

func (params *CreateChannelParams) SetFriendlyName(FriendlyName string) *CreateChannelParams

func (*CreateChannelParams) SetType 

func (params *CreateChannelParams) SetType(Type string) *CreateChannelParams

func (*CreateChannelParams) SetUniqueName 

func (params *CreateChannelParams) SetUniqueName(UniqueName string) *CreateChannelParams

type CreateCredentialParams 

type CreateCredentialParams struct {
	// [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
	ApiKey *string `json:"ApiKey,omitempty"`
	// [APN only] The URL encoded representation of the certificate. For example,  `-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A== -----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// [APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. -----END RSA PRIVATE KEY-----`
	PrivateKey *string `json:"PrivateKey,omitempty"`
	// [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
	Sandbox *bool `json:"Sandbox,omitempty"`
	// [FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.
	Secret *string `json:"Secret,omitempty"`
	// The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateCredential'

func (*CreateCredentialParams) SetApiKey 

func (params *CreateCredentialParams) SetApiKey(ApiKey string) *CreateCredentialParams

func (*CreateCredentialParams) SetCertificate 

func (params *CreateCredentialParams) SetCertificate(Certificate string) *CreateCredentialParams

func (*CreateCredentialParams) SetFriendlyName 

func (params *CreateCredentialParams) SetFriendlyName(FriendlyName string) *CreateCredentialParams

func (*CreateCredentialParams) SetPrivateKey 

func (params *CreateCredentialParams) SetPrivateKey(PrivateKey string) *CreateCredentialParams

func (*CreateCredentialParams) SetSandbox 

func (params *CreateCredentialParams) SetSandbox(Sandbox bool) *CreateCredentialParams

func (*CreateCredentialParams) SetSecret 

func (params *CreateCredentialParams) SetSecret(Secret string) *CreateCredentialParams

func (*CreateCredentialParams) SetType 

func (params *CreateCredentialParams) SetType(Type string) *CreateCredentialParams

type CreateInviteParams 

type CreateInviteParams struct {
	// The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new member.
	RoleSid *string `json:"RoleSid,omitempty"`
}

Optional parameters for the method 'CreateInvite'

func (*CreateInviteParams) SetIdentity 

func (params *CreateInviteParams) SetIdentity(Identity string) *CreateInviteParams

func (*CreateInviteParams) SetRoleSid 

func (params *CreateInviteParams) SetRoleSid(RoleSid string) *CreateInviteParams

type CreateMemberParams 

type CreateMemberParams struct {
	// The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).
	RoleSid *string `json:"RoleSid,omitempty"`
}

Optional parameters for the method 'CreateMember'

func (*CreateMemberParams) SetIdentity 

func (params *CreateMemberParams) SetIdentity(Identity string) *CreateMemberParams

func (*CreateMemberParams) SetRoleSid 

func (params *CreateMemberParams) SetRoleSid(RoleSid string) *CreateMemberParams

type CreateMessageParams 

type CreateMessageParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
	Body *string `json:"Body,omitempty"`
	// The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.
	From *string `json:"From,omitempty"`
}

Optional parameters for the method 'CreateMessage'

func (*CreateMessageParams) SetAttributes 

func (params *CreateMessageParams) SetAttributes(Attributes string) *CreateMessageParams

func (*CreateMessageParams) SetBody 

func (params *CreateMessageParams) SetBody(Body string) *CreateMessageParams

func (*CreateMessageParams) SetFrom 

func (params *CreateMessageParams) SetFrom(From string) *CreateMessageParams

type CreateRoleParams 

type CreateRoleParams struct {
	// A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.
	Permission *[]string `json:"Permission,omitempty"`
	// The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateRole'

func (*CreateRoleParams) SetFriendlyName 

func (params *CreateRoleParams) SetFriendlyName(FriendlyName string) *CreateRoleParams

func (*CreateRoleParams) SetPermission 

func (params *CreateRoleParams) SetPermission(Permission []string) *CreateRoleParams

func (*CreateRoleParams) SetType 

func (params *CreateRoleParams) SetType(Type string) *CreateRoleParams

type CreateServiceParams 

type CreateServiceParams struct {
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetFriendlyName 

func (params *CreateServiceParams) SetFriendlyName(FriendlyName string) *CreateServiceParams

type CreateUserParams 

type CreateUserParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the new resource. This value is often used for display purposes.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is often a username or email address. See the Identity documentation for more details.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new User.
	RoleSid *string `json:"RoleSid,omitempty"`
}

Optional parameters for the method 'CreateUser'

func (*CreateUserParams) SetAttributes 

func (params *CreateUserParams) SetAttributes(Attributes string) *CreateUserParams

func (*CreateUserParams) SetFriendlyName 

func (params *CreateUserParams) SetFriendlyName(FriendlyName string) *CreateUserParams

func (*CreateUserParams) SetIdentity 

func (params *CreateUserParams) SetIdentity(Identity string) *CreateUserParams

func (*CreateUserParams) SetRoleSid 

func (params *CreateUserParams) SetRoleSid(RoleSid string) *CreateUserParams

type DefaultApiService 

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

func NewDefaultApiService 

func NewDefaultApiService(requestHandler *twilio.RequestHandler) *DefaultApiService

func NewDefaultApiServiceWithClient added in v0.9.0 

func NewDefaultApiServiceWithClient(client twilio.BaseClient) *DefaultApiService

func (*DefaultApiService) CreateChannel 

func (c *DefaultApiService) CreateChannel(ServiceSid string, params *CreateChannelParams) (*ChatV1ServiceChannel, error)

func (*DefaultApiService) CreateCredential 

func (c *DefaultApiService) CreateCredential(params *CreateCredentialParams) (*ChatV1Credential, error)

func (*DefaultApiService) CreateInvite 

func (c *DefaultApiService) CreateInvite(ServiceSid string, ChannelSid string, params *CreateInviteParams) (*ChatV1ServiceChannelInvite, error)

func (*DefaultApiService) CreateMember 

func (c *DefaultApiService) CreateMember(ServiceSid string, ChannelSid string, params *CreateMemberParams) (*ChatV1ServiceChannelMember, error)

func (*DefaultApiService) CreateMessage 

func (c *DefaultApiService) CreateMessage(ServiceSid string, ChannelSid string, params *CreateMessageParams) (*ChatV1ServiceChannelMessage, error)

func (*DefaultApiService) CreateRole 

func (c *DefaultApiService) CreateRole(ServiceSid string, params *CreateRoleParams) (*ChatV1ServiceRole, error)

func (*DefaultApiService) CreateService 

func (c *DefaultApiService) CreateService(params *CreateServiceParams) (*ChatV1Service, error)

func (*DefaultApiService) CreateUser 

func (c *DefaultApiService) CreateUser(ServiceSid string, params *CreateUserParams) (*ChatV1ServiceUser, error)

func (*DefaultApiService) DeleteChannel 

func (c *DefaultApiService) DeleteChannel(ServiceSid string, Sid string) error

func (*DefaultApiService) DeleteCredential 

func (c *DefaultApiService) DeleteCredential(Sid string) error

func (*DefaultApiService) DeleteInvite 

func (c *DefaultApiService) DeleteInvite(ServiceSid string, ChannelSid string, Sid string) error

func (*DefaultApiService) DeleteMember 

func (c *DefaultApiService) DeleteMember(ServiceSid string, ChannelSid string, Sid string) error

func (*DefaultApiService) DeleteMessage 

func (c *DefaultApiService) DeleteMessage(ServiceSid string, ChannelSid string, Sid string) error

func (*DefaultApiService) DeleteRole 

func (c *DefaultApiService) DeleteRole(ServiceSid string, Sid string) error

func (*DefaultApiService) DeleteService 

func (c *DefaultApiService) DeleteService(Sid string) error

func (*DefaultApiService) DeleteUser 

func (c *DefaultApiService) DeleteUser(ServiceSid string, Sid string) error

func (*DefaultApiService) FetchChannel 

func (c *DefaultApiService) FetchChannel(ServiceSid string, Sid string) (*ChatV1ServiceChannel, error)

func (*DefaultApiService) FetchCredential 

func (c *DefaultApiService) FetchCredential(Sid string) (*ChatV1Credential, error)

func (*DefaultApiService) FetchInvite 

func (c *DefaultApiService) FetchInvite(ServiceSid string, ChannelSid string, Sid string) (*ChatV1ServiceChannelInvite, error)

func (*DefaultApiService) FetchMember 

func (c *DefaultApiService) FetchMember(ServiceSid string, ChannelSid string, Sid string) (*ChatV1ServiceChannelMember, error)

func (*DefaultApiService) FetchMessage 

func (c *DefaultApiService) FetchMessage(ServiceSid string, ChannelSid string, Sid string) (*ChatV1ServiceChannelMessage, error)

func (*DefaultApiService) FetchRole 

func (c *DefaultApiService) FetchRole(ServiceSid string, Sid string) (*ChatV1ServiceRole, error)

func (*DefaultApiService) FetchService 

func (c *DefaultApiService) FetchService(Sid string) (*ChatV1Service, error)

func (*DefaultApiService) FetchUser 

func (c *DefaultApiService) FetchUser(ServiceSid string, Sid string) (*ChatV1ServiceUser, error)

func (*DefaultApiService) ListChannel 

func (c *DefaultApiService) ListChannel(ServiceSid string, params *ListChannelParams) (*ListChannelResponse, error)

func (*DefaultApiService) ListCredential 

func (c *DefaultApiService) ListCredential(params *ListCredentialParams) (*ListCredentialResponse, error)

func (*DefaultApiService) ListInvite 

func (c *DefaultApiService) ListInvite(ServiceSid string, ChannelSid string, params *ListInviteParams) (*ListInviteResponse, error)

func (*DefaultApiService) ListMember 

func (c *DefaultApiService) ListMember(ServiceSid string, ChannelSid string, params *ListMemberParams) (*ListMemberResponse, error)

func (*DefaultApiService) ListMessage 

func (c *DefaultApiService) ListMessage(ServiceSid string, ChannelSid string, params *ListMessageParams) (*ListMessageResponse, error)

func (*DefaultApiService) ListRole 

func (c *DefaultApiService) ListRole(ServiceSid string, params *ListRoleParams) (*ListRoleResponse, error)

func (*DefaultApiService) ListService 

func (c *DefaultApiService) ListService(params *ListServiceParams) (*ListServiceResponse, error)

func (*DefaultApiService) ListUser 

func (c *DefaultApiService) ListUser(ServiceSid string, params *ListUserParams) (*ListUserResponse, error)

func (*DefaultApiService) ListUserChannel 

func (c *DefaultApiService) ListUserChannel(ServiceSid string, UserSid string, params *ListUserChannelParams) (*ListUserChannelResponse, error)

List all Channels for a given User.

func (*DefaultApiService) UpdateChannel 

func (c *DefaultApiService) UpdateChannel(ServiceSid string, Sid string, params *UpdateChannelParams) (*ChatV1ServiceChannel, error)

func (*DefaultApiService) UpdateCredential 

func (c *DefaultApiService) UpdateCredential(Sid string, params *UpdateCredentialParams) (*ChatV1Credential, error)

func (*DefaultApiService) UpdateMember 

func (c *DefaultApiService) UpdateMember(ServiceSid string, ChannelSid string, Sid string, params *UpdateMemberParams) (*ChatV1ServiceChannelMember, error)

func (*DefaultApiService) UpdateMessage 

func (c *DefaultApiService) UpdateMessage(ServiceSid string, ChannelSid string, Sid string, params *UpdateMessageParams) (*ChatV1ServiceChannelMessage, error)

func (*DefaultApiService) UpdateRole 

func (c *DefaultApiService) UpdateRole(ServiceSid string, Sid string, params *UpdateRoleParams) (*ChatV1ServiceRole, error)

func (*DefaultApiService) UpdateService 

func (c *DefaultApiService) UpdateService(Sid string, params *UpdateServiceParams) (*ChatV1Service, error)

func (*DefaultApiService) UpdateUser 

func (c *DefaultApiService) UpdateUser(ServiceSid string, Sid string, params *UpdateUserParams) (*ChatV1ServiceUser, error)

type ListChannelParams 

type ListChannelParams struct {
	// The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.
	Type *[]string `json:"Type,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListChannel'

func (*ListChannelParams) SetPageSize 

func (params *ListChannelParams) SetPageSize(PageSize int32) *ListChannelParams

func (*ListChannelParams) SetType 

func (params *ListChannelParams) SetType(Type []string) *ListChannelParams

type ListChannelResponse 

type ListChannelResponse struct {
	Channels []ChatV1ServiceChannel     `json:"channels,omitempty"`
	Meta     ListCredentialResponseMeta `json:"meta,omitempty"`
}

ListChannelResponse struct for ListChannelResponse

type ListCredentialParams 

type ListCredentialParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListCredential'

func (*ListCredentialParams) SetPageSize 

func (params *ListCredentialParams) SetPageSize(PageSize int32) *ListCredentialParams

type ListCredentialResponse 

type ListCredentialResponse struct {
	Credentials []ChatV1Credential         `json:"credentials,omitempty"`
	Meta        ListCredentialResponseMeta `json:"meta,omitempty"`
}

ListCredentialResponse struct for ListCredentialResponse

type ListCredentialResponseMeta 

type ListCredentialResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int32  `json:"page,omitempty"`
	PageSize        int32  `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListCredentialResponseMeta struct for ListCredentialResponseMeta

type ListInviteParams 

type ListInviteParams struct {
	// The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.
	Identity *[]string `json:"Identity,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListInvite'

func (*ListInviteParams) SetIdentity 

func (params *ListInviteParams) SetIdentity(Identity []string) *ListInviteParams

func (*ListInviteParams) SetPageSize 

func (params *ListInviteParams) SetPageSize(PageSize int32) *ListInviteParams

type ListInviteResponse 

type ListInviteResponse struct {
	Invites []ChatV1ServiceChannelInvite `json:"invites,omitempty"`
	Meta    ListCredentialResponseMeta   `json:"meta,omitempty"`
}

ListInviteResponse struct for ListInviteResponse

type ListMemberParams 

type ListMemberParams struct {
	// The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.
	Identity *[]string `json:"Identity,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListMember'

func (*ListMemberParams) SetIdentity 

func (params *ListMemberParams) SetIdentity(Identity []string) *ListMemberParams

func (*ListMemberParams) SetPageSize 

func (params *ListMemberParams) SetPageSize(PageSize int32) *ListMemberParams

type ListMemberResponse 

type ListMemberResponse struct {
	Members []ChatV1ServiceChannelMember `json:"members,omitempty"`
	Meta    ListCredentialResponseMeta   `json:"meta,omitempty"`
}

ListMemberResponse struct for ListMemberResponse

type ListMessageParams 

type ListMessageParams struct {
	// The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
	Order *string `json:"Order,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListMessage'

func (*ListMessageParams) SetOrder 

func (params *ListMessageParams) SetOrder(Order string) *ListMessageParams

func (*ListMessageParams) SetPageSize 

func (params *ListMessageParams) SetPageSize(PageSize int32) *ListMessageParams

type ListMessageResponse 

type ListMessageResponse struct {
	Messages []ChatV1ServiceChannelMessage `json:"messages,omitempty"`
	Meta     ListCredentialResponseMeta    `json:"meta,omitempty"`
}

ListMessageResponse struct for ListMessageResponse

type ListRoleParams 

type ListRoleParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListRole'

func (*ListRoleParams) SetPageSize 

func (params *ListRoleParams) SetPageSize(PageSize int32) *ListRoleParams

type ListRoleResponse 

type ListRoleResponse struct {
	Meta  ListCredentialResponseMeta `json:"meta,omitempty"`
	Roles []ChatV1ServiceRole        `json:"roles,omitempty"`
}

ListRoleResponse struct for ListRoleResponse

type ListServiceParams 

type ListServiceParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetPageSize 

func (params *ListServiceParams) SetPageSize(PageSize int32) *ListServiceParams

type ListServiceResponse 

type ListServiceResponse struct {
	Meta     ListCredentialResponseMeta `json:"meta,omitempty"`
	Services []ChatV1Service            `json:"services,omitempty"`
}

ListServiceResponse struct for ListServiceResponse

type ListUserChannelParams 

type ListUserChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListUserChannel'

func (*ListUserChannelParams) SetPageSize 

func (params *ListUserChannelParams) SetPageSize(PageSize int32) *ListUserChannelParams

type ListUserChannelResponse 

type ListUserChannelResponse struct {
	Channels []ChatV1ServiceUserUserChannel `json:"channels,omitempty"`
	Meta     ListCredentialResponseMeta     `json:"meta,omitempty"`
}

ListUserChannelResponse struct for ListUserChannelResponse

type ListUserParams 

type ListUserParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListUser'

func (*ListUserParams) SetPageSize 

func (params *ListUserParams) SetPageSize(PageSize int32) *ListUserParams

type ListUserResponse 

type ListUserResponse struct {
	Meta  ListCredentialResponseMeta `json:"meta,omitempty"`
	Users []ChatV1ServiceUser        `json:"users,omitempty"`
}

ListUserResponse struct for ListUserResponse

type UpdateChannelParams 

type UpdateChannelParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'UpdateChannel'

func (*UpdateChannelParams) SetAttributes 

func (params *UpdateChannelParams) SetAttributes(Attributes string) *UpdateChannelParams

func (*UpdateChannelParams) SetFriendlyName 

func (params *UpdateChannelParams) SetFriendlyName(FriendlyName string) *UpdateChannelParams

func (*UpdateChannelParams) SetUniqueName 

func (params *UpdateChannelParams) SetUniqueName(UniqueName string) *UpdateChannelParams

type UpdateCredentialParams 

type UpdateCredentialParams struct {
	// [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
	ApiKey *string `json:"ApiKey,omitempty"`
	// [APN only] The URL encoded representation of the certificate. For example,  `-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A== -----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// [APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. -----END RSA PRIVATE KEY-----`
	PrivateKey *string `json:"PrivateKey,omitempty"`
	// [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
	Sandbox *bool `json:"Sandbox,omitempty"`
	// [FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.
	Secret *string `json:"Secret,omitempty"`
}

Optional parameters for the method 'UpdateCredential'

func (*UpdateCredentialParams) SetApiKey 

func (params *UpdateCredentialParams) SetApiKey(ApiKey string) *UpdateCredentialParams

func (*UpdateCredentialParams) SetCertificate 

func (params *UpdateCredentialParams) SetCertificate(Certificate string) *UpdateCredentialParams

func (*UpdateCredentialParams) SetFriendlyName 

func (params *UpdateCredentialParams) SetFriendlyName(FriendlyName string) *UpdateCredentialParams

func (*UpdateCredentialParams) SetPrivateKey 

func (params *UpdateCredentialParams) SetPrivateKey(PrivateKey string) *UpdateCredentialParams

func (*UpdateCredentialParams) SetSandbox 

func (params *UpdateCredentialParams) SetSandbox(Sandbox bool) *UpdateCredentialParams

func (*UpdateCredentialParams) SetSecret 

func (params *UpdateCredentialParams) SetSecret(Secret string) *UpdateCredentialParams

type UpdateMemberParams 

type UpdateMemberParams struct {
	// The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).
	LastConsumedMessageIndex *int32 `json:"LastConsumedMessageIndex,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).
	RoleSid *string `json:"RoleSid,omitempty"`
}

Optional parameters for the method 'UpdateMember'

func (*UpdateMemberParams) SetLastConsumedMessageIndex 

func (params *UpdateMemberParams) SetLastConsumedMessageIndex(LastConsumedMessageIndex int32) *UpdateMemberParams

func (*UpdateMemberParams) SetRoleSid 

func (params *UpdateMemberParams) SetRoleSid(RoleSid string) *UpdateMemberParams

type UpdateMessageParams 

type UpdateMessageParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
	Body *string `json:"Body,omitempty"`
}

Optional parameters for the method 'UpdateMessage'

func (*UpdateMessageParams) SetAttributes 

func (params *UpdateMessageParams) SetAttributes(Attributes string) *UpdateMessageParams

func (*UpdateMessageParams) SetBody 

func (params *UpdateMessageParams) SetBody(Body string) *UpdateMessageParams

type UpdateRoleParams 

type UpdateRoleParams struct {
	// A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.
	Permission *[]string `json:"Permission,omitempty"`
}

Optional parameters for the method 'UpdateRole'

func (*UpdateRoleParams) SetPermission 

func (params *UpdateRoleParams) SetPermission(Permission []string) *UpdateRoleParams

type UpdateServiceParams 

type UpdateServiceParams struct {
	// DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
	ConsumptionReportInterval *int32 `json:"ConsumptionReportInterval,omitempty"`
	// The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
	DefaultChannelCreatorRoleSid *string `json:"DefaultChannelCreatorRoleSid,omitempty"`
	// The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
	DefaultChannelRoleSid *string `json:"DefaultChannelRoleSid,omitempty"`
	// The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
	DefaultServiceRoleSid *string `json:"DefaultServiceRoleSid,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
	LimitsChannelMembers *int32 `json:"Limits.ChannelMembers,omitempty"`
	// The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.
	LimitsUserChannels *int32 `json:"Limits.UserChannels,omitempty"`
	// Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.
	NotificationsAddedToChannelEnabled *bool `json:"Notifications.AddedToChannel.Enabled,omitempty"`
	// The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.
	NotificationsAddedToChannelTemplate *string `json:"Notifications.AddedToChannel.Template,omitempty"`
	// Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.
	NotificationsInvitedToChannelEnabled *bool `json:"Notifications.InvitedToChannel.Enabled,omitempty"`
	// The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.
	NotificationsInvitedToChannelTemplate *string `json:"Notifications.InvitedToChannel.Template,omitempty"`
	// Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.
	NotificationsNewMessageEnabled *bool `json:"Notifications.NewMessage.Enabled,omitempty"`
	// The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.
	NotificationsNewMessageTemplate *string `json:"Notifications.NewMessage.Template,omitempty"`
	// Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.
	NotificationsRemovedFromChannelEnabled *bool `json:"Notifications.RemovedFromChannel.Enabled,omitempty"`
	// The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.
	NotificationsRemovedFromChannelTemplate *string `json:"Notifications.RemovedFromChannel.Template,omitempty"`
	// The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
	PostWebhookUrl *string `json:"PostWebhookUrl,omitempty"`
	// The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
	PreWebhookUrl *string `json:"PreWebhookUrl,omitempty"`
	// Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.
	ReachabilityEnabled *bool `json:"ReachabilityEnabled,omitempty"`
	// Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.
	ReadStatusEnabled *bool `json:"ReadStatusEnabled,omitempty"`
	// How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received.  The default is 5 seconds.
	TypingIndicatorTimeout *int32 `json:"TypingIndicatorTimeout,omitempty"`
	// The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	WebhookFilters *[]string `json:"WebhookFilters,omitempty"`
	// The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	WebhookMethod *string `json:"WebhookMethod,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_add.url`.
	WebhooksOnChannelAddMethod *string `json:"Webhooks.OnChannelAdd.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.
	WebhooksOnChannelAddUrl *string `json:"Webhooks.OnChannelAdd.Url,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_added` event`.
	WebhooksOnChannelAddedMethod *string `json:"Webhooks.OnChannelAdded.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.
	WebhooksOnChannelAddedUrl *string `json:"Webhooks.OnChannelAdded.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.
	WebhooksOnChannelDestroyMethod *string `json:"Webhooks.OnChannelDestroy.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.
	WebhooksOnChannelDestroyUrl *string `json:"Webhooks.OnChannelDestroy.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.
	WebhooksOnChannelDestroyedMethod *string `json:"Webhooks.OnChannelDestroyed.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.
	WebhooksOnChannelDestroyedUrl *string `json:"Webhooks.OnChannelDestroyed.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_update.url`.
	WebhooksOnChannelUpdateMethod *string `json:"Webhooks.OnChannelUpdate.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.
	WebhooksOnChannelUpdateUrl *string `json:"Webhooks.OnChannelUpdate.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
	WebhooksOnChannelUpdatedMethod *string `json:"Webhooks.OnChannelUpdated.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
	WebhooksOnChannelUpdatedUrl *string `json:"Webhooks.OnChannelUpdated.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_member_add.url`.
	WebhooksOnMemberAddMethod *string `json:"Webhooks.OnMemberAdd.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.
	WebhooksOnMemberAddUrl *string `json:"Webhooks.OnMemberAdd.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
	WebhooksOnMemberAddedMethod *string `json:"Webhooks.OnMemberAdded.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
	WebhooksOnMemberAddedUrl *string `json:"Webhooks.OnMemberAdded.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_member_remove.url`.
	WebhooksOnMemberRemoveMethod *string `json:"Webhooks.OnMemberRemove.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.
	WebhooksOnMemberRemoveUrl *string `json:"Webhooks.OnMemberRemove.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_member_removed.url`.
	WebhooksOnMemberRemovedMethod *string `json:"Webhooks.OnMemberRemoved.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.
	WebhooksOnMemberRemovedUrl *string `json:"Webhooks.OnMemberRemoved.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_message_remove.url`.
	WebhooksOnMessageRemoveMethod *string `json:"Webhooks.OnMessageRemove.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.
	WebhooksOnMessageRemoveUrl *string `json:"Webhooks.OnMessageRemove.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_message_removed.url`.
	WebhooksOnMessageRemovedMethod *string `json:"Webhooks.OnMessageRemoved.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.
	WebhooksOnMessageRemovedUrl *string `json:"Webhooks.OnMessageRemoved.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_message_send.url`.
	WebhooksOnMessageSendMethod *string `json:"Webhooks.OnMessageSend.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.
	WebhooksOnMessageSendUrl *string `json:"Webhooks.OnMessageSend.Url,omitempty"`
	// The URL of the webhook to call in response to the `on_message_sent` event`.
	WebhooksOnMessageSentMethod *string `json:"Webhooks.OnMessageSent.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.
	WebhooksOnMessageSentUrl *string `json:"Webhooks.OnMessageSent.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_message_update.url`.
	WebhooksOnMessageUpdateMethod *string `json:"Webhooks.OnMessageUpdate.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.
	WebhooksOnMessageUpdateUrl *string `json:"Webhooks.OnMessageUpdate.Url,omitempty"`
	// The HTTP method to use when calling the `webhooks.on_message_updated.url`.
	WebhooksOnMessageUpdatedMethod *string `json:"Webhooks.OnMessageUpdated.Method,omitempty"`
	// The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.
	WebhooksOnMessageUpdatedUrl *string `json:"Webhooks.OnMessageUpdated.Url,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetConsumptionReportInterval 

func (params *UpdateServiceParams) SetConsumptionReportInterval(ConsumptionReportInterval int32) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultChannelCreatorRoleSid 

func (params *UpdateServiceParams) SetDefaultChannelCreatorRoleSid(DefaultChannelCreatorRoleSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultChannelRoleSid 

func (params *UpdateServiceParams) SetDefaultChannelRoleSid(DefaultChannelRoleSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultServiceRoleSid 

func (params *UpdateServiceParams) SetDefaultServiceRoleSid(DefaultServiceRoleSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetFriendlyName 

func (params *UpdateServiceParams) SetFriendlyName(FriendlyName string) *UpdateServiceParams

func (*UpdateServiceParams) SetLimitsChannelMembers 

func (params *UpdateServiceParams) SetLimitsChannelMembers(LimitsChannelMembers int32) *UpdateServiceParams

func (*UpdateServiceParams) SetLimitsUserChannels 

func (params *UpdateServiceParams) SetLimitsUserChannels(LimitsUserChannels int32) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsAddedToChannelEnabled 

func (params *UpdateServiceParams) SetNotificationsAddedToChannelEnabled(NotificationsAddedToChannelEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsAddedToChannelTemplate 

func (params *UpdateServiceParams) SetNotificationsAddedToChannelTemplate(NotificationsAddedToChannelTemplate string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsInvitedToChannelEnabled 

func (params *UpdateServiceParams) SetNotificationsInvitedToChannelEnabled(NotificationsInvitedToChannelEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsInvitedToChannelTemplate 

func (params *UpdateServiceParams) SetNotificationsInvitedToChannelTemplate(NotificationsInvitedToChannelTemplate string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsNewMessageEnabled 

func (params *UpdateServiceParams) SetNotificationsNewMessageEnabled(NotificationsNewMessageEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsNewMessageTemplate 

func (params *UpdateServiceParams) SetNotificationsNewMessageTemplate(NotificationsNewMessageTemplate string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsRemovedFromChannelEnabled 

func (params *UpdateServiceParams) SetNotificationsRemovedFromChannelEnabled(NotificationsRemovedFromChannelEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsRemovedFromChannelTemplate 

func (params *UpdateServiceParams) SetNotificationsRemovedFromChannelTemplate(NotificationsRemovedFromChannelTemplate string) *UpdateServiceParams

func (*UpdateServiceParams) SetPostWebhookUrl 

func (params *UpdateServiceParams) SetPostWebhookUrl(PostWebhookUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetPreWebhookUrl 

func (params *UpdateServiceParams) SetPreWebhookUrl(PreWebhookUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetReachabilityEnabled 

func (params *UpdateServiceParams) SetReachabilityEnabled(ReachabilityEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetReadStatusEnabled 

func (params *UpdateServiceParams) SetReadStatusEnabled(ReadStatusEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetTypingIndicatorTimeout 

func (params *UpdateServiceParams) SetTypingIndicatorTimeout(TypingIndicatorTimeout int32) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhookFilters 

func (params *UpdateServiceParams) SetWebhookFilters(WebhookFilters []string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhookMethod 

func (params *UpdateServiceParams) SetWebhookMethod(WebhookMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelAddMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelAddMethod(WebhooksOnChannelAddMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelAddUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelAddUrl(WebhooksOnChannelAddUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelAddedMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelAddedMethod(WebhooksOnChannelAddedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelAddedUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelAddedUrl(WebhooksOnChannelAddedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelDestroyMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelDestroyMethod(WebhooksOnChannelDestroyMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelDestroyUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelDestroyUrl(WebhooksOnChannelDestroyUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelDestroyedMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelDestroyedMethod(WebhooksOnChannelDestroyedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelDestroyedUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelDestroyedUrl(WebhooksOnChannelDestroyedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelUpdateMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelUpdateMethod(WebhooksOnChannelUpdateMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelUpdateUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelUpdateUrl(WebhooksOnChannelUpdateUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelUpdatedMethod 

func (params *UpdateServiceParams) SetWebhooksOnChannelUpdatedMethod(WebhooksOnChannelUpdatedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnChannelUpdatedUrl 

func (params *UpdateServiceParams) SetWebhooksOnChannelUpdatedUrl(WebhooksOnChannelUpdatedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberAddMethod 

func (params *UpdateServiceParams) SetWebhooksOnMemberAddMethod(WebhooksOnMemberAddMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberAddUrl 

func (params *UpdateServiceParams) SetWebhooksOnMemberAddUrl(WebhooksOnMemberAddUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberAddedMethod 

func (params *UpdateServiceParams) SetWebhooksOnMemberAddedMethod(WebhooksOnMemberAddedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberAddedUrl 

func (params *UpdateServiceParams) SetWebhooksOnMemberAddedUrl(WebhooksOnMemberAddedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberRemoveMethod 

func (params *UpdateServiceParams) SetWebhooksOnMemberRemoveMethod(WebhooksOnMemberRemoveMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberRemoveUrl 

func (params *UpdateServiceParams) SetWebhooksOnMemberRemoveUrl(WebhooksOnMemberRemoveUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberRemovedMethod 

func (params *UpdateServiceParams) SetWebhooksOnMemberRemovedMethod(WebhooksOnMemberRemovedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMemberRemovedUrl 

func (params *UpdateServiceParams) SetWebhooksOnMemberRemovedUrl(WebhooksOnMemberRemovedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageRemoveMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageRemoveMethod(WebhooksOnMessageRemoveMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageRemoveUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageRemoveUrl(WebhooksOnMessageRemoveUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageRemovedMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageRemovedMethod(WebhooksOnMessageRemovedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageRemovedUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageRemovedUrl(WebhooksOnMessageRemovedUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageSendMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageSendMethod(WebhooksOnMessageSendMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageSendUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageSendUrl(WebhooksOnMessageSendUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageSentMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageSentMethod(WebhooksOnMessageSentMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageSentUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageSentUrl(WebhooksOnMessageSentUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageUpdateMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageUpdateMethod(WebhooksOnMessageUpdateMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageUpdateUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageUpdateUrl(WebhooksOnMessageUpdateUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageUpdatedMethod 

func (params *UpdateServiceParams) SetWebhooksOnMessageUpdatedMethod(WebhooksOnMessageUpdatedMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksOnMessageUpdatedUrl 

func (params *UpdateServiceParams) SetWebhooksOnMessageUpdatedUrl(WebhooksOnMessageUpdatedUrl string) *UpdateServiceParams

type UpdateUserParams 

type UpdateUserParams struct {
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the resource. It is often used for display purposes.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
	RoleSid *string `json:"RoleSid,omitempty"`
}

Optional parameters for the method 'UpdateUser'

func (*UpdateUserParams) SetAttributes 

func (params *UpdateUserParams) SetAttributes(Attributes string) *UpdateUserParams

func (*UpdateUserParams) SetFriendlyName 

func (params *UpdateUserParams) SetFriendlyName(FriendlyName string) *UpdateUserParams

func (*UpdateUserParams) SetRoleSid 

func (params *UpdateUserParams) SetRoleSid(RoleSid string) *UpdateUserParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.