rcs-js 1.0.22 → 2.0.0-rc.2

package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts

@@ -0,0 +1,158 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         agent: {
+ *             color: "#000000",
+ *             description: "Engaging campaigns with RBM \u2013 next-gen SMS marketing with rich content and better analytics.",
+ *             emails: [{
+ *                     email: "founders@trypinnacle.app",
+ *                     label: "Email Us"
+ *                 }],
+ *             heroUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6",
+ *             iconUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3",
+ *             name: "Pinnacle Software Development",
+ *             phones: [{
+ *                     label: "Contact us directly",
+ *                     phone: "+14154467821"
+ *                 }],
+ *             websites: [{
+ *                     label: "Get started with Pinnacle",
+ *                     url: "https://www.trypinnacle.app/"
+ *                 }]
+ *         },
+ *         brand: 2,
+ *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
+ *         links: {
+ *             privacyPolicy: "https://www.trypinnacle.app/privacy",
+ *             termsOfService: "https://www.trypinnacle.app/terms"
+ *         },
+ *         optIn: {
+ *             method: "WEBSITE",
+ *             termsAndConditions: "Would you like to subscribe to Pinnacle?"
+ *         },
+ *         optOut: {
+ *             description: "Reply STOP to opt-out anytime.",
+ *             keywords: ["STOP", "UNSUBSCRIBE", "END"]
+ *         },
+ *         useCase: {
+ *             behavior: "Acts as a customer service representative.",
+ *             value: "OTHER"
+ *         }
+ *     }
+ */
+export interface UpsertRcsCampaignParams {
+    /** Create an agent for the campaign. */
+    agent?: UpsertRcsCampaignParams.Agent;
+    /** Unique identifier for the brand. */
+    brand?: number;
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    /** List of what the agent might say to users (1-5 required). */
+    expectedAgentResponses?: string[];
+    /** Legal documentation links. */
+    links?: UpsertRcsCampaignParams.Links;
+    /** Opt-in configuration. */
+    optIn?: UpsertRcsCampaignParams.OptIn;
+    /** Opt-out configuration. */
+    optOut?: UpsertRcsCampaignParams.OptOut;
+    /** Use case classification for the campaign. */
+    useCase?: UpsertRcsCampaignParams.UseCase;
+}
+export declare namespace UpsertRcsCampaignParams {
+    /**
+     * Create an agent for the campaign.
+     */
+    interface Agent {
+        /**
+         * Color of the agent's buttons. <br>
+         *
+         * Must have sufficient contrast with white.
+         */
+        color?: string;
+        /** Description of the agent. */
+        description?: string;
+        /** List of emails (1-3 required). */
+        emails?: Agent.Emails.Item[];
+        /** Link to the agent's hero. */
+        heroUrl?: string;
+        /** Link to the agent's icon. */
+        iconUrl?: string;
+        /** Name of the agent. */
+        name?: string;
+        /** List of phone numbers (1-3 required). */
+        phones?: Agent.Phones.Item[];
+        /** List of urls (1-3 required). */
+        websites?: Agent.Websites.Item[];
+    }
+    namespace Agent {
+        type Emails = Emails.Item[];
+        namespace Emails {
+            interface Item {
+                /** Email attached to the agent. */
+                email?: string;
+                /** Label for the email. */
+                label?: string;
+            }
+        }
+        type Phones = Phones.Item[];
+        namespace Phones {
+            interface Item {
+                /** Label for the phone number. */
+                label?: string;
+                /** Phone number attached to the agent in E.164 format. */
+                phone?: string;
+            }
+        }
+        type Websites = Websites.Item[];
+        namespace Websites {
+            interface Item {
+                /** Label for the url. */
+                label?: string;
+                /** Url attached to the agent. */
+                url?: string;
+            }
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Opt-in configuration.
+     */
+    interface OptIn {
+        method?: Pinnacle.RcsCampaignOptInMethodEnum;
+        /** Message shown to users explaining what they are agreeing to when opting in. */
+        termsAndConditions?: string;
+    }
+    /**
+     * Opt-out configuration.
+     */
+    interface OptOut {
+        /** Description for the keyword. */
+        description?: string;
+        /**
+         * Keywords to opt-out. <br>
+         *
+         * Each keyword must be a single word with no spaces or whitespace characters.
+         */
+        keywords?: string[];
+    }
+    /**
+     * Use case classification for the campaign.
+     */
+    interface UseCase {
+        /** Summary of the use case. */
+        behavior?: string;
+        value?: Pinnacle.RcsCampaignUseCaseEnum;
+    }
+}

package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type UpsertRcsCampaignParams } from "./UpsertRcsCampaignParams.js";

package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../../../index.js";
+export interface RcsAutofillResponse extends Pinnacle.RcsCampaign {
+    brand?: number;
+}

package/dist/cjs/api/resources/campaigns/resources/rcs/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./RcsAutofillResponse.js";

package/dist/cjs/api/resources/campaigns/resources/rcs/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./RcsAutofillResponse.js"), exports);

package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts

@@ -0,0 +1,136 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Pinnacle from "../../../../../index.js";
+export declare namespace TollFree {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class TollFree {
+    protected readonly _options: TollFree.Options;
+    constructor(_options: TollFree.Options);
+    /**
+     * Generate campaign details based off existing campaign and the brand it's connected to.
+     *
+     * @param {Pinnacle.AutofillCampaignParams} request
+     * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.campaigns.tollFree.autofill({
+     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
+     *         campaignId: 161
+     *     })
+     */
+    autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.TollFreeAutofillResponse>;
+    private __autofill;
+    /**
+     * Retrieve Toll-Free campaign.
+     *
+     * @param {number} campaignId - Unique identifier of toll-free campaign.
+     * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.campaigns.tollFree.get(161)
+     */
+    get(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
+    private __get;
+    /**
+     * Submit your toll-free campaign for approval and activation with carriers.
+     *
+     * @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
+     * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.campaigns.tollFree.submit(161)
+     */
+    submit(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
+    private __submit;
+    /**
+     * Create a new toll-free campaign or updates an existing one.<br>
+     *
+     * Omit campaignId to create a campaign.
+     *
+     * @param {Pinnacle.campaigns.UpsertTollFreeCampaignParams} request
+     * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.campaigns.tollFree.upsert({
+     *         brand: 2,
+     *         campaignId: 161,
+     *         monthlyVolume: "1,000",
+     *         name: "Pinnacle",
+     *         optIn: {
+     *             method: "DIGITAL",
+     *             url: "https://www.pinnacle.sh/",
+     *             workflowDescription: "Visit https://www.pinnacle.sh/"
+     *         },
+     *         productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+     *         useCase: {
+     *             summary: "Alerts clients about any Pinnacle hosted workshops.",
+     *             value: "WORKSHOP_ALERTS"
+     *         }
+     *     })
+     */
+    upsert(request?: Pinnacle.campaigns.UpsertTollFreeCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
+    private __upsert;
+    /**
+     * Validate your toll-free campaign configuration against carrier requirements and compliance rules.
+     *
+     * @param {Pinnacle.ValidateCampaignParams} request
+     * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.campaigns.tollFree.validate({
+     *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
+     *         campaignId: 161
+     *     })
+     */
+    validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
+    private __validate;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}