pingram 1.0.39 → 1.0.40-alpha.1695

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

@@ -0,0 +1,262 @@
+/**
+ * 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.
+ */
+/**
+ * Fields for creating a US A2P 10DLC registration. `country` is the country of incorporation (US or CA), not the destination.
+ * @export
+ * @interface SmsRegistrationCreateRequestA2p10dlc
+ */
+export interface SmsRegistrationCreateRequestA2p10dlc {
+    /**
+     * Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignSample1?: string;
+    /**
+     * Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignSample2?: string;
+    /**
+     * Optional third example SMS.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignSample3?: string;
+    /**
+     * Optional fourth example SMS.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignMessageFlow?: string;
+    /**
+     * Extra opt-in keywords as a comma-separated list. START is always included.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignOptinMessage?: string;
+    /**
+     * Extra opt-out keywords as a comma-separated list. STOP is always included.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignOptoutMessage?: string;
+    /**
+     * Extra help keywords as a comma-separated list. HELP is always included.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignHelpMessage?: string;
+    /**
+     * Whether campaign messages include URLs.
+     * @type {boolean}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignEmbeddedLink?: boolean;
+    /**
+     * Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignEmbeddedLinkUrl?: string;
+    /**
+     * Whether campaign messages include phone numbers.
+     * @type {boolean}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignEmbeddedPhone?: boolean;
+    /**
+     * Whether campaign content is age-restricted (18+).
+     * @type {boolean}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignAgeGated?: boolean;
+    /**
+     * Whether the campaign relates to direct lending or loan products.
+     * @type {boolean}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignDirectLending?: boolean;
+    /**
+     * Public URL of the privacy policy that covers this SMS program.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignPrivacyPolicyLink?: string;
+    /**
+     * Public URL of the terms and conditions that cover this SMS program.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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 SmsRegistrationCreateRequestA2p10dlc
+     */
+    campaignUsecase?: string;
+    /**
+     * Who the 10DLC brand is registered for.
+     * - own_brand: personal or company project
+     * - client_brand: agency or contractor
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    scenarioId: SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum;
+    /**
+     * Legal entity type for a 10DLC brand.
+     * - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.)
+     * - SOLE_PROPRIETOR: sole proprietorship
+     * - PUBLIC_PROFIT: publicly traded for-profit
+     * - NON_PROFIT: non-profit
+     * - GOVERNMENT: government
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    businessType: SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum;
+    /**
+     * Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    legalName?: string;
+    /**
+     * Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For companies with no DBA, use the same value as legalName. For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name (set firstName and lastName for that). If the sole proprietor has no DBA, use first and last name.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    displayName: string;
+    /**
+     * Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    firstName?: string;
+    /**
+     * Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    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. Required except when businessType is SOLE_PROPRIETOR.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    taxId?: string;
+    /**
+     * Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    website: string;
+    /**
+     * ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    country: string;
+    /**
+     * Street address that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    street: string;
+    /**
+     * City that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    city: string;
+    /**
+     * State (US) or province (CA) that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    state: string;
+    /**
+     * ZIP code (US) or postal code (CA) that matches official tax registration.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    postalCode: string;
+    /**
+     * Email for the 10DLC compliance contact. Used for carrier and registration follow-up.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    complianceContactEmail: string;
+    /**
+     * Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestA2p10dlc
+     */
+    complianceContactPhone: string;
+}
+/**
+ * @export
+ */
+export declare const SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum: {
+    readonly OWN_BRAND: "own_brand";
+    readonly CLIENT_BRAND: "client_brand";
+};
+export type SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum = (typeof SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum)[keyof typeof SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum];
+/**
+ * @export
+ */
+export declare const SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum: {
+    readonly PRIVATE_PROFIT: "PRIVATE_PROFIT";
+    readonly SOLE_PROPRIETOR: "SOLE_PROPRIETOR";
+    readonly PUBLIC_PROFIT: "PUBLIC_PROFIT";
+    readonly NON_PROFIT: "NON_PROFIT";
+    readonly GOVERNMENT: "GOVERNMENT";
+};
+export type SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum = (typeof SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum)[keyof typeof SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum];
+/**
+ * Check if a given object implements the SmsRegistrationCreateRequestA2p10dlc interface.
+ */
+export declare function instanceOfSmsRegistrationCreateRequestA2p10dlc(value: object): value is SmsRegistrationCreateRequestA2p10dlc;
+export declare function SmsRegistrationCreateRequestA2p10dlcFromJSON(json: any): SmsRegistrationCreateRequestA2p10dlc;
+export declare function SmsRegistrationCreateRequestA2p10dlcFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsRegistrationCreateRequestA2p10dlc;
+export declare function SmsRegistrationCreateRequestA2p10dlcToJSON(json: any): SmsRegistrationCreateRequestA2p10dlc;
+export declare function SmsRegistrationCreateRequestA2p10dlcToJSONTyped(value?: SmsRegistrationCreateRequestA2p10dlc | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,186 @@
+"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.SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum = exports.SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum = void 0;
+exports.instanceOfSmsRegistrationCreateRequestA2p10dlc = instanceOfSmsRegistrationCreateRequestA2p10dlc;
+exports.SmsRegistrationCreateRequestA2p10dlcFromJSON = SmsRegistrationCreateRequestA2p10dlcFromJSON;
+exports.SmsRegistrationCreateRequestA2p10dlcFromJSONTyped = SmsRegistrationCreateRequestA2p10dlcFromJSONTyped;
+exports.SmsRegistrationCreateRequestA2p10dlcToJSON = SmsRegistrationCreateRequestA2p10dlcToJSON;
+exports.SmsRegistrationCreateRequestA2p10dlcToJSONTyped = SmsRegistrationCreateRequestA2p10dlcToJSONTyped;
+/**
+ * @export
+ */
+exports.SmsRegistrationCreateRequestA2p10dlcScenarioIdEnum = {
+    OWN_BRAND: 'own_brand',
+    CLIENT_BRAND: 'client_brand'
+};
+/**
+ * @export
+ */
+exports.SmsRegistrationCreateRequestA2p10dlcBusinessTypeEnum = {
+    PRIVATE_PROFIT: 'PRIVATE_PROFIT',
+    SOLE_PROPRIETOR: 'SOLE_PROPRIETOR',
+    PUBLIC_PROFIT: 'PUBLIC_PROFIT',
+    NON_PROFIT: 'NON_PROFIT',
+    GOVERNMENT: 'GOVERNMENT'
+};
+/**
+ * Check if a given object implements the SmsRegistrationCreateRequestA2p10dlc interface.
+ */
+function instanceOfSmsRegistrationCreateRequestA2p10dlc(value) {
+    if (!('scenarioId' in value) || value['scenarioId'] === undefined)
+        return false;
+    if (!('businessType' in value) || value['businessType'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    if (!('website' in value) || value['website'] === undefined)
+        return false;
+    if (!('country' in value) || value['country'] === undefined)
+        return false;
+    if (!('street' in value) || value['street'] === undefined)
+        return false;
+    if (!('city' in value) || value['city'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('postalCode' in value) || value['postalCode'] === undefined)
+        return false;
+    if (!('complianceContactEmail' in value) ||
+        value['complianceContactEmail'] === undefined)
+        return false;
+    if (!('complianceContactPhone' in value) ||
+        value['complianceContactPhone'] === undefined)
+        return false;
+    return true;
+}
+function SmsRegistrationCreateRequestA2p10dlcFromJSON(json) {
+    return SmsRegistrationCreateRequestA2p10dlcFromJSONTyped(json, false);
+}
+function SmsRegistrationCreateRequestA2p10dlcFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        campaignDescription: json['campaignDescription'] == null
+            ? undefined
+            : json['campaignDescription'],
+        campaignSample1: json['campaignSample1'] == null ? undefined : json['campaignSample1'],
+        campaignSample2: json['campaignSample2'] == null ? undefined : json['campaignSample2'],
+        campaignSample3: json['campaignSample3'] == null ? undefined : json['campaignSample3'],
+        campaignSample4: json['campaignSample4'] == null ? undefined : json['campaignSample4'],
+        campaignMessageFlow: json['campaignMessageFlow'] == null
+            ? undefined
+            : json['campaignMessageFlow'],
+        campaignOptinKeywords: json['campaignOptinKeywords'] == null
+            ? undefined
+            : json['campaignOptinKeywords'],
+        campaignOptinMessage: json['campaignOptinMessage'] == null
+            ? undefined
+            : json['campaignOptinMessage'],
+        campaignOptoutKeywords: json['campaignOptoutKeywords'] == null
+            ? undefined
+            : json['campaignOptoutKeywords'],
+        campaignOptoutMessage: json['campaignOptoutMessage'] == null
+            ? undefined
+            : json['campaignOptoutMessage'],
+        campaignHelpKeywords: json['campaignHelpKeywords'] == null
+            ? undefined
+            : json['campaignHelpKeywords'],
+        campaignHelpMessage: json['campaignHelpMessage'] == null
+            ? undefined
+            : json['campaignHelpMessage'],
+        campaignEmbeddedLink: json['campaignEmbeddedLink'] == null
+            ? undefined
+            : json['campaignEmbeddedLink'],
+        campaignEmbeddedLinkUrl: json['campaignEmbeddedLinkUrl'] == null
+            ? undefined
+            : json['campaignEmbeddedLinkUrl'],
+        campaignEmbeddedPhone: json['campaignEmbeddedPhone'] == null
+            ? undefined
+            : json['campaignEmbeddedPhone'],
+        campaignAgeGated: json['campaignAgeGated'] == null ? undefined : json['campaignAgeGated'],
+        campaignDirectLending: json['campaignDirectLending'] == null
+            ? undefined
+            : json['campaignDirectLending'],
+        campaignPrivacyPolicyLink: json['campaignPrivacyPolicyLink'] == null
+            ? undefined
+            : json['campaignPrivacyPolicyLink'],
+        campaignTermsAndConditionsLink: json['campaignTermsAndConditionsLink'] == null
+            ? undefined
+            : json['campaignTermsAndConditionsLink'],
+        campaignUsecase: json['campaignUsecase'] == null ? undefined : json['campaignUsecase'],
+        scenarioId: json['scenarioId'],
+        businessType: json['businessType'],
+        legalName: json['legalName'] == null ? undefined : json['legalName'],
+        displayName: json['displayName'],
+        firstName: json['firstName'] == null ? undefined : json['firstName'],
+        lastName: json['lastName'] == null ? undefined : json['lastName'],
+        taxId: json['taxId'] == null ? undefined : json['taxId'],
+        website: json['website'],
+        country: json['country'],
+        street: json['street'],
+        city: json['city'],
+        state: json['state'],
+        postalCode: json['postalCode'],
+        complianceContactEmail: json['complianceContactEmail'],
+        complianceContactPhone: json['complianceContactPhone']
+    };
+}
+function SmsRegistrationCreateRequestA2p10dlcToJSON(json) {
+    return SmsRegistrationCreateRequestA2p10dlcToJSONTyped(json, false);
+}
+function SmsRegistrationCreateRequestA2p10dlcToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        campaignDescription: value['campaignDescription'],
+        campaignSample1: value['campaignSample1'],
+        campaignSample2: value['campaignSample2'],
+        campaignSample3: value['campaignSample3'],
+        campaignSample4: value['campaignSample4'],
+        campaignMessageFlow: value['campaignMessageFlow'],
+        campaignOptinKeywords: value['campaignOptinKeywords'],
+        campaignOptinMessage: value['campaignOptinMessage'],
+        campaignOptoutKeywords: value['campaignOptoutKeywords'],
+        campaignOptoutMessage: value['campaignOptoutMessage'],
+        campaignHelpKeywords: value['campaignHelpKeywords'],
+        campaignHelpMessage: value['campaignHelpMessage'],
+        campaignEmbeddedLink: value['campaignEmbeddedLink'],
+        campaignEmbeddedLinkUrl: value['campaignEmbeddedLinkUrl'],
+        campaignEmbeddedPhone: value['campaignEmbeddedPhone'],
+        campaignAgeGated: value['campaignAgeGated'],
+        campaignDirectLending: value['campaignDirectLending'],
+        campaignPrivacyPolicyLink: value['campaignPrivacyPolicyLink'],
+        campaignTermsAndConditionsLink: value['campaignTermsAndConditionsLink'],
+        campaignUsecase: value['campaignUsecase'],
+        scenarioId: value['scenarioId'],
+        businessType: value['businessType'],
+        legalName: value['legalName'],
+        displayName: value['displayName'],
+        firstName: value['firstName'],
+        lastName: value['lastName'],
+        taxId: value['taxId'],
+        website: value['website'],
+        country: value['country'],
+        street: value['street'],
+        city: value['city'],
+        state: value['state'],
+        postalCode: value['postalCode'],
+        complianceContactEmail: value['complianceContactEmail'],
+        complianceContactPhone: value['complianceContactPhone']
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 { LocalNumberAdminUpdateRequestFields } from './LocalNumberAdminUpdateRequestFields';
+import type { SmsRegistrationCreateRequestLocalNumberDocumentsInner } from './SmsRegistrationCreateRequestLocalNumberDocumentsInner';
+/**
+ *
+ * @export
+ * @interface SmsRegistrationCreateRequestLocalNumber
+ */
+export interface SmsRegistrationCreateRequestLocalNumber {
+    /**
+     * Whether this local number is registered to a person or a business.
+     * - personal: an individual. firstName and lastName are that person.
+     * - business: a company. firstName and lastName are the authorized representative.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestLocalNumber
+     */
+    registrationType: SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum;
+    /**
+     *
+     * @type {LocalNumberAdminUpdateRequestFields}
+     * @memberof SmsRegistrationCreateRequestLocalNumber
+     */
+    fields: LocalNumberAdminUpdateRequestFields;
+    /**
+     *
+     * @type {Array<SmsRegistrationCreateRequestLocalNumberDocumentsInner>}
+     * @memberof SmsRegistrationCreateRequestLocalNumber
+     */
+    documents: Array<SmsRegistrationCreateRequestLocalNumberDocumentsInner>;
+}
+/**
+ * @export
+ */
+export declare const SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum: {
+    readonly PERSONAL: "personal";
+    readonly BUSINESS: "business";
+};
+export type SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum = (typeof SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum)[keyof typeof SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum];
+/**
+ * Check if a given object implements the SmsRegistrationCreateRequestLocalNumber interface.
+ */
+export declare function instanceOfSmsRegistrationCreateRequestLocalNumber(value: object): value is SmsRegistrationCreateRequestLocalNumber;
+export declare function SmsRegistrationCreateRequestLocalNumberFromJSON(json: any): SmsRegistrationCreateRequestLocalNumber;
+export declare function SmsRegistrationCreateRequestLocalNumberFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsRegistrationCreateRequestLocalNumber;
+export declare function SmsRegistrationCreateRequestLocalNumberToJSON(json: any): SmsRegistrationCreateRequestLocalNumber;
+export declare function SmsRegistrationCreateRequestLocalNumberToJSONTyped(value?: SmsRegistrationCreateRequestLocalNumber | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,68 @@
+"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.SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum = void 0;
+exports.instanceOfSmsRegistrationCreateRequestLocalNumber = instanceOfSmsRegistrationCreateRequestLocalNumber;
+exports.SmsRegistrationCreateRequestLocalNumberFromJSON = SmsRegistrationCreateRequestLocalNumberFromJSON;
+exports.SmsRegistrationCreateRequestLocalNumberFromJSONTyped = SmsRegistrationCreateRequestLocalNumberFromJSONTyped;
+exports.SmsRegistrationCreateRequestLocalNumberToJSON = SmsRegistrationCreateRequestLocalNumberToJSON;
+exports.SmsRegistrationCreateRequestLocalNumberToJSONTyped = SmsRegistrationCreateRequestLocalNumberToJSONTyped;
+const LocalNumberAdminUpdateRequestFields_1 = require("./LocalNumberAdminUpdateRequestFields");
+const SmsRegistrationCreateRequestLocalNumberDocumentsInner_1 = require("./SmsRegistrationCreateRequestLocalNumberDocumentsInner");
+/**
+ * @export
+ */
+exports.SmsRegistrationCreateRequestLocalNumberRegistrationTypeEnum = {
+    PERSONAL: 'personal',
+    BUSINESS: 'business'
+};
+/**
+ * Check if a given object implements the SmsRegistrationCreateRequestLocalNumber interface.
+ */
+function instanceOfSmsRegistrationCreateRequestLocalNumber(value) {
+    if (!('registrationType' in value) || value['registrationType'] === undefined)
+        return false;
+    if (!('fields' in value) || value['fields'] === undefined)
+        return false;
+    if (!('documents' in value) || value['documents'] === undefined)
+        return false;
+    return true;
+}
+function SmsRegistrationCreateRequestLocalNumberFromJSON(json) {
+    return SmsRegistrationCreateRequestLocalNumberFromJSONTyped(json, false);
+}
+function SmsRegistrationCreateRequestLocalNumberFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        registrationType: json['registrationType'],
+        fields: (0, LocalNumberAdminUpdateRequestFields_1.LocalNumberAdminUpdateRequestFieldsFromJSON)(json['fields']),
+        documents: json['documents'].map(SmsRegistrationCreateRequestLocalNumberDocumentsInner_1.SmsRegistrationCreateRequestLocalNumberDocumentsInnerFromJSON)
+    };
+}
+function SmsRegistrationCreateRequestLocalNumberToJSON(json) {
+    return SmsRegistrationCreateRequestLocalNumberToJSONTyped(json, false);
+}
+function SmsRegistrationCreateRequestLocalNumberToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        registrationType: value['registrationType'],
+        fields: (0, LocalNumberAdminUpdateRequestFields_1.LocalNumberAdminUpdateRequestFieldsToJSON)(value['fields']),
+        documents: (value['documents'] ?? []).map(SmsRegistrationCreateRequestLocalNumberDocumentsInner_1.SmsRegistrationCreateRequestLocalNumberDocumentsInnerToJSON)
+    };
+}

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

