@surgeapi/node 0.39.0 → 0.41.0

package/src/resources/audiences.ts

@@ -0,0 +1,117 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as ContactsAPI from './contacts';
+import { ContactsCursor } 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';
+
+export class Audiences extends APIResource {
+  /**
+   * Creates a new audience.
+   *
+   * @example
+   * ```ts
+   * const audience = await client.audiences.create(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   *   { name: 'The Family' },
+   * );
+   * ```
+   */
+  create(
+    accountID: string,
+    body: AudienceCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AudienceCreateResponse> {
+    return this._client.post(path`/accounts/${accountID}/audiences`, { body, ...options });
+  }
+
+  /**
+   * Adds an existing contact to a manual audience.
+   *
+   * @example
+   * ```ts
+   * const contact = await client.audiences.addContact(
+   *   'aud_01j9a43avnfqzbjfch6pygv1td',
+   *   { id: 'ctc_01j9dy8mdzfn3r0e8x1tbdrdrf' },
+   * );
+   * ```
+   */
+  addContact(
+    audienceID: string,
+    body: AudienceAddContactParams,
+    options?: RequestOptions,
+  ): APIPromise<ContactsAPI.Contact> {
+    return this._client.post(path`/audiences/${audienceID}/contacts`, { body, ...options });
+  }
+
+  /**
+   * List all contacts in an audience with cursor-based pagination. The account is
+   * inferred from the audience.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.audiences.listContacts(
+   *   'aud_01j9a43avnfqzbjfch6pygv1td',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  listContacts(
+    audienceID: string,
+    query: AudienceListContactsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactsCursor, ContactsAPI.Contact> {
+    return this._client.getAPIList(path`/audiences/${audienceID}/contacts`, Cursor<ContactsAPI.Contact>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+/**
+ * A group of contacts used for targeting messages.
+ */
+export interface AudienceCreateResponse {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * A name to identify this Audience. This name will only be visible within Surge.
+   */
+  name: string;
+}
+
+export interface AudienceCreateParams {
+  /**
+   * The audience name.
+   */
+  name: string;
+}
+
+export interface AudienceAddContactParams {
+  /**
+   * The ID of the contact to add. The contact must belong to the same account as the
+   * audience.
+   */
+  id: string;
+}
+
+export interface AudienceListContactsParams extends CursorParams {}
+
+export declare namespace Audiences {
+  export {
+    type AudienceCreateResponse as AudienceCreateResponse,
+    type AudienceCreateParams as AudienceCreateParams,
+    type AudienceAddContactParams as AudienceAddContactParams,
+    type AudienceListContactsParams as AudienceListContactsParams,
+  };
+}
+
+export { type ContactsCursor };

package/src/resources/campaigns.ts

@@ -25,6 +25,8 @@ export class Campaigns extends APIResource {
    *       'Your car is ready to go. See your invoice here: https://l.fastauto.shop/s034ij',
    *     ],
    *     privacy_policy_url: 'https://fastauto.shop/sms-privacy',
+   *     terms_and_conditions_url:
+   *       'https://fastauto.shop/terms-and-conditions',
    *     use_cases: [
    *       'account_notification',
    *       'customer_care',
@@ -53,6 +55,43 @@ export class Campaigns extends APIResource {
     return this._client.get(path`/campaigns/${id}`, options);
   }
 
+  /**
+   * Updates a campaign that has not yet been approved. This can be used to fix
+   * issues flagged during review and resubmit the campaign. Returns an error if the
+   * campaign is currently in review, has already been approved, or has been
+   * deactivated.
+   *
+   * @example
+   * ```ts
+   * const campaign = await client.campaigns.update(
+   *   'cpn_01k0qczvhbet4azgn5xm2ccfst',
+   *   {
+   *     consent_flow:
+   *       'When customers bring in their car for service, they will fill out this web form for intake: https://fastauto.shop/bp108c In it they can choose to opt in to text message notifications. If they choose to opt in, we will send them notifications to let them know if our mechanics find issues and once the car is ready to go, as well as links to invoices and to leave us feedback.',
+   *     description:
+   *       'This phone number will send auto maintenance notifications to end users that have opted in. It will also be used for responding to customer inquiries and sending some marketing offers.',
+   *     message_samples: [
+   *       'You are now opted in to receive repair notifications from DT Precision Auto. Frequency varies. Msg&data rates apply. Reply STOP to opt out.',
+   *       "You're lucky that hundred shot of NOS didn't blow the welds on the intake!",
+   *       'Your car is ready to go. See your invoice here: https://l.fastauto.shop/s034ij',
+   *     ],
+   *     privacy_policy_url: 'https://fastauto.shop/sms-privacy',
+   *     terms_and_conditions_url:
+   *       'https://fastauto.shop/terms-and-conditions',
+   *     use_cases: [
+   *       'account_notification',
+   *       'customer_care',
+   *       'marketing',
+   *     ],
+   *     volume: 'high',
+   *   },
+   * );
+   * ```
+   */
+  update(id: string, body: CampaignUpdateParams, options?: RequestOptions): APIPromise<Campaign> {
+    return this._client.patch(path`/campaigns/${id}`, { body, ...options });
+  }
+
   /**
    * List all campaigns for an account with cursor-based pagination.
    *
@@ -251,6 +290,14 @@ export declare namespace CampaignCreateParams {
      */
     privacy_policy_url: 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;
+
     /**
      * A list containing 1-5 types of messages that will be sent with this campaign.
      *
@@ -327,6 +374,53 @@ export declare namespace CampaignCreateParams {
      * to disable automatic link shortening.
      */
     link_sample?: string;
+  }
+
+  export interface ExternalCampaignParams {
+    /**
+     * The Campaign Registry (TCR) ID for the externally registered campaign
+     */
+    tcr_id: string;
+  }
+}
+
+export type CampaignUpdateParams =
+  | CampaignUpdateParams.StandardCampaignParams
+  | CampaignUpdateParams.ExternalCampaignParams;
+
+export declare namespace CampaignUpdateParams {
+  export interface StandardCampaignParams {
+    /**
+     * 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;
 
     /**
      * The URL of the terms and conditions presented to end users when they opt in to
@@ -334,7 +428,84 @@ export declare namespace CampaignCreateParams {
      * customers if they're the terms that are presented to end users when they opt in
      * to messaging.
      */
-    terms_and_conditions_url?: string;
+    terms_and_conditions_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;
   }
 
   export interface ExternalCampaignParams {
@@ -352,6 +523,7 @@ export declare namespace Campaigns {
     type Campaign as Campaign,
     type CampaignsCursor as CampaignsCursor,
     type CampaignCreateParams as CampaignCreateParams,
+    type CampaignUpdateParams as CampaignUpdateParams,
     type CampaignListParams as CampaignListParams,
   };
 }

package/src/resources/index.ts

@@ -10,11 +10,19 @@ export {
   type AccountUpdateParams,
   type AccountRetrieveStatusParams,
 } from './accounts';
+export {
+  Audiences,
+  type AudienceCreateResponse,
+  type AudienceCreateParams,
+  type AudienceAddContactParams,
+  type AudienceListContactsParams,
+} from './audiences';
 export { Blasts, type Blast, type BlastCreateParams } from './blasts';
 export {
   Campaigns,
   type Campaign,
   type CampaignCreateParams,
+  type CampaignUpdateParams,
   type CampaignListParams,
   type CampaignsCursor,
 } from './campaigns';

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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