eventnotificationsv1

package
v0.0.7 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2022 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Overview

Package eventnotificationsv1 : Operations and models for the EventNotificationsV1 service

Index

Constants

View Source 
const (
	CreateDestinationOptionsTypePushAndroidConst = "push_android"
	CreateDestinationOptionsTypePushIosConst     = "push_ios"
	CreateDestinationOptionsTypeWebhookConst     = "webhook"
)

Constants associated with the CreateDestinationOptions.Type property. The type of Destination Webhook.

View Source 
const (
	DestinationTypePushAndroidConst = "push_android"
	DestinationTypePushIosConst     = "push_ios"
	DestinationTypeSMTPIBMConst     = "smtp_ibm"
	DestinationTypeSmsIBMConst      = "sms_ibm"
	DestinationTypeWebhookConst     = "webhook"
)

Constants associated with the Destination.Type property. Destination type Email/SMS/Webhook/FCM.

View Source 
const (
	DestinationConfigParamsVerbGetConst  = "get"
	DestinationConfigParamsVerbPostConst = "post"
)

Constants associated with the DestinationConfigParams.Verb property. HTTP method of webhook.

View Source 
const (
	DestinationListItemTypePushAndroidConst = "push_android"
	DestinationListItemTypePushIosConst     = "push_ios"
	DestinationListItemTypeSMTPIBMConst     = "smtp_ibm"
	DestinationListItemTypeSmsIBMConst      = "sms_ibm"
	DestinationListItemTypeWebhookConst     = "webhook"
)

Constants associated with the DestinationListItem.Type property. Destination type Email/SMS/Webhook.

View Source 
const (
	NotificationApnsBodyMessageDataTypeDefaultConst = "DEFAULT"
	NotificationApnsBodyMessageDataTypeMixedConst   = "MIXED"
	NotificationApnsBodyMessageDataTypeSilentConst  = "SILENT"
)

Constants associated with the NotificationApnsBodyMessageData.Type property.

View Source 
const (
	NotificationFcmBodyMessageDataTypeDefaultConst = "DEFAULT"
	NotificationFcmBodyMessageDataTypeSilentConst  = "SILENT"
)

Constants associated with the NotificationFcmBodyMessageData.Type property. Notification type.

View Source 
const (
	SubscriptionDestinationTypeSMTPIBMConst = "smtp_ibm"
	SubscriptionDestinationTypeSmsIBMConst  = "sms_ibm"
	SubscriptionDestinationTypeWebhookConst = "webhook"
)

Constants associated with the Subscription.DestinationType property. The type of destination.

View Source 
const (
	SubscriptionListItemDestinationTypeSMTPIBMConst = "smtp_ibm"
	SubscriptionListItemDestinationTypeSmsIBMConst  = "sms_ibm"
	SubscriptionListItemDestinationTypeWebhookConst = "webhook"
)

Constants associated with the SubscriptionListItem.DestinationType property. The type of destination.

View Source 
const (
	DestinationConfigParamsWebhookDestinationConfigVerbGetConst  = "get"
	DestinationConfigParamsWebhookDestinationConfigVerbPostConst = "post"
)

Constants associated with the DestinationConfigParamsWebhookDestinationConfig.Verb property. HTTP method of webhook.

View Source 
const DefaultServiceName = "event_notifications"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://us-south.event-notifications.cloud.ibm.com/event-notifications"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	DestinationResponseTypeWebhookConst = "webhook"
)

Constants associated with the DestinationResponse.Type property. Destination type Email/SMS/Webhook.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalDestination 

func UnmarshalDestination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestination unmarshals an instance of Destination from the specified map of raw messages.

func UnmarshalDestinationConfig 

func UnmarshalDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationConfig unmarshals an instance of DestinationConfig from the specified map of raw messages.

func UnmarshalDestinationConfigParams 

