pingram 1.0.39 → 1.0.40-alpha.1693

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

@@ -0,0 +1,80 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pingram
+ * 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.instanceOfSmsLocalNumberSubmitResponseSlotsInner = instanceOfSmsLocalNumberSubmitResponseSlotsInner;
+exports.SmsLocalNumberSubmitResponseSlotsInnerFromJSON = SmsLocalNumberSubmitResponseSlotsInnerFromJSON;
+exports.SmsLocalNumberSubmitResponseSlotsInnerFromJSONTyped = SmsLocalNumberSubmitResponseSlotsInnerFromJSONTyped;
+exports.SmsLocalNumberSubmitResponseSlotsInnerToJSON = SmsLocalNumberSubmitResponseSlotsInnerToJSON;
+exports.SmsLocalNumberSubmitResponseSlotsInnerToJSONTyped = SmsLocalNumberSubmitResponseSlotsInnerToJSONTyped;
+/**
+ * Check if a given object implements the SmsLocalNumberSubmitResponseSlotsInner interface.
+ */
+function instanceOfSmsLocalNumberSubmitResponseSlotsInner(value) {
+    if (!('requirementId' in value) || value['requirementId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('fieldType' in value) || value['fieldType'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('optional' in value) || value['optional'] === undefined)
+        return false;
+    if (!('ready' in value) || value['ready'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('valuePreview' in value) || value['valuePreview'] === undefined)
+        return false;
+    return true;
+}
+function SmsLocalNumberSubmitResponseSlotsInnerFromJSON(json) {
+    return SmsLocalNumberSubmitResponseSlotsInnerFromJSONTyped(json, false);
+}
+function SmsLocalNumberSubmitResponseSlotsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        requirementId: json['requirementId'],
+        name: json['name'],
+        fieldType: json['fieldType'],
+        kind: json['kind'],
+        optional: json['optional'],
+        ready: json['ready'],
+        source: json['source'],
+        valuePreview: json['valuePreview'],
+        missingReason: json['missingReason'] == null ? undefined : json['missingReason']
+    };
+}
+function SmsLocalNumberSubmitResponseSlotsInnerToJSON(json) {
+    return SmsLocalNumberSubmitResponseSlotsInnerToJSONTyped(json, false);
+}
+function SmsLocalNumberSubmitResponseSlotsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        requirementId: value['requirementId'],
+        name: value['name'],
+        fieldType: value['fieldType'],
+        kind: value['kind'],
+        optional: value['optional'],
+        ready: value['ready'],
+        source: value['source'],
+        valuePreview: value['valuePreview'],
+        missingReason: value['missingReason']
+    };
+}

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

