@surgeapi/node 0.26.0 → 0.27.1

package/resources/blasts.d.mts

@@ -1,5 +1,4 @@
 import { APIResource } from "../core/resource.mjs";
-import * as MessagesAPI from "./messages.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Blasts extends APIResource {
@@ -45,11 +44,8 @@ export declare namespace Blast {
         url?: string;
     }
 }
-/**
- * Parameters for creating a Blast
- */
-export interface BlastParams {
-    attachments?: Array<MessagesAPI.AttachmentParams>;
+export interface BlastCreateParams {
+    attachments?: Array<BlastCreateParams.Attachment>;
     /**
      * The message body.
      */
@@ -76,35 +72,18 @@ export interface BlastParams {
      */
     to?: Array<string>;
 }
-export interface BlastCreateParams {
-    attachments?: Array<MessagesAPI.AttachmentParams>;
-    /**
-     * The message body.
-     */
-    body?: string;
-    /**
-     * @deprecated Deprecated. Use `to` instead.
-     */
-    contacts?: Array<string>;
-    /**
-     * Optional name for the blast.
-     */
-    name?: string;
+export declare namespace BlastCreateParams {
     /**
-     * @deprecated Deprecated. Use `to` instead.
-     */
-    segments?: Array<string>;
-    /**
-     * When to send the blast. If not provided, sends immediately.
-     */
-    send_at?: string;
-    /**
-     * List of recipients to whom the blast should be sent. This can be a combination
-     * of contact IDs, segment IDs, and phone numbers.
+     * Params for creating an attachment
      */
-    to?: Array<string>;
+    interface Attachment {
+        /**
+         * The URL of the attachment.
+         */
+        url: string;
+    }
 }
 export declare namespace Blasts {
-    export { type Blast as Blast, type BlastParams as BlastParams, type BlastCreateParams as BlastCreateParams, };
+    export { type Blast as Blast, type BlastCreateParams as BlastCreateParams };
 }
 //# sourceMappingURL=blasts.d.mts.map

package/resources/blasts.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"blasts.d.mts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"blasts.d.mts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC7E"}

package/resources/blasts.d.ts

@@ -1,5 +1,4 @@
 import { APIResource } from "../core/resource.js";
-import * as MessagesAPI from "./messages.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Blasts extends APIResource {
@@ -45,11 +44,8 @@ export declare namespace Blast {
         url?: string;
     }
 }
-/**
- * Parameters for creating a Blast
- */
-export interface BlastParams {
-    attachments?: Array<MessagesAPI.AttachmentParams>;
+export interface BlastCreateParams {
+    attachments?: Array<BlastCreateParams.Attachment>;
     /**
      * The message body.
      */
@@ -76,35 +72,18 @@ export interface BlastParams {
      */
     to?: Array<string>;
 }
-export interface BlastCreateParams {
-    attachments?: Array<MessagesAPI.AttachmentParams>;
-    /**
-     * The message body.
-     */
-    body?: string;
-    /**
-     * @deprecated Deprecated. Use `to` instead.
-     */
-    contacts?: Array<string>;
-    /**
-     * Optional name for the blast.
-     */
-    name?: string;
+export declare namespace BlastCreateParams {
     /**
-     * @deprecated Deprecated. Use `to` instead.
-     */
-    segments?: Array<string>;
-    /**
-     * When to send the blast. If not provided, sends immediately.
-     */
-    send_at?: string;
-    /**
-     * List of recipients to whom the blast should be sent. This can be a combination
-     * of contact IDs, segment IDs, and phone numbers.
+     * Params for creating an attachment
      */
-    to?: Array<string>;
+    interface Attachment {
+        /**
+         * The URL of the attachment.
+         */
+        url: string;
+    }
 }
 export declare namespace Blasts {
-    export { type Blast as Blast, type BlastParams as BlastParams, type BlastCreateParams as BlastCreateParams, };
+    export { type Blast as Blast, type BlastCreateParams as BlastCreateParams };
 }
 //# sourceMappingURL=blasts.d.ts.map

package/resources/blasts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blasts.d.ts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"blasts.d.ts","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC7E"}

package/resources/blasts.js.map

@@ -1 +1 @@
-{"version":3,"file":"blasts.js","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAdD,wBAcC"}
+{"version":3,"file":"blasts.js","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAdD,wBAcC"}

package/resources/blasts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"blasts.mjs","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF"}
+{"version":3,"file":"blasts.mjs","sourceRoot":"","sources":["../src/resources/blasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAuB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF"}

package/resources/campaigns.d.mts

@@ -139,208 +139,115 @@ export interface Campaign {
      */
     terms_and_conditions_url?: string;
 }
-/**
- * Parameters for creating a new campaign
- */
-export interface CampaignParams {
-    /**
-     * A string explaining the method through which end users will opt in to receive
-     * messages from the brand. Typically this should include URLs for opt-in forms or
-     * screenshots that might be helpful in explaining the flow to someone unfamiliar
-     * with the organization's purpose.
-     */
-    consent_flow: string;
-    /**
-     * An explanation of the organization's purpose and how it will be using text
-     * messaging to accomplish that purpose.
-     */
-    description: string;
-    /**
-     * An array of 2-5 strings with examples of the messages that will be sent from
-     * this campaign. Typically the first sample should be a compliance message like
-     * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
-     * These samples don't necessarily need to be the only templates that will be used
-     * for the campaign, but they should reflect the purpose of the messages that will
-     * be sent. Any variable content can be reflected by wrapping it in square brackets
-     * like `[customer name]`.
-     */
-    message_samples: Array<string>;
-    /**
-     * The URL of the privacy policy for the brand in question. This may be a shared
-     * privacy policy if it's the policy that is displayed to end users when they opt
-     * in to messaging.
-     */
-    privacy_policy_url: string;
-    /**
-     * A list containing 1-5 types of messages that will be sent with this campaign.
-     *
-     * The following use cases are typically available to all brands:
-     *
-     * - `account_notification` - For sending reminders, alerts, and general
-     *   account-related notifications like booking confirmations or appointment
-     *   reminders.
-     * - `customer_care` - For account support, troubleshooting, and general customer
-     *   service communication.
-     * - `delivery_notification` - For notifying customers about the status of product
-     *   or service deliveries.
-     * - `fraud_alert` - For warning customers about suspicious or potentially
-     *   fraudulent activity.
-     * - `higher_education` - For messaging related to colleges, universities, and
-     *   school districts outside of K–12.
-     * - `marketing` - For promotional or advertising messages intended to market
-     *   products or services.
-     * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
-     * - `public_service_announcement` - For raising awareness about social issues or
-     *   important public information.
-     * - `security_alert` - For alerts related to potential security breaches or
-     *   compromised systems requiring user action.
-     * - `two_factor_authentication` - For sending one-time passwords or verification
-     *   codes for login or password reset.
-     *
-     * For access to special use cases not shown here, reach out to support@surge.app.
-     */
-    use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
-    /**
-     * This will be one of the following:
-     *
-     * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-     *   T-Mobile customers each day. In this case your platform will be charged for
-     *   the setup fee for a low volume number upon receipt of the API request.
-     * - `high` - The campaign will be allowed to send up to 200k SMS segments to
-     *   T-Mobile customers each day, depending on the trust score assigned by The
-     *   Campaign Registry. Your platform will be charged for the setup fee for a high
-     *   volume number upon receipt of the API request, and phone numbers will be
-     *   charged as high volume numbers going forward.
-     */
-    volume: 'high' | 'low';
-    /**
-     * A list of properties that this campaign should include. These properties can be
-     * any of the following values:
-     *
-     * - `links` - whether the campaign might send links in messages
-     * - `phone_numbers` - whether the campaign might send phone numbers in messages
-     * - `age_gated` - whether the campaign contains age gated content (controlled
-     *   substances or adult content)
-     * - `direct_lending` - whether the campaign contains content related to direct
-     *   lending or other loan arrangements
-     */
-    includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
-    /**
-     * A sample link that might be sent by this campaign. If links from other domains
-     * are sent through this campaign, they are much more likely to be filtered by the
-     * carriers. If link shortening is enabled for the account, the link shortener URL
-     * will be used instead of what is provided. Reach out to support if you would like
-     * to disable automatic link shortening.
-     */
-    link_sample?: string;
-    /**
-     * The URL of the terms and conditions presented to end users when they opt in to
-     * messaging. These terms and conditions may be shared among all of a platform's
-     * customers if they're the terms that are presented to end users when they opt in
-     * to messaging.
-     */
-    terms_and_conditions_url?: string;
-}
-export interface CampaignCreateParams {
-    /**
-     * A string explaining the method through which end users will opt in to receive
-     * messages from the brand. Typically this should include URLs for opt-in forms or
-     * screenshots that might be helpful in explaining the flow to someone unfamiliar
-     * with the organization's purpose.
-     */
-    consent_flow: string;
-    /**
-     * An explanation of the organization's purpose and how it will be using text
-     * messaging to accomplish that purpose.
-     */
-    description: string;
-    /**
-     * An array of 2-5 strings with examples of the messages that will be sent from
-     * this campaign. Typically the first sample should be a compliance message like
-     * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
-     * These samples don't necessarily need to be the only templates that will be used
-     * for the campaign, but they should reflect the purpose of the messages that will
-     * be sent. Any variable content can be reflected by wrapping it in square brackets
-     * like `[customer name]`.
-     */
-    message_samples: Array<string>;
-    /**
-     * The URL of the privacy policy for the brand in question. This may be a shared
-     * privacy policy if it's the policy that is displayed to end users when they opt
-     * in to messaging.
-     */
-    privacy_policy_url: string;
-    /**
-     * A list containing 1-5 types of messages that will be sent with this campaign.
-     *
-     * The following use cases are typically available to all brands:
-     *
-     * - `account_notification` - For sending reminders, alerts, and general
-     *   account-related notifications like booking confirmations or appointment
-     *   reminders.
-     * - `customer_care` - For account support, troubleshooting, and general customer
-     *   service communication.
-     * - `delivery_notification` - For notifying customers about the status of product
-     *   or service deliveries.
-     * - `fraud_alert` - For warning customers about suspicious or potentially
-     *   fraudulent activity.
-     * - `higher_education` - For messaging related to colleges, universities, and
-     *   school districts outside of K–12.
-     * - `marketing` - For promotional or advertising messages intended to market
-     *   products or services.
-     * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
-     * - `public_service_announcement` - For raising awareness about social issues or
-     *   important public information.
-     * - `security_alert` - For alerts related to potential security breaches or
-     *   compromised systems requiring user action.
-     * - `two_factor_authentication` - For sending one-time passwords or verification
-     *   codes for login or password reset.
-     *
-     * For access to special use cases not shown here, reach out to support@surge.app.
-     */
-    use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
-    /**
-     * This will be one of the following:
-     *
-     * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-     *   T-Mobile customers each day. In this case your platform will be charged for
-     *   the setup fee for a low volume number upon receipt of the API request.
-     * - `high` - The campaign will be allowed to send up to 200k SMS segments to
-     *   T-Mobile customers each day, depending on the trust score assigned by The
-     *   Campaign Registry. Your platform will be charged for the setup fee for a high
-     *   volume number upon receipt of the API request, and phone numbers will be
-     *   charged as high volume numbers going forward.
-     */
-    volume: 'high' | 'low';
-    /**
-     * A list of properties that this campaign should include. These properties can be
-     * any of the following values:
-     *
-     * - `links` - whether the campaign might send links in messages
-     * - `phone_numbers` - whether the campaign might send phone numbers in messages
-     * - `age_gated` - whether the campaign contains age gated content (controlled
-     *   substances or adult content)
-     * - `direct_lending` - whether the campaign contains content related to direct
-     *   lending or other loan arrangements
-     */
-    includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
-    /**
-     * A sample link that might be sent by this campaign. If links from other domains
-     * are sent through this campaign, they are much more likely to be filtered by the
-     * carriers. If link shortening is enabled for the account, the link shortener URL
-     * will be used instead of what is provided. Reach out to support if you would like
-     * to disable automatic link shortening.
-     */
-    link_sample?: string;
-    /**
-     * The URL of the terms and conditions presented to end users when they opt in to
-     * messaging. These terms and conditions may be shared among all of a platform's
-     * customers if they're the terms that are presented to end users when they opt in
-     * to messaging.
-     */
-    terms_and_conditions_url?: string;
+export type CampaignCreateParams = CampaignCreateParams.StandardCampaignParams | CampaignCreateParams.ExternalCampaignParams;
+export declare namespace CampaignCreateParams {
+    interface StandardCampaignParams {
+        /**
+         * A string explaining the method through which end users will opt in to receive
+         * messages from the brand. Typically this should include URLs for opt-in forms or
+         * screenshots that might be helpful in explaining the flow to someone unfamiliar
+         * with the organization's purpose.
+         */
+        consent_flow: string;
+        /**
+         * An explanation of the organization's purpose and how it will be using text
+         * messaging to accomplish that purpose.
+         */
+        description: string;
+        /**
+         * An array of 2-5 strings with examples of the messages that will be sent from
+         * this campaign. Typically the first sample should be a compliance message like
+         * `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
+         * These samples don't necessarily need to be the only templates that will be used
+         * for the campaign, but they should reflect the purpose of the messages that will
+         * be sent. Any variable content can be reflected by wrapping it in square brackets
+         * like `[customer name]`.
+         */
+        message_samples: Array<string>;
+        /**
+         * The URL of the privacy policy for the brand in question. This may be a shared
+         * privacy policy if it's the policy that is displayed to end users when they opt
+         * in to messaging.
+         */
+        privacy_policy_url: string;
+        /**
+         * A list containing 1-5 types of messages that will be sent with this campaign.
+         *
+         * The following use cases are typically available to all brands:
+         *
+         * - `account_notification` - For sending reminders, alerts, and general
+         *   account-related notifications like booking confirmations or appointment
+         *   reminders.
+         * - `customer_care` - For account support, troubleshooting, and general customer
+         *   service communication.
+         * - `delivery_notification` - For notifying customers about the status of product
+         *   or service deliveries.
+         * - `fraud_alert` - For warning customers about suspicious or potentially
+         *   fraudulent activity.
+         * - `higher_education` - For messaging related to colleges, universities, and
+         *   school districts outside of K–12.
+         * - `marketing` - For promotional or advertising messages intended to market
+         *   products or services.
+         * - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
+         * - `public_service_announcement` - For raising awareness about social issues or
+         *   important public information.
+         * - `security_alert` - For alerts related to potential security breaches or
+         *   compromised systems requiring user action.
+         * - `two_factor_authentication` - For sending one-time passwords or verification
+         *   codes for login or password reset.
+         *
+         * For access to special use cases not shown here, reach out to support@surge.app.
+         */
+        use_cases: Array<'account_notification' | 'customer_care' | 'delivery_notification' | 'fraud_alert' | 'higher_education' | 'marketing' | 'polling_voting' | 'public_service_announcement' | 'security_alert' | 'two_factor_authentication'>;
+        /**
+         * This will be one of the following:
+         *
+         * - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+         *   T-Mobile customers each day. In this case your platform will be charged for
+         *   the setup fee for a low volume number upon receipt of the API request.
+         * - `high` - The campaign will be allowed to send up to 200k SMS segments to
+         *   T-Mobile customers each day, depending on the trust score assigned by The
+         *   Campaign Registry. Your platform will be charged for the setup fee for a high
+         *   volume number upon receipt of the API request, and phone numbers will be
+         *   charged as high volume numbers going forward.
+         */
+        volume: 'high' | 'low';
+        /**
+         * A list of properties that this campaign should include. These properties can be
+         * any of the following values:
+         *
+         * - `links` - whether the campaign might send links in messages
+         * - `phone_numbers` - whether the campaign might send phone numbers in messages
+         * - `age_gated` - whether the campaign contains age gated content (controlled
+         *   substances or adult content)
+         * - `direct_lending` - whether the campaign contains content related to direct
+         *   lending or other loan arrangements
+         */
+        includes?: Array<'links' | 'phone_numbers' | 'age_gated' | 'direct_lending'>;
+        /**
+         * A sample link that might be sent by this campaign. If links from other domains
+         * are sent through this campaign, they are much more likely to be filtered by the
+         * carriers. If link shortening is enabled for the account, the link shortener URL
+         * will be used instead of what is provided. Reach out to support if you would like
+         * to disable automatic link shortening.
+         */
+        link_sample?: string;
+        /**
+         * The URL of the terms and conditions presented to end users when they opt in to
+         * messaging. These terms and conditions may be shared among all of a platform's
+         * customers if they're the terms that are presented to end users when they opt in
+         * to messaging.
+         */
+        terms_and_conditions_url?: string;
+    }
+    interface ExternalCampaignParams {
+        /**
+         * The Campaign Registry (TCR) ID for the externally registered campaign
+         */
+        tcr_id: string;
+    }
 }
 export declare namespace Campaigns {
-    export { type Campaign as Campaign, type CampaignParams as CampaignParams, type CampaignCreateParams as CampaignCreateParams, };
+    export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
 }
 //# sourceMappingURL=campaigns.d.mts.map

package/resources/campaigns.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"campaigns.d.mts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;IAE5E;;;;;;;;OAQG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,sBAAsB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;;;;WAQG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,SAAS,EAAE,KAAK,CACZ,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,6BAA6B,GAC7B,gBAAgB,GAChB,2BAA2B,CAC9B,CAAC;QAEF;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;QAEvB;;;;;;;;;;WAUG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,WAAW,GAAG,gBAAgB,CAAC,CAAC;QAE7E;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACzF"}