func UnmarshalDestinationConfigParams(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationConfigParams unmarshals an instance of DestinationConfigParams from the specified map of raw messages.

func UnmarshalDestinationConfigParamsFcmDestinationConfig added in v0.0.6 

func UnmarshalDestinationConfigParamsFcmDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationConfigParamsFcmDestinationConfig unmarshals an instance of DestinationConfigParamsFcmDestinationConfig from the specified map of raw messages.

func UnmarshalDestinationConfigParamsIosDestinationConfig added in v0.0.7 

func UnmarshalDestinationConfigParamsIosDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationConfigParamsIosDestinationConfig unmarshals an instance of DestinationConfigParamsIosDestinationConfig from the specified map of raw messages.

func UnmarshalDestinationConfigParamsWebhookDestinationConfig 

func UnmarshalDestinationConfigParamsWebhookDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationConfigParamsWebhookDestinationConfig unmarshals an instance of DestinationConfigParamsWebhookDestinationConfig from the specified map of raw messages.

func UnmarshalDestinationDevicesList added in v0.0.6 

func UnmarshalDestinationDevicesList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationDevicesList unmarshals an instance of DestinationDevicesList from the specified map of raw messages.

func UnmarshalDestinationDevicesListItem added in v0.0.6 

func UnmarshalDestinationDevicesListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationDevicesListItem unmarshals an instance of DestinationDevicesListItem from the specified map of raw messages.

func UnmarshalDestinationDevicesReport added in v0.0.6 

func UnmarshalDestinationDevicesReport(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationDevicesReport unmarshals an instance of DestinationDevicesReport from the specified map of raw messages.

func UnmarshalDestinationList 

func UnmarshalDestinationList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationList unmarshals an instance of DestinationList from the specified map of raw messages.

func UnmarshalDestinationListItem added in v0.0.6 

func UnmarshalDestinationListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationListItem unmarshals an instance of DestinationListItem from the specified map of raw messages.

func UnmarshalDestinationResponse 

func UnmarshalDestinationResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationResponse unmarshals an instance of DestinationResponse from the specified map of raw messages.

func UnmarshalDestinationTagsSubscriptionResponse added in v0.0.6 

func UnmarshalDestinationTagsSubscriptionResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDestinationTagsSubscriptionResponse unmarshals an instance of DestinationTagsSubscriptionResponse from the specified map of raw messages.

func UnmarshalEmailUpdateAttributesTo added in v0.0.5 

func UnmarshalEmailUpdateAttributesTo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEmailUpdateAttributesTo unmarshals an instance of EmailUpdateAttributesTo from the specified map of raw messages.

func UnmarshalEmailUpdateAttributesUnsubscribed added in v0.0.5 

func UnmarshalEmailUpdateAttributesUnsubscribed(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEmailUpdateAttributesUnsubscribed unmarshals an instance of EmailUpdateAttributesUnsubscribed from the specified map of raw messages.

func UnmarshalLights added in v0.0.6 

func UnmarshalLights(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLights unmarshals an instance of Lights from the specified map of raw messages.

func UnmarshalNotificationApnsBody added in v0.0.7 

func UnmarshalNotificationApnsBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationApnsBody unmarshals an instance of NotificationApnsBody from the specified map of raw messages.

func UnmarshalNotificationApnsBodyMessageData added in v0.0.7 

func UnmarshalNotificationApnsBodyMessageData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationApnsBodyMessageData unmarshals an instance of NotificationApnsBodyMessageData from the specified map of raw messages.

func UnmarshalNotificationApnsBodyMessageEnData added in v0.0.7 

func UnmarshalNotificationApnsBodyMessageEnData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationApnsBodyMessageEnData unmarshals an instance of NotificationApnsBodyMessageEnData from the specified map of raw messages.

func UnmarshalNotificationApnsBodyNotificationPayload added in v0.0.7 

func UnmarshalNotificationApnsBodyNotificationPayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationApnsBodyNotificationPayload unmarshals an instance of NotificationApnsBodyNotificationPayload from the specified map of raw messages.

func UnmarshalNotificationDevices added in v0.0.7 

func UnmarshalNotificationDevices(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationDevices unmarshals an instance of NotificationDevices from the specified map of raw messages.

func UnmarshalNotificationFcmBody added in v0.0.6 

func UnmarshalNotificationFcmBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationFcmBody unmarshals an instance of NotificationFcmBody from the specified map of raw messages.

func UnmarshalNotificationFcmBodyMessageData added in v0.0.6 

func UnmarshalNotificationFcmBodyMessageData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationFcmBodyMessageData unmarshals an instance of NotificationFcmBodyMessageData from the specified map of raw messages.

func UnmarshalNotificationFcmBodyMessageEnData added in v0.0.7 

func UnmarshalNotificationFcmBodyMessageEnData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationFcmBodyMessageEnData unmarshals an instance of NotificationFcmBodyMessageEnData from the specified map of raw messages.

func UnmarshalNotificationFcmBodyNotificationPayload added in v0.0.7 

func UnmarshalNotificationFcmBodyNotificationPayload(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationFcmBodyNotificationPayload unmarshals an instance of NotificationFcmBodyNotificationPayload from the specified map of raw messages.

func UnmarshalNotificationResponse added in v0.0.6 

func UnmarshalNotificationResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationResponse unmarshals an instance of NotificationResponse from the specified map of raw messages.

func UnmarshalRules 

func UnmarshalRules(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRules unmarshals an instance of Rules from the specified map of raw messages.

func UnmarshalRulesGet 

func UnmarshalRulesGet(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRulesGet unmarshals an instance of RulesGet from the specified map of raw messages.

func UnmarshalSource 

func UnmarshalSource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSource unmarshals an instance of Source from the specified map of raw messages.

func UnmarshalSourceList 

func UnmarshalSourceList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSourceList unmarshals an instance of SourceList from the specified map of raw messages.

func UnmarshalSourceListItem added in v0.0.6 

func UnmarshalSourceListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSourceListItem unmarshals an instance of SourceListItem from the specified map of raw messages.

func UnmarshalSourcesListItem 

func UnmarshalSourcesListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSourcesListItem unmarshals an instance of SourcesListItem from the specified map of raw messages.

func UnmarshalStyle added in v0.0.6 

func UnmarshalStyle(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalStyle unmarshals an instance of Style from the specified map of raw messages.

func UnmarshalSubscription 

func UnmarshalSubscription(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscription unmarshals an instance of Subscription from the specified map of raw messages.

func UnmarshalSubscriptionAttributes 

func UnmarshalSubscriptionAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionAttributes unmarshals an instance of SubscriptionAttributes from the specified map of raw messages.

func UnmarshalSubscriptionAttributesEmailAttributesResponse 

func UnmarshalSubscriptionAttributesEmailAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionAttributesEmailAttributesResponse unmarshals an instance of SubscriptionAttributesEmailAttributesResponse from the specified map of raw messages.

func UnmarshalSubscriptionAttributesSmsAttributesResponse 

func UnmarshalSubscriptionAttributesSmsAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionAttributesSmsAttributesResponse unmarshals an instance of SubscriptionAttributesSmsAttributesResponse from the specified map of raw messages.

func UnmarshalSubscriptionAttributesWebhookAttributesResponse 

func UnmarshalSubscriptionAttributesWebhookAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionAttributesWebhookAttributesResponse unmarshals an instance of SubscriptionAttributesWebhookAttributesResponse from the specified map of raw messages.

func UnmarshalSubscriptionCreateAttributes 

func UnmarshalSubscriptionCreateAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionCreateAttributes unmarshals an instance of SubscriptionCreateAttributes from the specified map of raw messages.

func UnmarshalSubscriptionCreateAttributesEmailAttributes 

func UnmarshalSubscriptionCreateAttributesEmailAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionCreateAttributesEmailAttributes unmarshals an instance of SubscriptionCreateAttributesEmailAttributes from the specified map of raw messages.

func UnmarshalSubscriptionCreateAttributesFcmAttributes added in v0.0.6 

func UnmarshalSubscriptionCreateAttributesFcmAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionCreateAttributesFcmAttributes unmarshals an instance of SubscriptionCreateAttributesFcmAttributes from the specified map of raw messages.

func UnmarshalSubscriptionCreateAttributesSmsAttributes 

func UnmarshalSubscriptionCreateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionCreateAttributesSmsAttributes unmarshals an instance of SubscriptionCreateAttributesSmsAttributes from the specified map of raw messages.

func UnmarshalSubscriptionCreateAttributesWebhookAttributes 

func UnmarshalSubscriptionCreateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionCreateAttributesWebhookAttributes unmarshals an instance of SubscriptionCreateAttributesWebhookAttributes from the specified map of raw messages.

func UnmarshalSubscriptionList 

func UnmarshalSubscriptionList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionList unmarshals an instance of SubscriptionList from the specified map of raw messages.

func UnmarshalSubscriptionListItem 

func UnmarshalSubscriptionListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionListItem unmarshals an instance of SubscriptionListItem from the specified map of raw messages.

func UnmarshalSubscriptionUpdateAttributes 

func UnmarshalSubscriptionUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionUpdateAttributes unmarshals an instance of SubscriptionUpdateAttributes from the specified map of raw messages.

func UnmarshalSubscriptionUpdateAttributesEmailUpdateAttributes added in v0.0.5 

func UnmarshalSubscriptionUpdateAttributesEmailUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionUpdateAttributesEmailUpdateAttributes unmarshals an instance of SubscriptionUpdateAttributesEmailUpdateAttributes from the specified map of raw messages.

func UnmarshalSubscriptionUpdateAttributesSmsAttributes 

func UnmarshalSubscriptionUpdateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionUpdateAttributesSmsAttributes unmarshals an instance of SubscriptionUpdateAttributesSmsAttributes from the specified map of raw messages.

func UnmarshalSubscriptionUpdateAttributesWebhookAttributes 

func UnmarshalSubscriptionUpdateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSubscriptionUpdateAttributesWebhookAttributes unmarshals an instance of SubscriptionUpdateAttributesWebhookAttributes from the specified map of raw messages.

func UnmarshalTagsSubscriptionList added in v0.0.6 

func UnmarshalTagsSubscriptionList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTagsSubscriptionList unmarshals an instance of TagsSubscriptionList from the specified map of raw messages.

func UnmarshalTagsSubscriptionListItem added in v0.0.6 

func UnmarshalTagsSubscriptionListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTagsSubscriptionListItem unmarshals an instance of TagsSubscriptionListItem from the specified map of raw messages.

func UnmarshalTopic 

func UnmarshalTopic(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopic unmarshals an instance of Topic from the specified map of raw messages.

func UnmarshalTopicList 

func UnmarshalTopicList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicList unmarshals an instance of TopicList from the specified map of raw messages.

func UnmarshalTopicResponse 

func UnmarshalTopicResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicResponse unmarshals an instance of TopicResponse from the specified map of raw messages.

func UnmarshalTopicUpdateSourcesItem 

func UnmarshalTopicUpdateSourcesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicUpdateSourcesItem unmarshals an instance of TopicUpdateSourcesItem from the specified map of raw messages.

func UnmarshalTopicsListItem 

func UnmarshalTopicsListItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicsListItem unmarshals an instance of TopicsListItem from the specified map of raw messages.

Types

type CreateDestinationOptions 

type CreateDestinationOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// The Destintion name.
	Name *string `json:"name" validate:"required"`

	// The type of Destination Webhook.
	Type *string `json:"type" validate:"required"`

	// The Destination description.
	Description *string `json:"description,omitempty"`

	// Payload describing a destination configuration.
	Config *DestinationConfig `json:"config,omitempty"`

	// Certificate for APNS.
	Certificate io.ReadCloser `json:"certificate,omitempty"`

	// The content type of certificate.
	CertificateContentType *string `json:"certificate_content_type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateDestinationOptions : The CreateDestination options.

func (*CreateDestinationOptions) SetCertificate added in v0.0.7 

func (_options *CreateDestinationOptions) SetCertificate(certificate io.ReadCloser) *CreateDestinationOptions

SetCertificate : Allow user to set Certificate

func (*CreateDestinationOptions) SetCertificateContentType added in v0.0.7 

func (_options *CreateDestinationOptions) SetCertificateContentType(certificateContentType string) *CreateDestinationOptions

SetCertificateContentType : Allow user to set CertificateContentType

func (*CreateDestinationOptions) SetConfig 

func (_options *CreateDestinationOptions) SetConfig(config *DestinationConfig) *CreateDestinationOptions

SetConfig : Allow user to set Config

func (*CreateDestinationOptions) SetDescription 

func (_options *CreateDestinationOptions) SetDescription(description string) *CreateDestinationOptions

SetDescription : Allow user to set Description

func (*CreateDestinationOptions) SetHeaders 

func (options *CreateDestinationOptions) SetHeaders(param map[string]string) *CreateDestinationOptions

SetHeaders : Allow user to set Headers

func (*CreateDestinationOptions) SetInstanceID 

func (_options *CreateDestinationOptions) SetInstanceID(instanceID string) *CreateDestinationOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateDestinationOptions) SetName 

func (_options *CreateDestinationOptions) SetName(name string) *CreateDestinationOptions

SetName : Allow user to set Name

func (*CreateDestinationOptions) SetType 

func (_options *CreateDestinationOptions) SetType(typeVar string) *CreateDestinationOptions

SetType : Allow user to set Type

type CreateSubscriptionOptions 

type CreateSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Subscription name.
	Name *string `json:"name" validate:"required"`

	// Destination ID.
	DestinationID *string `json:"destination_id" validate:"required"`

	// Topic ID.
	TopicID *string `json:"topic_id" validate:"required"`

	// Subscription description.
	Description *string `json:"description,omitempty"`

	Attributes SubscriptionCreateAttributesIntf `json:"attributes,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSubscriptionOptions : The CreateSubscription options.

func (*CreateSubscriptionOptions) SetAttributes 

func (_options *CreateSubscriptionOptions) SetAttributes(attributes SubscriptionCreateAttributesIntf) *CreateSubscriptionOptions

SetAttributes : Allow user to set Attributes

func (*CreateSubscriptionOptions) SetDescription 

func (_options *CreateSubscriptionOptions) SetDescription(description string) *CreateSubscriptionOptions

SetDescription : Allow user to set Description

func (*CreateSubscriptionOptions) SetDestinationID 

func (_options *CreateSubscriptionOptions) SetDestinationID(destinationID string) *CreateSubscriptionOptions

SetDestinationID : Allow user to set DestinationID

func (*CreateSubscriptionOptions) SetHeaders 

func (options *CreateSubscriptionOptions) SetHeaders(param map[string]string) *CreateSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*CreateSubscriptionOptions) SetInstanceID 

func (_options *CreateSubscriptionOptions) SetInstanceID(instanceID string) *CreateSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateSubscriptionOptions) SetName 

func (_options *CreateSubscriptionOptions) SetName(name string) *CreateSubscriptionOptions

SetName : Allow user to set Name

func (*CreateSubscriptionOptions) SetTopicID 

func (_options *CreateSubscriptionOptions) SetTopicID(topicID string) *CreateSubscriptionOptions

SetTopicID : Allow user to set TopicID

type CreateTagsSubscriptionOptions added in v0.0.6 

type CreateTagsSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Unique identifier of the device.
	DeviceID *string `json:"device_id" validate:"required"`

	// The name of the tag its subscribed.
	TagName *string `json:"tag_name" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTagsSubscriptionOptions : The CreateTagsSubscription options.

func (*CreateTagsSubscriptionOptions) SetDeviceID added in v0.0.6 

func (_options *CreateTagsSubscriptionOptions) SetDeviceID(deviceID string) *CreateTagsSubscriptionOptions

SetDeviceID : Allow user to set DeviceID

func (*CreateTagsSubscriptionOptions) SetHeaders added in v0.0.6 

func (options *CreateTagsSubscriptionOptions) SetHeaders(param map[string]string) *CreateTagsSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*CreateTagsSubscriptionOptions) SetID added in v0.0.6 

func (_options *CreateTagsSubscriptionOptions) SetID(id string) *CreateTagsSubscriptionOptions

SetID : Allow user to set ID

func (*CreateTagsSubscriptionOptions) SetInstanceID added in v0.0.6 

func (_options *CreateTagsSubscriptionOptions) SetInstanceID(instanceID string) *CreateTagsSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateTagsSubscriptionOptions) SetTagName added in v0.0.6 

func (_options *CreateTagsSubscriptionOptions) SetTagName(tagName string) *CreateTagsSubscriptionOptions

SetTagName : Allow user to set TagName

type CreateTopicOptions 

type CreateTopicOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Name of the topic.
	Name *string `json:"name" validate:"required"`

	// Description of the topic.
	Description *string `json:"description,omitempty"`

	// List of sources.
	Sources []TopicUpdateSourcesItem `json:"sources,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTopicOptions : The CreateTopic options.

func (*CreateTopicOptions) SetDescription 

func (_options *CreateTopicOptions) SetDescription(description string) *CreateTopicOptions

SetDescription : Allow user to set Description

func (*CreateTopicOptions) SetHeaders 

func (options *CreateTopicOptions) SetHeaders(param map[string]string) *CreateTopicOptions

SetHeaders : Allow user to set Headers

func (*CreateTopicOptions) SetInstanceID 

func (_options *CreateTopicOptions) SetInstanceID(instanceID string) *CreateTopicOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateTopicOptions) SetName 

func (_options *CreateTopicOptions) SetName(name string) *CreateTopicOptions

SetName : Allow user to set Name

func (*CreateTopicOptions) SetSources 

func (_options *CreateTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *CreateTopicOptions

SetSources : Allow user to set Sources

type DeleteDestinationOptions 

type DeleteDestinationOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDestinationOptions : The DeleteDestination options.

func (*DeleteDestinationOptions) SetHeaders 

func (options *DeleteDestinationOptions) SetHeaders(param map[string]string) *DeleteDestinationOptions

SetHeaders : Allow user to set Headers

func (*DeleteDestinationOptions) SetID 

func (_options *DeleteDestinationOptions) SetID(id string) *DeleteDestinationOptions

SetID : Allow user to set ID

func (*DeleteDestinationOptions) SetInstanceID 

func (_options *DeleteDestinationOptions) SetInstanceID(instanceID string) *DeleteDestinationOptions

SetInstanceID : Allow user to set InstanceID

type DeleteSubscriptionOptions 

type DeleteSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Subscription.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSubscriptionOptions : The DeleteSubscription options.

func (*DeleteSubscriptionOptions) SetHeaders 

func (options *DeleteSubscriptionOptions) SetHeaders(param map[string]string) *DeleteSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*DeleteSubscriptionOptions) SetID 

func (_options *DeleteSubscriptionOptions) SetID(id string) *DeleteSubscriptionOptions

SetID : Allow user to set ID

func (*DeleteSubscriptionOptions) SetInstanceID 

func (_options *DeleteSubscriptionOptions) SetInstanceID(instanceID string) *DeleteSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

type DeleteTagsSubscriptionOptions added in v0.0.6 

type DeleteTagsSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// DeviceID of the destination tagsubscription.
	DeviceID *string `json:"device_id,omitempty"`

	// TagName of the subscription.
	TagName *string `json:"tag_name,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTagsSubscriptionOptions : The DeleteTagsSubscription options.

func (*DeleteTagsSubscriptionOptions) SetDeviceID added in v0.0.6 

func (_options *DeleteTagsSubscriptionOptions) SetDeviceID(deviceID string) *DeleteTagsSubscriptionOptions

SetDeviceID : Allow user to set DeviceID

func (*DeleteTagsSubscriptionOptions) SetHeaders added in v0.0.6 

func (options *DeleteTagsSubscriptionOptions) SetHeaders(param map[string]string) *DeleteTagsSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*DeleteTagsSubscriptionOptions) SetID added in v0.0.6 

func (_options *DeleteTagsSubscriptionOptions) SetID(id string) *DeleteTagsSubscriptionOptions

SetID : Allow user to set ID

func (*DeleteTagsSubscriptionOptions) SetInstanceID added in v0.0.6 

func (_options *DeleteTagsSubscriptionOptions) SetInstanceID(instanceID string) *DeleteTagsSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

func (*DeleteTagsSubscriptionOptions) SetTagName added in v0.0.6 

func (_options *DeleteTagsSubscriptionOptions) SetTagName(tagName string) *DeleteTagsSubscriptionOptions

SetTagName : Allow user to set TagName

type DeleteTopicOptions 

type DeleteTopicOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Topic.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTopicOptions : The DeleteTopic options.

func (*DeleteTopicOptions) SetHeaders 

func (options *DeleteTopicOptions) SetHeaders(param map[string]string) *DeleteTopicOptions

SetHeaders : Allow user to set Headers

func (*DeleteTopicOptions) SetID 

func (_options *DeleteTopicOptions) SetID(id string) *DeleteTopicOptions

SetID : Allow user to set ID

func (*DeleteTopicOptions) SetInstanceID 

func (_options *DeleteTopicOptions) SetInstanceID(instanceID string) *DeleteTopicOptions

SetInstanceID : Allow user to set InstanceID

type Destination 

type Destination struct {
	// Destination ID.
	ID *string `json:"id" validate:"required"`

	// Destination name.
	Name *string `json:"name" validate:"required"`

	// Destination description.
	Description *string `json:"description" validate:"required"`

	// Destination type Email/SMS/Webhook/FCM.
	Type *string `json:"type" validate:"required"`

	// Payload describing a destination configuration.
	Config *DestinationConfig `json:"config,omitempty"`

	// Last updated time.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Number of subscriptions.
	SubscriptionCount *int64 `json:"subscription_count" validate:"required"`

	// List of subscriptions.
	SubscriptionNames []string `json:"subscription_names" validate:"required"`
}

Destination : Payload describing a destination get request.

type DestinationConfig 

type DestinationConfig struct {
	Params DestinationConfigParamsIntf `json:"params" validate:"required"`
}

DestinationConfig : Payload describing a destination configuration.

type DestinationConfigParams 

type DestinationConfigParams struct {
	// URL of webhook.
	URL *string `json:"url,omitempty"`

	// HTTP method of webhook.
	Verb *string `json:"verb,omitempty"`

	// Custom headers (Key-Value pair) for webhook call.
	CustomHeaders map[string]string `json:"custom_headers,omitempty"`

	// List of sensitive headers from custom headers.
	SensitiveHeaders []string `json:"sensitive_headers,omitempty"`

	// FCM server_key.
	ServerKey *string `json:"server_key,omitempty"`

	// FCM sender_id.
	SenderID *string `json:"sender_id,omitempty"`

	// Authentication type (p8 or p12).
	CertType *string `json:"cert_type,omitempty"`

	// Sandbox mode for IOS destinations.
	IsSandbox *bool `json:"is_sandbox,omitempty"`

	// Password for certificate (Required when cert_type is p12).
	Password *string `json:"password,omitempty"`

	// Key ID for token (Required when cert_type is p8).
	KeyID *string `json:"key_id,omitempty"`

	// Team ID for token (Required when cert_type is p8).
	TeamID *string `json:"team_id,omitempty"`

	// Bundle ID for token (Required when cert_type is p8).
	BundleID *string `json:"bundle_id,omitempty"`
}

DestinationConfigParams : DestinationConfigParams struct Models which "extend" this model: - DestinationConfigParamsWebhookDestinationConfig - DestinationConfigParamsFcmDestinationConfig - DestinationConfigParamsIosDestinationConfig

type DestinationConfigParamsFcmDestinationConfig added in v0.0.6 

type DestinationConfigParamsFcmDestinationConfig struct {
	// FCM server_key.
	ServerKey *string `json:"server_key" validate:"required"`

	// FCM sender_id.
	SenderID *string `json:"sender_id" validate:"required"`
}

DestinationConfigParamsFcmDestinationConfig : Payload describing a FCM destination configuration. This model "extends" DestinationConfigParams

type DestinationConfigParamsIntf 

type DestinationConfigParamsIntf interface {
	// contains filtered or unexported methods
}

type DestinationConfigParamsIosDestinationConfig added in v0.0.7 

type DestinationConfigParamsIosDestinationConfig struct {
	// Authentication type (p8 or p12).
	CertType *string `json:"cert_type" validate:"required"`

	// Sandbox mode for IOS destinations.
	IsSandbox *bool `json:"is_sandbox" validate:"required"`

	// Password for certificate (Required when cert_type is p12).
	Password *string `json:"password,omitempty"`

	// Key ID for token (Required when cert_type is p8).
	KeyID *string `json:"key_id,omitempty"`

	// Team ID for token (Required when cert_type is p8).
	TeamID *string `json:"team_id,omitempty"`

	// Bundle ID for token (Required when cert_type is p8).
	BundleID *string `json:"bundle_id,omitempty"`
}

DestinationConfigParamsIosDestinationConfig : Payload describing a IOS destination configuration. This model "extends" DestinationConfigParams

type DestinationConfigParamsWebhookDestinationConfig 

type DestinationConfigParamsWebhookDestinationConfig struct {
	// URL of webhook.
	URL *string `json:"url" validate:"required"`

	// HTTP method of webhook.
	Verb *string `json:"verb" validate:"required"`

	// Custom headers (Key-Value pair) for webhook call.
	CustomHeaders map[string]string `json:"custom_headers,omitempty"`

	// List of sensitive headers from custom headers.
	SensitiveHeaders []string `json:"sensitive_headers,omitempty"`
}

DestinationConfigParamsWebhookDestinationConfig : Payload describing a webhook destination configuration. This model "extends" DestinationConfigParams

type DestinationDevicesList added in v0.0.6 

type DestinationDevicesList struct {
	// Total number of destination devices.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show destination devices.
	Limit *int64 `json:"limit" validate:"required"`

	// List of devices.
	Devices []DestinationDevicesListItem `json:"devices" validate:"required"`
}

DestinationDevicesList : Payload describing a destination devices list request.

type DestinationDevicesListItem added in v0.0.6 

type DestinationDevicesListItem struct {
	// device ID.
	ID *string `json:"id" validate:"required"`

	// user ID.
	UserID *string `json:"user_id,omitempty"`

	// Destination platform.
	Platform *string `json:"platform" validate:"required"`

	// Destination device token.
	Token *string `json:"token" validate:"required"`

	// Updated at.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

DestinationDevicesListItem : device object.

type DestinationDevicesReport added in v0.0.6 

type DestinationDevicesReport struct {
	// Android Devices Registered.
	Android *int64 `json:"android" validate:"required"`

	// ios Devices Registered.
	Ios *int64 `json:"ios" validate:"required"`

	// chrome web Devices Registered.
	Chrome *int64 `json:"chrome" validate:"required"`

	// firefox web Devices Registered.
	Firefox *int64 `json:"firefox" validate:"required"`

	// safari web Devices Registered.
	Safari *int64 `json:"safari" validate:"required"`

	// chromeAppExt Devices Registered.
	ChromeAppExt *int64 `json:"chromeAppExt" validate:"required"`

	// Total Devices Registered.
	All *int64 `json:"all" validate:"required"`
}

DestinationDevicesReport : Payload describing a destination devices report.

type DestinationList 

type DestinationList struct {
	// Total number of destinations.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show destinations.
	Limit *int64 `json:"limit" validate:"required"`

	// List of destinations.
	Destinations []DestinationListItem `json:"destinations" validate:"required"`
}

DestinationList : Payload describing a destination list request.

type DestinationListItem added in v0.0.6 

type DestinationListItem struct {
	// Destination ID.
	ID *string `json:"id" validate:"required"`

	// Destination name.
	Name *string `json:"name" validate:"required"`

	// Destination description.
	Description *string `json:"description" validate:"required"`

	// Destination type Email/SMS/Webhook.
	Type *string `json:"type" validate:"required"`

	// Subscription count.
	SubscriptionCount *int64 `json:"subscription_count" validate:"required"`

	// Names of subscriptions.
	SubscriptionNames []string `json:"subscription_names" validate:"required"`

	// Updated at.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

DestinationListItem : Destination object.

type DestinationResponse 

type DestinationResponse struct {
	// Destination ID.
	ID *string `json:"id" validate:"required"`

	// Destination name.
	Name *string `json:"name" validate:"required"`

	// Destination description.
	Description *string `json:"description" validate:"required"`

	// Destination type Email/SMS/Webhook.
	Type *string `json:"type" validate:"required"`

	// Payload describing a destination configuration.
	Config *DestinationConfig `json:"config" validate:"required"`

	// Last updated time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
}

DestinationResponse : Payload describing a destination get request.

type DestinationTagsSubscriptionResponse added in v0.0.6 

type DestinationTagsSubscriptionResponse struct {
	// Subscription Tag ID.
	ID *string `json:"id" validate:"required"`

	// Unique identifier of the device.
	DeviceID *string `json:"device_id" validate:"required"`

	// The name of the tag its subscribed.
	TagName *string `json:"tag_name" validate:"required"`

	// The user identifier for the the device registration.
	UserID *string `json:"user_id,omitempty"`

	// Last updated time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`
}

DestinationTagsSubscriptionResponse : Payload describing a destination get request.

type EmailUpdateAttributesTo added in v0.0.5 

type EmailUpdateAttributesTo struct {
	// The email ids.
	Add []string `json:"add,omitempty"`

	// The email ids for removal.
	Remove []string `json:"remove,omitempty"`
}

EmailUpdateAttributesTo : The email ids.

type EmailUpdateAttributesUnsubscribed added in v0.0.5 

type EmailUpdateAttributesUnsubscribed struct {
	// The email ids unsubscribed.
	Remove []string `json:"remove,omitempty"`
}

EmailUpdateAttributesUnsubscribed : The email ids.

type EventNotificationsV1 

type EventNotificationsV1 struct {
	Service *core.BaseService
}

EventNotificationsV1 : No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

API Version: 1.0

func NewEventNotificationsV1 

func NewEventNotificationsV1(options *EventNotificationsV1Options) (service *EventNotificationsV1, err error)

NewEventNotificationsV1 : constructs an instance of EventNotificationsV1 with passed in options.

func NewEventNotificationsV1UsingExternalConfig 

func NewEventNotificationsV1UsingExternalConfig(options *EventNotificationsV1Options) (eventNotifications *EventNotificationsV1, err error)

NewEventNotificationsV1UsingExternalConfig : constructs an instance of EventNotificationsV1 with passed in options and external configuration.

func (*EventNotificationsV1) Clone 

func (eventNotifications *EventNotificationsV1) Clone() *EventNotificationsV1

Clone makes a copy of "eventNotifications" suitable for processing requests.

func (*EventNotificationsV1) CreateDestination 

func (eventNotifications *EventNotificationsV1) CreateDestination(createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)

CreateDestination : Create a new Destination Create a new Destination.

func (*EventNotificationsV1) CreateDestinationWithContext 

func (eventNotifications *EventNotificationsV1) CreateDestinationWithContext(ctx context.Context, createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)

CreateDestinationWithContext is an alternate form of the CreateDestination method which supports a Context parameter

func (*EventNotificationsV1) CreateSubscription 

func (eventNotifications *EventNotificationsV1) CreateSubscription(createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

CreateSubscription : Create a new Subscription Create a new Subscription.

func (*EventNotificationsV1) CreateSubscriptionWithContext 

func (eventNotifications *EventNotificationsV1) CreateSubscriptionWithContext(ctx context.Context, createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

CreateSubscriptionWithContext is an alternate form of the CreateSubscription method which supports a Context parameter

func (*EventNotificationsV1) CreateTagsSubscription added in v0.0.6 

func (eventNotifications *EventNotificationsV1) CreateTagsSubscription(createTagsSubscriptionOptions *CreateTagsSubscriptionOptions) (result *DestinationTagsSubscriptionResponse, response *core.DetailedResponse, err error)

CreateTagsSubscription : Create a new Tag subscription Create a new Tag subscription.

func (*EventNotificationsV1) CreateTagsSubscriptionWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) CreateTagsSubscriptionWithContext(ctx context.Context, createTagsSubscriptionOptions *CreateTagsSubscriptionOptions) (result *DestinationTagsSubscriptionResponse, response *core.DetailedResponse, err error)

CreateTagsSubscriptionWithContext is an alternate form of the CreateTagsSubscription method which supports a Context parameter

func (*EventNotificationsV1) CreateTopic 

func (eventNotifications *EventNotificationsV1) CreateTopic(createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)

CreateTopic : Create a new Topic Create a new Topic.

func (*EventNotificationsV1) CreateTopicWithContext 

func (eventNotifications *EventNotificationsV1) CreateTopicWithContext(ctx context.Context, createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)

CreateTopicWithContext is an alternate form of the CreateTopic method which supports a Context parameter

func (*EventNotificationsV1) DeleteDestination 

func (eventNotifications *EventNotificationsV1) DeleteDestination(deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)

DeleteDestination : Delete a Destination Delete a Destination.

func (*EventNotificationsV1) DeleteDestinationWithContext 

func (eventNotifications *EventNotificationsV1) DeleteDestinationWithContext(ctx context.Context, deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)

DeleteDestinationWithContext is an alternate form of the DeleteDestination method which supports a Context parameter

func (*EventNotificationsV1) DeleteSubscription 

func (eventNotifications *EventNotificationsV1) DeleteSubscription(deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)

DeleteSubscription : Delete a Subscription Delete a Subscription.

func (*EventNotificationsV1) DeleteSubscriptionWithContext 

func (eventNotifications *EventNotificationsV1) DeleteSubscriptionWithContext(ctx context.Context, deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)

DeleteSubscriptionWithContext is an alternate form of the DeleteSubscription method which supports a Context parameter

func (*EventNotificationsV1) DeleteTagsSubscription added in v0.0.6 

func (eventNotifications *EventNotificationsV1) DeleteTagsSubscription(deleteTagsSubscriptionOptions *DeleteTagsSubscriptionOptions) (response *core.DetailedResponse, err error)

DeleteTagsSubscription : Delete a Tag subcription Delete a Tag subcription.

func (*EventNotificationsV1) DeleteTagsSubscriptionWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) DeleteTagsSubscriptionWithContext(ctx context.Context, deleteTagsSubscriptionOptions *DeleteTagsSubscriptionOptions) (response *core.DetailedResponse, err error)

DeleteTagsSubscriptionWithContext is an alternate form of the DeleteTagsSubscription method which supports a Context parameter

func (*EventNotificationsV1) DeleteTopic 

func (eventNotifications *EventNotificationsV1) DeleteTopic(deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)

DeleteTopic : Delete a Topic Delete a Topic.

func (*EventNotificationsV1) DeleteTopicWithContext 

func (eventNotifications *EventNotificationsV1) DeleteTopicWithContext(ctx context.Context, deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)

DeleteTopicWithContext is an alternate form of the DeleteTopic method which supports a Context parameter

func (*EventNotificationsV1) DisableRetries 

func (eventNotifications *EventNotificationsV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*EventNotificationsV1) EnableRetries 

func (eventNotifications *EventNotificationsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*EventNotificationsV1) GetDestination 

func (eventNotifications *EventNotificationsV1) GetDestination(getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)

GetDestination : Get details of a Destination Get details of a Destination.

func (*EventNotificationsV1) GetDestinationDevicesReport added in v0.0.6 

func (eventNotifications *EventNotificationsV1) GetDestinationDevicesReport(getDestinationDevicesReportOptions *GetDestinationDevicesReportOptions) (result *DestinationDevicesReport, response *core.DetailedResponse, err error)

GetDestinationDevicesReport : Retrieves report of destination devices registered Retrieves report of destination devices registered.

func (*EventNotificationsV1) GetDestinationDevicesReportWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) GetDestinationDevicesReportWithContext(ctx context.Context, getDestinationDevicesReportOptions *GetDestinationDevicesReportOptions) (result *DestinationDevicesReport, response *core.DetailedResponse, err error)

GetDestinationDevicesReportWithContext is an alternate form of the GetDestinationDevicesReport method which supports a Context parameter

func (*EventNotificationsV1) GetDestinationWithContext 

func (eventNotifications *EventNotificationsV1) GetDestinationWithContext(ctx context.Context, getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)

GetDestinationWithContext is an alternate form of the GetDestination method which supports a Context parameter

func (*EventNotificationsV1) GetEnableGzipCompression 

func (eventNotifications *EventNotificationsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*EventNotificationsV1) GetServiceURL 

func (eventNotifications *EventNotificationsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*EventNotificationsV1) GetSource 

func (eventNotifications *EventNotificationsV1) GetSource(getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)

GetSource : Get a Source Get a Sources.

func (*EventNotificationsV1) GetSourceWithContext 

func (eventNotifications *EventNotificationsV1) GetSourceWithContext(ctx context.Context, getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)

GetSourceWithContext is an alternate form of the GetSource method which supports a Context parameter

func (*EventNotificationsV1) GetSubscription 

func (eventNotifications *EventNotificationsV1) GetSubscription(getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

GetSubscription : Get details of a Subscription Get details of a Subscription.

func (*EventNotificationsV1) GetSubscriptionWithContext 

func (eventNotifications *EventNotificationsV1) GetSubscriptionWithContext(ctx context.Context, getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

GetSubscriptionWithContext is an alternate form of the GetSubscription method which supports a Context parameter

func (*EventNotificationsV1) GetTopic 

func (eventNotifications *EventNotificationsV1) GetTopic(getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)

GetTopic : Get details of a Topic Get details of a Topic.

func (*EventNotificationsV1) GetTopicWithContext 

func (eventNotifications *EventNotificationsV1) GetTopicWithContext(ctx context.Context, getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)

GetTopicWithContext is an alternate form of the GetTopic method which supports a Context parameter

func (*EventNotificationsV1) ListDestinationDevices added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListDestinationDevices(listDestinationDevicesOptions *ListDestinationDevicesOptions) (result *DestinationDevicesList, response *core.DetailedResponse, err error)

ListDestinationDevices : Get list of Destination devices Get list of Destination devices.

func (*EventNotificationsV1) ListDestinationDevicesWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListDestinationDevicesWithContext(ctx context.Context, listDestinationDevicesOptions *ListDestinationDevicesOptions) (result *DestinationDevicesList, response *core.DetailedResponse, err error)

ListDestinationDevicesWithContext is an alternate form of the ListDestinationDevices method which supports a Context parameter

func (*EventNotificationsV1) ListDestinations 

func (eventNotifications *EventNotificationsV1) ListDestinations(listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)

ListDestinations : List all Destinations List all Destinations.

func (*EventNotificationsV1) ListDestinationsWithContext 

func (eventNotifications *EventNotificationsV1) ListDestinationsWithContext(ctx context.Context, listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)

ListDestinationsWithContext is an alternate form of the ListDestinations method which supports a Context parameter

func (*EventNotificationsV1) ListSources 

func (eventNotifications *EventNotificationsV1) ListSources(listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)

ListSources : List all Sources List all Sources.

func (*EventNotificationsV1) ListSourcesWithContext 

func (eventNotifications *EventNotificationsV1) ListSourcesWithContext(ctx context.Context, listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)

ListSourcesWithContext is an alternate form of the ListSources method which supports a Context parameter

func (*EventNotificationsV1) ListSubscriptions 

func (eventNotifications *EventNotificationsV1) ListSubscriptions(listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)

ListSubscriptions : List all Subscriptions List all Subscriptions.

func (*EventNotificationsV1) ListSubscriptionsWithContext 

func (eventNotifications *EventNotificationsV1) ListSubscriptionsWithContext(ctx context.Context, listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)

ListSubscriptionsWithContext is an alternate form of the ListSubscriptions method which supports a Context parameter

func (*EventNotificationsV1) ListTagsSubscription added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListTagsSubscription(listTagsSubscriptionOptions *ListTagsSubscriptionOptions) (result *TagsSubscriptionList, response *core.DetailedResponse, err error)

ListTagsSubscription : List all Tag Subscriptions List all Tag Subscriptions.

func (*EventNotificationsV1) ListTagsSubscriptionWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListTagsSubscriptionWithContext(ctx context.Context, listTagsSubscriptionOptions *ListTagsSubscriptionOptions) (result *TagsSubscriptionList, response *core.DetailedResponse, err error)

ListTagsSubscriptionWithContext is an alternate form of the ListTagsSubscription method which supports a Context parameter

func (*EventNotificationsV1) ListTagsSubscriptionsDevice added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListTagsSubscriptionsDevice(listTagsSubscriptionsDeviceOptions *ListTagsSubscriptionsDeviceOptions) (result *TagsSubscriptionList, response *core.DetailedResponse, err error)

ListTagsSubscriptionsDevice : List all Tag Subscriptions for a device List all Tag Subscriptions for a device.

func (*EventNotificationsV1) ListTagsSubscriptionsDeviceWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) ListTagsSubscriptionsDeviceWithContext(ctx context.Context, listTagsSubscriptionsDeviceOptions *ListTagsSubscriptionsDeviceOptions) (result *TagsSubscriptionList, response *core.DetailedResponse, err error)

ListTagsSubscriptionsDeviceWithContext is an alternate form of the ListTagsSubscriptionsDevice method which supports a Context parameter

func (*EventNotificationsV1) ListTopics 

func (eventNotifications *EventNotificationsV1) ListTopics(listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)

ListTopics : List all Topics List all Topics.

func (*EventNotificationsV1) ListTopicsWithContext 

func (eventNotifications *EventNotificationsV1) ListTopicsWithContext(ctx context.Context, listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)

ListTopicsWithContext is an alternate form of the ListTopics method which supports a Context parameter

func (*EventNotificationsV1) NewCreateDestinationOptions 

func (*EventNotificationsV1) NewCreateDestinationOptions(instanceID string, name string, typeVar string) *CreateDestinationOptions

NewCreateDestinationOptions : Instantiate CreateDestinationOptions

func (*EventNotificationsV1) NewCreateSubscriptionOptions 

func (*EventNotificationsV1) NewCreateSubscriptionOptions(instanceID string, name string, destinationID string, topicID string) *CreateSubscriptionOptions

NewCreateSubscriptionOptions : Instantiate CreateSubscriptionOptions

func (*EventNotificationsV1) NewCreateTagsSubscriptionOptions added in v0.0.6 

func (*EventNotificationsV1) NewCreateTagsSubscriptionOptions(instanceID string, id string, deviceID string, tagName string) *CreateTagsSubscriptionOptions

NewCreateTagsSubscriptionOptions : Instantiate CreateTagsSubscriptionOptions

func (*EventNotificationsV1) NewCreateTopicOptions 

func (*EventNotificationsV1) NewCreateTopicOptions(instanceID string, name string) *CreateTopicOptions

NewCreateTopicOptions : Instantiate CreateTopicOptions

func (*EventNotificationsV1) NewDeleteDestinationOptions 

func (*EventNotificationsV1) NewDeleteDestinationOptions(instanceID string, id string) *DeleteDestinationOptions

NewDeleteDestinationOptions : Instantiate DeleteDestinationOptions

func (*EventNotificationsV1) NewDeleteSubscriptionOptions 

func (*EventNotificationsV1) NewDeleteSubscriptionOptions(instanceID string, id string) *DeleteSubscriptionOptions

NewDeleteSubscriptionOptions : Instantiate DeleteSubscriptionOptions

func (*EventNotificationsV1) NewDeleteTagsSubscriptionOptions added in v0.0.6 

func (*EventNotificationsV1) NewDeleteTagsSubscriptionOptions(instanceID string, id string) *DeleteTagsSubscriptionOptions

NewDeleteTagsSubscriptionOptions : Instantiate DeleteTagsSubscriptionOptions

func (*EventNotificationsV1) NewDeleteTopicOptions 

func (*EventNotificationsV1) NewDeleteTopicOptions(instanceID string, id string) *DeleteTopicOptions

NewDeleteTopicOptions : Instantiate DeleteTopicOptions

func (*EventNotificationsV1) NewDestinationConfig 

func (*EventNotificationsV1) NewDestinationConfig(params DestinationConfigParamsIntf) (_model *DestinationConfig, err error)

NewDestinationConfig : Instantiate DestinationConfig (Generic Model Constructor)

func (*EventNotificationsV1) NewDestinationConfigParamsFcmDestinationConfig added in v0.0.6 

func (*EventNotificationsV1) NewDestinationConfigParamsFcmDestinationConfig(serverKey string, senderID string) (_model *DestinationConfigParamsFcmDestinationConfig, err error)

NewDestinationConfigParamsFcmDestinationConfig : Instantiate DestinationConfigParamsFcmDestinationConfig (Generic Model Constructor)

func (*EventNotificationsV1) NewDestinationConfigParamsIosDestinationConfig added in v0.0.7 

func (*EventNotificationsV1) NewDestinationConfigParamsIosDestinationConfig(certType string, isSandbox bool) (_model *DestinationConfigParamsIosDestinationConfig, err error)

NewDestinationConfigParamsIosDestinationConfig : Instantiate DestinationConfigParamsIosDestinationConfig (Generic Model Constructor)

func (*EventNotificationsV1) NewDestinationConfigParamsWebhookDestinationConfig 

func (*EventNotificationsV1) NewDestinationConfigParamsWebhookDestinationConfig(url string, verb string) (_model *DestinationConfigParamsWebhookDestinationConfig, err error)

NewDestinationConfigParamsWebhookDestinationConfig : Instantiate DestinationConfigParamsWebhookDestinationConfig (Generic Model Constructor)

func (*EventNotificationsV1) NewGetDestinationDevicesReportOptions added in v0.0.6 

func (*EventNotificationsV1) NewGetDestinationDevicesReportOptions(instanceID string, id string) *GetDestinationDevicesReportOptions

NewGetDestinationDevicesReportOptions : Instantiate GetDestinationDevicesReportOptions

func (*EventNotificationsV1) NewGetDestinationOptions 

func (*EventNotificationsV1) NewGetDestinationOptions(instanceID string, id string) *GetDestinationOptions

NewGetDestinationOptions : Instantiate GetDestinationOptions

func (*EventNotificationsV1) NewGetSourceOptions 

func (*EventNotificationsV1) NewGetSourceOptions(instanceID string, id string) *GetSourceOptions

NewGetSourceOptions : Instantiate GetSourceOptions

func (*EventNotificationsV1) NewGetSubscriptionOptions 

func (*EventNotificationsV1) NewGetSubscriptionOptions(instanceID string, id string) *GetSubscriptionOptions

NewGetSubscriptionOptions : Instantiate GetSubscriptionOptions

func (*EventNotificationsV1) NewGetTopicOptions 

func (*EventNotificationsV1) NewGetTopicOptions(instanceID string, id string) *GetTopicOptions

NewGetTopicOptions : Instantiate GetTopicOptions

func (*EventNotificationsV1) NewListDestinationDevicesOptions added in v0.0.6 

func (*EventNotificationsV1) NewListDestinationDevicesOptions(instanceID string, id string) *ListDestinationDevicesOptions

NewListDestinationDevicesOptions : Instantiate ListDestinationDevicesOptions

func (*EventNotificationsV1) NewListDestinationsOptions 

func (*EventNotificationsV1) NewListDestinationsOptions(instanceID string) *ListDestinationsOptions

NewListDestinationsOptions : Instantiate ListDestinationsOptions

func (*EventNotificationsV1) NewListSourcesOptions 

func (*EventNotificationsV1) NewListSourcesOptions(instanceID string) *ListSourcesOptions

NewListSourcesOptions : Instantiate ListSourcesOptions

func (*EventNotificationsV1) NewListSubscriptionsOptions 

func (*EventNotificationsV1) NewListSubscriptionsOptions(instanceID string) *ListSubscriptionsOptions

NewListSubscriptionsOptions : Instantiate ListSubscriptionsOptions

func (*EventNotificationsV1) NewListTagsSubscriptionOptions added in v0.0.6 

func (*EventNotificationsV1) NewListTagsSubscriptionOptions(instanceID string, id string) *ListTagsSubscriptionOptions

NewListTagsSubscriptionOptions : Instantiate ListTagsSubscriptionOptions

func (*EventNotificationsV1) NewListTagsSubscriptionsDeviceOptions added in v0.0.6 

func (*EventNotificationsV1) NewListTagsSubscriptionsDeviceOptions(instanceID string, id string, deviceID string) *ListTagsSubscriptionsDeviceOptions

NewListTagsSubscriptionsDeviceOptions : Instantiate ListTagsSubscriptionsDeviceOptions

func (*EventNotificationsV1) NewListTopicsOptions 

func (*EventNotificationsV1) NewListTopicsOptions(instanceID string) *ListTopicsOptions

NewListTopicsOptions : Instantiate ListTopicsOptions

func (*EventNotificationsV1) NewNotificationApnsBodyMessageData added in v0.0.7 

func (*EventNotificationsV1) NewNotificationApnsBodyMessageData(alert string) (_model *NotificationApnsBodyMessageData, err error)

NewNotificationApnsBodyMessageData : Instantiate NotificationApnsBodyMessageData (Generic Model Constructor)

func (*EventNotificationsV1) NewNotificationFcmBodyMessageData added in v0.0.6 

func (*EventNotificationsV1) NewNotificationFcmBodyMessageData(alert string) (_model *NotificationFcmBodyMessageData, err error)

NewNotificationFcmBodyMessageData : Instantiate NotificationFcmBodyMessageData (Generic Model Constructor)

func (*EventNotificationsV1) NewReplaceTopicOptions 

func (*EventNotificationsV1) NewReplaceTopicOptions(instanceID string, id string) *ReplaceTopicOptions

NewReplaceTopicOptions : Instantiate ReplaceTopicOptions

func (*EventNotificationsV1) NewRules 

func (*EventNotificationsV1) NewRules(eventTypeFilter string) (_model *Rules, err error)

NewRules : Instantiate Rules (Generic Model Constructor)

func (*EventNotificationsV1) NewSendNotificationsOptions added in v0.0.6 

func (*EventNotificationsV1) NewSendNotificationsOptions(instanceID string, subject string, severity string, id string, source string, enSourceID string, typeVar string, time *strfmt.DateTime) *SendNotificationsOptions

NewSendNotificationsOptions : Instantiate SendNotificationsOptions

func (*EventNotificationsV1) NewSubscriptionCreateAttributesEmailAttributes 

func (*EventNotificationsV1) NewSubscriptionCreateAttributesEmailAttributes(to []string, addNotificationPayload bool, replyToMail string, replyToName string, fromName string) (_model *SubscriptionCreateAttributesEmailAttributes, err error)

NewSubscriptionCreateAttributesEmailAttributes : Instantiate SubscriptionCreateAttributesEmailAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewSubscriptionCreateAttributesSmsAttributes 

func (*EventNotificationsV1) NewSubscriptionCreateAttributesSmsAttributes(to []string) (_model *SubscriptionCreateAttributesSmsAttributes, err error)

NewSubscriptionCreateAttributesSmsAttributes : Instantiate SubscriptionCreateAttributesSmsAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewSubscriptionCreateAttributesWebhookAttributes 

func (*EventNotificationsV1) NewSubscriptionCreateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionCreateAttributesWebhookAttributes, err error)

NewSubscriptionCreateAttributesWebhookAttributes : Instantiate SubscriptionCreateAttributesWebhookAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesEmailUpdateAttributes added in v0.0.5 

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesEmailUpdateAttributes(to *EmailUpdateAttributesTo, addNotificationPayload bool, replyToMail string, replyToName string, fromName string) (_model *SubscriptionUpdateAttributesEmailUpdateAttributes, err error)

NewSubscriptionUpdateAttributesEmailUpdateAttributes : Instantiate SubscriptionUpdateAttributesEmailUpdateAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesSmsAttributes 

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesSmsAttributes(to []string) (_model *SubscriptionUpdateAttributesSmsAttributes, err error)

NewSubscriptionUpdateAttributesSmsAttributes : Instantiate SubscriptionUpdateAttributesSmsAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesWebhookAttributes 

func (*EventNotificationsV1) NewSubscriptionUpdateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionUpdateAttributesWebhookAttributes, err error)

NewSubscriptionUpdateAttributesWebhookAttributes : Instantiate SubscriptionUpdateAttributesWebhookAttributes (Generic Model Constructor)

func (*EventNotificationsV1) NewTopicUpdateSourcesItem 

func (*EventNotificationsV1) NewTopicUpdateSourcesItem(id string, rules []Rules) (_model *TopicUpdateSourcesItem, err error)

NewTopicUpdateSourcesItem : Instantiate TopicUpdateSourcesItem (Generic Model Constructor)

func (*EventNotificationsV1) NewUpdateDestinationOptions 

func (*EventNotificationsV1) NewUpdateDestinationOptions(instanceID string, id string) *UpdateDestinationOptions

NewUpdateDestinationOptions : Instantiate UpdateDestinationOptions

func (*EventNotificationsV1) NewUpdateSubscriptionOptions 

func (*EventNotificationsV1) NewUpdateSubscriptionOptions(instanceID string, id string) *UpdateSubscriptionOptions

NewUpdateSubscriptionOptions : Instantiate UpdateSubscriptionOptions

func (*EventNotificationsV1) ReplaceTopic 

func (eventNotifications *EventNotificationsV1) ReplaceTopic(replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)

ReplaceTopic : Update details of a Topic Update details of a Topic.

func (*EventNotificationsV1) ReplaceTopicWithContext 

func (eventNotifications *EventNotificationsV1) ReplaceTopicWithContext(ctx context.Context, replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)

ReplaceTopicWithContext is an alternate form of the ReplaceTopic method which supports a Context parameter

func (*EventNotificationsV1) SendNotifications added in v0.0.6 

func (eventNotifications *EventNotificationsV1) SendNotifications(sendNotificationsOptions *SendNotificationsOptions) (result *NotificationResponse, response *core.DetailedResponse, err error)

SendNotifications : Send a notification Send a notification.

func (*EventNotificationsV1) SendNotificationsWithContext added in v0.0.6 

func (eventNotifications *EventNotificationsV1) SendNotificationsWithContext(ctx context.Context, sendNotificationsOptions *SendNotificationsOptions) (result *NotificationResponse, response *core.DetailedResponse, err error)

SendNotificationsWithContext is an alternate form of the SendNotifications method which supports a Context parameter

func (*EventNotificationsV1) SetDefaultHeaders 

func (eventNotifications *EventNotificationsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*EventNotificationsV1) SetEnableGzipCompression 

func (eventNotifications *EventNotificationsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*EventNotificationsV1) SetServiceURL 

func (eventNotifications *EventNotificationsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*EventNotificationsV1) UpdateDestination 

func (eventNotifications *EventNotificationsV1) UpdateDestination(updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)

UpdateDestination : Update details of a Destination Update details of a Destination.

func (*EventNotificationsV1) UpdateDestinationWithContext 

func (eventNotifications *EventNotificationsV1) UpdateDestinationWithContext(ctx context.Context, updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)

UpdateDestinationWithContext is an alternate form of the UpdateDestination method which supports a Context parameter

func (*EventNotificationsV1) UpdateSubscription 

func (eventNotifications *EventNotificationsV1) UpdateSubscription(updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

UpdateSubscription : Update details of a Subscription Update details of a Subscription.

func (*EventNotificationsV1) UpdateSubscriptionWithContext 

func (eventNotifications *EventNotificationsV1) UpdateSubscriptionWithContext(ctx context.Context, updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)

UpdateSubscriptionWithContext is an alternate form of the UpdateSubscription method which supports a Context parameter

type EventNotificationsV1Options 

type EventNotificationsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

EventNotificationsV1Options : Service options

type GetDestinationDevicesReportOptions added in v0.0.6 

type GetDestinationDevicesReportOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Number of days report has to be generated from
	// * `Note :` Max value is 90
	// * Min or default value is 1.
	Days *int64 `json:"days,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDestinationDevicesReportOptions : The GetDestinationDevicesReport options.

func (*GetDestinationDevicesReportOptions) SetDays added in v0.0.6 

func (_options *GetDestinationDevicesReportOptions) SetDays(days int64) *GetDestinationDevicesReportOptions

SetDays : Allow user to set Days

func (*GetDestinationDevicesReportOptions) SetHeaders added in v0.0.6 

func (options *GetDestinationDevicesReportOptions) SetHeaders(param map[string]string) *GetDestinationDevicesReportOptions

SetHeaders : Allow user to set Headers

func (*GetDestinationDevicesReportOptions) SetID added in v0.0.6 

func (_options *GetDestinationDevicesReportOptions) SetID(id string) *GetDestinationDevicesReportOptions

SetID : Allow user to set ID

func (*GetDestinationDevicesReportOptions) SetInstanceID added in v0.0.6 

func (_options *GetDestinationDevicesReportOptions) SetInstanceID(instanceID string) *GetDestinationDevicesReportOptions

SetInstanceID : Allow user to set InstanceID

type GetDestinationOptions 

type GetDestinationOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDestinationOptions : The GetDestination options.

func (*GetDestinationOptions) SetHeaders 

func (options *GetDestinationOptions) SetHeaders(param map[string]string) *GetDestinationOptions

SetHeaders : Allow user to set Headers

func (*GetDestinationOptions) SetID 

func (_options *GetDestinationOptions) SetID(id string) *GetDestinationOptions

SetID : Allow user to set ID

func (*GetDestinationOptions) SetInstanceID 

func (_options *GetDestinationOptions) SetInstanceID(instanceID string) *GetDestinationOptions

SetInstanceID : Allow user to set InstanceID

type GetSourceOptions 

type GetSourceOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Source.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSourceOptions : The GetSource options.

func (*GetSourceOptions) SetHeaders 

func (options *GetSourceOptions) SetHeaders(param map[string]string) *GetSourceOptions

SetHeaders : Allow user to set Headers

func (*GetSourceOptions) SetID 

func (_options *GetSourceOptions) SetID(id string) *GetSourceOptions

SetID : Allow user to set ID

func (*GetSourceOptions) SetInstanceID 

func (_options *GetSourceOptions) SetInstanceID(instanceID string) *GetSourceOptions

SetInstanceID : Allow user to set InstanceID

type GetSubscriptionOptions 

type GetSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Subscription.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSubscriptionOptions : The GetSubscription options.

func (*GetSubscriptionOptions) SetHeaders 

func (options *GetSubscriptionOptions) SetHeaders(param map[string]string) *GetSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*GetSubscriptionOptions) SetID 

func (_options *GetSubscriptionOptions) SetID(id string) *GetSubscriptionOptions

SetID : Allow user to set ID

func (*GetSubscriptionOptions) SetInstanceID 

func (_options *GetSubscriptionOptions) SetInstanceID(instanceID string) *GetSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

type GetTopicOptions 

type GetTopicOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Topic.
	ID *string `json:"id" validate:"required,ne="`

	// Include sub topics.
	Include *string `json:"include,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTopicOptions : The GetTopic options.

func (*GetTopicOptions) SetHeaders 

func (options *GetTopicOptions) SetHeaders(param map[string]string) *GetTopicOptions

SetHeaders : Allow user to set Headers

func (*GetTopicOptions) SetID 

func (_options *GetTopicOptions) SetID(id string) *GetTopicOptions

SetID : Allow user to set ID

func (*GetTopicOptions) SetInclude 

func (_options *GetTopicOptions) SetInclude(include string) *GetTopicOptions

SetInclude : Allow user to set Include

func (*GetTopicOptions) SetInstanceID 

func (_options *GetTopicOptions) SetInstanceID(instanceID string) *GetTopicOptions

SetInstanceID : Allow user to set InstanceID

type Lights added in v0.0.6 

type Lights struct {
	// The color of the led. The hardware will do its best approximation.
	LedArgb *string `json:"led_argb,omitempty"`

	// The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.
	LedOnMs *int64 `json:"led_on_ms,omitempty"`

	// The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.
	LedOffMs *string `json:"led_off_ms,omitempty"`
}

Lights : Allows setting the notification LED color on receiving push notification .

type ListDestinationDevicesOptions added in v0.0.6 

type ListDestinationDevicesOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDestinationDevicesOptions : The ListDestinationDevices options.

func (*ListDestinationDevicesOptions) SetHeaders added in v0.0.6 

func (options *ListDestinationDevicesOptions) SetHeaders(param map[string]string) *ListDestinationDevicesOptions

SetHeaders : Allow user to set Headers

func (*ListDestinationDevicesOptions) SetID added in v0.0.6 

func (_options *ListDestinationDevicesOptions) SetID(id string) *ListDestinationDevicesOptions

SetID : Allow user to set ID

func (*ListDestinationDevicesOptions) SetInstanceID added in v0.0.6 

func (_options *ListDestinationDevicesOptions) SetInstanceID(instanceID string) *ListDestinationDevicesOptions

SetInstanceID : Allow user to set InstanceID

func (*ListDestinationDevicesOptions) SetLimit added in v0.0.6 

func (_options *ListDestinationDevicesOptions) SetLimit(limit int64) *ListDestinationDevicesOptions

SetLimit : Allow user to set Limit

func (*ListDestinationDevicesOptions) SetOffset added in v0.0.6 

func (_options *ListDestinationDevicesOptions) SetOffset(offset int64) *ListDestinationDevicesOptions

SetOffset : Allow user to set Offset

func (*ListDestinationDevicesOptions) SetSearch added in v0.0.6 

func (_options *ListDestinationDevicesOptions) SetSearch(search string) *ListDestinationDevicesOptions

SetSearch : Allow user to set Search

type ListDestinationsOptions 

type ListDestinationsOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDestinationsOptions : The ListDestinations options.

func (*ListDestinationsOptions) SetHeaders 

func (options *ListDestinationsOptions) SetHeaders(param map[string]string) *ListDestinationsOptions

SetHeaders : Allow user to set Headers

func (*ListDestinationsOptions) SetInstanceID 

func (_options *ListDestinationsOptions) SetInstanceID(instanceID string) *ListDestinationsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListDestinationsOptions) SetLimit 

func (_options *ListDestinationsOptions) SetLimit(limit int64) *ListDestinationsOptions

SetLimit : Allow user to set Limit

func (*ListDestinationsOptions) SetOffset 

func (_options *ListDestinationsOptions) SetOffset(offset int64) *ListDestinationsOptions

SetOffset : Allow user to set Offset

func (*ListDestinationsOptions) SetSearch 

func (_options *ListDestinationsOptions) SetSearch(search string) *ListDestinationsOptions

SetSearch : Allow user to set Search

type ListSourcesOptions 

type ListSourcesOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSourcesOptions : The ListSources options.

func (*ListSourcesOptions) SetHeaders 

func (options *ListSourcesOptions) SetHeaders(param map[string]string) *ListSourcesOptions

SetHeaders : Allow user to set Headers

func (*ListSourcesOptions) SetInstanceID 

func (_options *ListSourcesOptions) SetInstanceID(instanceID string) *ListSourcesOptions

SetInstanceID : Allow user to set InstanceID

func (*ListSourcesOptions) SetLimit 

func (_options *ListSourcesOptions) SetLimit(limit int64) *ListSourcesOptions

SetLimit : Allow user to set Limit

func (*ListSourcesOptions) SetOffset 

func (_options *ListSourcesOptions) SetOffset(offset int64) *ListSourcesOptions

SetOffset : Allow user to set Offset

func (*ListSourcesOptions) SetSearch 

func (_options *ListSourcesOptions) SetSearch(search string) *ListSourcesOptions

SetSearch : Allow user to set Search

type ListSubscriptionsOptions 

type ListSubscriptionsOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSubscriptionsOptions : The ListSubscriptions options.

func (*ListSubscriptionsOptions) SetHeaders 

func (options *ListSubscriptionsOptions) SetHeaders(param map[string]string) *ListSubscriptionsOptions

SetHeaders : Allow user to set Headers

func (*ListSubscriptionsOptions) SetInstanceID 

func (_options *ListSubscriptionsOptions) SetInstanceID(instanceID string) *ListSubscriptionsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListSubscriptionsOptions) SetLimit 

func (_options *ListSubscriptionsOptions) SetLimit(limit int64) *ListSubscriptionsOptions

SetLimit : Allow user to set Limit

func (*ListSubscriptionsOptions) SetOffset 

func (_options *ListSubscriptionsOptions) SetOffset(offset int64) *ListSubscriptionsOptions

SetOffset : Allow user to set Offset

func (*ListSubscriptionsOptions) SetSearch 

func (_options *ListSubscriptionsOptions) SetSearch(search string) *ListSubscriptionsOptions

SetSearch : Allow user to set Search

type ListTagsSubscriptionOptions added in v0.0.6 

type ListTagsSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// DeviceID of the destination tagsubscription.
	DeviceID *string `json:"device_id,omitempty"`

	// UserID of the destination.
	UserID *string `json:"user_id,omitempty"`

	// TagName of the subscription.
	TagName *string `json:"tag_name,omitempty"`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTagsSubscriptionOptions : The ListTagsSubscription options.

func (*ListTagsSubscriptionOptions) SetDeviceID added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetDeviceID(deviceID string) *ListTagsSubscriptionOptions

SetDeviceID : Allow user to set DeviceID

func (*ListTagsSubscriptionOptions) SetHeaders added in v0.0.6 

func (options *ListTagsSubscriptionOptions) SetHeaders(param map[string]string) *ListTagsSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*ListTagsSubscriptionOptions) SetID added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetID(id string) *ListTagsSubscriptionOptions

SetID : Allow user to set ID

func (*ListTagsSubscriptionOptions) SetInstanceID added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetInstanceID(instanceID string) *ListTagsSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

func (*ListTagsSubscriptionOptions) SetLimit added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetLimit(limit int64) *ListTagsSubscriptionOptions

SetLimit : Allow user to set Limit

func (*ListTagsSubscriptionOptions) SetOffset added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetOffset(offset int64) *ListTagsSubscriptionOptions

SetOffset : Allow user to set Offset

func (*ListTagsSubscriptionOptions) SetSearch added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetSearch(search string) *ListTagsSubscriptionOptions

SetSearch : Allow user to set Search

func (*ListTagsSubscriptionOptions) SetTagName added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetTagName(tagName string) *ListTagsSubscriptionOptions

SetTagName : Allow user to set TagName

func (*ListTagsSubscriptionOptions) SetUserID added in v0.0.6 

func (_options *ListTagsSubscriptionOptions) SetUserID(userID string) *ListTagsSubscriptionOptions

SetUserID : Allow user to set UserID

type ListTagsSubscriptionsDeviceOptions added in v0.0.6 

type ListTagsSubscriptionsDeviceOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// DeviceID of the destination.
	DeviceID *string `json:"device_id" validate:"required,ne="`

	// TagName of the subscription.
	TagName *string `json:"tag_name,omitempty"`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTagsSubscriptionsDeviceOptions : The ListTagsSubscriptionsDevice options.

func (*ListTagsSubscriptionsDeviceOptions) SetDeviceID added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetDeviceID(deviceID string) *ListTagsSubscriptionsDeviceOptions

SetDeviceID : Allow user to set DeviceID

func (*ListTagsSubscriptionsDeviceOptions) SetHeaders added in v0.0.6 

func (options *ListTagsSubscriptionsDeviceOptions) SetHeaders(param map[string]string) *ListTagsSubscriptionsDeviceOptions

SetHeaders : Allow user to set Headers

func (*ListTagsSubscriptionsDeviceOptions) SetID added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetID(id string) *ListTagsSubscriptionsDeviceOptions

SetID : Allow user to set ID

func (*ListTagsSubscriptionsDeviceOptions) SetInstanceID added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetInstanceID(instanceID string) *ListTagsSubscriptionsDeviceOptions

SetInstanceID : Allow user to set InstanceID

func (*ListTagsSubscriptionsDeviceOptions) SetLimit added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetLimit(limit int64) *ListTagsSubscriptionsDeviceOptions

SetLimit : Allow user to set Limit

func (*ListTagsSubscriptionsDeviceOptions) SetOffset added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetOffset(offset int64) *ListTagsSubscriptionsDeviceOptions

SetOffset : Allow user to set Offset

func (*ListTagsSubscriptionsDeviceOptions) SetTagName added in v0.0.6 

func (_options *ListTagsSubscriptionsDeviceOptions) SetTagName(tagName string) *ListTagsSubscriptionsDeviceOptions

SetTagName : Allow user to set TagName

type ListTopicsOptions 

type ListTopicsOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Page limit for paginated results.
	Limit *int64 `json:"limit,omitempty"`

	// offset for paginated results.
	Offset *int64 `json:"offset,omitempty"`

	// Search string for filtering results.
	Search *string `json:"search,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTopicsOptions : The ListTopics options.

func (*ListTopicsOptions) SetHeaders 

func (options *ListTopicsOptions) SetHeaders(param map[string]string) *ListTopicsOptions

SetHeaders : Allow user to set Headers

func (*ListTopicsOptions) SetInstanceID 

func (_options *ListTopicsOptions) SetInstanceID(instanceID string) *ListTopicsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListTopicsOptions) SetLimit 

func (_options *ListTopicsOptions) SetLimit(limit int64) *ListTopicsOptions

SetLimit : Allow user to set Limit

func (*ListTopicsOptions) SetOffset 

func (_options *ListTopicsOptions) SetOffset(offset int64) *ListTopicsOptions

SetOffset : Allow user to set Offset

func (*ListTopicsOptions) SetSearch 

func (_options *ListTopicsOptions) SetSearch(search string) *ListTopicsOptions

SetSearch : Allow user to set Search

type NotificationApnsBody added in v0.0.7 

type NotificationApnsBody struct {
	// Payload describing a apns notifications body message Data.
	EnData *NotificationApnsBodyMessageData `json:"en_data,omitempty"`
	// contains filtered or unexported fields
}

NotificationApnsBody : Payload describing a APNs Notifications body. Models which "extend" this model: - NotificationApnsBodyMessageEnData - NotificationApnsBodyNotificationPayload

func (*NotificationApnsBody) GetProperties added in v0.0.7 

func (o *NotificationApnsBody) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationApnsBody

func (*NotificationApnsBody) GetProperty added in v0.0.7 

func (o *NotificationApnsBody) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationApnsBody

func (*NotificationApnsBody) MarshalJSON added in v0.0.7 

func (o *NotificationApnsBody) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationApnsBody

func (*NotificationApnsBody) SetProperties added in v0.0.7 

func (o *NotificationApnsBody) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationApnsBody

func (*NotificationApnsBody) SetProperty added in v0.0.7 

func (o *NotificationApnsBody) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationApnsBody

type NotificationApnsBodyIntf added in v0.0.7 

type NotificationApnsBodyIntf interface {
	SetProperty(key string, value interface{})
	SetProperties(m map[string]interface{})
	GetProperty(key string) interface{}
	GetProperties() map[string]interface{}
	// contains filtered or unexported methods
}

type NotificationApnsBodyMessageData added in v0.0.7 

type NotificationApnsBodyMessageData struct {
	// The notification message to be shown to the user.
	Alert *string `json:"alert" validate:"required"`

	// The number to display as the badge of the application icon.
	Badge *int64 `json:"badge,omitempty"`

	// The category identifier to be used for the interactive push notifications.
	InteractiveCategory *string `json:"interactiveCategory,omitempty"`

	// The title for the Action key.
	IosActionKey *string `json:"iosActionKey,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload interface{} `json:"payload,omitempty"`

	// The name of the sound file in the application bundle. The sound of this file is played as an alert.
	Sound *string `json:"sound,omitempty"`

	// The key to a title string in the Localizable.strings file for the current localization. The key string can be
	// formatted with %@ and %n$@ specifiers to take the variables specified in the titleLocArgs array.
	TitleLocKey *string `json:"titleLocKey,omitempty"`

	// A key to an alert-message string in a Localizabl.strings file for the current localization (which is set by the
	// user’s language preference).
	//   The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the locArgs array.
	LocKey *string `json:"locKey,omitempty"`

	// The filename of an image file in the app bundle, with or without the filename extension. The image is used as the
	// launch image when users tap the action button or move the action slider.
	LaunchImage *string `json:"launchImage,omitempty"`

	// Variable string values to appear in place of the format specifiers in title-loc-key.
	TitleLocArgs []string `json:"titleLocArgs,omitempty"`

	// Variable string values to appear in place of the format specifiers in locKey.
	LocArgs []string `json:"locArgs,omitempty"`

	// The title of Rich Push notifications (Supported only on iOS 10 and above).
	Title *string `json:"title,omitempty"`

	// The subtitle of the Rich Notifications.(Supported only on iOS 10 and above).
	Subtitle *string `json:"subtitle,omitempty"`

	// The link to the iOS notifications media (video, audio, GIF, images - Supported only on iOS 10 and above).
	AttachmentURL *string `json:"attachmentUrl,omitempty"`

	Type *string `json:"type,omitempty"`

	// Multiple notifications with the same collapse identifier are displayed to the user as a single notification.
	ApnsCollapseID *string `json:"apnsCollapseId,omitempty"`

	// An app-specific identifier for grouping related notifications. This value corresponds to the threadIdentifier
	// property in the UNNotificationContent object.
	ApnsThreadID *string `json:"apnsThreadId,omitempty"`

	// The string the notification adds to the category's summary format string.
	ApnsGroupSummaryArg *string `json:"apnsGroupSummaryArg,omitempty"`

	// The number of items the notification adds to the category's summary format string.
	ApnsGroupSummaryArgCount *int64 `json:"apnsGroupSummaryArgCount,omitempty"`
}

NotificationApnsBodyMessageData : Payload describing a apns notifications body message Data.

type NotificationApnsBodyMessageEnData added in v0.0.7 

type NotificationApnsBodyMessageEnData struct {
	// Payload describing a apns notifications body message Data.
	EnData *NotificationApnsBodyMessageData `json:"en_data,omitempty"`
	// contains filtered or unexported fields
}

NotificationApnsBodyMessageEnData : Payload describing a fcm notifications body message. This model "extends" NotificationApnsBody

func (*NotificationApnsBodyMessageEnData) GetProperties added in v0.0.7 

func (o *NotificationApnsBodyMessageEnData) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationApnsBodyMessageEnData

func (*NotificationApnsBodyMessageEnData) GetProperty added in v0.0.7 

func (o *NotificationApnsBodyMessageEnData) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationApnsBodyMessageEnData

func (*NotificationApnsBodyMessageEnData) MarshalJSON added in v0.0.7 

func (o *NotificationApnsBodyMessageEnData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationApnsBodyMessageEnData

func (*NotificationApnsBodyMessageEnData) SetProperties added in v0.0.7 

func (o *NotificationApnsBodyMessageEnData) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationApnsBodyMessageEnData

func (*NotificationApnsBodyMessageEnData) SetProperty added in v0.0.7 

func (o *NotificationApnsBodyMessageEnData) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationApnsBodyMessageEnData

type NotificationApnsBodyNotificationPayload added in v0.0.7 

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

NotificationApnsBodyNotificationPayload : The attributes for an FCM/APNs notification. This model "extends" NotificationApnsBody

func (*NotificationApnsBodyNotificationPayload) GetProperties added in v0.0.7 

func (o *NotificationApnsBodyNotificationPayload) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationApnsBodyNotificationPayload

func (*NotificationApnsBodyNotificationPayload) GetProperty added in v0.0.7 

func (o *NotificationApnsBodyNotificationPayload) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationApnsBodyNotificationPayload

func (*NotificationApnsBodyNotificationPayload) MarshalJSON added in v0.0.7 

func (o *NotificationApnsBodyNotificationPayload) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationApnsBodyNotificationPayload

func (*NotificationApnsBodyNotificationPayload) SetProperties added in v0.0.7 

func (o *NotificationApnsBodyNotificationPayload) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationApnsBodyNotificationPayload

func (*NotificationApnsBodyNotificationPayload) SetProperty added in v0.0.7 

func (o *NotificationApnsBodyNotificationPayload) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationApnsBodyNotificationPayload

type NotificationDevices added in v0.0.7 

type NotificationDevices struct {
	// List of FCM deviceIds.
	FcmDevices []string `json:"fcm_devices,omitempty"`

	// List of APNs deviceIds.
	ApnsDevices []string `json:"apns_devices,omitempty"`

	// List of userIds.
	UserIds []string `json:"user_ids,omitempty"`

	// List of tags.
	Tags []string `json:"tags,omitempty"`

	// List of platforms.
	Platforms []string `json:"platforms,omitempty"`
}

NotificationDevices : Payload describing a FCM Notifications targets.

type NotificationFcmBody added in v0.0.6 

type NotificationFcmBody struct {
	// Payload describing a fcm notifications body message Data.
	EnData *NotificationFcmBodyMessageData `json:"en_data,omitempty"`
	// contains filtered or unexported fields
}

NotificationFcmBody : NotificationFcmBody struct Models which "extend" this model: - NotificationFcmBodyMessageEnData - NotificationFcmBodyNotificationPayload

func (*NotificationFcmBody) GetProperties added in v0.0.7 

func (o *NotificationFcmBody) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationFcmBody

func (*NotificationFcmBody) GetProperty added in v0.0.7 

func (o *NotificationFcmBody) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationFcmBody

func (*NotificationFcmBody) MarshalJSON added in v0.0.7 

func (o *NotificationFcmBody) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationFcmBody

func (*NotificationFcmBody) SetProperties added in v0.0.7 

func (o *NotificationFcmBody) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationFcmBody

func (*NotificationFcmBody) SetProperty added in v0.0.7 

func (o *NotificationFcmBody) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationFcmBody

type NotificationFcmBodyIntf added in v0.0.7 

type NotificationFcmBodyIntf interface {
	SetProperty(key string, value interface{})
	SetProperties(m map[string]interface{})
	GetProperty(key string) interface{}
	GetProperties() map[string]interface{}
	// contains filtered or unexported methods
}

type NotificationFcmBodyMessageData added in v0.0.6 

type NotificationFcmBodyMessageData struct {
	// The notification message to be shown to the user.
	Alert *string `json:"alert" validate:"required"`

	// Dozed devices to display only the latest notification and discard old low priority notifications.
	CollapseKey *string `json:"collapse_key,omitempty"`

	// The category identifier to be used for the interactive push notifications.
	InteractiveCategory *string `json:"interactive_category,omitempty"`

	// Specify the name of the icon to be displayed for the notification. Make sure the icon is already packaged with the
	// client application.
	Icon *string `json:"icon,omitempty"`

	// When this parameter is set to true, it indicates that the
	//   message should not be sent until the device becomes active.
	DelayWhileIdle *bool `json:"delay_while_idle,omitempty"`

	// Device group messaging makes it possible for every app instance in a group to reflect the latest messaging state.
	Sync *bool `json:"sync,omitempty"`

	// private/public - Visibility of this notification, which affects how and when the notifications are revealed on a
	// secure locked screen.
	Visibility *string `json:"visibility,omitempty"`

	// Content specified will show up on a secure locked screen on the device when visibility is set to Private.
	Redact *string `json:"redact,omitempty"`

	// Custom JSON payload that will be sent as part of the notification message.
	Payload map[string]interface{} `json:"payload,omitempty"`

	// A string value that indicates the priority of this notification. Allowed values are 'max', 'high', 'default', 'low'
	// and 'min'. High/Max priority notifications along with 'sound' field may be used for Heads up notification in Android
	// 5.0 or higher.sampleval='low'.
	Priority *string `json:"priority,omitempty"`

	// The sound file (on device) that will be attempted to play when the notification arrives on the device.
	Sound *string `json:"sound,omitempty"`

	// This parameter specifies how long (in seconds) the message
	//   should be kept in GCM storage if the device is offline.
	TimeToLive *int64 `json:"time_to_live,omitempty"`

	// Allows setting the notification LED color on receiving push notification .
	Lights *Lights `json:"lights,omitempty"`

	// The title of Rich Push notifications.
	AndroidTitle *string `json:"android_title,omitempty"`

	// Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may display
	// in a cluster or stack on devices which support such rendering.
	GroupID *string `json:"group_id,omitempty"`

	// Options to specify for Android expandable notifications. The types of expandable notifications are
	// picture_notification, bigtext_notification, inbox_notification.
	Style *Style `json:"style,omitempty"`

	// Notification type.
	Type *string `json:"type,omitempty"`
}

NotificationFcmBodyMessageData : Payload describing a fcm notifications body message Data.

type NotificationFcmBodyMessageEnData added in v0.0.7 

type NotificationFcmBodyMessageEnData struct {
	// Payload describing a fcm notifications body message Data.
	EnData *NotificationFcmBodyMessageData `json:"en_data,omitempty"`
	// contains filtered or unexported fields
}

NotificationFcmBodyMessageEnData : Payload describing a fcm notifications body message. This model "extends" NotificationFcmBody

func (*NotificationFcmBodyMessageEnData) GetProperties added in v0.0.7 

func (o *NotificationFcmBodyMessageEnData) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationFcmBodyMessageEnData

func (*NotificationFcmBodyMessageEnData) GetProperty added in v0.0.7 

func (o *NotificationFcmBodyMessageEnData) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationFcmBodyMessageEnData

func (*NotificationFcmBodyMessageEnData) MarshalJSON added in v0.0.7 

func (o *NotificationFcmBodyMessageEnData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationFcmBodyMessageEnData

func (*NotificationFcmBodyMessageEnData) SetProperties added in v0.0.7 

func (o *NotificationFcmBodyMessageEnData) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationFcmBodyMessageEnData

func (*NotificationFcmBodyMessageEnData) SetProperty added in v0.0.7 

func (o *NotificationFcmBodyMessageEnData) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationFcmBodyMessageEnData

type NotificationFcmBodyNotificationPayload added in v0.0.7 

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

NotificationFcmBodyNotificationPayload : The attributes for an FCM/APNs notification. This model "extends" NotificationFcmBody

func (*NotificationFcmBodyNotificationPayload) GetProperties added in v0.0.7 

func (o *NotificationFcmBodyNotificationPayload) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationFcmBodyNotificationPayload

func (*NotificationFcmBodyNotificationPayload) GetProperty added in v0.0.7 

func (o *NotificationFcmBodyNotificationPayload) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationFcmBodyNotificationPayload

func (*NotificationFcmBodyNotificationPayload) MarshalJSON added in v0.0.7 

func (o *NotificationFcmBodyNotificationPayload) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationFcmBodyNotificationPayload

func (*NotificationFcmBodyNotificationPayload) SetProperties added in v0.0.7 

func (o *NotificationFcmBodyNotificationPayload) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationFcmBodyNotificationPayload

func (*NotificationFcmBodyNotificationPayload) SetProperty added in v0.0.7 

func (o *NotificationFcmBodyNotificationPayload) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationFcmBodyNotificationPayload

type NotificationResponse added in v0.0.6 

type NotificationResponse struct {
	// Notification ID.
	NotificationID *string `json:"notification_id" validate:"required"`
	// contains filtered or unexported fields
}

NotificationResponse : Payload describing a notifications response.

func (*NotificationResponse) GetProperties added in v0.0.7 

func (o *NotificationResponse) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of NotificationResponse

func (*NotificationResponse) GetProperty added in v0.0.7 

func (o *NotificationResponse) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of NotificationResponse

func (*NotificationResponse) MarshalJSON added in v0.0.7 

func (o *NotificationResponse) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of NotificationResponse

func (*NotificationResponse) SetProperties added in v0.0.7 

func (o *NotificationResponse) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of NotificationResponse

func (*NotificationResponse) SetProperty added in v0.0.7 

func (o *NotificationResponse) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of NotificationResponse

type ReplaceTopicOptions 

type ReplaceTopicOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Topic.
	ID *string `json:"id" validate:"required,ne="`

	// Name of the topic.
	Name *string `json:"name,omitempty"`

	// Description of the topic.
	Description *string `json:"description,omitempty"`

	// List of sources.
	Sources []TopicUpdateSourcesItem `json:"sources,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceTopicOptions : The ReplaceTopic options.

func (*ReplaceTopicOptions) SetDescription 

func (_options *ReplaceTopicOptions) SetDescription(description string) *ReplaceTopicOptions

SetDescription : Allow user to set Description

func (*ReplaceTopicOptions) SetHeaders 

func (options *ReplaceTopicOptions) SetHeaders(param map[string]string) *ReplaceTopicOptions

SetHeaders : Allow user to set Headers

func (*ReplaceTopicOptions) SetID 

func (_options *ReplaceTopicOptions) SetID(id string) *ReplaceTopicOptions

SetID : Allow user to set ID

func (*ReplaceTopicOptions) SetInstanceID 

func (_options *ReplaceTopicOptions) SetInstanceID(instanceID string) *ReplaceTopicOptions

SetInstanceID : Allow user to set InstanceID

func (*ReplaceTopicOptions) SetName 

func (_options *ReplaceTopicOptions) SetName(name string) *ReplaceTopicOptions

SetName : Allow user to set Name

func (*ReplaceTopicOptions) SetSources 

func (_options *ReplaceTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *ReplaceTopicOptions

SetSources : Allow user to set Sources

type Rules 

type Rules struct {
	// Whether the rule is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`

	// Event type filter.
	EventTypeFilter *string `json:"event_type_filter" validate:"required"`

	// Notification filter.
	NotificationFilter *string `json:"notification_filter,omitempty"`
}

Rules : Rule object.

type RulesGet 

type RulesGet struct {
	// Whether the rule is enabled or not.
	Enabled *bool `json:"enabled" validate:"required"`

	// Event type filter.
	EventTypeFilter *string `json:"event_type_filter" validate:"required"`

	// Notification filter.
	NotificationFilter *string `json:"notification_filter" validate:"required"`

	// Last time the topic was updated.
	UpdatedAt *string `json:"updated_at" validate:"required"`

	// Autogenerated rule ID.
	ID *string `json:"id" validate:"required"`
}

RulesGet : Rule object.

type SendNotificationsOptions added in v0.0.6 

type SendNotificationsOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// The Notifications subject.
	Subject *string `json:"subject" validate:"required"`

	// The Notifications severity.
	Severity *string `json:"severity" validate:"required"`

	// The Notifications id.
	ID *string `json:"id" validate:"required"`

	// The source of Notifications.
	Source *string `json:"source" validate:"required"`

	// The Event Notifications source id.
	EnSourceID *string `json:"en_source_id" validate:"required"`

	// The Notifications type.
	Type *string `json:"type" validate:"required"`

	// The Notifications time.
	Time *strfmt.DateTime `json:"time" validate:"required"`

	// The Notifications data for webhook.
	Data map[string]interface{} `json:"data,omitempty"`

	// Payload describing a FCM Notifications targets.
	PushTo *NotificationDevices `json:"push_to,omitempty"`

	MessageFcmBody NotificationFcmBodyIntf `json:"message_fcm_body,omitempty"`

	// The attributes for an FCM/APNs notification.
	MessageApnsHeaders map[string]interface{} `json:"message_apns_headers,omitempty"`

	// Payload describing a APNs Notifications body.
	MessageApnsBody NotificationApnsBodyIntf `json:"message_apns_body,omitempty"`

	// The Notifications content type.
	Datacontenttype *string `json:"datacontenttype,omitempty"`

	// The Notifications specversion.
	Specversion *string `json:"specversion,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SendNotificationsOptions : The SendNotifications options.

func (*SendNotificationsOptions) SetData added in v0.0.6 

func (_options *SendNotificationsOptions) SetData(data map[string]interface{}) *SendNotificationsOptions

SetData : Allow user to set Data

func (*SendNotificationsOptions) SetDatacontenttype added in v0.0.6 

func (_options *SendNotificationsOptions) SetDatacontenttype(datacontenttype string) *SendNotificationsOptions

SetDatacontenttype : Allow user to set Datacontenttype

func (*SendNotificationsOptions) SetEnSourceID added in v0.0.6 

func (_options *SendNotificationsOptions) SetEnSourceID(enSourceID string) *SendNotificationsOptions

SetEnSourceID : Allow user to set EnSourceID

func (*SendNotificationsOptions) SetHeaders added in v0.0.6 

func (options *SendNotificationsOptions) SetHeaders(param map[string]string) *SendNotificationsOptions

SetHeaders : Allow user to set Headers

func (*SendNotificationsOptions) SetID added in v0.0.6 

func (_options *SendNotificationsOptions) SetID(id string) *SendNotificationsOptions

SetID : Allow user to set ID

func (*SendNotificationsOptions) SetInstanceID added in v0.0.6 

func (_options *SendNotificationsOptions) SetInstanceID(instanceID string) *SendNotificationsOptions

SetInstanceID : Allow user to set InstanceID

func (*SendNotificationsOptions) SetMessageApnsBody added in v0.0.7 

func (_options *SendNotificationsOptions) SetMessageApnsBody(messageApnsBody NotificationApnsBodyIntf) *SendNotificationsOptions

SetMessageApnsBody : Allow user to set MessageApnsBody

func (*SendNotificationsOptions) SetMessageApnsHeaders added in v0.0.7 

func (_options *SendNotificationsOptions) SetMessageApnsHeaders(messageApnsHeaders map[string]interface{}) *SendNotificationsOptions

SetMessageApnsHeaders : Allow user to set MessageApnsHeaders

func (*SendNotificationsOptions) SetMessageFcmBody added in v0.0.6 

func (_options *SendNotificationsOptions) SetMessageFcmBody(messageFcmBody NotificationFcmBodyIntf) *SendNotificationsOptions

SetMessageFcmBody : Allow user to set MessageFcmBody

func (*SendNotificationsOptions) SetPushTo added in v0.0.6 

func (_options *SendNotificationsOptions) SetPushTo(pushTo *NotificationDevices) *SendNotificationsOptions

SetPushTo : Allow user to set PushTo

func (*SendNotificationsOptions) SetSeverity added in v0.0.6 

func (_options *SendNotificationsOptions) SetSeverity(severity string) *SendNotificationsOptions

SetSeverity : Allow user to set Severity

func (*SendNotificationsOptions) SetSource added in v0.0.6 

func (_options *SendNotificationsOptions) SetSource(source string) *SendNotificationsOptions

SetSource : Allow user to set Source

func (*SendNotificationsOptions) SetSpecversion added in v0.0.6 

func (_options *SendNotificationsOptions) SetSpecversion(specversion string) *SendNotificationsOptions

SetSpecversion : Allow user to set Specversion

func (*SendNotificationsOptions) SetSubject added in v0.0.6 

func (_options *SendNotificationsOptions) SetSubject(subject string) *SendNotificationsOptions

SetSubject : Allow user to set Subject

func (*SendNotificationsOptions) SetTime added in v0.0.6 

func (_options *SendNotificationsOptions) SetTime(time *strfmt.DateTime) *SendNotificationsOptions

SetTime : Allow user to set Time

func (*SendNotificationsOptions) SetType added in v0.0.6 

func (_options *SendNotificationsOptions) SetType(typeVar string) *SendNotificationsOptions

SetType : Allow user to set Type

type Source 

type Source struct {
	// The id of the source.
	ID *string `json:"id" validate:"required"`

	// The name of the source.
	Name *string `json:"name" validate:"required"`

	// The description of the source.
	Description *string `json:"description" validate:"required"`

	// The status of the source.
	Enabled *bool `json:"enabled" validate:"required"`

	// Type of the source.
	Type *string `json:"type" validate:"required"`

	// The last updated time of the source.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The number of topics.
	TopicCount *int64 `json:"topic_count" validate:"required"`

	// The names of the topics.
	TopicNames []string `json:"topic_names" validate:"required"`
}

Source : Payload describing a source generate request.

type SourceList 

type SourceList struct {
	// Number of sources.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show sources.
	Limit *int64 `json:"limit" validate:"required"`

	// List of sources.
	Sources []SourceListItem `json:"sources" validate:"required"`
}

SourceList : Payload describing a source list request.

type SourceListItem added in v0.0.6 

type SourceListItem struct {
	// ID of the source.
	ID *string `json:"id" validate:"required"`

	// Name of the source.
	Name *string `json:"name" validate:"required"`

	// Description of the source.
	Description *string `json:"description" validate:"required"`

	// Type of the source.
	Type *string `json:"type" validate:"required"`

	// Whether the source is enabled or not.
	Enabled *bool `json:"enabled" validate:"required"`

	// Time of the last update.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Number of topics.
	TopicCount *int64 `json:"topic_count" validate:"required"`
}

SourceListItem : Payload describing a source list item.

type SourcesListItem 

type SourcesListItem struct {
	// ID of the source.
	ID *string `json:"id" validate:"required"`

	// Name of the source.
	Name *string `json:"name" validate:"required"`

	// List of rules.
	Rules []RulesGet `json:"rules" validate:"required"`
}

SourcesListItem : SourcesListItem struct

type Style added in v0.0.6 

type Style struct {
	// Specifies the type of expandable notifications.  The possible values are bigtext_notification, picture_notification,
	// inbox_notification.
	Type *string `json:"type,omitempty"`

	// Specifies the title of the notification.  The title is displayed when the notification is expanded.  Title must be
	// specified for all three expandable notification.
	Title *string `json:"title,omitempty"`

	// An URL from which the picture has to be obtained for the notification.  Must be specified for picture_notification.
	URL *string `json:"url,omitempty"`

	// The big text that needs to be displayed on expanding a bigtext_notification.  Must be specified for
	// bigtext_notification.
	Text *string `json:"text,omitempty"`

	// An array of strings that is to be displayed in inbox style for inbox_notification.  Must be specified for
	// inbox_notification.
	Lines []string `json:"lines,omitempty"`
	// contains filtered or unexported fields
}

Style : Options to specify for Android expandable notifications. The types of expandable notifications are picture_notification, bigtext_notification, inbox_notification.

func (*Style) GetProperties added in v0.0.6 

func (o *Style) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Style

func (*Style) GetProperty added in v0.0.6 

func (o *Style) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of Style

func (*Style) MarshalJSON added in v0.0.6 

func (o *Style) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of Style

func (*Style) SetProperties added in v0.0.6 

func (o *Style) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of Style

func (*Style) SetProperty added in v0.0.6 

func (o *Style) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of Style

type Subscription 

type Subscription struct {
	// Subscription ID.
	ID *string `json:"id" validate:"required"`

	// Subscription name.
	Name *string `json:"name" validate:"required"`

	// Subscription description.
	Description *string `json:"description" validate:"required"`

	// Last updated time.
	UpdatedAt *string `json:"updated_at" validate:"required"`

	// From Email ID (it will be displayed only in case of smtp_ibm destination type).
	From *string `json:"from,omitempty"`

	// The type of destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// The destination ID.
	DestinationID *string `json:"destination_id" validate:"required"`

	// The destination name.
	DestinationName *string `json:"destination_name" validate:"required"`

	// Topic ID.
	TopicID *string `json:"topic_id" validate:"required"`

	// Topic name.
	TopicName *string `json:"topic_name" validate:"required"`

	Attributes SubscriptionAttributesIntf `json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

Subscription : Subscription object.

func (*Subscription) GetProperties 

func (o *Subscription) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Subscription

func (*Subscription) GetProperty 

func (o *Subscription) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of Subscription

func (*Subscription) MarshalJSON 

func (o *Subscription) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of Subscription

func (*Subscription) SetProperties 

func (o *Subscription) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of Subscription

func (*Subscription) SetProperty 

func (o *Subscription) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of Subscription

type SubscriptionAttributes 

type SubscriptionAttributes struct {
	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled,omitempty"`

	// Decision for Notification Payload to be added.
	AddNotificationPayload *bool `json:"add_notification_payload,omitempty"`
	// contains filtered or unexported fields
}

SubscriptionAttributes : SubscriptionAttributes struct Models which "extend" this model: - SubscriptionAttributesSmsAttributesResponse - SubscriptionAttributesEmailAttributesResponse - SubscriptionAttributesWebhookAttributesResponse

func (*SubscriptionAttributes) GetProperties added in v0.0.5 

func (o *SubscriptionAttributes) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SubscriptionAttributes

func (*SubscriptionAttributes) GetProperty added in v0.0.5 

func (o *SubscriptionAttributes) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SubscriptionAttributes

func (*SubscriptionAttributes) MarshalJSON added in v0.0.5 

func (o *SubscriptionAttributes) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SubscriptionAttributes

func (*SubscriptionAttributes) SetProperties added in v0.0.5 

func (o *SubscriptionAttributes) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SubscriptionAttributes

func (*SubscriptionAttributes) SetProperty added in v0.0.5 

func (o *SubscriptionAttributes) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SubscriptionAttributes

type SubscriptionAttributesEmailAttributesResponse 

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

SubscriptionAttributesEmailAttributesResponse : The attributes reponse for an email destination. This model "extends" SubscriptionAttributes

func (*SubscriptionAttributesEmailAttributesResponse) GetProperties added in v0.0.5 

func (o *SubscriptionAttributesEmailAttributesResponse) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SubscriptionAttributesEmailAttributesResponse

func (*SubscriptionAttributesEmailAttributesResponse) GetProperty added in v0.0.5 

func (o *SubscriptionAttributesEmailAttributesResponse) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SubscriptionAttributesEmailAttributesResponse

func (*SubscriptionAttributesEmailAttributesResponse) MarshalJSON added in v0.0.5 

func (o *SubscriptionAttributesEmailAttributesResponse) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SubscriptionAttributesEmailAttributesResponse

func (*SubscriptionAttributesEmailAttributesResponse) SetProperties added in v0.0.5 

func (o *SubscriptionAttributesEmailAttributesResponse) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SubscriptionAttributesEmailAttributesResponse

func (*SubscriptionAttributesEmailAttributesResponse) SetProperty added in v0.0.5 

func (o *SubscriptionAttributesEmailAttributesResponse) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SubscriptionAttributesEmailAttributesResponse

type SubscriptionAttributesIntf 

type SubscriptionAttributesIntf interface {
	SetProperty(key string, value interface{})
	SetProperties(m map[string]interface{})
	GetProperty(key string) interface{}
	GetProperties() map[string]interface{}
	// contains filtered or unexported methods
}

type SubscriptionAttributesSmsAttributesResponse 

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

SubscriptionAttributesSmsAttributesResponse : SMS attributes object. This model "extends" SubscriptionAttributes

func (*SubscriptionAttributesSmsAttributesResponse) GetProperties added in v0.0.5 

func (o *SubscriptionAttributesSmsAttributesResponse) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SubscriptionAttributesSmsAttributesResponse

func (*SubscriptionAttributesSmsAttributesResponse) GetProperty added in v0.0.5 

func (o *SubscriptionAttributesSmsAttributesResponse) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SubscriptionAttributesSmsAttributesResponse

func (*SubscriptionAttributesSmsAttributesResponse) MarshalJSON added in v0.0.5 

func (o *SubscriptionAttributesSmsAttributesResponse) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SubscriptionAttributesSmsAttributesResponse

func (*SubscriptionAttributesSmsAttributesResponse) SetProperties added in v0.0.5 

func (o *SubscriptionAttributesSmsAttributesResponse) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SubscriptionAttributesSmsAttributesResponse

func (*SubscriptionAttributesSmsAttributesResponse) SetProperty added in v0.0.5 

func (o *SubscriptionAttributesSmsAttributesResponse) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SubscriptionAttributesSmsAttributesResponse

type SubscriptionAttributesWebhookAttributesResponse 

type SubscriptionAttributesWebhookAttributesResponse struct {
	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled" validate:"required"`

	// Decision for Notification Payload to be added.
	AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"`
	// contains filtered or unexported fields
}

SubscriptionAttributesWebhookAttributesResponse : The attributes for a webhook notification. This model "extends" SubscriptionAttributes

func (*SubscriptionAttributesWebhookAttributesResponse) GetProperties added in v0.0.5 

func (o *SubscriptionAttributesWebhookAttributesResponse) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SubscriptionAttributesWebhookAttributesResponse

func (*SubscriptionAttributesWebhookAttributesResponse) GetProperty added in v0.0.5 

func (o *SubscriptionAttributesWebhookAttributesResponse) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of SubscriptionAttributesWebhookAttributesResponse

func (*SubscriptionAttributesWebhookAttributesResponse) MarshalJSON added in v0.0.5 

func (o *SubscriptionAttributesWebhookAttributesResponse) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SubscriptionAttributesWebhookAttributesResponse

func (*SubscriptionAttributesWebhookAttributesResponse) SetProperties added in v0.0.5 

func (o *SubscriptionAttributesWebhookAttributesResponse) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of SubscriptionAttributesWebhookAttributesResponse

func (*SubscriptionAttributesWebhookAttributesResponse) SetProperty added in v0.0.5 

func (o *SubscriptionAttributesWebhookAttributesResponse) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of SubscriptionAttributesWebhookAttributesResponse

type SubscriptionCreateAttributes 

type SubscriptionCreateAttributes struct {
	// The phone number to send the SMS to.
	To []string `json:"to,omitempty"`

	// Whether to add the notification payload to the email.
	AddNotificationPayload *bool `json:"add_notification_payload,omitempty"`

	// The email address to reply to.
	ReplyToMail *string `json:"reply_to_mail,omitempty"`

	// The email name to reply to.
	ReplyToName *string `json:"reply_to_name,omitempty"`

	// The email name of From.
	FromName *string `json:"from_name,omitempty"`

	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled,omitempty"`
}

SubscriptionCreateAttributes : SubscriptionCreateAttributes struct Models which "extend" this model: - SubscriptionCreateAttributesSmsAttributes - SubscriptionCreateAttributesEmailAttributes - SubscriptionCreateAttributesWebhookAttributes - SubscriptionCreateAttributesFcmAttributes

type SubscriptionCreateAttributesEmailAttributes 

type SubscriptionCreateAttributesEmailAttributes struct {
	// The email id string.
	To []string `json:"to" validate:"required"`

	// Whether to add the notification payload to the email.
	AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"`

	// The email address to reply to.
	ReplyToMail *string `json:"reply_to_mail" validate:"required"`

	// The email name to reply to.
	ReplyToName *string `json:"reply_to_name" validate:"required"`

	// The email name of From.
	FromName *string `json:"from_name" validate:"required"`
}

SubscriptionCreateAttributesEmailAttributes : The attributes for an email notification. This model "extends" SubscriptionCreateAttributes

type SubscriptionCreateAttributesFcmAttributes added in v0.0.6 

type SubscriptionCreateAttributesFcmAttributes struct {
}

SubscriptionCreateAttributesFcmAttributes : The attributes for an FCM notification. This model "extends" SubscriptionCreateAttributes

type SubscriptionCreateAttributesIntf 

type SubscriptionCreateAttributesIntf interface {
	// contains filtered or unexported methods
}

type SubscriptionCreateAttributesSmsAttributes 

type SubscriptionCreateAttributesSmsAttributes struct {
	// The phone number to send the SMS to.
	To []string `json:"to" validate:"required"`
}

SubscriptionCreateAttributesSmsAttributes : SMS attributes object. This model "extends" SubscriptionCreateAttributes

type SubscriptionCreateAttributesWebhookAttributes 

type SubscriptionCreateAttributesWebhookAttributes struct {
	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled" validate:"required"`
}

SubscriptionCreateAttributesWebhookAttributes : The attributes for a webhook notification. This model "extends" SubscriptionCreateAttributes

type SubscriptionList 

type SubscriptionList struct {
	// Number of subscriptions.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show subscriptions.
	Limit *int64 `json:"limit" validate:"required"`

	// List of subscriptions.
	Subscriptions []SubscriptionListItem `json:"subscriptions" validate:"required"`
}

SubscriptionList : Subscription list object.

type SubscriptionListItem 

type SubscriptionListItem struct {
	// ID of the subscription.
	ID *string `json:"id" validate:"required"`

	// Name of the subscription.
	Name *string `json:"name" validate:"required"`

	// Description of the subscription.
	Description *string `json:"description" validate:"required"`

	// ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required"`

	// Name of the destination.
	DestinationName *string `json:"destination_name,omitempty"`

	// The type of destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// ID of the topic.
	TopicID *string `json:"topic_id" validate:"required"`

	// Name of the topic.
	TopicName *string `json:"topic_name,omitempty"`

	// Last updated time of the subscription.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

SubscriptionListItem : Subscription list item.

type SubscriptionUpdateAttributes 

type SubscriptionUpdateAttributes struct {
	// The phone number to send the SMS to.
	To []string `json:"to,omitempty"`

	// Whether to add the notification payload to the email.
	AddNotificationPayload *bool `json:"add_notification_payload,omitempty"`

	// The email address to reply to.
	ReplyToMail *string `json:"reply_to_mail,omitempty"`

	// The email name to reply to.
	ReplyToName *string `json:"reply_to_name,omitempty"`

	// The email name of From.
	FromName *string `json:"from_name,omitempty"`

	// The email ids invited.
	Invited []string `json:"invited,omitempty"`

	// The email ids.
	Unsubscribed *EmailUpdateAttributesUnsubscribed `json:"unsubscribed,omitempty"`

	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled,omitempty"`
}

SubscriptionUpdateAttributes : SubscriptionUpdateAttributes struct Models which "extend" this model: - SubscriptionUpdateAttributesSmsAttributes - SubscriptionUpdateAttributesEmailUpdateAttributes - SubscriptionUpdateAttributesWebhookAttributes

type SubscriptionUpdateAttributesEmailUpdateAttributes added in v0.0.5 

type SubscriptionUpdateAttributesEmailUpdateAttributes struct {
	// The email ids.
	To *EmailUpdateAttributesTo `json:"to" validate:"required"`

	// Whether to add the notification payload to the email.
	AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"`

	// The email address to reply to.
	ReplyToMail *string `json:"reply_to_mail" validate:"required"`

	// The email name to reply to.
	ReplyToName *string `json:"reply_to_name" validate:"required"`

	// The email name of From.
	FromName *string `json:"from_name" validate:"required"`

	// The email ids invited.
	Invited []string `json:"invited,omitempty"`

	// The email ids.
	Unsubscribed *EmailUpdateAttributesUnsubscribed `json:"unsubscribed,omitempty"`
}

SubscriptionUpdateAttributesEmailUpdateAttributes : The attributes for an email notification. This model "extends" SubscriptionUpdateAttributes

type SubscriptionUpdateAttributesIntf 

type SubscriptionUpdateAttributesIntf interface {
	// contains filtered or unexported methods
}

type SubscriptionUpdateAttributesSmsAttributes 

type SubscriptionUpdateAttributesSmsAttributes struct {
	// The phone number to send the SMS to.
	To []string `json:"to" validate:"required"`
}

SubscriptionUpdateAttributesSmsAttributes : SMS attributes object. This model "extends" SubscriptionUpdateAttributes

type SubscriptionUpdateAttributesWebhookAttributes 

type SubscriptionUpdateAttributesWebhookAttributes struct {
	// Signing webhook attributes.
	SigningEnabled *bool `json:"signing_enabled" validate:"required"`
}

SubscriptionUpdateAttributesWebhookAttributes : The attributes for a webhook notification. This model "extends" SubscriptionUpdateAttributes

type TagsSubscriptionList added in v0.0.6 

type TagsSubscriptionList struct {
	// Total number of tags.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show tags.
	Limit *int64 `json:"limit" validate:"required"`

	// List of tags.
	TagSubscriptions []TagsSubscriptionListItem `json:"tag_subscriptions" validate:"required"`
}

TagsSubscriptionList : Payload describing a tags list request.

type TagsSubscriptionListItem added in v0.0.6 

type TagsSubscriptionListItem struct {
	// Subscription Tag ID.
	ID *string `json:"id" validate:"required"`

	// Unique identifier of the device.
	DeviceID *string `json:"device_id" validate:"required"`

	// The name of the tag its subscribed.
	TagName *string `json:"tag_name" validate:"required"`

	// The user identifier for the the device registration.
	UserID *string `json:"user_id,omitempty"`

	// Updated at.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`
}

TagsSubscriptionListItem : Tags subscription object.

type Topic 

type Topic struct {
	// Autogenerated topic ID.
	ID *string `json:"id" validate:"required"`

	// Description of the topic.
	Description *string `json:"description" validate:"required"`

	// Name of the topic.
	Name *string `json:"name" validate:"required"`

	// Last time the topic was updated.
	UpdatedAt *string `json:"updated_at" validate:"required"`

	// Number of sources.
	SourceCount *int64 `json:"source_count" validate:"required"`

	// List of sources.
	Sources []SourcesListItem `json:"sources" validate:"required"`

	// Number of subscriptions.
	SubscriptionCount *int64 `json:"subscription_count" validate:"required"`

	// List of subscriptions.
	Subscriptions []SubscriptionListItem `json:"subscriptions" validate:"required"`
}

Topic : Topic object.

type TopicList 

type TopicList struct {
	// Number of topics.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Current offset.
	Offset *int64 `json:"offset" validate:"required"`

	// limit to show subscriptions.
	Limit *int64 `json:"limit" validate:"required"`

	// List of topics.
	Topics []TopicsListItem `json:"topics" validate:"required"`
}

TopicList : Topic list object.

type TopicResponse 

type TopicResponse struct {
	// Autogenerated topic ID.
	ID *string `json:"id" validate:"required"`

	// Name of the topic.
	Name *string `json:"name" validate:"required"`

	// Description of the topic.
	Description *string `json:"description" validate:"required"`

	// Last time the topic was updated.
	CreatedAt *string `json:"created_at" validate:"required"`
}

TopicResponse : Topic object.

type TopicUpdateSourcesItem 

type TopicUpdateSourcesItem struct {
	// ID of the source.
	ID *string `json:"id" validate:"required"`

	// List of rules.
	Rules []Rules `json:"rules" validate:"required"`
}

TopicUpdateSourcesItem : TopicUpdateSourcesItem struct

type TopicsListItem 

type TopicsListItem struct {
	// Autogenerated topic ID.
	ID *string `json:"id" validate:"required"`

	// Name of the topic.
	Name *string `json:"name" validate:"required"`

	// Description of the topic.
	Description *string `json:"description" validate:"required"`

	// Number of sources.
	SourceCount *int64 `json:"source_count" validate:"required"`

	// List of source names.
	SourcesNames []string `json:"sources_names" validate:"required"`

	// Number of subscriptions.
	SubscriptionCount *int64 `json:"subscription_count" validate:"required"`
}

TopicsListItem : Topic list item object.

type UpdateDestinationOptions 

type UpdateDestinationOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Destination.
	ID *string `json:"id" validate:"required,ne="`

	// Destination name.
	Name *string `json:"name,omitempty"`

	// Destination description.
	Description *string `json:"description,omitempty"`

	// Payload describing a destination configuration.
	Config *DestinationConfig `json:"config,omitempty"`

	// Certificate for APNS.
	Certificate io.ReadCloser `json:"certificate,omitempty"`

	// The content type of certificate.
	CertificateContentType *string `json:"certificate_content_type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateDestinationOptions : The UpdateDestination options.

func (*UpdateDestinationOptions) SetCertificate added in v0.0.7 

func (_options *UpdateDestinationOptions) SetCertificate(certificate io.ReadCloser) *UpdateDestinationOptions

SetCertificate : Allow user to set Certificate

func (*UpdateDestinationOptions) SetCertificateContentType added in v0.0.7 

func (_options *UpdateDestinationOptions) SetCertificateContentType(certificateContentType string) *UpdateDestinationOptions

SetCertificateContentType : Allow user to set CertificateContentType

func (*UpdateDestinationOptions) SetConfig 

func (_options *UpdateDestinationOptions) SetConfig(config *DestinationConfig) *UpdateDestinationOptions

SetConfig : Allow user to set Config

func (*UpdateDestinationOptions) SetDescription 

func (_options *UpdateDestinationOptions) SetDescription(description string) *UpdateDestinationOptions

SetDescription : Allow user to set Description

func (*UpdateDestinationOptions) SetHeaders 

func (options *UpdateDestinationOptions) SetHeaders(param map[string]string) *UpdateDestinationOptions

SetHeaders : Allow user to set Headers

func (*UpdateDestinationOptions) SetID 

func (_options *UpdateDestinationOptions) SetID(id string) *UpdateDestinationOptions

SetID : Allow user to set ID

func (*UpdateDestinationOptions) SetInstanceID 

func (_options *UpdateDestinationOptions) SetInstanceID(instanceID string) *UpdateDestinationOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateDestinationOptions) SetName 

func (_options *UpdateDestinationOptions) SetName(name string) *UpdateDestinationOptions

SetName : Allow user to set Name

type UpdateSubscriptionOptions 

type UpdateSubscriptionOptions struct {
	// Unique identifier for IBM Cloud Event Notifications instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Unique identifier for Subscription.
	ID *string `json:"id" validate:"required,ne="`

	// Name of the subscription.
	Name *string `json:"name,omitempty"`

	// Description of the subscription.
	Description *string `json:"description,omitempty"`

	Attributes SubscriptionUpdateAttributesIntf `json:"attributes,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSubscriptionOptions : The UpdateSubscription options.

func (*UpdateSubscriptionOptions) SetAttributes 

func (_options *UpdateSubscriptionOptions) SetAttributes(attributes SubscriptionUpdateAttributesIntf) *UpdateSubscriptionOptions

SetAttributes : Allow user to set Attributes

func (*UpdateSubscriptionOptions) SetDescription 

func (_options *UpdateSubscriptionOptions) SetDescription(description string) *UpdateSubscriptionOptions

SetDescription : Allow user to set Description

func (*UpdateSubscriptionOptions) SetHeaders 

func (options *UpdateSubscriptionOptions) SetHeaders(param map[string]string) *UpdateSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*UpdateSubscriptionOptions) SetID 

func (_options *UpdateSubscriptionOptions) SetID(id string) *UpdateSubscriptionOptions

SetID : Allow user to set ID

func (*UpdateSubscriptionOptions) SetInstanceID 

func (_options *UpdateSubscriptionOptions) SetInstanceID(instanceID string) *UpdateSubscriptionOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateSubscriptionOptions) SetName 

func (_options *UpdateSubscriptionOptions) SetName(name string) *UpdateSubscriptionOptions

SetName : Allow user to set Name

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.