@surgeapi/node 0.33.0 → 0.35.0

package/src/resources/contacts.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -50,8 +51,34 @@ export class Contacts extends APIResource {
   update(id: string, body: ContactUpdateParams, options?: RequestOptions): APIPromise<Contact> {
     return this._client.patch(path`/contacts/${id}`, { body, ...options });
   }
+
+  /**
+   * List all contacts for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.contacts.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactsCursor, Contact> {
+    return this._client.getAPIList(path`/accounts/${accountID}/contacts`, Cursor<Contact>, {
+      query,
+      ...options,
+    });
+  }
 }
 
+export type ContactsCursor = Cursor<Contact>;
+
 /**
  * A contact who has consented to receive messages
  */
@@ -141,10 +168,14 @@ export interface ContactUpdateParams {
   metadata?: { [key: string]: string };
 }
 
+export interface ContactListParams extends CursorParams {}
+
 export declare namespace Contacts {
   export {
     type Contact as Contact,
+    type ContactsCursor as ContactsCursor,
     type ContactCreateParams as ContactCreateParams,
     type ContactUpdateParams as ContactUpdateParams,
+    type ContactListParams as ContactListParams,
   };
 }

package/src/resources/index.ts

@@ -12,9 +12,28 @@ export {
 } from './accounts';
 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 {
+  Contacts,
+  type Contact,
+  type ContactCreateParams,
+  type ContactUpdateParams,
+  type ContactListParams,
+  type ContactsCursor,
+} from './contacts';
+export {
+  Messages,
+  type Message,
+  type MessageCreateParams,
+  type MessageListParams,
+  type MessagesCursor,
+} from './messages';
+export {
+  PhoneNumbers,
+  type PhoneNumber,
+  type PhoneNumberListParams,
+  type PhoneNumberPurchaseParams,
+  type PhoneNumbersCursor,
+} from './phone-numbers';
 export {
   Users,
   type User,

package/src/resources/messages.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import * as ContactsAPI from './contacts';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -63,8 +64,34 @@ export class Messages extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<Message> {
     return this._client.get(path`/messages/${id}`, options);
   }
+
+  /**
+   * List all messages for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const message of client.messages.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: MessageListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MessagesCursor, Message> {
+    return this._client.getAPIList(path`/accounts/${accountID}/messages`, Cursor<Message>, {
+      query,
+      ...options,
+    });
+  }
 }
 
+export type MessagesCursor = Cursor<Message>;
+
 /**
  * A Message is a communication sent to a Contact.
  */
@@ -76,10 +103,16 @@ export interface Message {
 
   attachments?: Array<Message.Attachment>;
 
+  /**
+   * The ID of the blast this message belongs to, if any. This can be used to
+   * attribute messages back to a specific blast.
+   */
+  blast_id?: string;
+
   /**
    * The message body.
    */
-  body?: string;
+  body?: string | null;
 
   /**
    * A conversation with a Contact
@@ -293,6 +326,13 @@ export declare namespace MessageCreateParams {
   }
 }
 
+export interface MessageListParams extends CursorParams {}
+
 export declare namespace Messages {
-  export { type Message as Message, type MessageCreateParams as MessageCreateParams };
+  export {
+    type Message as Message,
+    type MessagesCursor as MessagesCursor,
+    type MessageCreateParams as MessageCreateParams,
+    type MessageListParams as MessageListParams,
+  };
 }

package/src/resources/phone-numbers.ts

@@ -2,10 +2,35 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class PhoneNumbers extends APIResource {
+  /**
+   * List all phone numbers for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const phoneNumber of client.phoneNumbers.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PhoneNumbersCursor, PhoneNumber> {
+    return this._client.getAPIList(path`/accounts/${accountID}/phone_numbers`, Cursor<PhoneNumber>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Purchase a new phone number for the account. You can specify search criteria or
    * let the system select a random number.
@@ -26,6 +51,8 @@ export class PhoneNumbers extends APIResource {
   }
 }
 
+export type PhoneNumbersCursor = Cursor<PhoneNumber>;
+
 /**
  * A phone number that can be used to send and receive messages and calls
  */
@@ -43,9 +70,11 @@ export interface PhoneNumber {
   /**
    * Whether the phone number is local, toll-free, or short code
    */
-  type: 'local' | 'toll_free';
+  type: 'local' | 'short_code' | 'toll_free';
 }
 
+export interface PhoneNumberListParams extends CursorParams {}
+
 export interface PhoneNumberPurchaseParams {
   /**
    * The desired area code for this phone number. If provided without type, the type
@@ -73,5 +102,10 @@ export interface PhoneNumberPurchaseParams {
 }
 
 export declare namespace PhoneNumbers {
-  export { type PhoneNumber as PhoneNumber, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams };
+  export {
+    type PhoneNumber as PhoneNumber,
+    type PhoneNumbersCursor as PhoneNumbersCursor,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams,
+  };
 }

package/src/resources/webhooks.ts

@@ -313,7 +313,7 @@ export namespace MessageDeliveredWebhookEvent {
     /**
      * The content of the message
      */
-    body: string;
+    body: string | null;
 
     /**
      * The conversation this message belongs to
@@ -329,6 +329,12 @@ export namespace MessageDeliveredWebhookEvent {
      * Attachments included with the message
      */
     attachments?: Array<Data.Attachment>;
+
+    /**
+     * The ID of the blast this message belongs to, if any. This can be used to
+     * attribute messages back to a specific blast.
+     */
+    blast_id?: string;
   }
 
   export namespace Data {
@@ -406,7 +412,7 @@ export namespace MessageFailedWebhookEvent {
     /**
      * The content of the message
      */
-    body: string;
+    body: string | null;
 
     /**
      * The conversation this message belongs to
@@ -427,6 +433,12 @@ export namespace MessageFailedWebhookEvent {
      * Attachments included with the message
      */
     attachments?: Array<Data.Attachment>;
+
+    /**
+     * The ID of the blast this message belongs to, if any. This can be used to
+     * attribute messages back to a specific blast.
+     */
+    blast_id?: string;
   }
 
   export namespace Data {
@@ -504,7 +516,7 @@ export namespace MessageReceivedWebhookEvent {
     /**
      * The content of the message
      */
-    body: string;
+    body: string | null;
 
     /**
      * The conversation this message belongs to
@@ -520,6 +532,12 @@ export namespace MessageReceivedWebhookEvent {
      * Attachments included with the message
      */
     attachments?: Array<Data.Attachment>;
+
+    /**
+     * The ID of the blast this message belongs to, if any. This can be used to
+     * attribute messages back to a specific blast.
+     */
+    blast_id?: string;
   }
 
   export namespace Data {
@@ -597,7 +615,7 @@ export namespace MessageSentWebhookEvent {
     /**
      * The content of the message
      */
-    body: string;
+    body: string | null;
 
     /**
      * The conversation this message belongs to
@@ -613,6 +631,12 @@ export namespace MessageSentWebhookEvent {
      * Attachments included with the message
      */
     attachments?: Array<Data.Attachment>;
+
+    /**
+     * The ID of the blast this message belongs to, if any. This can be used to
+     * attribute messages back to a specific blast.
+     */
+    blast_id?: string;
   }
 
   export namespace Data {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.33.0'; // x-release-please-version
+export const VERSION = '0.35.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.33.0";
+export declare const VERSION = "0.35.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.33.0";
+export declare const VERSION = "0.35.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.33.0'; // x-release-please-version
+exports.VERSION = '0.35.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.33.0'; // x-release-please-version
+export const VERSION = '0.35.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map