openapi

package
v1.7.2 Latest Latest
Warning

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

Go to latest
Published: Jun 1, 2023 License: MIT Imports: 6 Imported by: 2

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.43.2
  • 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
CredentialsApi CreateCredential Post /v2/Credentials
CredentialsApi DeleteCredential Delete /v2/Credentials/{Sid}
CredentialsApi FetchCredential Get /v2/Credentials/{Sid}
CredentialsApi ListCredential Get /v2/Credentials
CredentialsApi UpdateCredential Post /v2/Credentials/{Sid}
ServicesApi CreateService Post /v2/Services
ServicesApi DeleteService Delete /v2/Services/{Sid}
ServicesApi FetchService Get /v2/Services/{Sid}
ServicesApi ListService Get /v2/Services
ServicesApi UpdateService Post /v2/Services/{Sid}
ServicesBindingsApi DeleteBinding Delete /v2/Services/{ServiceSid}/Bindings/{Sid}
ServicesBindingsApi FetchBinding Get /v2/Services/{ServiceSid}/Bindings/{Sid}
ServicesBindingsApi ListBinding Get /v2/Services/{ServiceSid}/Bindings
ServicesChannelsApi CreateChannel Post /v2/Services/{ServiceSid}/Channels
ServicesChannelsApi DeleteChannel Delete /v2/Services/{ServiceSid}/Channels/{Sid}
ServicesChannelsApi FetchChannel Get /v2/Services/{ServiceSid}/Channels/{Sid}
ServicesChannelsApi ListChannel Get /v2/Services/{ServiceSid}/Channels
ServicesChannelsApi UpdateChannel Post /v2/Services/{ServiceSid}/Channels/{Sid}
ServicesChannelsInvitesApi CreateInvite Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
ServicesChannelsInvitesApi DeleteInvite Delete /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
ServicesChannelsInvitesApi FetchInvite Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
ServicesChannelsInvitesApi ListInvite Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
ServicesChannelsMembersApi CreateMember Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members
ServicesChannelsMembersApi DeleteMember Delete /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
ServicesChannelsMembersApi FetchMember Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
ServicesChannelsMembersApi ListMember Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members
ServicesChannelsMembersApi UpdateMember Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}
ServicesChannelsMessagesApi CreateMessage Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
ServicesChannelsMessagesApi DeleteMessage Delete /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
ServicesChannelsMessagesApi FetchMessage Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
ServicesChannelsMessagesApi ListMessage Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
ServicesChannelsMessagesApi UpdateMessage Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
ServicesChannelsWebhooksApi CreateChannelWebhook Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks
ServicesChannelsWebhooksApi DeleteChannelWebhook Delete /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}
ServicesChannelsWebhooksApi FetchChannelWebhook Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}
ServicesChannelsWebhooksApi ListChannelWebhook Get /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks
ServicesChannelsWebhooksApi UpdateChannelWebhook Post /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}
ServicesRolesApi CreateRole Post /v2/Services/{ServiceSid}/Roles
ServicesRolesApi DeleteRole Delete /v2/Services/{ServiceSid}/Roles/{Sid}
ServicesRolesApi FetchRole Get /v2/Services/{ServiceSid}/Roles/{Sid}
ServicesRolesApi ListRole Get /v2/Services/{ServiceSid}/Roles
ServicesRolesApi UpdateRole Post /v2/Services/{ServiceSid}/Roles/{Sid}
ServicesUsersApi CreateUser Post /v2/Services/{ServiceSid}/Users
ServicesUsersApi DeleteUser Delete /v2/Services/{ServiceSid}/Users/{Sid}
ServicesUsersApi FetchUser Get /v2/Services/{ServiceSid}/Users/{Sid}
ServicesUsersApi ListUser Get /v2/Services/{ServiceSid}/Users
ServicesUsersApi UpdateUser Post /v2/Services/{ServiceSid}/Users/{Sid}
ServicesUsersBindingsApi DeleteUserBinding Delete /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}
ServicesUsersBindingsApi FetchUserBinding Get /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}
ServicesUsersBindingsApi ListUserBinding Get /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings
ServicesUsersChannelsApi DeleteUserChannel Delete /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}
ServicesUsersChannelsApi FetchUserChannel Get /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}
ServicesUsersChannelsApi ListUserChannel Get /v2/Services/{ServiceSid}/Users/{UserSid}/Channels
ServicesUsersChannelsApi UpdateUserChannel Post /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}

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)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0

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

func NewApiService added in v0.11.0

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateChannel added in v0.11.0

func (c *ApiService) CreateChannel(ServiceSid string, params *CreateChannelParams) (*ChatV2Channel, error)

func (*ApiService) CreateChannelWebhook added in v0.11.0

func (c *ApiService) CreateChannelWebhook(ServiceSid string, ChannelSid string, params *CreateChannelWebhookParams) (*ChatV2ChannelWebhook, error)

func (*ApiService) CreateCredential added in v0.11.0

func (c *ApiService) CreateCredential(params *CreateCredentialParams) (*ChatV2Credential, error)

func (*ApiService) CreateInvite added in v0.11.0

func (c *ApiService) CreateInvite(ServiceSid string, ChannelSid string, params *CreateInviteParams) (*ChatV2Invite, error)

func (*ApiService) CreateMember added in v0.11.0

func (c *ApiService) CreateMember(ServiceSid string, ChannelSid string, params *CreateMemberParams) (*ChatV2Member, error)

func (*ApiService) CreateMessage added in v0.11.0

func (c *ApiService) CreateMessage(ServiceSid string, ChannelSid string, params *CreateMessageParams) (*ChatV2Message, error)

func (*ApiService) CreateRole added in v0.11.0

func (c *ApiService) CreateRole(ServiceSid string, params *CreateRoleParams) (*ChatV2Role, error)

func (*ApiService) CreateService added in v0.11.0

func (c *ApiService) CreateService(params *CreateServiceParams) (*ChatV2Service, error)

func (*ApiService) CreateUser added in v0.11.0

func (c *ApiService) CreateUser(ServiceSid string, params *CreateUserParams) (*ChatV2User, error)

func (*ApiService) DeleteBinding added in v0.11.0

func (c *ApiService) DeleteBinding(ServiceSid string, Sid string) error

func (*ApiService) DeleteChannel added in v0.11.0

func (c *ApiService) DeleteChannel(ServiceSid string, Sid string, params *DeleteChannelParams) error

func (*ApiService) DeleteChannelWebhook added in v0.11.0

func (c *ApiService) DeleteChannelWebhook(ServiceSid string, ChannelSid string, Sid string) error

func (*ApiService) DeleteCredential added in v0.11.0

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

func (*ApiService) DeleteInvite added in v0.11.0

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

func (*ApiService) DeleteMember added in v0.11.0

func (c *ApiService) DeleteMember(ServiceSid string, ChannelSid string, Sid string, params *DeleteMemberParams) error

