@sentdm/sentdm 0.46.0 → 0.48.0

package/resources/webhooks.mjs

@@ -12,11 +12,29 @@ import { path } from "../internal/utils/path.mjs";
  */
 export class Webhooks extends APIResource {
     /**
-     * Creates a new webhook endpoint for the authenticated customer.
+     * Creates a new webhook endpoint for the authenticated customer. A webhook is
+     * version 2 unless the request sets webhook_version to 1: Svix delivers it, signed
+     * with the webhook-id, webhook-timestamp and webhook-signature headers, and
+     * retries it on its own schedule, so retry_count and timeout_seconds apply to
+     * version 1 only. sender_profile applies to version 1 only and is ignored on
+     * version 2; is_inheritable applies to version 2 only. A version 1 webhook's
+     * response returns its sender_profile selection, with an empty event_types when it
+     * is not cloned onto sender profiles; a version 2 webhook's response leaves
+     * sender_profile out.
      *
      * @example
      * ```ts
-     * const apiResponseWebhook = await client.webhooks.create();
+     * const apiResponseWebhook = await client.webhooks.create({
+     *   display_name: 'Order Notifications',
+     *   endpoint_url: 'https://example.com/webhooks/orders',
+     *   event_filters: {
+     *     message: ['delivered', 'failed'],
+     *     templates: ['approved', 'rejected'],
+     *   },
+     *   event_types: ['contact', 'message', 'templates'],
+     *   retry_count: 3,
+     *   timeout_seconds: 30,
+     * });
      * ```
      */
     create(params, options) {
@@ -34,7 +52,8 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Retrieves a single webhook by ID for the authenticated customer.
+     * Retrieves a single webhook by ID for the authenticated customer. A version 1
+     * webhook includes its sender_profile selection.
      *
      * @example
      * ```ts
@@ -54,12 +73,24 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Updates an existing webhook for the authenticated customer.
+     * Updates an existing webhook for the authenticated customer. Its version does not
+     * change. sender_profile applies to a version 1 webhook and is_inheritable to a
+     * version 2 one; retry_count and timeout_seconds apply to version 1 only. A
+     * version 1 webhook's response returns its sender_profile selection as saved; a
+     * version 2 webhook's response leaves sender_profile out.
      *
      * @example
      * ```ts
      * const apiResponseWebhook = await client.webhooks.update(
      *   'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
+     *   {
+     *     display_name: 'Updated Order Notifications',
+     *     endpoint_url: 'https://example.com/webhooks/orders-v2',
+     *     event_filters: { message: ['delivered', 'failed'] },
+     *     event_types: ['contact', 'message', 'templates'],
+     *     retry_count: 5,
+     *     timeout_seconds: 60,
+     *   },
      * );
      * ```
      */
@@ -78,7 +109,8 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Retrieves a paginated list of webhooks for the authenticated customer.
+     * Retrieves a paginated list of webhooks for the authenticated customer. Each
+     * version 1 webhook includes its sender_profile selection.
      *
      * @example
      * ```ts
@@ -138,9 +170,11 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Retrieves a paginated list of delivery events for the specified webhook. If the
-     * webhook is cloned onto your sender profiles, the list includes what those clones
-     * received; read payload.account_id to tell whose event it is.
+     * Retrieves a paginated list of delivery events for the specified webhook, newest
+     * first. If the webhook is cloned onto your sender profiles (version 1) or
+     * inheritable by them (version 2, is_inheritable), the list includes their events;
+     * read payload.account_id to tell whose event it is. A sender profile may read its
+     * organization's inheritable webhook too, and gets the events about itself.
      *
      * @example
      * ```ts
@@ -164,8 +198,11 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Generates a new signing secret for the specified webhook. The old secret is
-     * immediately invalidated.
+     * Generates a new signing secret for the specified webhook. A version 1 webhook's
+     * old secret stops verifying at once. A version 2 webhook's deliveries are signed
+     * with the new secret at once, and with the old one as well for the next 24 hours,
+     * so a receiver can switch over without rejecting any; after that the old secret
+     * no longer verifies.
      *
      * @example
      * ```ts
@@ -189,7 +226,10 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * Sends a test event to the specified webhook endpoint to verify connectivity.
+     * Sends a test event to the specified webhook endpoint to verify connectivity. A
+     * version 1 webhook is tested at once and the answer says whether it was
+     * delivered; a version 2 webhook's test is queued with Svix, which delivers it
+     * right after, and the answer says it was queued.
      *
      * @example
      * ```ts

package/resources/webhooks.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAEL,iBAAiB,EAEjB,YAAY,GAEb,+BAA2B;AAC5B,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;GAMG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,YAA6B,CAAA,EAAE;YAC5E,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CACZ,SAAyD,EAAE,EAC3D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CACR,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAC/B,CAAA,iBAA4C,CAAA,EAC5C;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,gBAAgB,EAAE;YAC/D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAU,EAAE,MAAyB,EAAE,OAAwB;QAClE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,OAAO,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,gBAAgB,EAAE;YAChE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAEL,iBAAiB,EAEjB,YAAY,GAEb,+BAA2B;AAC5B,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;GAMG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACvC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,EAAU,EAAE,MAA2B,EAAE,OAAwB;QACtE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,YAA6B,CAAA,EAAE;YAC5E,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE;YACnD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CACZ,SAAyD,EAAE,EAC3D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAC/B,CAAA,iBAA4C,CAAA,EAC5C;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,gBAAgB,EAAE;YAC/D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAU,EAAE,MAAyB,EAAE,OAAwB;QAClE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,OAAO,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,gBAAgB,EAAE;YAChE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/client.ts

@@ -25,6 +25,8 @@ import {
   ConversationsPageResponse,
   type TemplatesPageParams,
   TemplatesPageResponse,
+  type VoiceAgentsPageParams,
+  VoiceAgentsPageResponse,
   type WebhookEventsPageParams,
   WebhookEventsPageResponse,
   type WebhooksPageParams,
@@ -1017,6 +1019,12 @@ export declare namespace Sent {
   export import CallsPage = Pagination.CallsPage;
   export { type CallsPageParams as CallsPageParams, type CallsPageResponse as CallsPageResponse };
 
+  export import VoiceAgentsPage = Pagination.VoiceAgentsPage;
+  export {
+    type VoiceAgentsPageParams as VoiceAgentsPageParams,
+    type VoiceAgentsPageResponse as VoiceAgentsPageResponse,
+  };
+
   export {
     Webhooks as Webhooks,
     type APIMeta as APIMeta,

package/src/core/pagination.ts

@@ -485,3 +485,67 @@ export class CallsPage<Item> extends AbstractPage<Item> implements CallsPageResp
     };
   }
 }
+
+export interface VoiceAgentsPageResponse<Item> {
+  data: VoiceAgentsPageResponse.Data<Item>;
+}
+
+export namespace VoiceAgentsPageResponse {
+  export interface Data<Item> {
+    agents?: Array<Item>;
+
+    pagination?: Data.Pagination;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface VoiceAgentsPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class VoiceAgentsPage<Item> extends AbstractPage<Item> implements VoiceAgentsPageResponse<Item> {
+  data: VoiceAgentsPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: VoiceAgentsPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.agents ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as VoiceAgentsPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}

package/src/resources/channels/voice.ts

@@ -35,6 +35,16 @@ export class Voice extends APIResource {
    * question the way you verify a webhook. `POST /v3/channels/voice/{number}/test`
    * sends a test question and reports the verdict.
    *
+   * Send `agent_id` instead of `callback_url`, or with it, to have one of your voice
+   * agents (`GET /v3/voice/agents`) answer calls to the number. The agent wins over
+   * the callback URL for calls to the number; calls your app places from it still
+   * follow your app. `routes_to` in the response says which answers, and reads
+   * `agent_pending` while the number is still being moved to the agent. Calls follow
+   * the move within about an hour, as the provider applies it on its own clock.
+   * While numbers cannot be bound to agents, a request with `agent_id` is refused
+   * with `502` before any number is obtained or anything is written; send
+   * `callback_url` instead.
+   *
    * Your first voice number becomes the line app-originated calls are placed from
    * when a voice token names no number; send `default_for_app_calls: true` to give
    * that role to another number. A number you turned off earlier is turned back on,
@@ -109,18 +119,23 @@ export class Voice extends APIResource {
    *
    * ## What it changes
    *
-   * | Body                                          | Effect                                                                                                       |
-   * | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
-   * | `"status": "ACTIVE"`                          | turns calls on again for a number you turned off; the callback URL and the secret it had are kept            |
-   * | `"status": "INACTIVE"`                        | turns calls off; the callback URL and the secret stay on the number                                          |
-   * | `"default_for_app_calls": true`               | makes this the line app-originated calls are placed from when a voice token names no number                  |
-   * | `"callback_url": "https://example.com/voice"` | replaces where Sent asks what to do with each call on the number; the signing secret and the status are kept |
-   * | key omitted                                   | left exactly as it is                                                                                        |
+   * | Body                                          | Effect                                                                                                                                                                                                                                                                                                                                                                                                     |
+   * | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   * | `"status": "ACTIVE"`                          | turns calls on again for a number you turned off; the callback URL and the secret it had are kept                                                                                                                                                                                                                                                                                                          |
+   * | `"status": "INACTIVE"`                        | turns calls off; the callback URL and the secret stay on the number                                                                                                                                                                                                                                                                                                                                        |
+   * | `"default_for_app_calls": true`               | makes this the line app-originated calls are placed from when a voice token names no number                                                                                                                                                                                                                                                                                                                |
+   * | `"callback_url": "https://example.com/voice"` | replaces where Sent asks what to do with each call on the number; the signing secret and the status are kept                                                                                                                                                                                                                                                                                               |
+   * | `"agent_id": "agent_…"`                       | one of your voice agents answers calls to the number, within about an hour of the change (the provider applies the move on its own clock, and `routes_to` reads `agent` as soon as it has recorded it); it wins over `callback_url` for calls to the number, and calls your app places from it still follow your app. `routes_to` reads `agent_pending` while the number is still being moved to the agent |
+   * | `"agent_id": null`                            | unbinds the agent, so `callback_url` answers calls to the number again                                                                                                                                                                                                                                                                                                                                     |
+   * | key omitted                                   | left exactly as it is                                                                                                                                                                                                                                                                                                                                                                                      |
    *
    * `status` is matched ignoring case. Any combination is accepted:
    * `status: "ACTIVE"` with `default_for_app_calls: true` turns a number on as the
-   * new default, and a `callback_url` sent with either status is written too. A body
-   * that names none of the three is refused.
+   * new default, and a `callback_url` sent with either status is written too.
+   * `agent_id` is applied first, so a refusal to move the number to or from the
+   * agent leaves everything as it was, and the `409` and `400` refusals below are
+   * decided before anything is written, so they leave everything as it was too. A
+   * body that names none of them is refused.
    *
    * A number can be on without a callback URL: calls placed from your app then
    * connect straight to the number or user they dial, and calls to the number are
@@ -139,8 +154,12 @@ export class Voice extends APIResource {
    * **Making an inactive number the default is `400`.** Send `status: "ACTIVE"` in
    * the same call.
    *
-   * **A number you never turned voice on for is `404`.** Add it with
-   * `POST /v3/channels/voice`.
+   * **A number you never turned voice on for is `404`**, and so is an `agent_id`
+   * that is not one of your agents. Add the number with `POST /v3/channels/voice`.
+   *
+   * **`502` means the number could not be moved to or from the agent**, or an
+   * `agent_id` was sent while numbers cannot be bound to agents; nothing was
+   * written.
    *
    * The number is the E.164 value in the path with the plus sign URL-encoded
    * (`%2B`).
@@ -152,7 +171,7 @@ export class Voice extends APIResource {
    * @example
    * ```ts
    * const apiResponseOfVoiceNumber =
-   *   await client.channels.voice.update('+12125550100');
+   *   await client.channels.voice.update('number');
    * ```
    */
   update(
@@ -503,6 +522,14 @@ export interface VoiceCallbackTestResponseInfo {
  * One number the profile carries phone calls on.
  */
 export interface VoiceNumber {
+  /**
+   * The voice agent calls to this number go to, such as
+   * agent_9f2ab000-0000-4000-8000-000000000001. It wins over callback_url for calls
+   * to the number; calls your app places from the number still follow your app. Null
+   * when no agent answers the number.
+   */
+  agent_id?: string | null;
+
   /**
    * Where Sent asks what to do with each call on this number: a signed question is
    * POSTed here when a call arrives or a caller presses a key, and the answer
@@ -525,6 +552,14 @@ export interface VoiceNumber {
    */
   number?: string;
 
+  /**
+   * Who answers calls to this number: agent, the voice agent in agent_id;
+   * agent_pending, that agent once the number has finished moving to it, with calls
+   * possibly unanswered until then; callback, your callback_url; or none, in which
+   * case calls to it are declined.
+   */
+  routes_to?: string;
+
   /**
    * ACTIVE while the number carries calls, INACTIVE once it was turned off. Nothing
    * provisions: a number the customer holds can carry calls the moment voice is
@@ -561,14 +596,13 @@ export interface VoiceSecret {
 
 export interface VoiceCreateParams {
   /**
-   * Body param: Where Sent asks what to do with each call on this number: an
-   * absolute HTTP or HTTPS URL on a public host. A signed question is POSTed here
-   * when a call arrives or a caller presses a key, and the answer decides the call.
-   * Every question is signed with the callback_secret the response returns, the same
-   * way your webhooks are signed. Turning the number on again with a different URL
-   * replaces it and keeps the secret.
+   * Body param: One of your voice agents (GET /v3/voice/agents), such as
+   * agent_9f2ab000-0000-4000-8000-000000000001, to answer calls to this number. It
+   * wins over callback_url for calls to the number, and both may be sent; calls your
+   * app places from the number still follow your app. Send it instead of
+   * callback_url for a number only an agent answers.
    */
-  callback_url: string;
+  agent_id?: string | null;
 
   /**
    * Body param: The US area code a new number should be in, as 212. Only for a
@@ -578,6 +612,16 @@ export interface VoiceCreateParams {
    */
   area_code?: string | null;
 
+  /**
+   * Body param: Where Sent asks what to do with each call on this number: an
+   * absolute HTTP or HTTPS URL on a public host. A signed question is POSTed here
+   * when a call arrives or a caller presses a key, and the answer decides the call.
+   * Every question is signed with the callback_secret the response returns, the same
+   * way your webhooks are signed. Turning the number on again with a different URL
+   * replaces it and keeps the secret. Required unless agent_id is sent.
+   */
+  callback_url?: string | null;
+
   /**
    * Body param: Make this the line app-originated calls are placed from when a voice
    * token names no number. Omit it and your first voice number takes that role; a
@@ -622,6 +666,15 @@ export interface VoiceRetrieveParams {
 }
 
 export interface VoiceUpdateParams {
+  /**
+   * Body param: One of your voice agents, such as
+   * agent_9f2ab000-0000-4000-8000-000000000001, to answer calls to the number, or
+   * null to unbind it so the callback URL answers them again. The agent wins over
+   * callback_url for calls to the number; calls your app places from it still follow
+   * your app.
+   */
+  agent_id?: string | null;
+
   /**
    * Body param: A new callback URL for the number, active or not: an absolute HTTP
    * or HTTPS URL on a public host, where Sent asks what to do with each call. The

package/src/resources/profiles/campaigns.ts

@@ -53,8 +53,9 @@ export class Campaigns extends APIResource {
    * which models a profile's markets, compliance, brand, campaigns and billing
    * explicitly.
    *
-   * Updates an existing campaign under the brand of the specified profile. Cannot
-   * update campaigns that have already been submitted to TCR.
+   * Updates an existing campaign under the brand of the specified profile. Once the
+   * campaign has been submitted to TCR its volume can no longer move between low
+   * volume (under 2,000 messages a day) and high volume.
    *
    * @deprecated
    */