JSDoc: subscriptions

A module related to xMatters subscriptions.

https://help.xmatters.com/xmapi/index.html#subscriptions

View Source subscriptions.js, line 3

Members

# inner delete

Delete a subscription in xMatters

https://help.xmatters.com/xmapi/index.html#delete-a-subscription

View Source subscriptions.js, line 90

# inner constant fields

The key values from the object that can be synchronized.

View Source subscriptions.js, line 181

Methods

# async inner create(env, subscription) → {Promise.<Subscription>}

Create a subscription in xMatters

https://help.xmatters.com/xmapi/index.html#create-a-subscription

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`subscription`	Subscription	https://help.xmatters.com/xmapi/index.html#subscription-object

View Source subscriptions.js, line 70

Returns:

Subscription Object Created

Type: Promise.<Subscription>

# async inner deleteSubscriber(env, subscriberId, subscriptionId) → {Promise}

Remove a subscriber from a subscription in xMatters

https://help.xmatters.com/xmapi/index.html#unsubscribe-a-user

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`subscriberId`	string	The unique identifier (id) for the person to remove from the subscription Examples: - a1341d69-8b83-4660-b8c8-f2e728f675f9
`subscriptionId`	string	The unique identifier (id) for the subscription. Examples: - b2341d69-8b83-4660-b8c8-f2e728f675f9

View Source subscriptions.js, line 120

Returns:

Type: Promise

# async inner exportToImport(destination, subscriptions, destinationData) → {Promise}

Transforms an array of records exported from xMatters to the format needed to import into xMatters.

Parameters:

Name	Type	Description
`destination`	module:environments.xMattersEnvironment	The xmtoolbox representation of the target or destination xMatters instance.
`subscriptions`	Subscription	https://help.xmatters.com/xmapi/index.html#subscription-object
`destinationData`	xMattersObjects	The xMatters data for the destination.

View Source subscriptions.js, line 136

Returns:

Type: Promise

# async inner get(env, subscriptionId, query) → {Subscription}

Get a subscription from xMatters

https://help.xmatters.com/xmapi/index.html#modify-a-subscription

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`subscriptionId`	string	The unique identifier (id) or name of the subscription. Examples: - b2341d69-8b83-4660-b8c8-f2e728f675f9 - High Security Events
`query`	Object	A json object representing the query string parameters for this request.

View Source subscriptions.js, line 23

Returns:

Subscription Object Requested

Type: Subscription

# async inner getMany(env, query) → {Promise.<Array.<Subscription>>}

Get all subscriptions from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-subscriptions

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`query`	Object	A json object representing the query string parameters for this request.

View Source subscriptions.js, line 36

Returns:

Array of Subscription Objects Requested

Type: Promise.<Array.<Subscription>>

# async inner getSubscribers(env, query, subscriptionId) → {Promise.<Array.<Person>>}

Get all people in a subscription from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-subscribers

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`query`	Object	A json object representing the query string parameters for this request.
`subscriptionId`	string	The unique identifier (id) for the subscription. Examples: - b2341d69-8b83-4660-b8c8-f2e728f675f9

View Source subscriptions.js, line 52

Returns:

Array of Person Objects Requested

Type: Promise.<Array.<Person>>

# async inner sync(destination, sourceSubscriptions, destinationSubscriptions, options)

Synchronizes an array of objects from a source with destination objects and updates the destination as necessary.

Parameters:

Name	Type	Description
`destination`	module:environments.xMattersEnvironment	The xmtoolbox representation of the target or destination xMatters instance.
`sourceSubscriptions`	Array.<Subscription>	An array of the subscription objects to synchronize from the source data.
`destinationSubscriptions`	Array.<Subscription>	An array of the subscription objects to synchronize from the destination data.
`options`	Object

View Source subscriptions.js, line 200

# async inner update(env, subscription, subscriptionId) → {Promise.<Subscription>}

Update a subscription in xMatters

https://help.xmatters.com/xmapi/index.html#modify-a-subscription

Parameters:

Name	Type	Description
`env`	module:environments.xMattersEnvironment	The xmtoolbox representation of an xMatters instance.
`subscription`	Subscription	https://help.xmatters.com/xmapi/index.html#subscription-object
`subscriptionId`	string	The unique identifier (id) for the subscription. Examples: - b2341d69-8b83-4660-b8c8-f2e728f675f9

View Source subscriptions.js, line 86

Returns:

Subscription Object Updated

Type: Promise.<Subscription>