func (*ApiService) DeleteMessage added in v0.11.0

func (c *ApiService) DeleteMessage(ServiceSid string, ChannelSid string, Sid string, params *DeleteMessageParams) error

func (*ApiService) DeleteRole added in v0.11.0

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

func (*ApiService) DeleteService added in v0.11.0

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

func (*ApiService) DeleteUser added in v0.11.0

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

func (*ApiService) DeleteUserBinding added in v0.11.0

func (c *ApiService) DeleteUserBinding(ServiceSid string, UserSid string, Sid string) error

func (*ApiService) DeleteUserChannel added in v0.11.0

func (c *ApiService) DeleteUserChannel(ServiceSid string, UserSid string, ChannelSid string, params *DeleteUserChannelParams) error

Removes User from selected Channel.

func (*ApiService) FetchBinding added in v0.11.0

func (c *ApiService) FetchBinding(ServiceSid string, Sid string) (*ChatV2Binding, error)

func (*ApiService) FetchChannel added in v0.11.0

func (c *ApiService) FetchChannel(ServiceSid string, Sid string) (*ChatV2Channel, error)

func (*ApiService) FetchChannelWebhook added in v0.11.0

func (c *ApiService) FetchChannelWebhook(ServiceSid string, ChannelSid string, Sid string) (*ChatV2ChannelWebhook, error)

func (*ApiService) FetchCredential added in v0.11.0

func (c *ApiService) FetchCredential(Sid string) (*ChatV2Credential, error)

func (*ApiService) FetchInvite added in v0.11.0

func (c *ApiService) FetchInvite(ServiceSid string, ChannelSid string, Sid string) (*ChatV2Invite, error)

func (*ApiService) FetchMember added in v0.11.0

func (c *ApiService) FetchMember(ServiceSid string, ChannelSid string, Sid string) (*ChatV2Member, error)

func (*ApiService) FetchMessage added in v0.11.0

func (c *ApiService) FetchMessage(ServiceSid string, ChannelSid string, Sid string) (*ChatV2Message, error)

func (*ApiService) FetchRole added in v0.11.0

func (c *ApiService) FetchRole(ServiceSid string, Sid string) (*ChatV2Role, error)

func (*ApiService) FetchService added in v0.11.0

func (c *ApiService) FetchService(Sid string) (*ChatV2Service, error)

func (*ApiService) FetchUser added in v0.11.0

func (c *ApiService) FetchUser(ServiceSid string, Sid string) (*ChatV2User, error)

func (*ApiService) FetchUserBinding added in v0.11.0

func (c *ApiService) FetchUserBinding(ServiceSid string, UserSid string, Sid string) (*ChatV2UserBinding, error)

func (*ApiService) FetchUserChannel added in v0.11.0

func (c *ApiService) FetchUserChannel(ServiceSid string, UserSid string, ChannelSid string) (*ChatV2UserChannel, error)

func (*ApiService) ListBinding added in v0.11.0

func (c *ApiService) ListBinding(ServiceSid string, params *ListBindingParams) ([]ChatV2Binding, error)

Lists Binding records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListChannel added in v0.11.0

func (c *ApiService) ListChannel(ServiceSid string, params *ListChannelParams) ([]ChatV2Channel, error)

Lists Channel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListChannelWebhook added in v0.11.0

func (c *ApiService) ListChannelWebhook(ServiceSid string, ChannelSid string, params *ListChannelWebhookParams) ([]ChatV2ChannelWebhook, error)

Lists ChannelWebhook records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListCredential added in v0.11.0

func (c *ApiService) ListCredential(params *ListCredentialParams) ([]ChatV2Credential, error)

Lists Credential records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInvite added in v0.11.0

func (c *ApiService) ListInvite(ServiceSid string, ChannelSid string, params *ListInviteParams) ([]ChatV2Invite, error)

Lists Invite records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListMember added in v0.11.0

func (c *ApiService) ListMember(ServiceSid string, ChannelSid string, params *ListMemberParams) ([]ChatV2Member, error)

Lists Member records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListMessage added in v0.11.0

func (c *ApiService) ListMessage(ServiceSid string, ChannelSid string, params *ListMessageParams) ([]ChatV2Message, error)

Lists Message records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListRole added in v0.11.0

func (c *ApiService) ListRole(ServiceSid string, params *ListRoleParams) ([]ChatV2Role, error)

Lists Role records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListService added in v0.11.0

func (c *ApiService) ListService(params *ListServiceParams) ([]ChatV2Service, error)

Lists Service records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListUser added in v0.11.0

func (c *ApiService) ListUser(ServiceSid string, params *ListUserParams) ([]ChatV2User, error)

Lists User records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListUserBinding added in v0.11.0

func (c *ApiService) ListUserBinding(ServiceSid string, UserSid string, params *ListUserBindingParams) ([]ChatV2UserBinding, error)

Lists UserBinding records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListUserChannel added in v0.11.0

func (c *ApiService) ListUserChannel(ServiceSid string, UserSid string, params *ListUserChannelParams) ([]ChatV2UserChannel, error)

Lists UserChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageBinding added in v0.13.0

func (c *ApiService) PageBinding(ServiceSid string, params *ListBindingParams, pageToken, pageNumber string) (*ListBindingResponse, error)

Retrieve a single page of Binding records from the API. Request is executed immediately.

func (*ApiService) PageChannel added in v0.13.0

func (c *ApiService) PageChannel(ServiceSid string, params *ListChannelParams, pageToken, pageNumber string) (*ListChannelResponse, error)

Retrieve a single page of Channel records from the API. Request is executed immediately.

func (*ApiService) PageChannelWebhook added in v0.13.0

func (c *ApiService) PageChannelWebhook(ServiceSid string, ChannelSid string, params *ListChannelWebhookParams, pageToken, pageNumber string) (*ListChannelWebhookResponse, error)

Retrieve a single page of ChannelWebhook records from the API. Request is executed immediately.

func (*ApiService) PageCredential added in v0.13.0

func (c *ApiService) PageCredential(params *ListCredentialParams, pageToken, pageNumber string) (*ListCredentialResponse, error)

Retrieve a single page of Credential records from the API. Request is executed immediately.

func (*ApiService) PageInvite added in v0.13.0

func (c *ApiService) PageInvite(ServiceSid string, ChannelSid string, params *ListInviteParams, pageToken, pageNumber string) (*ListInviteResponse, error)

Retrieve a single page of Invite records from the API. Request is executed immediately.

func (*ApiService) PageMember added in v0.13.0

func (c *ApiService) PageMember(ServiceSid string, ChannelSid string, params *ListMemberParams, pageToken, pageNumber string) (*ListMemberResponse, error)

Retrieve a single page of Member records from the API. Request is executed immediately.

func (*ApiService) PageMessage added in v0.13.0

