@sendly/cli 3.37.1 → 3.39.0

package/dist/lib/rcs-registration.d.ts

@@ -0,0 +1,231 @@
+/**
+ * RCS registration helpers
+ * Shapes, flag sets, body builders and output shared by the `sendly rcs`
+ * registration commands (registration, dossier, brands, agents)
+ */
+export type CustomerStage = "draft" | "in_review" | "changes_requested" | "rejected" | "brand_verification" | "agent_review" | "testing" | "launch_review" | "launching" | "launch_rejected" | "live" | "suspended" | "failed";
+export interface PublicRcsBrand {
+    id: string;
+    reviewStatus: string;
+    customerStage: CustomerStage;
+    displayName: string;
+    legalName: string;
+    legalEntityType: string;
+    organizationType: string;
+    stockSymbol: string | null;
+    websiteUrl: string;
+    ein: string;
+    address: {
+        line1: string;
+        line2: string | null;
+        city: string;
+        state: string;
+        postalCode: string;
+        countryCode: string;
+    };
+    contact: {
+        firstName: string;
+        lastName: string;
+        title: string | null;
+        email: string;
+        phoneNumber: string;
+    };
+    reviewNote: string | null;
+    rejectionReason: string | null;
+    submittedForReviewAt: string | null;
+    sentToCarrierAt: string | null;
+    verifiedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PublicRcsTestDevice {
+    id: string;
+    phoneNumber: string;
+    label: string | null;
+    inviteStatus: string | null;
+    createdAt: string;
+}
+export interface RcsAgentBasics {
+    displayName?: string | null;
+    useCase?: string | null;
+    hostingRegion?: string | null;
+    description?: string | null;
+    logoUrl?: string | null;
+    heroUrl?: string | null;
+    brandColor?: string | null;
+    privacyPolicyUrl?: string | null;
+    termsAndConditionsUrl?: string | null;
+    phoneNumber?: {
+        number?: string | null;
+        label?: string | null;
+    } | null;
+    website?: {
+        url?: string | null;
+        label?: string | null;
+    } | null;
+    email?: {
+        address?: string | null;
+        label?: string | null;
+    } | null;
+}
+export interface RcsCampaign {
+    companyOverview?: string | null;
+    agentOverview?: string | null;
+    interactions?: Array<{
+        interactionType?: string | null;
+        description?: string | null;
+    } | null> | null;
+    messageExamples?: Array<string | null> | null;
+    consentSettings?: {
+        optInMethods?: Array<{
+            methodType?: string | null;
+            description?: string | null;
+        } | null> | null;
+        callToAction?: string | null;
+        callToActionUrl?: string | null;
+        callToActionMediaUrl?: string | null;
+        doubleOptIn?: boolean | null;
+        doubleOptInMessage?: string | null;
+        optInMessage?: string | null;
+        helpResponse?: string | null;
+        optOutResponse?: string | null;
+    } | null;
+    additionalInformation?: string | null;
+}
+export interface RcsTesting {
+    testUrl?: string | null;
+    messageId?: string | null;
+    additionalInformation?: string | null;
+}
+export interface PublicRcsAgent {
+    id: string;
+    brandId: string | null;
+    status: string;
+    reviewStatus: string;
+    customerStage: CustomerStage;
+    displayName: string;
+    useCase: string | null;
+    hostingRegion: string | null;
+    basics: RcsAgentBasics;
+    campaign: RcsCampaign | null;
+    testing: RcsTesting | null;
+    reviewNote: string | null;
+    rejectionReason: string | null;
+    testDevices: PublicRcsTestDevice[];
+    submittedForReviewAt: string | null;
+    basicsSubmittedAt: string | null;
+    launchSubmittedAt: string | null;
+    liveAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface RegistrationResponse {
+    brand: PublicRcsBrand | null;
+    agent: PublicRcsAgent | null;
+    devices: PublicRcsTestDevice[];
+    stage: CustomerStage;
+    usEligible: boolean;
+}
+export interface DossierResponse {
+    brand: Record<string, unknown>;
+    usEligible: boolean;
+    source: "tendlc" | "verification" | "none";
+}
+export type Dict = Record<string, unknown>;
+export declare const LEGAL_ENTITY_TYPES: readonly ["LIMITED_LIABILITY_COMPANY", "CORPORATION", "S_CORPORATION", "PARTNERSHIP", "SOLE_PROPRIETORSHIP"];
+export declare const ORGANIZATION_TYPES: readonly ["PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT", "UNKNOWN"];
+export declare const AGENT_USE_CASES: readonly ["MULTI_USE", "TRANSACTIONAL", "PROMOTIONAL", "OTP"];
+export declare const INTERACTION_TYPES: readonly ["TRANSACTIONAL_UPDATES", "CUSTOMER_SUPPORT", "ACCOUNT_ALERTS", "LOYALTY_OR_REWARD", "MARKETING_OR_PROMOTIONAL", "TWO_WAY_CONVERSATION", "OTHER"];
+export declare const OPT_IN_METHOD_TYPES: readonly ["WEBSITE", "SMS", "MOBILE_APP", "QR_CODE", "SALE_POINT", "OTHER"];
+export declare const STAGE_LABELS: Record<CustomerStage, string>;
+export declare const EARLY_ACCESS_HINT = "RCS is rolling out gradually \u2014 contact support@sendly.live for early access.";
+export declare const idempotencyKeyFlag: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+export declare const BRAND_FLAGS: {
+    "display-name": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "legal-name": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "legal-entity-type": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "organization-type": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    website: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    ein: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "stock-symbol": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "address-line1": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "address-line2": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    city: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    state: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "postal-code": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    country: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "contact-first-name": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "contact-last-name": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "contact-title": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "contact-email": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "contact-phone": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+};
+export declare const BRAND_FIELD_PATHS: Record<string, string[]>;
+export declare const AGENT_BASICS_FLAGS: {
+    "display-name": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "use-case": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    description: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "logo-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "hero-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "brand-color": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "privacy-policy-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "terms-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    phone: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "phone-label": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    website: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "website-label": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    email: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "email-label": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+};
+export declare const AGENT_BASICS_PATHS: Record<string, string[]>;
+export declare const AGENT_CAMPAIGN_FLAGS: {
+    "company-overview": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "agent-overview": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "campaign-info": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    interaction: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "message-example": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "opt-in-method": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "call-to-action": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "call-to-action-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "call-to-action-media-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "double-opt-in": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+    "double-opt-in-message": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "opt-in-message": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "help-response": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "opt-out-response": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+};
+export declare const AGENT_CAMPAIGN_PATHS: Record<string, string[]>;
+export declare const AGENT_TESTING_FLAGS: {
+    "test-url": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "test-message-id": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    "testing-info": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+};
+export declare const AGENT_TESTING_PATHS: Record<string, string[]>;
+export declare function isDict(value: unknown): value is Dict;
+export declare function setPath(target: Dict, path: string[], value: unknown): void;
+export declare function getPath(source: Dict, path: string[]): unknown;
+export declare function readJsonBody(filePath: string): Dict;
+export interface BuildOptions {
+    clearEmpty: boolean;
+}
+export declare function buildBrandBody(flags: Dict, options: BuildOptions): Dict;
+export declare function parseTypedList(raw: string[] | undefined, typeKey: string, allowed: readonly string[], flagName: string): Array<Record<string, string>> | string;
+export declare function buildAgentBody(flags: Dict, options: BuildOptions): Dict | string;
+export declare function parseDeviceFlags(raw: string[] | undefined): Array<{
+    phoneNumber: string;
+    label?: string;
+}> | string;
+export declare function stageLabel(stage: string): string;
+export declare function formatStage(stage: string): string;
+export declare function formatReviewStatus(status: string): string;
+export declare function formatSendStatus(status: string): string;
+export declare function nextStepFor(stage: string, ids: {
+    brandId?: string | null;
+    agentId?: string | null;
+}): string[];
+export declare function printNextSteps(lines: string[]): void;
+export declare function printBrand(brand: PublicRcsBrand): void;
+export declare function printAgent(agent: PublicRcsAgent): void;
+export declare function formatInviteStatus(status: string | null): string;
+export declare function printDevices(devices: PublicRcsTestDevice[]): void;
+export declare function reportRcsError(err: unknown): boolean;