@@ -0,0 +1,66 @@
+/**
+ * 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 local-number registration document. Include exactly one of `content` or `url`. Inline `content` is about 4 MB raw in total for the request.
+ * @export
+ * @interface SmsRegistrationCreateRequestLocalNumberDocumentsInner
+ */
+export interface SmsRegistrationCreateRequestLocalNumberDocumentsInner {
+    /**
+     * Which document this is.
+     * - passport_or_id: GB personal, with utility_bill.
+     * - utility_bill: needed for GB registration; must be less than 3 months old.
+     * - company_registration_certificate: GB business, with utility_bill.
+     * - proof_of_address: needed for IL registration; must be less than 3 months old.
+     * - business_registration_certificate: IL business, with proof_of_address.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestLocalNumberDocumentsInner
+     */
+    docKind: SmsRegistrationCreateRequestLocalNumberDocumentsInnerDocKindEnum;
+    /**
+     * File name, including an image or PDF extension.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestLocalNumberDocumentsInner
+     */
+    fileName: string;
+    /**
+     * Base64-encoded image or PDF.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestLocalNumberDocumentsInner
+     */
+    content?: string;
+    /**
+     * HTTPS URL of an image or PDF, up to 10 MB.
+     * @type {string}
+     * @memberof SmsRegistrationCreateRequestLocalNumberDocumentsInner
+     */
+    url?: string;
+}
+/**
+ * @export
+ */
+export declare const SmsRegistrationCreateRequestLocalNumberDocumentsInnerDocKindEnum: {
+    readonly PASSPORT_OR_ID: "passport_or_id";
+    readonly COMPANY_REGISTRATION_CERTIFICATE: "company_registration_certificate";
+    readonly UTILITY_BILL: "utility_bill";
+    readonly BUSINESS_REGISTRATION_CERTIFICATE: "business_registration_certificate";
+    readonly PROOF_OF_ADDRESS: "proof_of_address";
+};
+export type SmsRegistrationCreateRequestLocalNumberDocumentsInnerDocKindEnum = (typeof SmsRegistrationCreateRequestLocalNumberDocumentsInnerDocKindEnum)[keyof typeof SmsRegistrationCreateRequestLocalNumberDocumentsInnerDocKindEnum];
+/**
+ * Check if a given object implements the SmsRegistrationCreateRequestLocalNumberDocumentsInner interface.
+ */
+export declare function instanceOfSmsRegistrationCreateRequestLocalNumberDocumentsInner(value: object): value is SmsRegistrationCreateRequestLocalNumberDocumentsInner;
+export declare function SmsRegistrationCreateRequestLocalNumberDocumentsInnerFromJSON(json: any): SmsRegistrationCreateRequestLocalNumberDocumentsInner;
+export declare function SmsRegistrationCreateRequestLocalNumberDocumentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsRegistrationCreateRequestLocalNumberDocumentsInner;
+export declare function SmsRegistrationCreateRequestLocalNumberDocumentsInnerToJSON(json: any): SmsRegistrationCreateRequestLocalNumberDocumentsInner;
+export declare function SmsRegistrationCreateRequestLocalNumberDocumentsInnerToJSONTyped(value?: SmsRegistrationCreateRequestLocalNumberDocumentsInner | null, ignoreDiscriminator?: boolean): any;