func (c *ApiService) PageMessage(ServiceSid string, ChannelSid string, params *ListMessageParams, pageToken, pageNumber string) (*ListMessageResponse, error)

Retrieve a single page of Message records from the API. Request is executed immediately.

func (*ApiService) PageRole added in v0.13.0

func (c *ApiService) PageRole(ServiceSid string, params *ListRoleParams, pageToken, pageNumber string) (*ListRoleResponse, error)

Retrieve a single page of Role records from the API. Request is executed immediately.

func (*ApiService) PageService added in v0.13.0

func (c *ApiService) PageService(params *ListServiceParams, pageToken, pageNumber string) (*ListServiceResponse, error)

Retrieve a single page of Service records from the API. Request is executed immediately.

func (*ApiService) PageUser added in v0.13.0

func (c *ApiService) PageUser(ServiceSid string, params *ListUserParams, pageToken, pageNumber string) (*ListUserResponse, error)

Retrieve a single page of User records from the API. Request is executed immediately.

func (*ApiService) PageUserBinding added in v0.13.0

func (c *ApiService) PageUserBinding(ServiceSid string, UserSid string, params *ListUserBindingParams, pageToken, pageNumber string) (*ListUserBindingResponse, error)

Retrieve a single page of UserBinding records from the API. Request is executed immediately.

func (*ApiService) PageUserChannel added in v0.13.0

func (c *ApiService) PageUserChannel(ServiceSid string, UserSid string, params *ListUserChannelParams, pageToken, pageNumber string) (*ListUserChannelResponse, error)

Retrieve a single page of UserChannel records from the API. Request is executed immediately.

func (*ApiService) StreamBinding added in v0.13.0

func (c *ApiService) StreamBinding(ServiceSid string, params *ListBindingParams) (chan ChatV2Binding, chan error)

Streams Binding records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamChannel added in v0.13.0

func (c *ApiService) StreamChannel(ServiceSid string, params *ListChannelParams) (chan ChatV2Channel, chan error)

Streams Channel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamChannelWebhook added in v0.13.0

func (c *ApiService) StreamChannelWebhook(ServiceSid string, ChannelSid string, params *ListChannelWebhookParams) (chan ChatV2ChannelWebhook, chan error)

Streams ChannelWebhook records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamCredential added in v0.13.0

func (c *ApiService) StreamCredential(params *ListCredentialParams) (chan ChatV2Credential, chan error)

Streams Credential records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInvite added in v0.13.0

func (c *ApiService) StreamInvite(ServiceSid string, ChannelSid string, params *ListInviteParams) (chan ChatV2Invite, chan error)

Streams Invite records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamMember added in v0.13.0

func (c *ApiService) StreamMember(ServiceSid string, ChannelSid string, params *ListMemberParams) (chan ChatV2Member, chan error)

Streams Member records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamMessage added in v0.13.0

func (c *ApiService) StreamMessage(ServiceSid string, ChannelSid string, params *ListMessageParams) (chan ChatV2Message, chan error)

Streams Message records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamRole added in v0.13.0

func (c *ApiService) StreamRole(ServiceSid string, params *ListRoleParams) (chan ChatV2Role, chan error)

Streams Role records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamService added in v0.13.0

func (c *ApiService) StreamService(params *ListServiceParams) (chan ChatV2Service, chan error)

Streams Service records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamUser added in v0.13.0

func (c *ApiService) StreamUser(ServiceSid string, params *ListUserParams) (chan ChatV2User, chan error)

Streams User records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamUserBinding added in v0.13.0

func (c *ApiService) StreamUserBinding(ServiceSid string, UserSid string, params *ListUserBindingParams) (chan ChatV2UserBinding, chan error)

Streams UserBinding records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamUserChannel added in v0.13.0

func (c *ApiService) StreamUserChannel(ServiceSid string, UserSid string, params *ListUserChannelParams) (chan ChatV2UserChannel, chan error)

Streams UserChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateChannel added in v0.11.0

func (c *ApiService) UpdateChannel(ServiceSid string, Sid string, params *UpdateChannelParams) (*ChatV2Channel, error)

func (*ApiService) UpdateChannelWebhook added in v0.11.0

func (c *ApiService) UpdateChannelWebhook(ServiceSid string, ChannelSid string, Sid string, params *UpdateChannelWebhookParams) (*ChatV2ChannelWebhook, error)

func (*ApiService) UpdateCredential added in v0.11.0

func (c *ApiService) UpdateCredential(Sid string, params *UpdateCredentialParams) (*ChatV2Credential, error)

func (*ApiService) UpdateMember added in v0.11.0

func (c *ApiService) UpdateMember(ServiceSid string, ChannelSid string, Sid string, params *UpdateMemberParams) (*ChatV2Member, error)

func (*ApiService) UpdateMessage added in v0.11.0

func (c *ApiService) UpdateMessage(ServiceSid string, ChannelSid string, Sid string, params *UpdateMessageParams) (*ChatV2Message, error)

func (*ApiService) UpdateRole added in v0.11.0

func (c *ApiService) UpdateRole(ServiceSid string, Sid string, params *UpdateRoleParams) (*ChatV2Role, error)

func (*ApiService) UpdateService added in v0.11.0

func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*ChatV2Service, error)

func (*ApiService) UpdateUser added in v0.11.0

func (c *ApiService) UpdateUser(ServiceSid string, Sid string, params *UpdateUserParams) (*ChatV2User, error)

func (*ApiService) UpdateUserChannel added in v0.11.0

func (c *ApiService) UpdateUserChannel(ServiceSid string, UserSid string, ChannelSid string, params *UpdateUserChannelParams) (*ChatV2UserChannel, error)

type ChatV2Binding added in v0.14.0

type ChatV2Binding struct {
	// The unique string that we created to identify the Binding resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.
	Endpoint *string `json:"endpoint,omitempty"`
	// The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"identity,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	CredentialSid *string `json:"credential_sid,omitempty"`
	BindingType   *string `json:"binding_type,omitempty"`
	// The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.
	MessageTypes *[]string `json:"message_types,omitempty"`
	// The absolute URL of the Binding resource.
	Url *string `json:"url,omitempty"`
	// The absolute URLs of the Binding's [User](https://www.twilio.com/docs/chat/rest/user-resource).
	Links *map[string]interface{} `json:"links,omitempty"`
}

ChatV2Binding struct for ChatV2Binding

type ChatV2Channel added in v0.14.0

