pingram 0.1.3-alpha.774 → 0.1.4-alpha.775

package/dist/generated/src/models/TemplatePatchRequest.d.ts

@@ -12,61 +12,61 @@
 import type { TemplatePatchRequestAnyOf1Instant } from './TemplatePatchRequestAnyOf1Instant';
 import type { TemplatePatchRequestAnyOf1Batch } from './TemplatePatchRequestAnyOf1Batch';
 /**
- *
+ * Request body for updating a template. Use EMAIL fields (html, subject, senderName, etc.) when channel is EMAIL. Use INAPP_WEB fields (title, redirectURL, imageURL, instant, batch) when channel is INAPP_WEB. Other channels have their own shapes; only include properties that apply to the channel.
  * @export
  * @interface TemplatePatchRequest
  */
 export interface TemplatePatchRequest {
     /**
-     *
+     * HTML body of the email.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     html?: string;
     /**
-     *
+     * Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     internal?: string;
     /**
-     *
+     * Email subject line.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     subject?: string;
     /**
-     *
+     * Sender display name.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     senderName?: string;
     /**
-     *
+     * Sender email address.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     senderEmail?: string;
     /**
-     *
+     * Migration metadata (e.g. from template migration).
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     migration?: string;
     /**
-     *
+     * Notification title (in-app).
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     title?: string;
     /**
-     *
+     * URL to open when the user taps the notification.
      * @type {string}
      * @memberof TemplatePatchRequest
      */
     redirectURL?: string;
     /**
-     *
+     * Image URL shown in the in-app notification.
      * @type {string}
      * @memberof TemplatePatchRequest
      */

package/dist/generated/src/models/TemplatePatchRequestAnyOf.d.ts

@@ -10,43 +10,43 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Properties for updating an EMAIL channel template. All fields are optional; only provided fields are updated.
  * @export
  * @interface TemplatePatchRequestAnyOf
  */
 export interface TemplatePatchRequestAnyOf {
     /**
-     *
+     * HTML body of the email.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */
     html?: string;
     /**
-     *
+     * Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */
     internal?: string;
     /**
-     *
+     * Email subject line.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */
     subject?: string;
     /**
-     *
+     * Sender display name.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */
     senderName?: string;
     /**
-     *
+     * Sender email address.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */
     senderEmail?: string;
     /**
-     *
+     * Migration metadata (e.g. from template migration).
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf
      */

package/dist/generated/src/models/TemplatePatchRequestAnyOf1.d.ts

@@ -12,25 +12,25 @@
 import type { TemplatePatchRequestAnyOf1Instant } from './TemplatePatchRequestAnyOf1Instant';
 import type { TemplatePatchRequestAnyOf1Batch } from './TemplatePatchRequestAnyOf1Batch';
 /**
- *
+ * Properties for updating an INAPP_WEB channel template. All fields are optional; only provided fields are updated. instant and batch configure delivery-mode-specific copy (real-time vs batched).
  * @export
  * @interface TemplatePatchRequestAnyOf1
  */
 export interface TemplatePatchRequestAnyOf1 {
     /**
-     *
+     * Notification title (in-app).
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf1
      */
     title?: string;
     /**
-     *
+     * URL to open when the user taps the notification.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf1
      */
     redirectURL?: string;
     /**
-     *
+     * Image URL shown in the in-app notification.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf1
      */

package/dist/generated/src/models/TemplatePatchRequestAnyOf1Batch.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * In-app batch delivery: title, redirect URL, and image URL shown when the notification is delivered in batch.
  * @export
  * @interface TemplatePatchRequestAnyOf1Batch
  */

package/dist/generated/src/models/TemplatePatchRequestAnyOf1Instant.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * In-app instant delivery: title, redirect URL, and image URL shown when the notification is delivered in real time.
  * @export
  * @interface TemplatePatchRequestAnyOf1Instant
  */
@@ -28,7 +28,7 @@ export interface TemplatePatchRequestAnyOf1Instant {
      */
     redirectURL?: string;
     /**
-     *
+     * Required for instant. Image URL shown in the in-app notification.
      * @type {string}
      * @memberof TemplatePatchRequestAnyOf1Instant
      */

package/dist/generated/src/models/TemplatePostRequest.d.ts

@@ -9,19 +9,130 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { TemplatePostRequestBatch } from './TemplatePostRequestBatch';
+import type { TemplatePostRequestInstant } from './TemplatePostRequestInstant';
 /**
- *
+ * Request body for creating a template. Include templateId (required) plus any channel-specific fields for the channel in the path. Which fields apply depends on the channel (EMAIL, INAPP_WEB, SMS, PUSH, etc.).
  * @export
  * @interface TemplatePostRequest
  */
 export interface TemplatePostRequest {
-    [key: string]: any | any;
     /**
-     *
+     * Unique ID for this template within the notification and channel. Required.
      * @type {string}
      * @memberof TemplatePostRequest
      */
     templateId: string;
+    /**
+     * HTML body of the email.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    html?: string;
+    /**
+     * Preview text (e.g. for inbox).
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    previewText?: string;
+    /**
+     * Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    internal?: string;
+    /**
+     * Email subject line.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    subject?: string;
+    /**
+     * Sender display name.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    senderName?: string;
+    /**
+     * Sender email address.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    senderEmail?: string;
+    /**
+     * Migration metadata (e.g. from template migration).
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    migration?: string;
+    /**
+     * Notification title (in-app).
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    title?: string;
+    /**
+     * URL to open when the user taps the notification.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    redirectURL?: string;
+    /**
+     * Image URL shown in the in-app notification.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    imageURL?: string;
+    /**
+     *
+     * @type {TemplatePostRequestInstant}
+     * @memberof TemplatePostRequest
+     */
+    instant?: TemplatePostRequestInstant;
+    /**
+     *
+     * @type {TemplatePostRequestBatch}
+     * @memberof TemplatePostRequest
+     */
+    batch?: TemplatePostRequestBatch;
+    /**
+     * Message text (SMS or call).
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    text?: string;
+    /**
+     * Push notification body text. (title is shared with INAPP_WEB above.)
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    message?: string;
+    /**
+     * Web push: icon URL. Slack: bot icon (emoji or URL).
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    icon?: string;
+    /**
+     * Web push: URL to open when the notification is clicked.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    url?: string;
+    /**
+     * Slack message blocks (optional).
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof TemplatePostRequest
+     */
+    blocks?: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     * Slack bot username.
+     * @type {string}
+     * @memberof TemplatePostRequest
+     */
+    username?: string;
 }
 /**
  * Check if a given object implements the TemplatePostRequest interface.

package/dist/generated/src/models/TemplatePostRequest.js

@@ -18,6 +18,8 @@ exports.TemplatePostRequestFromJSON = TemplatePostRequestFromJSON;
 exports.TemplatePostRequestFromJSONTyped = TemplatePostRequestFromJSONTyped;
 exports.TemplatePostRequestToJSON = TemplatePostRequestToJSON;
 exports.TemplatePostRequestToJSONTyped = TemplatePostRequestToJSONTyped;
+const TemplatePostRequestBatch_1 = require("./TemplatePostRequestBatch");
+const TemplatePostRequestInstant_1 = require("./TemplatePostRequestInstant");
 /**
  * Check if a given object implements the TemplatePostRequest interface.
  */
@@ -34,8 +36,29 @@ function TemplatePostRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        ...json,
-        templateId: json['templateId']
+        templateId: json['templateId'],
+        html: json['html'] == null ? undefined : json['html'],
+        previewText: json['previewText'] == null ? undefined : json['previewText'],
+        internal: json['internal'] == null ? undefined : json['internal'],
+        subject: json['subject'] == null ? undefined : json['subject'],
+        senderName: json['senderName'] == null ? undefined : json['senderName'],
+        senderEmail: json['senderEmail'] == null ? undefined : json['senderEmail'],
+        migration: json['migration'] == null ? undefined : json['migration'],
+        title: json['title'] == null ? undefined : json['title'],
+        redirectURL: json['redirectURL'] == null ? undefined : json['redirectURL'],
+        imageURL: json['imageURL'] == null ? undefined : json['imageURL'],
+        instant: json['instant'] == null
+            ? undefined
+            : (0, TemplatePostRequestInstant_1.TemplatePostRequestInstantFromJSON)(json['instant']),
+        batch: json['batch'] == null
+            ? undefined
+            : (0, TemplatePostRequestBatch_1.TemplatePostRequestBatchFromJSON)(json['batch']),
+        text: json['text'] == null ? undefined : json['text'],
+        message: json['message'] == null ? undefined : json['message'],
+        icon: json['icon'] == null ? undefined : json['icon'],
+        url: json['url'] == null ? undefined : json['url'],
+        blocks: json['blocks'] == null ? undefined : json['blocks'],
+        username: json['username'] == null ? undefined : json['username']
     };
 }
 function TemplatePostRequestToJSON(json) {
@@ -46,7 +69,24 @@ function TemplatePostRequestToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
-        ...value,
-        templateId: value['templateId']
+        templateId: value['templateId'],
+        html: value['html'],
+        previewText: value['previewText'],
+        internal: value['internal'],
+        subject: value['subject'],
+        senderName: value['senderName'],
+        senderEmail: value['senderEmail'],
+        migration: value['migration'],
+        title: value['title'],
+        redirectURL: value['redirectURL'],
+        imageURL: value['imageURL'],
+        instant: (0, TemplatePostRequestInstant_1.TemplatePostRequestInstantToJSON)(value['instant']),
+        batch: (0, TemplatePostRequestBatch_1.TemplatePostRequestBatchToJSON)(value['batch']),
+        text: value['text'],
+        message: value['message'],
+        icon: value['icon'],
+        url: value['url'],
+        blocks: value['blocks'],
+        username: value['username']
     };
 }

package/dist/generated/src/models/TemplatePostRequestBatch.d.ts

@@ -0,0 +1,44 @@
+/**
+ * NotificationAPI
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Copy for batch delivery.
+ * @export
+ * @interface TemplatePostRequestBatch
+ */
+export interface TemplatePostRequestBatch {
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestBatch
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestBatch
+     */
+    redirectURL: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestBatch
+     */
+    imageURL: string;
+}
+/**
+ * Check if a given object implements the TemplatePostRequestBatch interface.
+ */
+export declare function instanceOfTemplatePostRequestBatch(value: object): value is TemplatePostRequestBatch;
+export declare function TemplatePostRequestBatchFromJSON(json: any): TemplatePostRequestBatch;
+export declare function TemplatePostRequestBatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplatePostRequestBatch;
+export declare function TemplatePostRequestBatchToJSON(json: any): TemplatePostRequestBatch;
+export declare function TemplatePostRequestBatchToJSONTyped(value?: TemplatePostRequestBatch | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/TemplatePostRequestBatch.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NotificationAPI
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfTemplatePostRequestBatch = instanceOfTemplatePostRequestBatch;
+exports.TemplatePostRequestBatchFromJSON = TemplatePostRequestBatchFromJSON;
+exports.TemplatePostRequestBatchFromJSONTyped = TemplatePostRequestBatchFromJSONTyped;
+exports.TemplatePostRequestBatchToJSON = TemplatePostRequestBatchToJSON;
+exports.TemplatePostRequestBatchToJSONTyped = TemplatePostRequestBatchToJSONTyped;
+/**
+ * Check if a given object implements the TemplatePostRequestBatch interface.
+ */
+function instanceOfTemplatePostRequestBatch(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('redirectURL' in value) || value['redirectURL'] === undefined)
+        return false;
+    if (!('imageURL' in value) || value['imageURL'] === undefined)
+        return false;
+    return true;
+}
+function TemplatePostRequestBatchFromJSON(json) {
+    return TemplatePostRequestBatchFromJSONTyped(json, false);
+}
+function TemplatePostRequestBatchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        title: json['title'],
+        redirectURL: json['redirectURL'],
+        imageURL: json['imageURL']
+    };
+}
+function TemplatePostRequestBatchToJSON(json) {
+    return TemplatePostRequestBatchToJSONTyped(json, false);
+}
+function TemplatePostRequestBatchToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        title: value['title'],
+        redirectURL: value['redirectURL'],
+        imageURL: value['imageURL']
+    };
+}

