@knocklabs/node 1.0.0 → 1.1.0

package/resources/recipients.js

@@ -1,19 +1,6 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./recipients/index.js"), exports);
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./recipients/index.js"), exports);
 //# sourceMappingURL=recipients.js.map

package/resources/recipients.js.map

@@ -1 +1 @@
-{"version":3,"file":"recipients.js","sourceRoot":"","sources":["../src/resources/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,wDAAmC"}
+{"version":3,"file":"recipients.js","sourceRoot":"","sources":["../src/resources/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gEAAmC"}

package/resources/schedules/bulk.d.mts

@@ -10,6 +10,36 @@ export declare class Bulk extends APIResource {
      * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.schedules.bulk.create({
+     *   schedules: [
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'dnedry',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'esattler',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

package/resources/schedules/bulk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}

package/resources/schedules/bulk.d.ts

@@ -10,6 +10,36 @@ export declare class Bulk extends APIResource {
      * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.schedules.bulk.create({
+     *   schedules: [
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'dnedry',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'esattler',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

package/resources/schedules/bulk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}

package/resources/schedules/bulk.js

@@ -8,6 +8,36 @@ class Bulk extends resource_1.APIResource {
      * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.schedules.bulk.create({
+     *   schedules: [
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'dnedry',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'esattler',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/schedules/bulk/create', { body, ...options });

package/resources/schedules/bulk.js.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAQlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AATD,oBASC"}
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAQlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAvCD,oBAuCC"}

package/resources/schedules/bulk.mjs

@@ -5,6 +5,36 @@ export class Bulk extends APIResource {
      * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.schedules.bulk.create({
+     *   schedules: [
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'dnedry',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *     {
+     *       data: { ... },
+     *       ending_at: null,
+     *       recipient: 'esattler',
+     *       repeats: [
+     *         { ... },
+     *       ],
+     *       scheduled_at: null,
+     *       tenant: 'acme_corp',
+     *       workflow: 'comment-created',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/schedules/bulk/create', { body, ...options });

package/resources/schedules/bulk.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAQtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAQtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/resources/schedules/schedules.d.mts

@@ -14,6 +14,35 @@ export declare class Schedules extends APIResource {
      * handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.create({
+     *   recipients: ['user_123'],
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   workflow: 'comment-created',
+     *   data: { key: 'value' },
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse>;
     /**
@@ -22,16 +51,61 @@ export declare class Schedules extends APIResource {
      * This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.update({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     *   data: { key: 'value' },
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     update(body: ScheduleUpdateParams, options?: RequestOptions): APIPromise<ScheduleUpdateResponse>;
     /**
      * Returns a paginated list of schedules for the current environment, filtered by
      * workflow and optionally by recipients and tenant.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.schedules.list({
+     *   workflow: 'workflow',
+     * })) {
+     *   // ...
+     * }
+     * ```
      */
     list(query: ScheduleListParams, options?: RequestOptions): PagePromise<SchedulesEntriesCursor, Schedule>;
     /**
      * Permanently deletes one or more schedules identified by the provided schedule
      * IDs. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.delete({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     * });
+     * ```
      */
     delete(body: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse>;
 }

package/resources/schedules/schedules.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE;OAC1B,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIxG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjG;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACpE"}
+{"version":3,"file":"schedules.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE;OAC1B,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjG;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACpE"}

package/resources/schedules/schedules.d.ts

@@ -14,6 +14,35 @@ export declare class Schedules extends APIResource {
      * handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.create({
+     *   recipients: ['user_123'],
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   workflow: 'comment-created',
+     *   data: { key: 'value' },
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse>;
     /**
@@ -22,16 +51,61 @@ export declare class Schedules extends APIResource {
      * This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.update({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     *   data: { key: 'value' },
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     update(body: ScheduleUpdateParams, options?: RequestOptions): APIPromise<ScheduleUpdateResponse>;
     /**
      * Returns a paginated list of schedules for the current environment, filtered by
      * workflow and optionally by recipients and tenant.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.schedules.list({
+     *   workflow: 'workflow',
+     * })) {
+     *   // ...
+     * }
+     * ```
      */
     list(query: ScheduleListParams, options?: RequestOptions): PagePromise<SchedulesEntriesCursor, Schedule>;
     /**
      * Permanently deletes one or more schedules identified by the provided schedule
      * IDs. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.delete({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     * });
+     * ```
      */
     delete(body: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse>;
 }

package/resources/schedules/schedules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE;OAC1B,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIxG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjG;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACpE"}
+{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,OAAO;OACZ,EAAE,IAAI,EAAE,gBAAgB,EAAE;OAC1B,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGjG;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACpE"}

package/resources/schedules/schedules.js

@@ -1,32 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Schedules = void 0;
+const tslib_1 = require("../../internal/tslib.js");
 const resource_1 = require("../../core/resource.js");
-const BulkAPI = __importStar(require("./bulk.js"));
+const BulkAPI = tslib_1.__importStar(require("./bulk.js"));
 const bulk_1 = require("./bulk.js");
 const pagination_1 = require("../../core/pagination.js");
 class Schedules extends resource_1.APIResource {
@@ -40,6 +18,35 @@ class Schedules extends resource_1.APIResource {
      * handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.create({
+     *   recipients: ['user_123'],
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   workflow: 'comment-created',
+     *   data: { key: 'value' },
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/schedules', { body, ...options });
@@ -50,6 +57,34 @@ class Schedules extends resource_1.APIResource {
      * This endpoint also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.update({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     *   data: { key: 'value' },
+     *   repeats: [
+     *     {
+     *       __typename: 'ScheduleRepeat',
+     *       day_of_month: null,
+     *       days: [
+     *         'mon',
+     *         'tue',
+     *         'wed',
+     *         'thu',
+     *         'fri',
+     *         'sat',
+     *         'sun',
+     *       ],
+     *       frequency: 'daily',
+     *       hours: null,
+     *       interval: 1,
+     *       minutes: null,
+     *     },
+     *   ],
+     *   tenant: 'acme_corp',
+     * });
+     * ```
      */
     update(body, options) {
         return this._client.put('/v1/schedules', { body, ...options });
@@ -57,6 +92,16 @@ class Schedules extends resource_1.APIResource {
     /**
      * Returns a paginated list of schedules for the current environment, filtered by
      * workflow and optionally by recipients and tenant.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const schedule of client.schedules.list({
+     *   workflow: 'workflow',
+     * })) {
+     *   // ...
+     * }
+     * ```
      */
     list(query, options) {
         return this._client.getAPIList('/v1/schedules', (pagination_1.EntriesCursor), { query, ...options });
@@ -64,6 +109,13 @@ class Schedules extends resource_1.APIResource {
     /**
      * Permanently deletes one or more schedules identified by the provided schedule
      * IDs. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const schedules = await client.schedules.delete({
+     *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.delete('/v1/schedules', { body, ...options });

package/resources/schedules/schedules.js.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAElD,mDAAkC;AAClC,oCAAgD;AAGhD,yDAA6F;AAG7F,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuCtD,CAAC;IArCC;;;;;;OAMG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,KAAyB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,0BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAxCD,8BAwCC;AAkOD,SAAS,CAAC,IAAI,GAAG,WAAI,CAAC"}
+{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../src/resources/schedules/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,2DAAkC;AAClC,oCAAgD;AAGhD,yDAA6F;AAG7F,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiHtD,CAAC;IA/GC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAyB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,0BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAlHD,8BAkHC;AAkOD,SAAS,CAAC,IAAI,GAAG,WAAI,CAAC"}