type ChatV2Channel struct {
	// The unique string that we created to identify the Channel resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,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.
	UniqueName *string `json:"unique_name,omitempty"`
	// The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
	Attributes *string `json:"attributes,omitempty"`
	Type       *string `json:"type,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
	// The number of Members in the Channel.
	MembersCount *int `json:"members_count,omitempty"`
	// The number of Messages that have been passed in the Channel.
	MessagesCount *int `json:"messages_count,omitempty"`
	// The absolute URL of the Channel resource.
	Url *string `json:"url,omitempty"`
	// The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), [Messages](https://www.twilio.com/docs/chat/rest/message-resource), [Invites](https://www.twilio.com/docs/chat/rest/invite-resource), Webhooks and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) for the Channel.
	Links *map[string]interface{} `json:"links,omitempty"`
}

ChatV2Channel struct for ChatV2Channel

type ChatV2ChannelWebhook added in v0.14.0

type ChatV2ChannelWebhook struct {
	// The unique string that we created to identify the Channel Webhook resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel Webhook resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel Webhook resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource belongs to.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The type of webhook. Can be: `webhook`, `studio`, or `trigger`.
	Type *string `json:"type,omitempty"`
	// The absolute URL of the Channel Webhook resource.
	Url *string `json:"url,omitempty"`
	// The JSON string that describes how the channel webhook is configured. The configuration object contains the `url`, `method`, `filters`, and `retry_count` values that are configured by the create and update actions.
	Configuration *interface{} `json:"configuration,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

ChatV2ChannelWebhook struct for ChatV2ChannelWebhook

type ChatV2Credential

type ChatV2Credential struct {
	// The unique string that we created to identify the Credential resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Type         *string `json:"type,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 *string `json:"sandbox,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Credential resource.
	Url *string `json:"url,omitempty"`
}

ChatV2Credential struct for ChatV2Credential

type ChatV2Invite added in v0.14.0

type ChatV2Invite struct {
	// The unique string that we created to identify the Invite resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Invite resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource belongs to.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"identity,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the resource.
	RoleSid *string `json:"role_sid,omitempty"`
	// The `identity` of the User that created the invite.
	CreatedBy *string `json:"created_by,omitempty"`
	// The absolute URL of the Invite resource.
	Url *string `json:"url,omitempty"`
}

ChatV2Invite struct for ChatV2Invite

type ChatV2Member added in v0.14.0

type ChatV2Member struct {
	// The unique string that we created to identify the Member resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs to.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"identity,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the member.
	RoleSid *string `json:"role_sid,omitempty"`
	// The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
	LastConsumedMessageIndex *int `json:"last_consumed_message_index,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
	LastConsumptionTimestamp *time.Time `json:"last_consumption_timestamp,omitempty"`
	// The absolute URL of the Member resource.
	Url *string `json:"url,omitempty"`
	// The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
	Attributes *string `json:"attributes,omitempty"`
}

ChatV2Member struct for ChatV2Member

type ChatV2Message added in v0.14.0

type ChatV2Message struct {
	// The unique string that we created to identify the Message resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
	Attributes *string `json:"attributes,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) that the message was sent to.
	To *string `json:"to,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource belongs to.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.
	LastUpdatedBy *string `json:"last_updated_by,omitempty"`
	// Whether the message has been edited since it was created.
	WasEdited *bool `json:"was_edited,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`.
	From *string `json:"from,omitempty"`
	// The content of the message.
	Body *string `json:"body,omitempty"`
	// The index of the message within the [Channel](https://www.twilio.com/docs/chat/channels). Indices may skip numbers, but will always be in order of when the message was received.
	Index *int `json:"index,omitempty"`
	// The Message type. Can be: `text` or `media`.
	Type *string `json:"type,omitempty"`
	// An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.
	Media *interface{} `json:"media,omitempty"`
	// The absolute URL of the Message resource.
	Url *string `json:"url,omitempty"`
}

ChatV2Message struct for ChatV2Message

type ChatV2Role added in v0.14.0

type ChatV2Role struct {
	// The unique string that we created to identify the Role resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Type         *string `json:"type,omitempty"`
	// An array of the permissions the role has been granted.
	Permissions *[]string `json:"permissions,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Role resource.
	Url *string `json:"url,omitempty"`
}

ChatV2Role struct for ChatV2Role

type ChatV2Service

type ChatV2Service struct {
	// The unique string that we created to identify the Service resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultServiceRoleSid *string `json:"default_service_role_sid,omitempty"`
	// The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultChannelRoleSid *string `json:"default_channel_role_sid,omitempty"`
	// The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultChannelCreatorRoleSid *string `json:"default_channel_creator_role_sid,omitempty"`
	// Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is `true`.
	ReadStatusEnabled *bool `json:"read_status_enabled,omitempty"`
	// Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) is enabled for this Service instance. The default is `false`.
	ReachabilityEnabled *bool `json:"reachability_enabled,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 *int `json:"typing_indicator_timeout,omitempty"`
	// DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
	ConsumptionReportInterval *int `json:"consumption_report_interval,omitempty"`
	// An object that describes the limits of the service instance. The `limits` object contains  `channel_members` to describe the members/channel limit and `user_channels` to describe the channels/user limit. `channel_members` can be 1,000 or less, with a default of 250. `user_channels` can be 1,000 or less, with a default value of 100.
	Limits *interface{} `json:"limits,omitempty"`
	// The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	PreWebhookUrl *string `json:"pre_webhook_url,omitempty"`
	// The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	PostWebhookUrl *string `json:"post_webhook_url,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:"webhook_method,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:"webhook_filters,omitempty"`
	// The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.
	PreWebhookRetryCount *int `json:"pre_webhook_retry_count,omitempty"`
	// The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.
	PostWebhookRetryCount *int `json:"post_webhook_retry_count,omitempty"`
	// The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	Notifications *interface{} `json:"notifications,omitempty"`
	// An object that describes the properties of media that the service supports. The object contains the `size_limit_mb` property, which describes the size of the largest media file in MB; and the `compatibility_message` property, which contains the message text to send when a media message does not have any text.
	Media *interface{} `json:"media,omitempty"`
	// The absolute URL of the Service resource.
	Url *string `json:"url,omitempty"`
	// The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/channels), [Roles](https://www.twilio.com/docs/chat/rest/role-resource), [Bindings](https://www.twilio.com/docs/chat/rest/binding-resource), and [Users](https://www.twilio.com/docs/chat/rest/user-resource).
	Links *map[string]interface{} `json:"links,omitempty"`
}

ChatV2Service struct for ChatV2Service

type ChatV2User added in v0.14.0

type ChatV2User struct {
	// The unique string that we created to identify the User resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
	Attributes *string `json:"attributes,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the user.
	RoleSid *string `json:"role_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"identity,omitempty"`
	// Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for the Service instance, even if the Service's `reachability_enabled` is `true`.
	IsOnline *bool `json:"is_online,omitempty"`
	// Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`.
	IsNotifiable *bool `json:"is_notifiable,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The number of Channels the User is a Member of.
	JoinedChannelsCount *int `json:"joined_channels_count,omitempty"`
	// The absolute URLs of the [Channel](https://www.twilio.com/docs/chat/channels) and [Binding](https://www.twilio.com/docs/chat/rest/binding-resource) resources related to the user.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The absolute URL of the User resource.
	Url *string `json:"url,omitempty"`
}

ChatV2User struct for ChatV2User

type ChatV2UserBinding added in v0.14.0

type ChatV2UserBinding struct {
	// The unique string that we created to identify the User Binding resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User Binding resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User Binding resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`.
	Endpoint *string `json:"endpoint,omitempty"`
	// The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"identity,omitempty"`
	// The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resource.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	UserSid *string `json:"user_sid,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	CredentialSid *string `json:"credential_sid,omitempty"`
	BindingType   *string `json:"binding_type,omitempty"`
	// The [Programmable Chat message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.
	MessageTypes *[]string `json:"message_types,omitempty"`
	// The absolute URL of the User Binding resource.
	Url *string `json:"url,omitempty"`
}

ChatV2UserBinding struct for ChatV2UserBinding

type ChatV2UserChannel added in v0.14.0

type ChatV2UserChannel struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User Channel resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User Channel resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the User Channel resource belongs to.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel belongs to.
	UserSid *string `json:"user_sid,omitempty"`
	// The SID of a [Member](https://www.twilio.com/docs/chat/rest/member-resource) that represents the User on the Channel.
	MemberSid *string `json:"member_sid,omitempty"`
	Status    *string `json:"status,omitempty"`
	// The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
	LastConsumedMessageIndex *int `json:"last_consumed_message_index,omitempty"`
	// The number of unread Messages in the Channel for the User. Note that retrieving messages on a client endpoint does not mean that messages are consumed or read. See [Consumption Horizon feature](https://www.twilio.com/docs/chat/consumption-horizon) to learn how to mark messages as consumed.
	UnreadMessagesCount *int `json:"unread_messages_count,omitempty"`
	// The absolute URLs of the [Members](https://www.twilio.com/docs/chat/rest/member-resource), [Messages](https://www.twilio.com/docs/chat/rest/message-resource) , [Invites](https://www.twilio.com/docs/chat/rest/invite-resource) and, if it exists, the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) for the Channel.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The absolute URL of the User Channel resource.
	Url               *string `json:"url,omitempty"`
	NotificationLevel *string `json:"notification_level,omitempty"`
}

