notifications

Documentation

Overview

Package notifications contains auto-generated files. DO NOT MODIFY

Package notifications contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateNotificationInput) (*CreateNotificationResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateNotificationInput) (*CreateNotificationResponse, error)
• type ClientProperties
• type CreateNotificationInput
• type CreateNotificationResponse

Types

type Client

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

Client for managing service notification resources See https://www.twilio.com/docs/notify/api/notification-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the notifications client

func (Client) Create

func (c Client) Create(input *CreateNotificationInput) (*CreateNotificationResponse, error)

Create creates a service notification resource See https://www.twilio.com/docs/notify/api/notification-resource#create-a-notification-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateNotificationInput) (*CreateNotificationResponse, error)

CreateWithContext creates a service notification resource See https://www.twilio.com/docs/notify/api/notification-resource#create-a-notification-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the notifications resources

type CreateNotificationInput

type CreateNotificationInput struct {
	APN                 *string   `form:"Apn,omitempty"`
	Action              *string   `form:"Action,omitempty"`
	Body                *string   `form:"Body,omitempty"`
	Data                *string   `form:"Data,omitempty"`
	DeliveryCallbackURL *string   `form:"DeliveryCallbackUrl,omitempty"`
	FCM                 *string   `form:"Fcm,omitempty"`
	Identities          *[]string `form:"Identity,omitempty"`
	Priority            *string   `form:"Priority,omitempty"`
	SMS                 *string   `form:"Sms,omitempty"`
	Sound               *string   `form:"Sound,omitempty"`
	Tags                *[]string `form:"Tag,omitempty"`
	Title               *string   `form:"Title,omitempty"`
	ToBindings          *[]string `form:"ToBinding,omitempty"`
	Ttl                 *int      `form:"Ttl,omitempty"`
}

CreateNotificationInput defines the input fields for creating a new service notification

type CreateNotificationResponse

type CreateNotificationResponse struct {
	APN         *map[string]interface{} `json:"apn,omitempty"`
	AccountSid  string                  `json:"account_sid"`
	Action      *string                 `json:"action,omitempty"`
	Body        *string                 `json:"body,omitempty"`
	Data        *map[string]interface{} `json:"data,omitempty"`
	DateCreated time.Time               `json:"date_created"`
	FCM         *map[string]interface{} `json:"fcm,omitempty"`
	Identities  []string                `json:"identities"`
	Priority    string                  `json:"priority"`
	SMS         *map[string]interface{} `json:"sms,omitempty"`
	ServiceSid  string                  `json:"service_sid"`
	Sid         string                  `json:"sid"`
	Sound       *string                 `json:"sound,omitempty"`
	TTL         int                     `json:"ttl"`
	Tags        []string                `json:"tags"`
}

CreateNotificationResponse defines the response fields for the retrieved service notification