@surgeapi/node 0.35.0 → 0.37.0

package/src/client.ts

@@ -29,7 +29,13 @@ import {
   Organization,
 } from './resources/accounts';
 import { Blast, BlastCreateParams, Blasts } from './resources/blasts';
-import { Campaign, CampaignCreateParams, Campaigns } from './resources/campaigns';
+import {
+  Campaign,
+  CampaignCreateParams,
+  CampaignListParams,
+  Campaigns,
+  CampaignsCursor,
+} from './resources/campaigns';
 import {
   Contact,
   ContactCreateParams,
@@ -52,6 +58,7 @@ import {
   PhoneNumbers,
   PhoneNumbersCursor,
 } from './resources/phone-numbers';
+import { RecordingDeleteResponse, RecordingGetFileResponse, Recordings } from './resources/recordings';
 import {
   User,
   UserCreateParams,
@@ -78,7 +85,9 @@ import {
   MessageFailedWebhookEvent,
   MessageReceivedWebhookEvent,
   MessageSentWebhookEvent,
+  RecordingCompletedWebhookEvent,
   UnwrapWebhookEvent,
+  VoicemailReceivedWebhookEvent,
   Webhooks,
 } from './resources/webhooks';
 import { type Fetch } from './internal/builtin-types';
@@ -507,7 +516,7 @@ export class Surge {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -544,9 +553,14 @@ export class Surge {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -554,7 +568,7 @@ export class Surge {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as Surge, request, Page);
@@ -567,7 +581,7 @@ export class Surge {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    const abort = controller.abort.bind(controller);
+    const abort = this._makeAbort(controller);
     if (signal) signal.addEventListener('abort', abort, { once: true });
 
     const timeout = setTimeout(abort, ms);
@@ -737,6 +751,12 @@ export class Surge {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -769,6 +789,14 @@ export class Surge {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body as Record<string, unknown>),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -799,6 +827,7 @@ export class Surge {
   contacts: API.Contacts = new API.Contacts(this);
   messages: API.Messages = new API.Messages(this);
   phoneNumbers: API.PhoneNumbers = new API.PhoneNumbers(this);
+  recordings: API.Recordings = new API.Recordings(this);
   users: API.Users = new API.Users(this);
   verifications: API.Verifications = new API.Verifications(this);
   webhooks: API.Webhooks = new API.Webhooks(this);
@@ -810,6 +839,7 @@ Surge.Campaigns = Campaigns;
 Surge.Contacts = Contacts;
 Surge.Messages = Messages;
 Surge.PhoneNumbers = PhoneNumbers;
+Surge.Recordings = Recordings;
 Surge.Users = Users;
 Surge.Verifications = Verifications;
 Surge.Webhooks = Webhooks;
@@ -835,7 +865,9 @@ export declare namespace Surge {
   export {
     Campaigns as Campaigns,
     type Campaign as Campaign,
+    type CampaignsCursor as CampaignsCursor,
     type CampaignCreateParams as CampaignCreateParams,
+    type CampaignListParams as CampaignListParams,
   };
 
   export {
@@ -863,6 +895,12 @@ export declare namespace Surge {
     type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams,
   };
 
+  export {
+    Recordings as Recordings,
+    type RecordingDeleteResponse as RecordingDeleteResponse,
+    type RecordingGetFileResponse as RecordingGetFileResponse,
+  };
+
   export {
     Users as Users,
     type User as User,
@@ -892,6 +930,8 @@ export declare namespace Surge {
     type MessageFailedWebhookEvent as MessageFailedWebhookEvent,
     type MessageReceivedWebhookEvent as MessageReceivedWebhookEvent,
     type MessageSentWebhookEvent as MessageSentWebhookEvent,
+    type RecordingCompletedWebhookEvent as RecordingCompletedWebhookEvent,
+    type VoicemailReceivedWebhookEvent as VoicemailReceivedWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
 

package/src/resources/campaigns.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';
 
@@ -37,8 +38,48 @@ export class Campaigns extends APIResource {
   create(accountID: string, body: CampaignCreateParams, options?: RequestOptions): APIPromise<Campaign> {
     return this._client.post(path`/accounts/${accountID}/campaigns`, { body, ...options });
   }
+
+  /**
+   * Retrieves a Campaign object.
+   *
+   * @example
+   * ```ts
+   * const campaign = await client.campaigns.retrieve(
+   *   'cpn_01k0qczvhbet4azgn5xm2ccfst',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Campaign> {
+    return this._client.get(path`/campaigns/${id}`, options);
+  }
+
+  /**
+   * List all campaigns for an account with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const campaign of client.campaigns.list(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    accountID: string,
+    query: CampaignListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CampaignsCursor, Campaign> {
+    return this._client.getAPIList(path`/accounts/${accountID}/campaigns`, Cursor<Campaign>, {
+      query,
+      ...options,
+    });
+  }
 }
 
+export type CampaignsCursor = Cursor<Campaign>;
+
 /**
  * A campaign represents the context in which one or more of your phone numbers
  * communicates with your contacts. Consent and opt-outs are tied to the campaign.
@@ -94,6 +135,11 @@ export interface Campaign {
    */
   privacy_policy_url: string;
 
+  /**
+   * The current status of the campaign.
+   */
+  status: 'active' | 'canceled' | 'created' | 'deactivated' | 'in_review' | 'pending' | 'rejected';
+
   /**
    * A list containing 1-5 types of messages that will be sent with this campaign.
    *
@@ -299,6 +345,13 @@ export declare namespace CampaignCreateParams {
   }
 }
 
+export interface CampaignListParams extends CursorParams {}
+
 export declare namespace Campaigns {
-  export { type Campaign as Campaign, type CampaignCreateParams as CampaignCreateParams };
+  export {
+    type Campaign as Campaign,
+    type CampaignsCursor as CampaignsCursor,
+    type CampaignCreateParams as CampaignCreateParams,
+    type CampaignListParams as CampaignListParams,
+  };
 }

package/src/resources/index.ts

@@ -11,7 +11,13 @@ export {
   type AccountRetrieveStatusParams,
 } from './accounts';
 export { Blasts, type Blast, type BlastCreateParams } from './blasts';
-export { Campaigns, type Campaign, type CampaignCreateParams } from './campaigns';
+export {
+  Campaigns,
+  type Campaign,
+  type CampaignCreateParams,
+  type CampaignListParams,
+  type CampaignsCursor,
+} from './campaigns';
 export {
   Contacts,
   type Contact,
@@ -34,6 +40,7 @@ export {
   type PhoneNumberPurchaseParams,
   type PhoneNumbersCursor,
 } from './phone-numbers';
+export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from './recordings';
 export {
   Users,
   type User,
@@ -61,5 +68,7 @@ export {
   type MessageFailedWebhookEvent,
   type MessageReceivedWebhookEvent,
   type MessageSentWebhookEvent,
+  type RecordingCompletedWebhookEvent,
+  type VoicemailReceivedWebhookEvent,
   type UnwrapWebhookEvent,
 } from './webhooks';

package/src/resources/messages.ts

@@ -107,7 +107,7 @@ export interface Message {
    * 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;
+  blast_id?: string | null;
 
   /**
    * The message body.
@@ -138,7 +138,7 @@ export namespace Message {
     /**
      * The type of attachment.
      */
-    type?: string;
+    type?: 'file' | 'image' | 'link' | 'video';
 
     /**
      * The URL of the attachment.

package/src/resources/recordings.ts

@@ -0,0 +1,118 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as ContactsAPI from './contacts';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Recordings extends APIResource {
+  /**
+   * Deletes a recording. The recording file will be removed from storage
+   * asynchronously.
+   *
+   * @example
+   * ```ts
+   * const recording = await client.recordings.delete(
+   *   'rec_01kfyc9dgdec1avkgs7tng8htg',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<RecordingDeleteResponse> {
+    return this._client.delete(path`/recordings/${id}`, options);
+  }
+
+  /**
+   * Redirects to a signed URL where the recording audio file can be downloaded. URL
+   * is short-lived, so redirect should be followed immediately.
+   *
+   * @example
+   * ```ts
+   * const response = await client.recordings.getFile(
+   *   'rec_01kfyc9dgdec1avkgs7tng8htg',
+   * );
+   * ```
+   */
+  getFile(recordingID: string, options?: RequestOptions): APIPromise<RecordingGetFileResponse> {
+    return this._client.get(path`/recordings/${recordingID}/file`, options);
+  }
+}
+
+/**
+ * A call recording
+ */
+export interface RecordingDeleteResponse {
+  /**
+   * The unique identifier for the recording
+   */
+  id: string;
+
+  /**
+   * The call that produced this recording
+   */
+  call: RecordingDeleteResponse.Call;
+
+  /**
+   * The duration of the recording in seconds
+   */
+  duration: number;
+}
+
+export namespace RecordingDeleteResponse {
+  /**
+   * 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';
+  }
+}
+
+/**
+ * An error response
+ */
+export interface RecordingGetFileResponse {
+  /**
+   * An error response
+   */
+  error: Shared.Error;
+}
+
+export declare namespace Recordings {
+  export {
+    type RecordingDeleteResponse as RecordingDeleteResponse,
+    type RecordingGetFileResponse as RecordingGetFileResponse,
+  };
+}

package/src/resources/webhooks.ts

@@ -325,6 +325,11 @@ export namespace MessageDeliveredWebhookEvent {
      */
     delivered_at: string;
 
+    /**
+     * Set of key-value pairs that will be stored with the object.
+     */
+    metadata: { [key: string]: string };
+
     /**
      * Attachments included with the message
      */
@@ -429,6 +434,11 @@ export namespace MessageFailedWebhookEvent {
      */
     failure_reason: string;
 
+    /**
+     * Set of key-value pairs that will be stored with the object.
+     */
+    metadata: { [key: string]: string };
+
     /**
      * Attachments included with the message
      */
@@ -523,6 +533,11 @@ export namespace MessageReceivedWebhookEvent {
      */
     conversation: Data.Conversation;
 
+    /**
+     * Set of key-value pairs that will be stored with the object.
+     */
+    metadata: { [key: string]: string };
+
     /**
      * When the message was received
      */
@@ -622,6 +637,11 @@ export namespace MessageSentWebhookEvent {
      */
     conversation: Data.Conversation;
 
+    /**
+     * Set of key-value pairs that will be stored with the object.
+     */
+    metadata: { [key: string]: string };
+
     /**
      * When the message was sent
      */
@@ -679,6 +699,181 @@ export namespace MessageSentWebhookEvent {
   }
 }
 
+export interface RecordingCompletedWebhookEvent {
+  /**
+   * The ID of the account in which this event occurred
+   */
+  account_id: string;
+
+  /**
+   * The data associated with the event
+   */
+  data: RecordingCompletedWebhookEvent.Data;
+
+  /**
+   * The timestamp when this event occurred, in ISO8601 format
+   */
+  timestamp: string;
+
+  /**
+   * The type of the event. Always `recording.completed` for this event.
+   */
+  type: 'recording.completed';
+}
+
+export namespace RecordingCompletedWebhookEvent {
+  /**
+   * The data associated with the event
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the recording
+     */
+    id: string;
+
+    /**
+     * The call that produced this recording
+     */
+    call: Data.Call;
+
+    /**
+     * The duration of the recording in seconds
+     */
+    duration: number;
+  }
+
+  export namespace Data {
+    /**
+     * 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';
+    }
+  }
+}
+
+export interface VoicemailReceivedWebhookEvent {
+  /**
+   * The ID of the account in which this event occurred
+   */
+  account_id: string;
+
+  /**
+   * The data associated with the event
+   */
+  data: VoicemailReceivedWebhookEvent.Data;
+
+  /**
+   * The timestamp when this event occurred, in ISO8601 format
+   */
+  timestamp: string;
+
+  /**
+   * The type of the event. Always `voicemail.received` for this event.
+   */
+  type: 'voicemail.received';
+}
+
+export namespace VoicemailReceivedWebhookEvent {
+  /**
+   * The data associated with the event
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the voicemail
+     */
+    id: string;
+
+    /**
+     * The call that resulted in this voicemail
+     */
+    call: Data.Call;
+
+    /**
+     * The duration of the voicemail in seconds
+     */
+    duration: number;
+
+    /**
+     * The unique identifier for the recording
+     */
+    recording_id: string;
+  }
+
+  export namespace Data {
+    /**
+     * The call that resulted in this voicemail
+     */
+    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';
+    }
+  }
+}
+
 export type UnwrapWebhookEvent =
   | CallEndedWebhookEvent
   | CampaignApprovedWebhookEvent
@@ -689,7 +884,9 @@ export type UnwrapWebhookEvent =
   | MessageDeliveredWebhookEvent
   | MessageFailedWebhookEvent
   | MessageReceivedWebhookEvent
-  | MessageSentWebhookEvent;
+  | MessageSentWebhookEvent
+  | RecordingCompletedWebhookEvent
+  | VoicemailReceivedWebhookEvent;
 
 export declare namespace Webhooks {
   export {
@@ -703,6 +900,8 @@ export declare namespace Webhooks {
     type MessageFailedWebhookEvent as MessageFailedWebhookEvent,
     type MessageReceivedWebhookEvent as MessageReceivedWebhookEvent,
     type MessageSentWebhookEvent as MessageSentWebhookEvent,
+    type RecordingCompletedWebhookEvent as RecordingCompletedWebhookEvent,
+    type VoicemailReceivedWebhookEvent as VoicemailReceivedWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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