@@ -0,0 +1,68 @@
+/**
+ * Pingram
+ * 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.
+ */
+import type { SmsRegistrationA2p10dlc } from './SmsRegistrationA2p10dlc';
+import type { SmsRegistrationLocalNumber } from './SmsRegistrationLocalNumber';
+import type { SmsRegistrationSenderId } from './SmsRegistrationSenderId';
+/**
+ * A registration for one destination country.
+ * @export
+ * @interface SmsRegistration
+ */
+export interface SmsRegistration {
+    /**
+     * ISO 3166-1 alpha-2 destination country.
+     * @type {string}
+     * @memberof SmsRegistration
+     */
+    country: string;
+    /**
+     * Kind segment of /registrations/{country}/{kind}.
+     * @type {string}
+     * @memberof SmsRegistration
+     */
+    kind: SmsRegistrationKindEnum;
+    /**
+     *
+     * @type {SmsRegistrationA2p10dlc}
+     * @memberof SmsRegistration
+     */
+    a2p10dlc?: SmsRegistrationA2p10dlc;
+    /**
+     *
+     * @type {SmsRegistrationLocalNumber}
+     * @memberof SmsRegistration
+     */
+    localNumber?: SmsRegistrationLocalNumber;
+    /**
+     *
+     * @type {SmsRegistrationSenderId}
+     * @memberof SmsRegistration
+     */
+    senderId?: SmsRegistrationSenderId;
+}
+/**
+ * @export
+ */
+export declare const SmsRegistrationKindEnum: {
+    readonly A2P10DLC: "a2p10dlc";
+    readonly LOCAL_NUMBER: "local-number";
+    readonly SENDER_ID: "sender-id";
+};
+export type SmsRegistrationKindEnum = (typeof SmsRegistrationKindEnum)[keyof typeof SmsRegistrationKindEnum];
+/**
+ * Check if a given object implements the SmsRegistration interface.
+ */
+export declare function instanceOfSmsRegistration(value: object): value is SmsRegistration;
+export declare function SmsRegistrationFromJSON(json: any): SmsRegistration;
+export declare function SmsRegistrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsRegistration;
+export declare function SmsRegistrationToJSON(json: any): SmsRegistration;
+export declare function SmsRegistrationToJSONTyped(value?: SmsRegistration | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,78 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pingram
+ * 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.SmsRegistrationKindEnum = void 0;
+exports.instanceOfSmsRegistration = instanceOfSmsRegistration;
+exports.SmsRegistrationFromJSON = SmsRegistrationFromJSON;
+exports.SmsRegistrationFromJSONTyped = SmsRegistrationFromJSONTyped;
+exports.SmsRegistrationToJSON = SmsRegistrationToJSON;
+exports.SmsRegistrationToJSONTyped = SmsRegistrationToJSONTyped;
+const SmsRegistrationA2p10dlc_1 = require("./SmsRegistrationA2p10dlc");
+const SmsRegistrationLocalNumber_1 = require("./SmsRegistrationLocalNumber");
+const SmsRegistrationSenderId_1 = require("./SmsRegistrationSenderId");
+/**
+ * @export
+ */
+exports.SmsRegistrationKindEnum = {
+    A2P10DLC: 'a2p10dlc',
+    LOCAL_NUMBER: 'local-number',
+    SENDER_ID: 'sender-id'
+};
+/**
+ * Check if a given object implements the SmsRegistration interface.
+ */
+function instanceOfSmsRegistration(value) {
+    if (!('country' in value) || value['country'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    return true;
+}
+function SmsRegistrationFromJSON(json) {
+    return SmsRegistrationFromJSONTyped(json, false);
+}
+function SmsRegistrationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        country: json['country'],
+        kind: json['kind'],
+        a2p10dlc: json['a2p10dlc'] == null
+            ? undefined
+            : (0, SmsRegistrationA2p10dlc_1.SmsRegistrationA2p10dlcFromJSON)(json['a2p10dlc']),
+        localNumber: json['localNumber'] == null
+            ? undefined
+            : (0, SmsRegistrationLocalNumber_1.SmsRegistrationLocalNumberFromJSON)(json['localNumber']),
+        senderId: json['senderId'] == null
+            ? undefined
+            : (0, SmsRegistrationSenderId_1.SmsRegistrationSenderIdFromJSON)(json['senderId'])
+    };
+}
+function SmsRegistrationToJSON(json) {
+    return SmsRegistrationToJSONTyped(json, false);
+}
+function SmsRegistrationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        country: value['country'],
+        kind: value['kind'],
+        a2p10dlc: (0, SmsRegistrationA2p10dlc_1.SmsRegistrationA2p10dlcToJSON)(value['a2p10dlc']),
+        localNumber: (0, SmsRegistrationLocalNumber_1.SmsRegistrationLocalNumberToJSON)(value['localNumber']),
+        senderId: (0, SmsRegistrationSenderId_1.SmsRegistrationSenderIdToJSON)(value['senderId'])
+    };
+}

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