package/dist/generated/src/models/TemplatePostRequestInstant.d.ts

@@ -0,0 +1,44 @@
+/**
+ * NotificationAPI
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Copy for instant (real-time) delivery.
+ * @export
+ * @interface TemplatePostRequestInstant
+ */
+export interface TemplatePostRequestInstant {
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestInstant
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestInstant
+     */
+    redirectURL?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TemplatePostRequestInstant
+     */
+    imageURL: string;
+}
+/**
+ * Check if a given object implements the TemplatePostRequestInstant interface.
+ */
+export declare function instanceOfTemplatePostRequestInstant(value: object): value is TemplatePostRequestInstant;
+export declare function TemplatePostRequestInstantFromJSON(json: any): TemplatePostRequestInstant;
+export declare function TemplatePostRequestInstantFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplatePostRequestInstant;
+export declare function TemplatePostRequestInstantToJSON(json: any): TemplatePostRequestInstant;
+export declare function TemplatePostRequestInstantToJSONTyped(value?: TemplatePostRequestInstant | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/TemplatePostRequestInstant.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NotificationAPI
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfTemplatePostRequestInstant = instanceOfTemplatePostRequestInstant;
+exports.TemplatePostRequestInstantFromJSON = TemplatePostRequestInstantFromJSON;
+exports.TemplatePostRequestInstantFromJSONTyped = TemplatePostRequestInstantFromJSONTyped;
+exports.TemplatePostRequestInstantToJSON = TemplatePostRequestInstantToJSON;
+exports.TemplatePostRequestInstantToJSONTyped = TemplatePostRequestInstantToJSONTyped;
+/**
+ * Check if a given object implements the TemplatePostRequestInstant interface.
+ */
+function instanceOfTemplatePostRequestInstant(value) {
+    if (!('imageURL' in value) || value['imageURL'] === undefined)
+        return false;
+    return true;
+}
+function TemplatePostRequestInstantFromJSON(json) {
+    return TemplatePostRequestInstantFromJSONTyped(json, false);
+}
+function TemplatePostRequestInstantFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        title: json['title'] == null ? undefined : json['title'],
+        redirectURL: json['redirectURL'] == null ? undefined : json['redirectURL'],
+        imageURL: json['imageURL']
+    };
+}
+function TemplatePostRequestInstantToJSON(json) {
+    return TemplatePostRequestInstantToJSONTyped(json, false);
+}
+function TemplatePostRequestInstantToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        title: value['title'],
+        redirectURL: value['redirectURL'],
+        imageURL: value['imageURL']
+    };
+}