ChatV2UserChannel struct for ChatV2UserChannel

type CreateChannelParams

type CreateChannelParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,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"`
	// An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel 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"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	//
	Type *string `json:"Type,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source  and where a Message was previously updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// The `identity` of the User that created the channel. Default is: `system`.
	CreatedBy *string `json:"CreatedBy,omitempty"`
}

Optional parameters for the method 'CreateChannel'

func (*CreateChannelParams) SetAttributes

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

func (*CreateChannelParams) SetCreatedBy

func (params *CreateChannelParams) SetCreatedBy(CreatedBy string) *CreateChannelParams

func (*CreateChannelParams) SetDateCreated

func (params *CreateChannelParams) SetDateCreated(DateCreated time.Time) *CreateChannelParams

func (*CreateChannelParams) SetDateUpdated

func (params *CreateChannelParams) SetDateUpdated(DateUpdated time.Time) *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

func (*CreateChannelParams) SetXTwilioWebhookEnabled

func (params *CreateChannelParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *CreateChannelParams

type CreateChannelWebhookParams

type CreateChannelWebhookParams struct {
	//
	Type *string `json:"Type,omitempty"`
	// The URL of the webhook to call using the `configuration.method`.
	ConfigurationUrl *string `json:"Configuration.Url,omitempty"`
	//
	ConfigurationMethod *string `json:"Configuration.Method,omitempty"`
	// The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
	ConfigurationFilters *[]string `json:"Configuration.Filters,omitempty"`
	// A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
	ConfigurationTriggers *[]string `json:"Configuration.Triggers,omitempty"`
	// The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`.
	ConfigurationFlowSid *string `json:"Configuration.FlowSid,omitempty"`
	// The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
	ConfigurationRetryCount *int `json:"Configuration.RetryCount,omitempty"`
}

Optional parameters for the method 'CreateChannelWebhook'

func (*CreateChannelWebhookParams) SetConfigurationFilters

func (params *CreateChannelWebhookParams) SetConfigurationFilters(ConfigurationFilters []string) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetConfigurationFlowSid

func (params *CreateChannelWebhookParams) SetConfigurationFlowSid(ConfigurationFlowSid string) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetConfigurationMethod

func (params *CreateChannelWebhookParams) SetConfigurationMethod(ConfigurationMethod string) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetConfigurationRetryCount

func (params *CreateChannelWebhookParams) SetConfigurationRetryCount(ConfigurationRetryCount int) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetConfigurationTriggers

func (params *CreateChannelWebhookParams) SetConfigurationTriggers(ConfigurationTriggers []string) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetConfigurationUrl

func (params *CreateChannelWebhookParams) SetConfigurationUrl(ConfigurationUrl string) *CreateChannelWebhookParams

func (*CreateChannelWebhookParams) SetType

type CreateCredentialParams

type CreateCredentialParams struct {
	//
	Type *string `json:"Type,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 certificate. For example,  `-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// [APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----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"`
	// [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"`
	// [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 '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/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) 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 X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).
	RoleSid *string `json:"RoleSid,omitempty"`
	// The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source.
	LastConsumedMessageIndex *int `json:"LastConsumedMessageIndex,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
	LastConsumptionTimestamp *time.Time `json:"LastConsumptionTimestamp,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this parameter should only be used when a Member is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
}

Optional parameters for the method 'CreateMember'

func (*CreateMemberParams) SetAttributes

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

func (*CreateMemberParams) SetDateCreated

func (params *CreateMemberParams) SetDateCreated(DateCreated time.Time) *CreateMemberParams

func (*CreateMemberParams) SetDateUpdated

func (params *CreateMemberParams) SetDateUpdated(DateUpdated time.Time) *CreateMemberParams

func (*CreateMemberParams) SetIdentity

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

func (*CreateMemberParams) SetLastConsumedMessageIndex

func (params *CreateMemberParams) SetLastConsumedMessageIndex(LastConsumedMessageIndex int) *CreateMemberParams

func (*CreateMemberParams) SetLastConsumptionTimestamp

func (params *CreateMemberParams) SetLastConsumptionTimestamp(LastConsumptionTimestamp time.Time) *CreateMemberParams

func (*CreateMemberParams) SetRoleSid

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

func (*CreateMemberParams) SetXTwilioWebhookEnabled