@@ -0,0 +1,304 @@
+/**
+ * Pingram
+ * 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.
+ */
+/**
+ * A US A2P 10DLC registration. `country` is the country of incorporation (US or CA), not the destination. `brandStatus` and `campaignStatus` are reviewed separately by carriers.
+ * @export
+ * @interface SmsRegistrationA2p10dlc
+ */
+export interface SmsRegistrationA2p10dlc {
+    /**
+     * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignDescription?: string;
+    /**
+     * Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignSample1?: string;
+    /**
+     * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignSample2?: string;
+    /**
+     * Optional third example SMS.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignSample3?: string;
+    /**
+     * Optional fourth example SMS.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignSample4?: string;
+    /**
+     * How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignMessageFlow?: string;
+    /**
+     * Extra opt-in keywords as a comma-separated list. START is always included.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignOptinKeywords?: string;
+    /**
+     * Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignOptinMessage?: string;
+    /**
+     * Extra opt-out keywords as a comma-separated list. STOP is always included.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignOptoutKeywords?: string;
+    /**
+     * Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignOptoutMessage?: string;
+    /**
+     * Extra help keywords as a comma-separated list. HELP is always included.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignHelpKeywords?: string;
+    /**
+     * Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignHelpMessage?: string;
+    /**
+     * Whether campaign messages include URLs.
+     * @type {boolean}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignEmbeddedLink?: boolean;
+    /**
+     * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignEmbeddedLinkUrl?: string;
+    /**
+     * Whether campaign messages include phone numbers.
+     * @type {boolean}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignEmbeddedPhone?: boolean;
+    /**
+     * Whether campaign content is age-restricted (18+).
+     * @type {boolean}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignAgeGated?: boolean;
+    /**
+     * Whether the campaign relates to direct lending or loan products.
+     * @type {boolean}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignDirectLending?: boolean;
+    /**
+     * Public URL of the privacy policy that covers this SMS program.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignPrivacyPolicyLink?: string;
+    /**
+     * Public URL of the terms and conditions that cover this SMS program.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignTermsAndConditionsLink?: string;
+    /**
+     * 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignUsecase?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    accountId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    scenarioId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    businessType: string;
+    /**
+     * Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    legalName: string;
+    /**
+     * Public brand name shown to recipients and carriers.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    displayName?: string;
+    /**
+     * Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    firstName?: string;
+    /**
+     * Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    lastName?: string;
+    /**
+     * For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    taxId?: string;
+    /**
+     * Public website for the brand.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    website: string;
+    /**
+     * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    country: string;
+    /**
+     * Street address that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    street?: string;
+    /**
+     * City that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    city?: string;
+    /**
+     * State (US) or province (CA) that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    state?: string;
+    /**
+     * ZIP code (US) or postal code (CA) that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    postalCode?: string;
+    /**
+     * Legacy records only; new submissions use structured address fields.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    fullAddress?: string;
+    /**
+     * Email for the 10DLC compliance contact.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    complianceContactEmail: string;
+    /**
+     * Phone number for the 10DLC compliance contact.
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    complianceContactPhone: string;
+    /**
+     * Pingram-side 10DLC registration workflow status (brand or campaign).
+     * - not_started: no customer submission yet
+     * - pending_review: customer submitted; Pingram has not submitted to carriers
+     * - in_progress: submitted for carrier review
+     * - approved | rejected | info_needed: review outcome
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    brandStatus: SmsRegistrationA2p10dlcBrandStatusEnum;
+    /**
+     * Pingram-side 10DLC registration workflow status (brand or campaign).
+     * - not_started: no customer submission yet
+     * - pending_review: customer submitted; Pingram has not submitted to carriers
+     * - in_progress: submitted for carrier review
+     * - approved | rejected | info_needed: review outcome
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    campaignStatus: SmsRegistrationA2p10dlcCampaignStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SmsRegistrationA2p10dlc
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const SmsRegistrationA2p10dlcBrandStatusEnum: {
+    readonly NOT_STARTED: "not_started";
+    readonly IN_PROGRESS: "in_progress";
+    readonly PENDING_REVIEW: "pending_review";
+    readonly APPROVED: "approved";
+    readonly REJECTED: "rejected";
+    readonly INFO_NEEDED: "info_needed";
+};
+export type SmsRegistrationA2p10dlcBrandStatusEnum = (typeof SmsRegistrationA2p10dlcBrandStatusEnum)[keyof typeof SmsRegistrationA2p10dlcBrandStatusEnum];
+/**
+ * @export
+ */
+export declare const SmsRegistrationA2p10dlcCampaignStatusEnum: {
+    readonly NOT_STARTED: "not_started";
+    readonly IN_PROGRESS: "in_progress";
+    readonly PENDING_REVIEW: "pending_review";
+    readonly APPROVED: "approved";
+    readonly REJECTED: "rejected";
+    readonly INFO_NEEDED: "info_needed";
+};
+export type SmsRegistrationA2p10dlcCampaignStatusEnum = (typeof SmsRegistrationA2p10dlcCampaignStatusEnum)[keyof typeof SmsRegistrationA2p10dlcCampaignStatusEnum];
+/**
+ * Check if a given object implements the SmsRegistrationA2p10dlc interface.
+ */
+export declare function instanceOfSmsRegistrationA2p10dlc(value: object): value is SmsRegistrationA2p10dlc;
+export declare function SmsRegistrationA2p10dlcFromJSON(json: any): SmsRegistrationA2p10dlc;
+export declare function SmsRegistrationA2p10dlcFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsRegistrationA2p10dlc;
+export declare function SmsRegistrationA2p10dlcToJSON(json: any): SmsRegistrationA2p10dlc;
+export declare function SmsRegistrationA2p10dlcToJSONTyped(value?: SmsRegistrationA2p10dlc | null, ignoreDiscriminator?: boolean): any;