openapi

package
v0.10.0 Latest Latest
Warning

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

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

README

Go API client for openapi

This is the public Twilio REST API.

Overview

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

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

Installation

Install the following dependencies:

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

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

import "./openapi"

Documentation for API Endpoints

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

Class Method HTTP request Description
DefaultApi CreateBinding Post /v1/Services/{ServiceSid}/Bindings
DefaultApi CreateCredential Post /v1/Credentials
DefaultApi CreateNotification Post /v1/Services/{ServiceSid}/Notifications
DefaultApi CreateService Post /v1/Services
DefaultApi DeleteBinding Delete /v1/Services/{ServiceSid}/Bindings/{Sid}
DefaultApi DeleteCredential Delete /v1/Credentials/{Sid}
DefaultApi DeleteService Delete /v1/Services/{Sid}
DefaultApi FetchBinding Get /v1/Services/{ServiceSid}/Bindings/{Sid}
DefaultApi FetchCredential Get /v1/Credentials/{Sid}
DefaultApi FetchService Get /v1/Services/{Sid}
DefaultApi ListBinding Get /v1/Services/{ServiceSid}/Bindings
DefaultApi ListCredential Get /v1/Credentials
DefaultApi ListService Get /v1/Services
DefaultApi UpdateCredential Post /v1/Credentials/{Sid}
DefaultApi UpdateService Post /v1/Services/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

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

Author

support@twilio.com

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateBindingParams 

type CreateBindingParams struct {
	// The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.
	Address *string `json:"Address,omitempty"`
	// The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
	BindingType *string `json:"BindingType,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only `apn`, `fcm`, and `gcm` type Bindings.
	CredentialSid *string `json:"CredentialSid,omitempty"`
	// Deprecated.
	Endpoint *string `json:"Endpoint,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/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.
	Identity *string `json:"Identity,omitempty"`
	// The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). The current version is `\\\"3\\\"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.
	NotificationProtocolVersion *string `json:"NotificationProtocolVersion,omitempty"`
	// A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.
	Tag *[]string `json:"Tag,omitempty"`
}

Optional parameters for the method 'CreateBinding'

func (*CreateBindingParams) SetAddress 

func (params *CreateBindingParams) SetAddress(Address string) *CreateBindingParams

func (*CreateBindingParams) SetBindingType 

func (params *CreateBindingParams) SetBindingType(BindingType string) *CreateBindingParams

func (*CreateBindingParams) SetCredentialSid 

func (params *CreateBindingParams) SetCredentialSid(CredentialSid string) *CreateBindingParams

func (*CreateBindingParams) SetEndpoint 

func (params *CreateBindingParams) SetEndpoint(Endpoint string) *CreateBindingParams

func (*CreateBindingParams) SetIdentity 

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

func (*CreateBindingParams) SetNotificationProtocolVersion 

func (params *CreateBindingParams) SetNotificationProtocolVersion(NotificationProtocolVersion string) *CreateBindingParams

func (*CreateBindingParams) SetTag 

func (params *CreateBindingParams) SetTag(Tag []string) *CreateBindingParams

type CreateCredentialParams 

type CreateCredentialParams struct {
	// [GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
	ApiKey *string `json:"ApiKey,omitempty"`
	// [APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// [APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\\\n.-----END RSA PRIVATE KEY-----`
	PrivateKey *string `json:"PrivateKey,omitempty"`
	// [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
	Sandbox *bool `json:"Sandbox,omitempty"`
	// [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
	Secret *string `json:"Secret,omitempty"`
	// The Credential type. Can be: `gcm`, `fcm`, or `apn`.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateCredential'

func (*CreateCredentialParams) SetApiKey 

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

func (*CreateCredentialParams) SetCertificate 

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

func (*CreateCredentialParams) SetFriendlyName 

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

func (*CreateCredentialParams) SetPrivateKey 

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

func (*CreateCredentialParams) SetSandbox 

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

func (*CreateCredentialParams) SetSecret 

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

func (*CreateCredentialParams) SetType 

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

type CreateNotificationParams 

type CreateNotificationParams struct {
	// The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.
	Action *string `json:"Action,omitempty"`
	// Deprecated.
	Alexa *map[string]interface{} `json:"Alexa,omitempty"`
	// The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.
	Apn *map[string]interface{} `json:"Apn,omitempty"`
	// The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.
	Body *string `json:"Body,omitempty"`
	// The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.
	Data *map[string]interface{} `json:"Data,omitempty"`
	// URL to send webhooks.
	DeliveryCallbackUrl *string `json:"DeliveryCallbackUrl,omitempty"`
	// Deprecated.
	FacebookMessenger *map[string]interface{} `json:"FacebookMessenger,omitempty"`
	// The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.
	Fcm *map[string]interface{} `json:"Fcm,omitempty"`
	// The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.  This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
	Gcm *map[string]interface{} `json:"Gcm,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/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list.
	Identity *[]string `json:"Identity,omitempty"`
	// The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property.
	Priority *string `json:"Priority,omitempty"`
	// The Segment resource is deprecated. Use the `tag` parameter, instead.
	Segment *[]string `json:"Segment,omitempty"`
	// The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings.  Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource.  These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`.  The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.
	Sms *map[string]interface{} `json:"Sms,omitempty"`
	// The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`.  For APNS, this translates to `aps.sound`.  SMS does not support this property.
	Sound *string `json:"Sound,omitempty"`
	// A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel.
	Tag *[]string `json:"Tag,omitempty"`
	// The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.
	Title *string `json:"Title,omitempty"`
	// The destination address specified as a JSON string.  Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers.
	ToBinding *[]string `json:"ToBinding,omitempty"`
	// How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateNotification'

func (*CreateNotificationParams) SetAction 

func (params *CreateNotificationParams) SetAction(Action string) *CreateNotificationParams

func (*CreateNotificationParams) SetAlexa 

func (params *CreateNotificationParams) SetAlexa(Alexa map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetApn 

func (params *CreateNotificationParams) SetApn(Apn map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetBody 

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

func (*CreateNotificationParams) SetData 

func (params *CreateNotificationParams) SetData(Data map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetDeliveryCallbackUrl 

func (params *CreateNotificationParams) SetDeliveryCallbackUrl(DeliveryCallbackUrl string) *CreateNotificationParams

func (*CreateNotificationParams) SetFacebookMessenger 

func (params *CreateNotificationParams) SetFacebookMessenger(FacebookMessenger map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetFcm 

func (params *CreateNotificationParams) SetFcm(Fcm map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetGcm 

func (params *CreateNotificationParams) SetGcm(Gcm map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetIdentity 

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

func (*CreateNotificationParams) SetPriority 

func (params *CreateNotificationParams) SetPriority(Priority string) *CreateNotificationParams

func (*CreateNotificationParams) SetSegment 

func (params *CreateNotificationParams) SetSegment(Segment []string) *CreateNotificationParams

func (*CreateNotificationParams) SetSms 

func (params *CreateNotificationParams) SetSms(Sms map[string]interface{}) *CreateNotificationParams

func (*CreateNotificationParams) SetSound 

func (params *CreateNotificationParams) SetSound(Sound string) *CreateNotificationParams

func (*CreateNotificationParams) SetTag 

func (params *CreateNotificationParams) SetTag(Tag []string) *CreateNotificationParams

func (*CreateNotificationParams) SetTitle 

func (params *CreateNotificationParams) SetTitle(Title string) *CreateNotificationParams

func (*CreateNotificationParams) SetToBinding 

func (params *CreateNotificationParams) SetToBinding(ToBinding []string) *CreateNotificationParams

func (*CreateNotificationParams) SetTtl 

func (params *CreateNotificationParams) SetTtl(Ttl int32) *CreateNotificationParams

type CreateServiceParams 

type CreateServiceParams struct {
	// Deprecated.
	AlexaSkillId *string `json:"AlexaSkillId,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
	ApnCredentialSid *string `json:"ApnCredentialSid,omitempty"`
	// Deprecated.
	DefaultAlexaNotificationProtocolVersion *string `json:"DefaultAlexaNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultApnNotificationProtocolVersion *string `json:"DefaultApnNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultFcmNotificationProtocolVersion *string `json:"DefaultFcmNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultGcmNotificationProtocolVersion *string `json:"DefaultGcmNotificationProtocolVersion,omitempty"`
	// Callback configuration that enables delivery callbacks, default false
	DeliveryCallbackEnabled *bool `json:"DeliveryCallbackEnabled,omitempty"`
	// URL to send delivery status callback.
	DeliveryCallbackUrl *string `json:"DeliveryCallbackUrl,omitempty"`
	// Deprecated.
	FacebookMessengerPageId *string `json:"FacebookMessengerPageId,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
	FcmCredentialSid *string `json:"FcmCredentialSid,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
	GcmCredentialSid *string `json:"GcmCredentialSid,omitempty"`
	// Whether to log notifications. Can be: `true` or `false` and the default is `true`.
	LogEnabled *bool `json:"LogEnabled,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
	MessagingServiceSid *string `json:"MessagingServiceSid,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetAlexaSkillId 

func (params *CreateServiceParams) SetAlexaSkillId(AlexaSkillId string) *CreateServiceParams

func (*CreateServiceParams) SetApnCredentialSid 

func (params *CreateServiceParams) SetApnCredentialSid(ApnCredentialSid string) *CreateServiceParams

func (*CreateServiceParams) SetDefaultAlexaNotificationProtocolVersion 

func (params *CreateServiceParams) SetDefaultAlexaNotificationProtocolVersion(DefaultAlexaNotificationProtocolVersion string) *CreateServiceParams

func (*CreateServiceParams) SetDefaultApnNotificationProtocolVersion 

func (params *CreateServiceParams) SetDefaultApnNotificationProtocolVersion(DefaultApnNotificationProtocolVersion string) *CreateServiceParams

func (*CreateServiceParams) SetDefaultFcmNotificationProtocolVersion 

func (params *CreateServiceParams) SetDefaultFcmNotificationProtocolVersion(DefaultFcmNotificationProtocolVersion string) *CreateServiceParams

func (*CreateServiceParams) SetDefaultGcmNotificationProtocolVersion 

func (params *CreateServiceParams) SetDefaultGcmNotificationProtocolVersion(DefaultGcmNotificationProtocolVersion string) *CreateServiceParams

func (*CreateServiceParams) SetDeliveryCallbackEnabled 

func (params *CreateServiceParams) SetDeliveryCallbackEnabled(DeliveryCallbackEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetDeliveryCallbackUrl 

func (params *CreateServiceParams) SetDeliveryCallbackUrl(DeliveryCallbackUrl string) *CreateServiceParams

func (*CreateServiceParams) SetFacebookMessengerPageId 

func (params *CreateServiceParams) SetFacebookMessengerPageId(FacebookMessengerPageId string) *CreateServiceParams

func (*CreateServiceParams) SetFcmCredentialSid 

func (params *CreateServiceParams) SetFcmCredentialSid(FcmCredentialSid string) *CreateServiceParams

func (*CreateServiceParams) SetFriendlyName 

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

func (*CreateServiceParams) SetGcmCredentialSid 

func (params *CreateServiceParams) SetGcmCredentialSid(GcmCredentialSid string) *CreateServiceParams

func (*CreateServiceParams) SetLogEnabled 

func (params *CreateServiceParams) SetLogEnabled(LogEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetMessagingServiceSid 

func (params *CreateServiceParams) SetMessagingServiceSid(MessagingServiceSid string) *CreateServiceParams

type DefaultApiService 

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

func NewDefaultApiService 

func NewDefaultApiService(requestHandler *twilio.RequestHandler) *DefaultApiService

func NewDefaultApiServiceWithClient added in v0.9.0 

func NewDefaultApiServiceWithClient(client twilio.BaseClient) *DefaultApiService

func (*DefaultApiService) CreateBinding 

func (c *DefaultApiService) CreateBinding(ServiceSid string, params *CreateBindingParams) (*NotifyV1ServiceBinding, error)

func (*DefaultApiService) CreateCredential 

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

func (*DefaultApiService) CreateNotification 

func (c *DefaultApiService) CreateNotification(ServiceSid string, params *CreateNotificationParams) (*NotifyV1ServiceNotification, error)

func (*DefaultApiService) CreateService 

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

func (*DefaultApiService) DeleteBinding 

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

func (*DefaultApiService) DeleteCredential 

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

func (*DefaultApiService) DeleteService 

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

func (*DefaultApiService) FetchBinding 

func (c *DefaultApiService) FetchBinding(ServiceSid string, Sid string) (*NotifyV1ServiceBinding, error)

func (*DefaultApiService) FetchCredential 

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

func (*DefaultApiService) FetchService 

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

func (*DefaultApiService) ListBinding 

func (c *DefaultApiService) ListBinding(ServiceSid string, params *ListBindingParams) (*ListBindingResponse, error)

func (*DefaultApiService) ListCredential 

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

func (*DefaultApiService) ListService 

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

func (*DefaultApiService) UpdateCredential 

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

func (*DefaultApiService) UpdateService 

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

type ListBindingParams 

type ListBindingParams struct {
	// Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
	StartDate *string `json:"StartDate,omitempty"`
	// Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
	EndDate *string `json:"EndDate,omitempty"`
	// The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
	Identity *[]string `json:"Identity,omitempty"`
	// Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
	Tag *[]string `json:"Tag,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListBinding'

func (*ListBindingParams) SetEndDate 

func (params *ListBindingParams) SetEndDate(EndDate string) *ListBindingParams

func (*ListBindingParams) SetIdentity 

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

func (*ListBindingParams) SetPageSize 

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

func (*ListBindingParams) SetStartDate 

func (params *ListBindingParams) SetStartDate(StartDate string) *ListBindingParams

func (*ListBindingParams) SetTag 

func (params *ListBindingParams) SetTag(Tag []string) *ListBindingParams

type ListBindingResponse 

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

ListBindingResponse struct for ListBindingResponse

type ListCredentialParams 

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

Optional parameters for the method 'ListCredential'

func (*ListCredentialParams) SetPageSize 

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

type ListCredentialResponse 

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

ListCredentialResponse struct for ListCredentialResponse

type ListCredentialResponseMeta 

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

ListCredentialResponseMeta struct for ListCredentialResponseMeta

type ListServiceParams 

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

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetFriendlyName 

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

func (*ListServiceParams) SetPageSize 

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

type ListServiceResponse 

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

ListServiceResponse struct for ListServiceResponse

type NotifyV1Credential 

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

NotifyV1Credential struct for NotifyV1Credential

type NotifyV1Service 

type NotifyV1Service struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Deprecated
	AlexaSkillId *string `json:"alexa_skill_id,omitempty"`
	// The SID of the Credential to use for APN Bindings
	ApnCredentialSid *string `json:"apn_credential_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Deprecated
	DefaultAlexaNotificationProtocolVersion *string `json:"default_alexa_notification_protocol_version,omitempty"`
	// The protocol version to use for sending APNS notifications
	DefaultApnNotificationProtocolVersion *string `json:"default_apn_notification_protocol_version,omitempty"`
	// The protocol version to use for sending FCM notifications
	DefaultFcmNotificationProtocolVersion *string `json:"default_fcm_notification_protocol_version,omitempty"`
	// The protocol version to use for sending GCM notifications
	DefaultGcmNotificationProtocolVersion *string `json:"default_gcm_notification_protocol_version,omitempty"`
	// Enable delivery callbacks
	DeliveryCallbackEnabled *bool `json:"delivery_callback_enabled,omitempty"`
	// Webhook URL
	DeliveryCallbackUrl *string `json:"delivery_callback_url,omitempty"`
	// Deprecated
	FacebookMessengerPageId *string `json:"facebook_messenger_page_id,omitempty"`
	// The SID of the Credential to use for FCM Bindings
	FcmCredentialSid *string `json:"fcm_credential_sid,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The SID of the Credential to use for GCM Bindings
	GcmCredentialSid *string `json:"gcm_credential_sid,omitempty"`
	// The URLs of the resources related to the service
	Links *map[string]interface{} `json:"links,omitempty"`
	// Whether to log notifications
	LogEnabled *bool `json:"log_enabled,omitempty"`
	// The SID of the Messaging Service to use for SMS Bindings
	MessagingServiceSid *string `json:"messaging_service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Service resource
	Url *string `json:"url,omitempty"`
}

NotifyV1Service struct for NotifyV1Service

type NotifyV1ServiceBinding 

type NotifyV1ServiceBinding struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The channel-specific address
	Address *string `json:"address,omitempty"`
	// The type of the Binding
	BindingType *string `json:"binding_type,omitempty"`
	// The SID of the Credential resource to be used to send notifications to this Binding
	CredentialSid *string `json:"credential_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Deprecated
	Endpoint *string `json:"endpoint,omitempty"`
	// The `identity` value that identifies the new resource's User
	Identity *string `json:"identity,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The protocol version to use to send the notification
	NotificationProtocolVersion *string `json:"notification_protocol_version,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The list of tags associated with this Binding
	Tags *[]string `json:"tags,omitempty"`
	// The absolute URL of the Binding resource
	Url *string `json:"url,omitempty"`
}

NotifyV1ServiceBinding struct for NotifyV1ServiceBinding

type NotifyV1ServiceNotification 

type NotifyV1ServiceNotification struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The actions to display for the notification
	Action *string `json:"action,omitempty"`
	// Deprecated
	Alexa *map[string]interface{} `json:"alexa,omitempty"`
	// The APNS-specific payload that overrides corresponding attributes in a generic payload for APNS Bindings
	Apn *map[string]interface{} `json:"apn,omitempty"`
	// The notification body text
	Body *string `json:"body,omitempty"`
	// The custom key-value pairs of the notification's payload
	Data *map[string]interface{} `json:"data,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// Deprecated
	FacebookMessenger *map[string]interface{} `json:"facebook_messenger,omitempty"`
	// The FCM-specific payload that overrides corresponding attributes in generic payload for FCM Bindings
	Fcm *map[string]interface{} `json:"fcm,omitempty"`
	// The GCM-specific payload that overrides corresponding attributes in generic payload for GCM Bindings
	Gcm *map[string]interface{} `json:"gcm,omitempty"`
	// The list of identity values of the Users to notify
	Identities *[]string `json:"identities,omitempty"`
	// The priority of the notification
	Priority *string `json:"priority,omitempty"`
	// The list of Segments to notify
	Segments *[]string `json:"segments,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SMS-specific payload that overrides corresponding attributes in generic payload for SMS Bindings
	Sms *map[string]interface{} `json:"sms,omitempty"`
	// The name of the sound to be played for the notification
	Sound *string `json:"sound,omitempty"`
	// The tags that select the Bindings to notify
	Tags *[]string `json:"tags,omitempty"`
	// The notification title
	Title *string `json:"title,omitempty"`
	// How long, in seconds, the notification is valid
	Ttl *int32 `json:"ttl,omitempty"`
}

NotifyV1ServiceNotification struct for NotifyV1ServiceNotification

type UpdateCredentialParams 

type UpdateCredentialParams struct {
	// [GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
	ApiKey *string `json:"ApiKey,omitempty"`
	// [APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
	Certificate *string `json:"Certificate,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// [APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\\\n.-----END RSA PRIVATE KEY-----`
	PrivateKey *string `json:"PrivateKey,omitempty"`
	// [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
	Sandbox *bool `json:"Sandbox,omitempty"`
	// [FCM only] The `Server key` of your project from Firebase console 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 UpdateServiceParams 

type UpdateServiceParams struct {
	// Deprecated.
	AlexaSkillId *string `json:"AlexaSkillId,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
	ApnCredentialSid *string `json:"ApnCredentialSid,omitempty"`
	// Deprecated.
	DefaultAlexaNotificationProtocolVersion *string `json:"DefaultAlexaNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultApnNotificationProtocolVersion *string `json:"DefaultApnNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultFcmNotificationProtocolVersion *string `json:"DefaultFcmNotificationProtocolVersion,omitempty"`
	// The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
	DefaultGcmNotificationProtocolVersion *string `json:"DefaultGcmNotificationProtocolVersion,omitempty"`
	// Callback configuration that enables delivery callbacks, default false
	DeliveryCallbackEnabled *bool `json:"DeliveryCallbackEnabled,omitempty"`
	// URL to send delivery status callback.
	DeliveryCallbackUrl *string `json:"DeliveryCallbackUrl,omitempty"`
	// Deprecated.
	FacebookMessengerPageId *string `json:"FacebookMessengerPageId,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
	FcmCredentialSid *string `json:"FcmCredentialSid,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
	GcmCredentialSid *string `json:"GcmCredentialSid,omitempty"`
	// Whether to log notifications. Can be: `true` or `false` and the default is `true`.
	LogEnabled *bool `json:"LogEnabled,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
	MessagingServiceSid *string `json:"MessagingServiceSid,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetAlexaSkillId 

func (params *UpdateServiceParams) SetAlexaSkillId(AlexaSkillId string) *UpdateServiceParams

func (*UpdateServiceParams) SetApnCredentialSid 

func (params *UpdateServiceParams) SetApnCredentialSid(ApnCredentialSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultAlexaNotificationProtocolVersion 

func (params *UpdateServiceParams) SetDefaultAlexaNotificationProtocolVersion(DefaultAlexaNotificationProtocolVersion string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultApnNotificationProtocolVersion 

func (params *UpdateServiceParams) SetDefaultApnNotificationProtocolVersion(DefaultApnNotificationProtocolVersion string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultFcmNotificationProtocolVersion 

func (params *UpdateServiceParams) SetDefaultFcmNotificationProtocolVersion(DefaultFcmNotificationProtocolVersion string) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultGcmNotificationProtocolVersion 

func (params *UpdateServiceParams) SetDefaultGcmNotificationProtocolVersion(DefaultGcmNotificationProtocolVersion string) *UpdateServiceParams

func (*UpdateServiceParams) SetDeliveryCallbackEnabled 

func (params *UpdateServiceParams) SetDeliveryCallbackEnabled(DeliveryCallbackEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetDeliveryCallbackUrl 

func (params *UpdateServiceParams) SetDeliveryCallbackUrl(DeliveryCallbackUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetFacebookMessengerPageId 

func (params *UpdateServiceParams) SetFacebookMessengerPageId(FacebookMessengerPageId string) *UpdateServiceParams

func (*UpdateServiceParams) SetFcmCredentialSid 

func (params *UpdateServiceParams) SetFcmCredentialSid(FcmCredentialSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetFriendlyName 

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

func (*UpdateServiceParams) SetGcmCredentialSid 

func (params *UpdateServiceParams) SetGcmCredentialSid(GcmCredentialSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetLogEnabled 

func (params *UpdateServiceParams) SetLogEnabled(LogEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetMessagingServiceSid 

func (params *UpdateServiceParams) SetMessagingServiceSid(MessagingServiceSid string) *UpdateServiceParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

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