func (params *CreateMemberParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *CreateMemberParams

type CreateMessageParams

type CreateMessageParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the new message's author. The default value is `system`.
	From *string `json:"From,omitempty"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.
	LastUpdatedBy *string `json:"LastUpdatedBy,omitempty"`
	// The message to send to the channel. Can 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 SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message.
	MediaSid *string `json:"MediaSid,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) SetDateCreated

func (params *CreateMessageParams) SetDateCreated(DateCreated time.Time) *CreateMessageParams

func (*CreateMessageParams) SetDateUpdated

func (params *CreateMessageParams) SetDateUpdated(DateUpdated time.Time) *CreateMessageParams

func (*CreateMessageParams) SetFrom

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

func (*CreateMessageParams) SetLastUpdatedBy

func (params *CreateMessageParams) SetLastUpdatedBy(LastUpdatedBy string) *CreateMessageParams

func (*CreateMessageParams) SetMediaSid

func (params *CreateMessageParams) SetMediaSid(MediaSid string) *CreateMessageParams

func (*CreateMessageParams) SetXTwilioWebhookEnabled

func (params *CreateMessageParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled 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"`
	//
	Type *string `json:"Type,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`.
	Permission *[]string `json:"Permission,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 new resource.
	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 {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or email address. See the Identity documentation for more info.
	Identity *string `json:"Identity,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new User.
	RoleSid *string `json:"RoleSid,omitempty"`
	// 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"`
}

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

func (*CreateUserParams) SetXTwilioWebhookEnabled

func (params *CreateUserParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *CreateUserParams

type DeleteChannelParams

type DeleteChannelParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
}

Optional parameters for the method 'DeleteChannel'

func (*DeleteChannelParams) SetXTwilioWebhookEnabled

func (params *DeleteChannelParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *DeleteChannelParams

type DeleteMemberParams

type DeleteMemberParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
}

Optional parameters for the method 'DeleteMember'

func (*DeleteMemberParams) SetXTwilioWebhookEnabled

func (params *DeleteMemberParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *DeleteMemberParams

type DeleteMessageParams

type DeleteMessageParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
}

Optional parameters for the method 'DeleteMessage'

func (*DeleteMessageParams) SetXTwilioWebhookEnabled

func (params *DeleteMessageParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *DeleteMessageParams

type DeleteUserChannelParams added in v0.22.2

type DeleteUserChannelParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
}

Optional parameters for the method 'DeleteUserChannel'

func (*DeleteUserChannelParams) SetXTwilioWebhookEnabled added in v0.22.2

func (params *DeleteUserChannelParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *DeleteUserChannelParams

type ListBindingParams

type ListBindingParams struct {
	// The push technology used by the Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	BindingType *[]string `json:"BindingType,omitempty"`
	// The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListBinding'

func (*ListBindingParams) SetBindingType

func (params *ListBindingParams) SetBindingType(BindingType []string) *ListBindingParams

func (*ListBindingParams) SetIdentity

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

func (*ListBindingParams) SetLimit added in v0.13.0

func (params *ListBindingParams) SetLimit(Limit int) *ListBindingParams

func (*ListBindingParams) SetPageSize

func (params *ListBindingParams) SetPageSize(PageSize int) *ListBindingParams

type ListBindingResponse

type ListBindingResponse struct {
	Bindings []ChatV2Binding         `json:"bindings,omitempty"`
	Meta     ListBindingResponseMeta `json:"meta,omitempty"`
}

ListBindingResponse struct for ListBindingResponse

type ListBindingResponseMeta added in v1.0.0

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

ListBindingResponseMeta struct for ListBindingResponseMeta

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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListChannel'

func (*ListChannelParams) SetLimit added in v0.13.0

func (params *ListChannelParams) SetLimit(Limit int) *ListChannelParams

func (*ListChannelParams) SetPageSize

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

func (*ListChannelParams) SetType

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

type ListChannelResponse

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

ListChannelResponse struct for ListChannelResponse

type ListChannelWebhookParams

type ListChannelWebhookParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListChannelWebhook'

func (*ListChannelWebhookParams) SetLimit added in v0.13.0

func (params *ListChannelWebhookParams) SetLimit(Limit int) *ListChannelWebhookParams

func (*ListChannelWebhookParams) SetPageSize

func (params *ListChannelWebhookParams) SetPageSize(PageSize int) *ListChannelWebhookParams

type ListChannelWebhookResponse

type ListChannelWebhookResponse struct {
	Webhooks []ChatV2ChannelWebhook  `json:"webhooks,omitempty"`
	Meta     ListBindingResponseMeta `json:"meta,omitempty"`
}

ListChannelWebhookResponse struct for ListChannelWebhookResponse

type ListCredentialParams

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

Optional parameters for the method 'ListCredential'

func (*ListCredentialParams) SetLimit added in v0.13.0

func (params *ListCredentialParams) SetLimit(Limit int) *ListCredentialParams

func (*ListCredentialParams) SetPageSize

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

type ListCredentialResponse

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

ListCredentialResponse struct for ListCredentialResponse

type ListInviteParams

type ListInviteParams struct {
	// The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInvite'

func (*ListInviteParams) SetIdentity

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

func (*ListInviteParams) SetLimit added in v0.13.0

func (params *ListInviteParams) SetLimit(Limit int) *ListInviteParams

func (*ListInviteParams) SetPageSize

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

type ListInviteResponse

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

ListInviteResponse struct for ListInviteResponse

type ListMemberParams

type ListMemberParams struct {
	// The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMember'

func (*ListMemberParams) SetIdentity

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

func (*ListMemberParams) SetLimit added in v0.13.0

func (params *ListMemberParams) SetLimit(Limit int) *ListMemberParams

func (*ListMemberParams) SetPageSize

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

type ListMemberResponse

type ListMemberResponse struct {
	Members []ChatV2Member          `json:"members,omitempty"`
	Meta    ListBindingResponseMeta `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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMessage'

func (*ListMessageParams) SetLimit added in v0.13.0

func (params *ListMessageParams) SetLimit(Limit int) *ListMessageParams

func (*ListMessageParams) SetOrder

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

func (*ListMessageParams) SetPageSize

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

type ListMessageResponse

type ListMessageResponse struct {
	Messages []ChatV2Message         `json:"messages,omitempty"`
	Meta     ListBindingResponseMeta `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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListRole'

func (*ListRoleParams) SetLimit added in v0.13.0

func (params *ListRoleParams) SetLimit(Limit int) *ListRoleParams

func (*ListRoleParams) SetPageSize

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

type ListRoleResponse

type ListRoleResponse struct {
	Roles []ChatV2Role            `json:"roles,omitempty"`
	Meta  ListBindingResponseMeta `json:"meta,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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetLimit added in v0.13.0

func (params *ListServiceParams) SetLimit(Limit int) *ListServiceParams

func (*ListServiceParams) SetPageSize

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

type ListServiceResponse

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

ListServiceResponse struct for ListServiceResponse

type ListUserBindingParams

type ListUserBindingParams struct {
	// The push technology used by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
	BindingType *[]string `json:"BindingType,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListUserBinding'

func (*ListUserBindingParams) SetBindingType

func (params *ListUserBindingParams) SetBindingType(BindingType []string) *ListUserBindingParams

func (*ListUserBindingParams) SetLimit added in v0.13.0

func (params *ListUserBindingParams) SetLimit(Limit int) *ListUserBindingParams

func (*ListUserBindingParams) SetPageSize

func (params *ListUserBindingParams) SetPageSize(PageSize int) *ListUserBindingParams

type ListUserBindingResponse

type ListUserBindingResponse struct {
	Bindings []ChatV2UserBinding     `json:"bindings,omitempty"`
	Meta     ListBindingResponseMeta `json:"meta,omitempty"`
}

ListUserBindingResponse struct for ListUserBindingResponse

type ListUserChannelParams

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

Optional parameters for the method 'ListUserChannel'

func (*ListUserChannelParams) SetLimit added in v0.13.0

func (params *ListUserChannelParams) SetLimit(Limit int) *ListUserChannelParams

func (*ListUserChannelParams) SetPageSize

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

type ListUserChannelResponse

type ListUserChannelResponse struct {
	Channels []ChatV2UserChannel     `json:"channels,omitempty"`
	Meta     ListBindingResponseMeta `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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListUser'

func (*ListUserParams) SetLimit added in v0.13.0

func (params *ListUserParams) SetLimit(Limit int) *ListUserParams

func (*ListUserParams) SetPageSize

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

type ListUserResponse

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

ListUserResponse struct for ListUserResponse

type UpdateChannelParams

type UpdateChannelParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 256 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 256 characters or less in length and unique within the Service.
	UniqueName *string `json:"UniqueName,omitempty"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// The `identity` of the User that created the channel. Default is: `system`.
	CreatedBy *string `json:"CreatedBy,omitempty"`
}

Optional parameters for the method 'UpdateChannel'

func (*UpdateChannelParams) SetAttributes

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

func (*UpdateChannelParams) SetCreatedBy

func (params *UpdateChannelParams) SetCreatedBy(CreatedBy string) *UpdateChannelParams

func (*UpdateChannelParams) SetDateCreated

func (params *UpdateChannelParams) SetDateCreated(DateCreated time.Time) *UpdateChannelParams

func (*UpdateChannelParams) SetDateUpdated

func (params *UpdateChannelParams) SetDateUpdated(DateUpdated time.Time) *UpdateChannelParams

func (*UpdateChannelParams) SetFriendlyName

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

func (*UpdateChannelParams) SetUniqueName

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

func (*UpdateChannelParams) SetXTwilioWebhookEnabled

func (params *UpdateChannelParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *UpdateChannelParams

type UpdateChannelWebhookParams

type UpdateChannelWebhookParams struct {
	// The URL of the webhook to call using the `configuration.method`.
	ConfigurationUrl *string `json:"Configuration.Url,omitempty"`
	//
	ConfigurationMethod *string `json:"Configuration.Method,omitempty"`
	// The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
	ConfigurationFilters *[]string `json:"Configuration.Filters,omitempty"`
	// A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
	ConfigurationTriggers *[]string `json:"Configuration.Triggers,omitempty"`
	// The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` = `studio`.
	ConfigurationFlowSid *string `json:"Configuration.FlowSid,omitempty"`
	// The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
	ConfigurationRetryCount *int `json:"Configuration.RetryCount,omitempty"`
}

Optional parameters for the method 'UpdateChannelWebhook'

func (*UpdateChannelWebhookParams) SetConfigurationFilters

func (params *UpdateChannelWebhookParams) SetConfigurationFilters(ConfigurationFilters []string) *UpdateChannelWebhookParams

func (*UpdateChannelWebhookParams) SetConfigurationFlowSid

func (params *UpdateChannelWebhookParams) SetConfigurationFlowSid(ConfigurationFlowSid string) *UpdateChannelWebhookParams

func (*UpdateChannelWebhookParams) SetConfigurationMethod

func (params *UpdateChannelWebhookParams) SetConfigurationMethod(ConfigurationMethod string) *UpdateChannelWebhookParams

func (*UpdateChannelWebhookParams) SetConfigurationRetryCount

func (params *UpdateChannelWebhookParams) SetConfigurationRetryCount(ConfigurationRetryCount int) *UpdateChannelWebhookParams

func (*UpdateChannelWebhookParams) SetConfigurationTriggers

func (params *UpdateChannelWebhookParams) SetConfigurationTriggers(ConfigurationTriggers []string) *UpdateChannelWebhookParams

func (*UpdateChannelWebhookParams) SetConfigurationUrl

func (params *UpdateChannelWebhookParams) SetConfigurationUrl(ConfigurationUrl string) *UpdateChannelWebhookParams

type UpdateCredentialParams

type UpdateCredentialParams struct {
	// 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 certificate. For example,  `-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// [APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----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"`
	// [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"`
	// [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 X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).
	RoleSid *string `json:"RoleSid,omitempty"`
	// The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).
	LastConsumedMessageIndex *int `json:"LastConsumedMessageIndex,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
	LastConsumptionTimestamp *time.Time `json:"LastConsumptionTimestamp,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this parameter should only be used when a Member is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
}

Optional parameters for the method 'UpdateMember'

func (*UpdateMemberParams) SetAttributes

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

func (*UpdateMemberParams) SetDateCreated

func (params *UpdateMemberParams) SetDateCreated(DateCreated time.Time) *UpdateMemberParams

func (*UpdateMemberParams) SetDateUpdated

func (params *UpdateMemberParams) SetDateUpdated(DateUpdated time.Time) *UpdateMemberParams

func (*UpdateMemberParams) SetLastConsumedMessageIndex

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

func (*UpdateMemberParams) SetLastConsumptionTimestamp

func (params *UpdateMemberParams) SetLastConsumptionTimestamp(LastConsumptionTimestamp time.Time) *UpdateMemberParams

func (*UpdateMemberParams) SetRoleSid

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

func (*UpdateMemberParams) SetXTwilioWebhookEnabled

func (params *UpdateMemberParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *UpdateMemberParams

type UpdateMessageParams

type UpdateMessageParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The message to send to the channel. Can 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"`
	// A valid JSON string that contains application-specific data.
	Attributes *string `json:"Attributes,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.
	DateCreated *time.Time `json:"DateCreated,omitempty"`
	// The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
	DateUpdated *time.Time `json:"DateUpdated,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.
	LastUpdatedBy *string `json:"LastUpdatedBy,omitempty"`
	// The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author.
	From *string `json:"From,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

func (*UpdateMessageParams) SetDateCreated

func (params *UpdateMessageParams) SetDateCreated(DateCreated time.Time) *UpdateMessageParams

func (*UpdateMessageParams) SetDateUpdated

func (params *UpdateMessageParams) SetDateUpdated(DateUpdated time.Time) *UpdateMessageParams

func (*UpdateMessageParams) SetFrom

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

func (*UpdateMessageParams) SetLastUpdatedBy

func (params *UpdateMessageParams) SetLastUpdatedBy(LastUpdatedBy string) *UpdateMessageParams

func (*UpdateMessageParams) SetXTwilioWebhookEnabled

func (params *UpdateMessageParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled 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. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.
	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 {
	// A descriptive string that you create to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultServiceRoleSid *string `json:"DefaultServiceRoleSid,omitempty"`
	// The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultChannelRoleSid *string `json:"DefaultChannelRoleSid,omitempty"`
	// The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.
	DefaultChannelCreatorRoleSid *string `json:"DefaultChannelCreatorRoleSid,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"`
	// 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"`
	// 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 *int `json:"TypingIndicatorTimeout,omitempty"`
	// DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
	ConsumptionReportInterval *int `json:"ConsumptionReportInterval,omitempty"`
	// Whether to send a notification when a new message is added to a channel. 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"`
	// The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`.
	NotificationsNewMessageSound *string `json:"Notifications.NewMessage.Sound,omitempty"`
	// Whether the new message badge is enabled. The default is `false`.
	NotificationsNewMessageBadgeCountEnabled *bool `json:"Notifications.NewMessage.BadgeCountEnabled,omitempty"`
	// Whether to send a notification when a member is added to a channel. 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"`
	// The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.
	NotificationsAddedToChannelSound *string `json:"Notifications.AddedToChannel.Sound,omitempty"`
	// Whether to send a notification to a user when they are removed from a channel. 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 name of the sound to play to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.
	NotificationsRemovedFromChannelSound *string `json:"Notifications.RemovedFromChannel.Sound,omitempty"`
	// Whether to send a notification when a user is invited to a channel. 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"`
	// The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.
	NotificationsInvitedToChannelSound *string `json:"Notifications.InvitedToChannel.Sound,omitempty"`
	// The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	PreWebhookUrl *string `json:"PreWebhookUrl,omitempty"`
	// The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
	PostWebhookUrl *string `json:"PostWebhookUrl,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 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 maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
	LimitsChannelMembers *int `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 *int `json:"Limits.UserChannels,omitempty"`
	// The message to send when a media message has no text. Can be used as placeholder message.
	MediaCompatibilityMessage *string `json:"Media.CompatibilityMessage,omitempty"`
	// The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.
	PreWebhookRetryCount *int `json:"PreWebhookRetryCount,omitempty"`
	// The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.
	PostWebhookRetryCount *int `json:"PostWebhookRetryCount,omitempty"`
	// Whether to log notifications. The default is `false`.
	NotificationsLogEnabled *bool `json:"Notifications.LogEnabled,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetConsumptionReportInterval

func (params *UpdateServiceParams) SetConsumptionReportInterval(ConsumptionReportInterval int) *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 int) *UpdateServiceParams

func (*UpdateServiceParams) SetLimitsUserChannels

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

func (*UpdateServiceParams) SetMediaCompatibilityMessage

func (params *UpdateServiceParams) SetMediaCompatibilityMessage(MediaCompatibilityMessage string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsAddedToChannelEnabled

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

func (*UpdateServiceParams) SetNotificationsAddedToChannelSound

func (params *UpdateServiceParams) SetNotificationsAddedToChannelSound(NotificationsAddedToChannelSound string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsAddedToChannelTemplate

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

func (*UpdateServiceParams) SetNotificationsInvitedToChannelEnabled

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

func (*UpdateServiceParams) SetNotificationsInvitedToChannelSound

func (params *UpdateServiceParams) SetNotificationsInvitedToChannelSound(NotificationsInvitedToChannelSound string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsInvitedToChannelTemplate

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

func (*UpdateServiceParams) SetNotificationsLogEnabled

func (params *UpdateServiceParams) SetNotificationsLogEnabled(NotificationsLogEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsNewMessageBadgeCountEnabled

func (params *UpdateServiceParams) SetNotificationsNewMessageBadgeCountEnabled(NotificationsNewMessageBadgeCountEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsNewMessageEnabled

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

func (*UpdateServiceParams) SetNotificationsNewMessageSound

func (params *UpdateServiceParams) SetNotificationsNewMessageSound(NotificationsNewMessageSound string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsNewMessageTemplate

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

func (*UpdateServiceParams) SetNotificationsRemovedFromChannelEnabled

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

func (*UpdateServiceParams) SetNotificationsRemovedFromChannelSound

func (params *UpdateServiceParams) SetNotificationsRemovedFromChannelSound(NotificationsRemovedFromChannelSound string) *UpdateServiceParams

func (*UpdateServiceParams) SetNotificationsRemovedFromChannelTemplate

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

func (*UpdateServiceParams) SetPostWebhookRetryCount

func (params *UpdateServiceParams) SetPostWebhookRetryCount(PostWebhookRetryCount int) *UpdateServiceParams

func (*UpdateServiceParams) SetPostWebhookUrl

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

func (*UpdateServiceParams) SetPreWebhookRetryCount

func (params *UpdateServiceParams) SetPreWebhookRetryCount(PreWebhookRetryCount int) *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 int) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhookFilters

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

func (*UpdateServiceParams) SetWebhookMethod

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

type UpdateUserChannelParams

type UpdateUserChannelParams struct {
	//
	NotificationLevel *string `json:"NotificationLevel,omitempty"`
	// The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
	LastConsumedMessageIndex *int `json:"LastConsumedMessageIndex,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
	LastConsumptionTimestamp *time.Time `json:"LastConsumptionTimestamp,omitempty"`
}

Optional parameters for the method 'UpdateUserChannel'

func (*UpdateUserChannelParams) SetLastConsumedMessageIndex

func (params *UpdateUserChannelParams) SetLastConsumedMessageIndex(LastConsumedMessageIndex int) *UpdateUserChannelParams

func (*UpdateUserChannelParams) SetLastConsumptionTimestamp

func (params *UpdateUserChannelParams) SetLastConsumptionTimestamp(LastConsumptionTimestamp time.Time) *UpdateUserChannelParams

func (*UpdateUserChannelParams) SetNotificationLevel

func (params *UpdateUserChannelParams) SetNotificationLevel(NotificationLevel string) *UpdateUserChannelParams

type UpdateUserParams

type UpdateUserParams struct {
	// The X-Twilio-Webhook-Enabled HTTP request header
	XTwilioWebhookEnabled *string `json:"X-Twilio-Webhook-Enabled,omitempty"`
	// The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the User.
	RoleSid *string `json:"RoleSid,omitempty"`
	// 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"`
}

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

func (*UpdateUserParams) SetXTwilioWebhookEnabled

func (params *UpdateUserParams) SetXTwilioWebhookEnabled(XTwilioWebhookEnabled string) *UpdateUserParams

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL