@surgeapi/node 0.26.0 → 0.27.0

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,128 +167,6 @@ 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
@@ -409,9 +287,5 @@ export interface CampaignCreateParams {
 }
 
 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,

package/src/resources/messages.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 * as ContactsAPI from './contacts';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -52,16 +51,6 @@ export class Messages extends APIResource {
   }
 }
 
-/**
- * Params for creating an attachment
- */
-export interface AttachmentParams {
-  /**
-   * The URL of the attachment.
-   */
-  url: string;
-}
-
 /**
  * A Message is a communication sent to a Contact.
  */
@@ -148,18 +137,11 @@ export namespace Message {
   }
 }
 
-/**
- * Payload for creating a message. Either an attachment or the body must be given.
- * You can specify the recipient either using the 'conversation' parameter or the
- * 'to'/'from' parameters, but not both.
- */
-export type MessageParams = MessageParams.MessageParamsWithConversation | MessageParams.SimpleMessageParams;
+export type MessageCreateParams =
+  | MessageCreateParams.MessageParamsWithConversation
+  | MessageCreateParams.SimpleMessageParams;
 
-export namespace MessageParams {
-  /**
-   * Create a message while including parameters for the conversation in which the
-   * message should be sent.
-   */
+export declare namespace MessageCreateParams {
   export interface MessageParamsWithConversation {
     /**
      * Params for selecting or creating a new conversation. Either the id or the
@@ -167,7 +149,7 @@ export namespace MessageParams {
      */
     conversation: MessageParamsWithConversation.Conversation;
 
-    attachments?: Array<MessagesAPI.AttachmentParams>;
+    attachments?: Array<MessageParamsWithConversation.Attachment>;
 
     /**
      * The message body.
@@ -190,7 +172,7 @@ export namespace MessageParams {
       /**
        * Parameters for creating a contact
        */
-      contact: ContactsAPI.ContactParams;
+      contact: Conversation.Contact;
 
       /**
        * The phone number from which to send the message. This can be either the phone
@@ -198,81 +180,47 @@ export namespace MessageParams {
        */
       phone_number?: string;
     }
-  }
-
-  /**
-   * Create a basic message by specifying just the to/from phone numbers.
-   */
-  export interface SimpleMessageParams {
-    /**
-     * The recipient's phone number in E.164 format. Cannot be used together with
-     * 'conversation'.
-     */
-    to: string;
-
-    attachments?: Array<MessagesAPI.AttachmentParams>;
-
-    /**
-     * The message body.
-     */
-    body?: string;
-
-    /**
-     * The sender's phone number in E.164 format or phone number ID. If omitted, uses
-     * the account's default phone number. Cannot be used together with 'conversation'.
-     */
-    from?: string;
-
-    /**
-     * An optional datetime for scheduling message up to a couple of months in the
-     * future.
-     */
-    send_at?: string;
-  }
-}
 
