twilio 4.6.0 → 4.7.0

package/lib/rest/notify/v1/service/notification.d.ts

@@ -0,0 +1,208 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../../V1";
+type NotificationPriority = "high" | "low";
+/**
+ * Options to pass to create a NotificationInstance
+ */
+export interface NotificationListInstanceCreateOptions {
+    /** The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. */
+    body?: string;
+    /**  */
+    priority?: NotificationPriority;
+    /** How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property. */
+    ttl?: number;
+    /** The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices. */
+    title?: string;
+    /** The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`.  For APNS, this translates to `aps.sound`.  SMS does not support this property. */
+    sound?: string;
+    /** The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels. */
+    action?: string;
+    /** The custom key-value pairs of the notification\\\'s payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels. */
+    data?: any;
+    /** The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. */
+    apn?: any;
+    /** The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.  This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref). */
+    gcm?: any;
+    /** The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings.  Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource.  These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`.  The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array. */
+    sms?: any;
+    /** Deprecated. */
+    facebookMessenger?: any;
+    /** The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel. */
+    fcm?: any;
+    /** The Segment resource is deprecated. Use the `tag` parameter, instead. */
+    segment?: Array<string>;
+    /** Deprecated. */
+    alexa?: any;
+    /** The destination address specified as a JSON string.  Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers. */
+    toBinding?: Array<string>;
+    /** URL to send webhooks. */
+    deliveryCallbackUrl?: string;
+    /** The `identity` value that uniquely identifies the new resource\\\'s [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list. */
+    identity?: Array<string>;
+    /** A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel. */
+    tag?: Array<string>;
+}
+export interface NotificationSolution {
+    serviceSid: string;
+}
+export interface NotificationListInstance {
+    _version: V1;
+    _solution: NotificationSolution;
+    _uri: string;
+    /**
+     * Create a NotificationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed NotificationInstance
+     */
+    create(callback?: (error: Error | null, item?: NotificationInstance) => any): Promise<NotificationInstance>;
+    /**
+     * Create a NotificationInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed NotificationInstance
+     */
+    create(params: NotificationListInstanceCreateOptions, callback?: (error: Error | null, item?: NotificationInstance) => any): Promise<NotificationInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function NotificationListInstance(version: V1, serviceSid: string): NotificationListInstance;
+interface NotificationResource {
+    sid: string;
+    account_sid: string;
+    service_sid: string;
+    date_created: Date;
+    identities: Array<string>;
+    tags: Array<string>;
+    segments: Array<string>;
+    priority: NotificationPriority;
+    ttl: number;
+    title: string;
+    body: string;
+    sound: string;
+    action: string;
+    data: any;
+    apn: any;
+    gcm: any;
+    fcm: any;
+    sms: any;
+    facebook_messenger: any;
+    alexa: any;
+}
+export declare class NotificationInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: NotificationResource, serviceSid: string);
+    /**
+     * The unique string that we created to identify the Notification resource.
+     */
+    sid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource.
+     */
+    accountSid: string;
+    /**
+     * The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with.
+     */
+    serviceSid: string;
+    /**
+     * The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateCreated: Date;
+    /**
+     * The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.
+     */
+    identities: Array<string>;
+    /**
+     * The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.
+     */
+    tags: Array<string>;
+    /**
+     * The list of Segments to notify. The [Segment](https://www.twilio.com/docs/notify/api/segment-resource) resource is deprecated. Use the `tags` property, instead.
+     */
+    segments: Array<string>;
+    priority: NotificationPriority;
+    /**
+     * How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.
+     */
+    ttl: number;
+    /**
+     * The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.
+     */
+    title: string;
+    /**
+     * The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.
+     */
+    body: string;
+    /**
+     * The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`.  For APNS, this translates to `aps.sound`.  SMS does not support this property.
+     */
+    sound: string;
+    /**
+     * The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.
+     */
+    action: string;
+    /**
+     * The custom key-value pairs of the notification\'s payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.
+     */
+    data: any;
+    /**
+     * The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.
+     */
+    apn: any;
+    /**
+     * The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.  This property maps to the root JSON dictionary. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.
+     */
+    gcm: any;
+    /**
+     * The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.
+     */
+    fcm: any;
+    /**
+     * The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings.  Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/api/message-resource) resource.  These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`.  The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.
+     */
+    sms: any;
+    /**
+     * Deprecated.
+     */
+    facebookMessenger: any;
+    /**
+     * Deprecated.
+     */
+    alexa: any;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        accountSid: string;
+        serviceSid: string;
+        dateCreated: Date;
+        identities: string[];
+        tags: string[];
+        segments: string[];
+        priority: NotificationPriority;
+        ttl: number;
+        title: string;
+        body: string;
+        sound: string;
+        action: string;
+        data: any;
+        apn: any;
+        gcm: any;
+        fcm: any;
+        sms: any;
+        facebookMessenger: any;
+        alexa: any;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/notify/v1/service/notification.js

