@surgeapi/node 0.37.0 → 0.39.0

package/src/resources/index.ts

@@ -40,14 +40,24 @@ export {
   type PhoneNumberPurchaseParams,
   type PhoneNumbersCursor,
 } from './phone-numbers';
-export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from './recordings';
+export {
+  Recordings,
+  type RecordingRetrieveResponse,
+  type RecordingListResponse,
+  type RecordingDeleteResponse,
+  type RecordingGetFileResponse,
+  type RecordingListParams,
+  type RecordingListResponsesCursor,
+} from './recordings';
 export {
   Users,
   type User,
   type UserTokenResponse,
   type UserCreateParams,
   type UserUpdateParams,
+  type UserListParams,
   type UserCreateTokenParams,
+  type UsersCursor,
 } from './users';
 export {
   Verifications,
@@ -68,6 +78,7 @@ export {
   type MessageFailedWebhookEvent,
   type MessageReceivedWebhookEvent,
   type MessageSentWebhookEvent,
+  type PhoneNumberAttachedToCampaignWebhookEvent,
   type RecordingCompletedWebhookEvent,
   type VoicemailReceivedWebhookEvent,
   type UnwrapWebhookEvent,

package/src/resources/phone-numbers.ts

@@ -62,6 +62,11 @@ export interface PhoneNumber {
    */
   id: string;
 
+  /**
+   * The unique identifier of the campaign this phone number is attached to, if any
+   */
+  campaign_id: string | null;
+
   /**
    * The phone number in E.164 format
    */

package/src/resources/recordings.ts

@@ -4,10 +4,49 @@ import { APIResource } from '../core/resource';
 import * as ContactsAPI from './contacts';
 import * as Shared from './shared';
 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 Recordings extends APIResource {
+  /**
+   * Retrieves a Recording object.
+   *
+   * @example
+   * ```ts
+   * const recording = await client.recordings.retrieve(
+   *   'rec_01kfyc9dgdec1avkgs7tng8htg',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<RecordingRetrieveResponse> {
+    return this._client.get(path`/recordings/${id}`, options);
+  }
+
+  /**
+   * List all recordings for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const recordingListResponse of client.recordings.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: RecordingListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RecordingListResponsesCursor, RecordingListResponse> {
+    return this._client.getAPIList(path`/accounts/${accountID}/recordings`, Cursor<RecordingListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Deletes a recording. The recording file will be removed from storage
    * asynchronously.
@@ -39,6 +78,130 @@ export class Recordings extends APIResource {
   }
 }
 
+export type RecordingListResponsesCursor = Cursor<RecordingListResponse>;
+
+/**
+ * A call recording
+ */
+export interface RecordingRetrieveResponse {
+  /**
+   * The unique identifier for the recording
+   */
+  id: string;
+
+  /**
+   * The call that produced this recording
+   */
+  call: RecordingRetrieveResponse.Call;
+
+  /**
+   * The duration of the recording in seconds
+   */
+  duration: number;
+}
+
+export namespace RecordingRetrieveResponse {
+  /**
+   * The call that produced this recording
+   */
+  export interface Call {
+    /**
+     * The unique identifier for the call
+     */
+    id: string;
+
+    /**
+     * A contact who has consented to receive messages
+     */
+    contact: ContactsAPI.Contact;
+
+    /**
+     * The duration of the call in seconds
+     */
+    duration: number;
+
+    /**
+     * When the call was initiated
+     */
+    initiated_at: string;
+
+    /**
+     * The status of the call
+     */
+    status:
+      | 'busy'
+      | 'canceled'
+      | 'completed'
+      | 'failed'
+      | 'in_progress'
+      | 'missed'
+      | 'no_answer'
+      | 'queued'
+      | 'ringing';
+  }
+}
+
+/**
+ * A call recording
+ */
+export interface RecordingListResponse {
+  /**
+   * The unique identifier for the recording
+   */
+  id: string;
+
+  /**
+   * The call that produced this recording
+   */
+  call: RecordingListResponse.Call;
+
+  /**
+   * The duration of the recording in seconds
+   */
+  duration: number;
+}
+
+export namespace RecordingListResponse {
+  /**
+   * The call that produced this recording
+   */
+  export interface Call {
+    /**
+     * The unique identifier for the call
+     */
+    id: string;
+
+    /**
+     * A contact who has consented to receive messages
+     */
+    contact: ContactsAPI.Contact;
+
+    /**
+     * The duration of the call in seconds
+     */
+    duration: number;
+
+    /**
+     * When the call was initiated
+     */
+    initiated_at: string;
+
+    /**
+     * The status of the call
+     */
+    status:
+      | 'busy'
+      | 'canceled'
+      | 'completed'
+      | 'failed'
+      | 'in_progress'
+      | 'missed'
+      | 'no_answer'
+      | 'queued'
+      | 'ringing';
+  }
+}
+
 /**
  * A call recording
  */
@@ -110,9 +273,15 @@ export interface RecordingGetFileResponse {
   error: Shared.Error;
 }
 
+export interface RecordingListParams extends CursorParams {}
+
 export declare namespace Recordings {
   export {
+    type RecordingRetrieveResponse as RecordingRetrieveResponse,
+    type RecordingListResponse as RecordingListResponse,
     type RecordingDeleteResponse as RecordingDeleteResponse,
     type RecordingGetFileResponse as RecordingGetFileResponse,
+    type RecordingListResponsesCursor as RecordingListResponsesCursor,
+    type RecordingListParams as RecordingListParams,
   };
 }

package/src/resources/users.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,6 +51,27 @@ export class Users extends APIResource {
     return this._client.patch(path`/users/${id}`, { body, ...options });
   }
 
+  /**
+   * List all users for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const user of client.users.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<UsersCursor, User> {
+    return this._client.getAPIList(path`/accounts/${accountID}/users`, Cursor<User>, { query, ...options });
+  }
+
   /**
    * Deletes a user.
    *
@@ -88,6 +110,8 @@ export class Users extends APIResource {
   }
 }
 
+export type UsersCursor = Cursor<User>;
+
 /**
  * A user of the app
  */
@@ -172,6 +196,8 @@ export interface UserUpdateParams {
   photo_url?: string;
 }
 
+export interface UserListParams extends CursorParams {}
+
 export interface UserCreateTokenParams {
   /**
    * For how many seconds the token should be accepted. Defaults to 15 minutes.
@@ -183,8 +209,10 @@ export declare namespace Users {
   export {
     type User as User,
     type UserTokenResponse as UserTokenResponse,
+    type UsersCursor as UsersCursor,
     type UserCreateParams as UserCreateParams,
     type UserUpdateParams as UserUpdateParams,
+    type UserListParams as UserListParams,
     type UserCreateTokenParams as UserCreateTokenParams,
   };
 }

package/src/resources/webhooks.ts

@@ -699,6 +699,56 @@ export namespace MessageSentWebhookEvent {
   }
 }
 
+export interface PhoneNumberAttachedToCampaignWebhookEvent {
+  /**
+   * The ID of the account in which this event occurred
+   */
+  account_id: string;
+
+  /**
+   * The data associated with the event
+   */
+  data: PhoneNumberAttachedToCampaignWebhookEvent.Data;
+
+  /**
+   * The timestamp when this event occurred, in ISO8601 format
+   */
+  timestamp: string;
+
+  /**
+   * The type of the event. Always `phone_number.attached_to_campaign` for this
+   * event.
+   */
+  type: 'phone_number.attached_to_campaign';
+}
+
+export namespace PhoneNumberAttachedToCampaignWebhookEvent {
+  /**
+   * The data associated with the event
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the phone number
+     */
+    id: string;
+
+    /**
+     * The unique identifier of the campaign this phone number is attached to
+     */
+    campaign_id: string;
+
+    /**
+     * The phone number in E.164 format
+     */
+    number: string;
+
+    /**
+     * Whether the phone number is local, toll-free, or short code
+     */
+    type: 'local' | 'short_code' | 'toll_free';
+  }
+}
+
 export interface RecordingCompletedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -885,6 +935,7 @@ export type UnwrapWebhookEvent =
   | MessageFailedWebhookEvent
   | MessageReceivedWebhookEvent
   | MessageSentWebhookEvent
+  | PhoneNumberAttachedToCampaignWebhookEvent
   | RecordingCompletedWebhookEvent
   | VoicemailReceivedWebhookEvent;
 
@@ -900,6 +951,7 @@ export declare namespace Webhooks {
     type MessageFailedWebhookEvent as MessageFailedWebhookEvent,
     type MessageReceivedWebhookEvent as MessageReceivedWebhookEvent,
     type MessageSentWebhookEvent as MessageSentWebhookEvent,
+    type PhoneNumberAttachedToCampaignWebhookEvent as PhoneNumberAttachedToCampaignWebhookEvent,
     type RecordingCompletedWebhookEvent as RecordingCompletedWebhookEvent,
     type VoicemailReceivedWebhookEvent as VoicemailReceivedWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.37.0'; // x-release-please-version
+export const VERSION = '0.39.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.37.0";
+export declare const VERSION = "0.39.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.37.0'; // x-release-please-version
+exports.VERSION = '0.39.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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