-export type MessageCreateParams =
-  | MessageCreateParams.MessageParamsWithConversation
-  | MessageCreateParams.SimpleMessageParams;
-
-export declare namespace MessageCreateParams {
-  export interface MessageParamsWithConversation {
-    /**
-     * Params for selecting or creating a new conversation. Either the id or the
-     * Contact must be given.
-     */
-    conversation: MessageParamsWithConversation.Conversation;
-
-    attachments?: Array<AttachmentParams>;
-
-    /**
-     * The message body.
-     */
-    body?: string;
-
-    /**
-     * An optional datetime for scheduling message up to a couple of months in the
-     * future.
-     */
-    send_at?: string;
-  }
-
-  export namespace MessageParamsWithConversation {
-    /**
-     * Params for selecting or creating a new conversation. Either the id or the
-     * Contact must be given.
-     */
-    export interface Conversation {
+    export namespace Conversation {
       /**
        * Parameters for creating a contact
        */
-      contact: ContactsAPI.ContactParams;
+      export interface Contact {
+        /**
+         * 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 };
+      }
+    }
 
+    /**
+     * Params for creating an attachment
+     */
+    export interface Attachment {
       /**
-       * The phone number from which to send the message. This can be either the phone
-       * number in E.164 format or a Surge phone number id.
+       * The URL of the attachment.
        */
-      phone_number?: string;
+      url: string;
     }
   }
 
@@ -283,7 +231,7 @@ export declare namespace MessageCreateParams {
      */
     to: string;
 
-    attachments?: Array<AttachmentParams>;
+    attachments?: Array<SimpleMessageParams.Attachment>;
 
     /**
      * The message body.
@@ -302,13 +250,20 @@ export declare namespace MessageCreateParams {
      */
     send_at?: string;
   }
+
+  export namespace SimpleMessageParams {
+    /**
+     * Params for creating an attachment
+     */
+    export interface Attachment {
+      /**
+       * The URL of the attachment.
+       */
+      url: string;
+    }
+  }
 }
 
 export declare namespace Messages {
-  export {
-    type AttachmentParams as AttachmentParams,
-    type Message as Message,
-    type MessageParams as MessageParams,
-    type MessageCreateParams as MessageCreateParams,
-  };
+  export { type Message as Message, type MessageCreateParams as MessageCreateParams };
 }

package/src/resources/phone-numbers.ts

@@ -46,40 +46,6 @@ export interface PhoneNumber {
   type: 'local' | 'toll_free';
 }
 
-/**
- * Parameters for purchasing a new phone number. The system will automatically
- * infer the type in certain cases:
- *
- * - If only area_code is provided, type is inferred from the area code
- * - If only latitude/longitude are provided, type is inferred as 'local'
- * - Otherwise, type must be explicitly specified
- */
-export interface PhoneNumberPurchaseParams {
-  /**
-   * The desired area code for this phone number. If provided without type, the type
-   * will be inferred.
-   */
-  area_code?: string;
-
-  /**
-   * Latitude to search for nearby phone numbers. Must be used with longitude. If
-   * provided without type, type will be inferred as 'local'.
-   */
-  latitude?: number;
-
-  /**
-   * Longitude to search for nearby phone numbers. Must be used with latitude. If
-   * provided without type, type will be inferred as 'local'.
-   */
-  longitude?: number;
-
-  /**
-   * Whether the phone number is local or toll-free. Can be omitted if area_code or
-   * latitude/longitude are provided.
-   */
-  type?: 'local' | 'toll_free';
-}
-
 export interface PhoneNumberPurchaseParams {
   /**
    * The desired area code for this phone number. If provided without type, the type

package/src/resources/users.ts

@@ -100,41 +100,6 @@ export interface User {
   photo_url?: string;
 }
 
-/**
- * POST body for creating a user
- */
-export interface UserParams {
-  /**
-   * The user's first name.
-   */
-  first_name: string;
-
-  /**
-   * The user's last name.
-   */
-  last_name?: string;
-
-  /**
-   * Set of key-value pairs that will be stored with the object.
-   */
-  metadata?: { [key: string]: string };
-
-  /**
-   * URL of a photo to be used as the user's avatar.
-   */
-  photo_url?: string;
-}
-
-/**
- * A request to create a token
- */
-export interface UserTokenParams {
-  /**
-   * For how many seconds the token should be accepted. Defaults to 15 minutes.
-   */
-  duration_seconds?: number;
-}
-
 /**
  * Response when token has been created successfully
  */
@@ -199,8 +164,6 @@ export interface UserCreateTokenParams {
 export declare namespace Users {
   export {
     type User as User,
-    type UserParams as UserParams,
-    type UserTokenParams as UserTokenParams,
     type UserTokenResponse as UserTokenResponse,
     type UserCreateParams as UserCreateParams,
     type UserUpdateParams as UserUpdateParams,

package/src/resources/verifications.ts

@@ -76,26 +76,6 @@ export interface VerificationCheck {
   verification?: Verification;
 }
 
-/**
- * Parameters for checking a Verification code
- */
-export interface VerificationCheckParams {
-  /**
-   * The Verification code that was received.
-   */
-  code: string;
-}
-
-/**
- * Parameters for creating a Verification
- */
-export interface VerificationParams {
-  /**
-   * The phone number to be verified. In E.164 format.
-   */
-  phone_number: string;
-}
-
 export interface VerificationCreateParams {
   /**
    * The phone number to be verified. In E.164 format.
@@ -114,8 +94,7 @@ export declare namespace Verifications {
   export {
     type Verification as Verification,
     type VerificationCheck as VerificationCheck,
-    type VerificationCheckParams as VerificationCheckParams,
-    type VerificationParams as VerificationParams,
     type VerificationCreateParams as VerificationCreateParams,
+    type VerificationCheckParams as VerificationCheckParams,
   };
 }