@surgeapi/node 0.26.0 → 0.27.1

package/src/resources/blasts.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as MessagesAPI from './messages';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -58,11 +57,8 @@ export namespace Blast {
   }
 }
 
-/**
- * Parameters for creating a Blast
- */
-export interface BlastParams {
-  attachments?: Array<MessagesAPI.AttachmentParams>;
+export interface BlastCreateParams {
+  attachments?: Array<BlastCreateParams.Attachment>;
 
   /**
    * The message body.
@@ -96,45 +92,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;
-
-  /**
-   * @deprecated Deprecated. Use `to` instead.
-   */
-  segments?: Array<string>;
-
+export namespace BlastCreateParams {
   /**
-   * When to send the blast. If not provided, sends immediately.
+   * Params for creating an attachment
    */
-  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.
-   */
-  to?: Array<string>;
+  export 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 };
 }

package/src/resources/campaigns.ts

@@ -167,251 +167,138 @@ 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;
+export type CampaignCreateParams =
+  | CampaignCreateParams.StandardCampaignParams
+  | CampaignCreateParams.ExternalCampaignParams;
 
-  /**
-   * 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 declare namespace CampaignCreateParams {
+  export 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;
 
-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 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>;
 
-  /**
-   * 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;
 
-  /**
-   * 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'
+    >;
 
-  /**
-   * 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';
 
-  /**
-   * 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 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;
 
-  /**
-   * 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;
+  }
 
-  /**
-   * 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 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 };
 }

package/src/resources/contacts.ts

@@ -87,36 +87,6 @@ export interface Contact {
   metadata?: { [key: string]: string };
 }
 
-/**
- * Parameters for creating a contact
- */
-export interface ContactParams {
-  /**
-   * The contact's phone number in E.164 format.
-   */
-  phone_number: string;
-
-  /**
-   * The contact's email address.
-   */
-  email?: string;
-
-  /**
-   * The contact's first name.
-   */
-  first_name?: string;
-
-  /**
-   * The contact's last name.
-   */
-  last_name?: string;
-
-  /**
-   * Set of key-value pairs that will be stored with the object.
-   */
-  metadata?: { [key: string]: string };
-}
-
 export interface ContactCreateParams {
   /**
    * The contact's phone number in E.164 format.
@@ -174,7 +144,6 @@ export interface ContactUpdateParams {
 export declare namespace Contacts {
   export {
     type Contact as Contact,
-    type ContactParams as ContactParams,
     type ContactCreateParams as ContactCreateParams,
     type ContactUpdateParams as ContactUpdateParams,
   };

package/src/resources/index.ts

@@ -4,36 +4,20 @@ export * from './shared';
 export {
   Accounts,
   type Account,
-  type AccountParams,
   type AccountStatus,
-  type AccountUpdateParams,
   type Organization,
-  type OrganizationParams,
   type AccountCreateParams,
+  type AccountUpdateParams,
   type AccountRetrieveStatusParams,
 } from './accounts';
-export { Blasts, type Blast, type BlastParams, type BlastCreateParams } from './blasts';
-export { Campaigns, type Campaign, type CampaignParams, type CampaignCreateParams } from './campaigns';
-export {
-  Contacts,
-  type Contact,
-  type ContactParams,
-  type ContactCreateParams,
-  type ContactUpdateParams,
-} from './contacts';
-export {
-  Messages,
-  type AttachmentParams,
-  type Message,
-  type MessageParams,
-  type MessageCreateParams,
-} from './messages';
+export { Blasts, type Blast, type BlastCreateParams } from './blasts';
+export { Campaigns, type Campaign, type CampaignCreateParams } from './campaigns';
+export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams } from './contacts';
+export { Messages, type Message, type MessageCreateParams } from './messages';
 export { PhoneNumbers, type PhoneNumber, type PhoneNumberPurchaseParams } from './phone-numbers';
 export {
   Users,
   type User,
-  type UserParams,
-  type UserTokenParams,
   type UserTokenResponse,
   type UserCreateParams,
   type UserUpdateParams,
@@ -43,14 +27,15 @@ export {
   Verifications,
   type Verification,
   type VerificationCheck,
-  type VerificationCheckParams,
-  type VerificationParams,
   type VerificationCreateParams,
+  type VerificationCheckParams,
 } from './verifications';
 export {
   Webhooks,
   type CallEndedWebhookEvent,
   type CampaignApprovedWebhookEvent,
+  type ContactOptedInWebhookEvent,
+  type ContactOptedOutWebhookEvent,
   type ConversationCreatedWebhookEvent,
   type MessageDeliveredWebhookEvent,
   type MessageFailedWebhookEvent,