@@ -1,260 +1,152 @@
-'use strict';
-
-/* jshint ignore:start */
-/**
+"use strict";
+/*
  * This code was generated by
- * \ / _    _  _|   _  _
- *  | (_)\/(_)(_|\/| |(/_  v1.0.0
- *       /       /
- */
-/* jshint ignore:end */
-
-var Q = require('q');  /* jshint ignore:line */
-var _ = require('lodash');  /* jshint ignore:line */
-var Page = require('../../../../base/Page');  /* jshint ignore:line */
-var deserialize = require(
-    '../../../../base/deserialize');  /* jshint ignore:line */
-var serialize = require('../../../../base/serialize');  /* jshint ignore:line */
-var values = require('../../../../base/values');  /* jshint ignore:line */
-
-var NotificationList;
-var NotificationPage;
-var NotificationInstance;
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Notify.V1.ServiceContext.NotificationList
- * @description Initialize the NotificationList
- * PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Notify
+ * This is the public Twilio REST API.
  *
- * @param {Twilio.Notify.V1} version - Version of the resource
- * @param {string} serviceSid - The service_sid
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
  */
-/* jshint ignore:end */
-NotificationList = function NotificationList(version, serviceSid) {
-  /* jshint ignore:start */
-  /**
-   * @function notifications
-   * @memberof Twilio.Notify.V1.ServiceContext
-   * @instance
-   *
-   * @param {string} sid - sid of instance
-   *
-   * @returns {Twilio.Notify.V1.ServiceContext.NotificationContext}
-   */
-  /* jshint ignore:end */
-  function NotificationListInstance(sid) {
-    return NotificationListInstance.get(sid);
-  }
-
-  NotificationListInstance._version = version;
-  // Path Solution
-  NotificationListInstance._solution = {
-    serviceSid: serviceSid
-  };
-  NotificationListInstance._uri = _.template(
-    '/Services/<%= serviceSid %>/Notifications' // jshint ignore:line
-  )(NotificationListInstance._solution);
-  /* jshint ignore:start */
-  /**
-   * create a NotificationInstance
-   *
-   * @function create
-   * @memberof Twilio.Notify.V1.ServiceContext.NotificationList
-   * @instance
-   *
-   * @param {object|function} opts - ...
-   * @param {string} opts.serviceSid - The service_sid
-   * @param {string} [opts.body] - The body
-   * @param {notification.priority} [opts.priority] - The priority
-   * @param {number} [opts.ttl] - The ttl
-   * @param {string} [opts.title] - The title
-   * @param {string} [opts.sound] - The sound
-   * @param {string} [opts.action] - The action
-   * @param {string} [opts.data] - The data
-   * @param {string} [opts.apn] - The apn
-   * @param {string} [opts.gcm] - The gcm
-   * @param {string} [opts.sms] - The sms
-   * @param {string} [opts.facebookMessenger] - The facebook_messenger
-   * @param {string} [opts.fcm] - The fcm
-   * @param {string|list} [opts.segment] - The segment
-   * @param {string} [opts.alexa] - The alexa
-   * @param {string|list} [opts.toBinding] - The to_binding
-   * @param {string|list} [opts.identity] - The identity
-   * @param {string|list} [opts.tag] - The tag
-   * @param {function} [callback] - Callback to handle processed record
-   *
-   * @returns {Promise} Resolves to processed NotificationInstance
-   */
-  /* jshint ignore:end */
-  NotificationListInstance.create = function create(opts, callback) {
-    if (_.isFunction(opts)) {
-      callback = opts;
-      opts = {};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationInstance = exports.NotificationListInstance = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../../base/deserialize");
+const serialize = require("../../../../base/serialize");
+const utility_1 = require("../../../../base/utility");
+function NotificationListInstance(version, serviceSid) {
+    if (!(0, utility_1.isValidPathParam)(serviceSid)) {
+        throw new Error("Parameter 'serviceSid' is not valid.");
     }
-    opts = opts || {};
-
-    var deferred = Q.defer();
-    var data = values.of({
-      'Identity': _.get(opts, 'identity'),
-      'Tag': _.get(opts, 'tag'),
-      'Body': _.get(opts, 'body'),
-      'Priority': _.get(opts, 'priority'),
-      'Ttl': _.get(opts, 'ttl'),
-      'Title': _.get(opts, 'title'),
-      'Sound': _.get(opts, 'sound'),
-      'Action': _.get(opts, 'action'),
-      'Data': _.get(opts, 'data'),
-      'Apn': _.get(opts, 'apn'),
-      'Gcm': _.get(opts, 'gcm'),
-      'Sms': _.get(opts, 'sms'),
-      'FacebookMessenger': serialize.object(_.get(opts, 'facebookMessenger')),
-      'Fcm': _.get(opts, 'fcm'),
-      'Segment': _.get(opts, 'segment'),
-      'Alexa': _.get(opts, 'alexa'),
-      'ToBinding': _.get(opts, 'toBinding')
-    });
-
-    var promise = this._version.create({
-      uri: this._uri,
-      method: 'POST',
-      data: data
-    });
-
-    promise = promise.then(function(payload) {
-      deferred.resolve(new NotificationInstance(
-        this._version,
-        payload
-      ));
-    }.bind(this));
-
-    promise.catch(function(error) {
-      deferred.reject(error);
-    });
-
-    if (_.isFunction(callback)) {
-      deferred.promise.nodeify(callback);
+    const instance = {};
+    instance._version = version;
+    instance._solution = { serviceSid };
+    instance._uri = `/Services/${serviceSid}/Notifications`;
+    instance.create = function create(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["body"] !== undefined)
+            data["Body"] = params["body"];
+        if (params["priority"] !== undefined)
+            data["Priority"] = params["priority"];
+        if (params["ttl"] !== undefined)
+            data["Ttl"] = params["ttl"];
+        if (params["title"] !== undefined)
+            data["Title"] = params["title"];
+        if (params["sound"] !== undefined)
+            data["Sound"] = params["sound"];
+        if (params["action"] !== undefined)
+            data["Action"] = params["action"];
+        if (params["data"] !== undefined)
+            data["Data"] = serialize.object(params["data"]);
+        if (params["apn"] !== undefined)
+            data["Apn"] = serialize.object(params["apn"]);
+        if (params["gcm"] !== undefined)
+            data["Gcm"] = serialize.object(params["gcm"]);
+        if (params["sms"] !== undefined)
+            data["Sms"] = serialize.object(params["sms"]);
+        if (params["facebookMessenger"] !== undefined)
+            data["FacebookMessenger"] = serialize.object(params["facebookMessenger"]);
+        if (params["fcm"] !== undefined)
+            data["Fcm"] = serialize.object(params["fcm"]);
+        if (params["segment"] !== undefined)
+            data["Segment"] = serialize.map(params["segment"], (e) => e);
+        if (params["alexa"] !== undefined)
+            data["Alexa"] = serialize.object(params["alexa"]);
+        if (params["toBinding"] !== undefined)
+            data["ToBinding"] = serialize.map(params["toBinding"], (e) => e);
+        if (params["deliveryCallbackUrl"] !== undefined)
+            data["DeliveryCallbackUrl"] = params["deliveryCallbackUrl"];
+        if (params["identity"] !== undefined)
+            data["Identity"] = serialize.map(params["identity"], (e) => e);
+        if (params["tag"] !== undefined)
+            data["Tag"] = serialize.map(params["tag"], (e) => e);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new NotificationInstance(operationVersion, payload, instance._solution.serviceSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.NotificationListInstance = NotificationListInstance;
+class NotificationInstance {
+    constructor(_version, payload, serviceSid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.accountSid = payload.account_sid;
+        this.serviceSid = payload.service_sid;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.identities = payload.identities;
+        this.tags = payload.tags;
+        this.segments = payload.segments;
+        this.priority = payload.priority;
+        this.ttl = deserialize.integer(payload.ttl);
+        this.title = payload.title;
+        this.body = payload.body;
+        this.sound = payload.sound;
+        this.action = payload.action;
+        this.data = payload.data;
+        this.apn = payload.apn;
+        this.gcm = payload.gcm;
+        this.fcm = payload.fcm;
+        this.sms = payload.sms;
+        this.facebookMessenger = payload.facebook_messenger;
+        this.alexa = payload.alexa;
     }
-
-    return deferred.promise;
-  };
-
-  return NotificationListInstance;
-};
-
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Notify.V1.ServiceContext.NotificationPage
- * @augments Page
- * @description Initialize the NotificationPage
- * PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- *
- * @param {Twilio.Notify.V1} version - Version of the resource
- * @param {object} response - Response from the API
- * @param {object} solution - Path solution
- *
- * @returns NotificationPage
- */
-/* jshint ignore:end */
-NotificationPage = function NotificationPage(version, response, solution) {
-  // Path Solution
-  this._solution = solution;
-
-  Page.prototype.constructor.call(this, version, response, this._solution);
-};
-
-_.extend(NotificationPage.prototype, Page.prototype);
-NotificationPage.prototype.constructor = NotificationPage;
-
-/* jshint ignore:start */
-/**
- * Build an instance of NotificationInstance
- *
- * @function getInstance
- * @memberof Twilio.Notify.V1.ServiceContext.NotificationPage
- * @instance
- *
- * @param {object} payload - Payload response from the API
- *
- * @returns NotificationInstance
- */
-/* jshint ignore:end */
-NotificationPage.prototype.getInstance = function getInstance(payload) {
-  return new NotificationInstance(
-    this._version,
-    payload,
-    this._solution.serviceSid
-  );
-};
-
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Notify.V1.ServiceContext.NotificationInstance
- * @description Initialize the NotificationContext
- * PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- *
- * @property {string} sid - The sid
- * @property {string} accountSid - The account_sid
- * @property {string} serviceSid - The service_sid
- * @property {Date} dateCreated - The date_created
- * @property {string} identities - The identities
- * @property {string} tags - The tags
- * @property {string} segments - The segments
- * @property {notification.priority} priority - The priority
- * @property {number} ttl - The ttl
- * @property {string} title - The title
- * @property {string} body - The body
- * @property {string} sound - The sound
- * @property {string} action - The action
- * @property {string} data - The data
- * @property {string} apn - The apn
- * @property {string} gcm - The gcm
- * @property {string} fcm - The fcm
- * @property {string} sms - The sms
- * @property {string} facebookMessenger - The facebook_messenger
- * @property {string} alexa - The alexa
- *
- * @param {Twilio.Notify.V1} version - Version of the resource
- * @param {object} payload - The instance payload
- */
-/* jshint ignore:end */
-NotificationInstance = function NotificationInstance(version, payload,
-                                                      serviceSid) {
-  this._version = version;
-
-  // Marshaled Properties
-  this.sid = payload.sid; // jshint ignore:line
-  this.accountSid = payload.account_sid; // jshint ignore:line
-  this.serviceSid = payload.service_sid; // jshint ignore:line
-  this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
-  this.identities = payload.identities; // jshint ignore:line
-  this.tags = payload.tags; // jshint ignore:line
-  this.segments = payload.segments; // jshint ignore:line
-  this.priority = payload.priority; // jshint ignore:line
-  this.ttl = deserialize.integer(payload.ttl); // jshint ignore:line
-  this.title = payload.title; // jshint ignore:line
-  this.body = payload.body; // jshint ignore:line
-  this.sound = payload.sound; // jshint ignore:line
-  this.action = payload.action; // jshint ignore:line
-  this.data = payload.data; // jshint ignore:line
-  this.apn = payload.apn; // jshint ignore:line
-  this.gcm = payload.gcm; // jshint ignore:line
-  this.fcm = payload.fcm; // jshint ignore:line
-  this.sms = payload.sms; // jshint ignore:line
-  this.facebookMessenger = payload.facebook_messenger; // jshint ignore:line
-  this.alexa = payload.alexa; // jshint ignore:line
-
-  // Context
-  this._context = undefined;
-  this._solution = {
-    serviceSid: serviceSid,
-  };
-};
-
-module.exports = {
-  NotificationList: NotificationList,
-  NotificationPage: NotificationPage,
-  NotificationInstance: NotificationInstance
-};
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            accountSid: this.accountSid,
+            serviceSid: this.serviceSid,
+            dateCreated: this.dateCreated,
+            identities: this.identities,
+            tags: this.tags,
+            segments: this.segments,
+            priority: this.priority,
+            ttl: this.ttl,
+            title: this.title,
+            body: this.body,
+            sound: this.sound,
+            action: this.action,
+            data: this.data,
+            apn: this.apn,
+            gcm: this.gcm,
+            fcm: this.fcm,
+            sms: this.sms,
+            facebookMessenger: this.facebookMessenger,
+            alexa: this.alexa,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.NotificationInstance = NotificationInstance;