@surgeapi/node 0.36.0 → 0.38.0

package/src/client.ts

@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -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,7 +58,7 @@ import {
   PhoneNumbers,
   PhoneNumbersCursor,
 } from './resources/phone-numbers';
-import { RecordingGetFileResponse, Recordings } from './resources/recordings';
+import { RecordingDeleteResponse, RecordingGetFileResponse, Recordings } from './resources/recordings';
 import {
   User,
   UserCreateParams,
@@ -79,6 +85,7 @@ import {
   MessageFailedWebhookEvent,
   MessageReceivedWebhookEvent,
   MessageSentWebhookEvent,
+  PhoneNumberAttachedToCampaignWebhookEvent,
   RecordingCompletedWebhookEvent,
   UnwrapWebhookEvent,
   VoicemailReceivedWebhookEvent,
@@ -288,8 +295,8 @@ export class Surge {
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -321,12 +328,13 @@ export class Surge {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -510,7 +518,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(
@@ -655,9 +663,9 @@ export class Surge {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -783,6 +791,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),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -851,7 +867,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 {
@@ -879,7 +897,11 @@ export declare namespace Surge {
     type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams,
   };
 
-  export { Recordings as Recordings, type RecordingGetFileResponse as RecordingGetFileResponse };
+  export {
+    Recordings as Recordings,
+    type RecordingDeleteResponse as RecordingDeleteResponse,
+    type RecordingGetFileResponse as RecordingGetFileResponse,
+  };
 
   export {
     Users as Users,
@@ -910,6 +932,7 @@ export declare namespace Surge {
     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/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'comma' });
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/blasts.ts

@@ -83,7 +83,8 @@ export interface BlastCreateParams {
   name?: string;
 
   /**
-   * @deprecated Use `to` to specify recipients instead.
+   * @deprecated Use `to` with audience IDs (`aud_...`) to specify audience
+   * recipients instead.
    */
   segments?: Array<string>;
 
@@ -94,7 +95,7 @@ export interface BlastCreateParams {
 
   /**
    * List of recipients to whom the blast should be sent. This can be a combination
-   * of contact IDs, segment IDs, and phone numbers.
+   * of contact IDs, audience IDs, and phone numbers.
    */
   to?: Array<string>;
 }

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';
 
@@ -51,8 +52,34 @@ export class Campaigns extends APIResource {
   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.
@@ -111,7 +138,7 @@ export interface Campaign {
   /**
    * The current status of the campaign.
    */
-  status: 'active' | 'canceled' | 'created' | 'deactivated' | 'in_review' | 'pending' | 'rejected';
+  status: 'active' | 'canceled' | 'created' | 'deactivated' | 'in_review' | 'rejected';
 
   /**
    * A list containing 1-5 types of messages that will be sent with this campaign.
@@ -318,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,7 +40,7 @@ export {
   type PhoneNumberPurchaseParams,
   type PhoneNumbersCursor,
 } from './phone-numbers';
-export { Recordings, type RecordingGetFileResponse } from './recordings';
+export { Recordings, type RecordingDeleteResponse, type RecordingGetFileResponse } from './recordings';
 export {
   Users,
   type User,
@@ -62,6 +68,7 @@ export {
   type MessageFailedWebhookEvent,
   type MessageReceivedWebhookEvent,
   type MessageSentWebhookEvent,
+  type PhoneNumberAttachedToCampaignWebhookEvent,
   type RecordingCompletedWebhookEvent,
   type VoicemailReceivedWebhookEvent,
   type UnwrapWebhookEvent,

package/src/resources/messages.ts

@@ -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/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

@@ -1,12 +1,28 @@
 // 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.
@@ -23,6 +39,67 @@ export class Recordings extends APIResource {
   }
 }
 
+/**
+ * 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
  */
@@ -34,5 +111,8 @@ export interface RecordingGetFileResponse {
 }
 
 export declare namespace Recordings {
-  export { type RecordingGetFileResponse as RecordingGetFileResponse };
+  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,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
@@ -865,6 +935,7 @@ export type UnwrapWebhookEvent =
   | MessageFailedWebhookEvent
   | MessageReceivedWebhookEvent
   | MessageSentWebhookEvent
+  | PhoneNumberAttachedToCampaignWebhookEvent
   | RecordingCompletedWebhookEvent
   | VoicemailReceivedWebhookEvent;
 
@@ -880,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.36.0'; // x-release-please-version
+export const VERSION = '0.38.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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