package/dist/generated/src/models/index.d.ts

@@ -149,6 +149,8 @@ export * from './TemplatePatchRequestAnyOf1';
 export * from './TemplatePatchRequestAnyOf1Batch';
 export * from './TemplatePatchRequestAnyOf1Instant';
 export * from './TemplatePostRequest';
+export * from './TemplatePostRequestBatch';
+export * from './TemplatePostRequestInstant';
 export * from './UpdateAddressRequest';
 export * from './User';
 export * from './UserSuppressionDeleteResponse';

package/dist/generated/src/models/index.js

@@ -167,6 +167,8 @@ __exportStar(require("./TemplatePatchRequestAnyOf1"), exports);
 __exportStar(require("./TemplatePatchRequestAnyOf1Batch"), exports);
 __exportStar(require("./TemplatePatchRequestAnyOf1Instant"), exports);
 __exportStar(require("./TemplatePostRequest"), exports);
+__exportStar(require("./TemplatePostRequestBatch"), exports);
+__exportStar(require("./TemplatePostRequestInstant"), exports);
 __exportStar(require("./UpdateAddressRequest"), exports);
 __exportStar(require("./User"), exports);
 __exportStar(require("./UserSuppressionDeleteResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "0.1.3-alpha.774",
+  "version": "0.1.4-alpha.775",
   "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
   "main": "dist/index.js",
   "module": "dist/index.js",