@knocklabs/node 0.6.19 → 1.0.0

package/resources/schedules/bulk.d.ts

@@ -0,0 +1,68 @@
+import { APIResource } from "../../core/resource.js";
+import * as BulkOperationsAPI from "../bulk-operations.js";
+import * as RecipientsAPI from "../recipients/recipients.js";
+import * as SchedulesAPI from "./schedules.js";
+import * as TenantsAPI from "../tenants/tenants.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+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.
+     */
+    create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+}
+export interface BulkCreateParams {
+    /**
+     * A list of schedules.
+     */
+    schedules: Array<BulkCreateParams.Schedule>;
+}
+export declare namespace BulkCreateParams {
+    /**
+     * A schedule represents a recurring workflow execution.
+     */
+    interface Schedule {
+        /**
+         * The key of the workflow.
+         */
+        workflow: string;
+        /**
+         * Specifies a recipient in a request. This can either be a user identifier
+         * (string), an inline user request (object), or an inline object request, which is
+         * determined by the presence of a `collection` property.
+         */
+        actor?: RecipientsAPI.RecipientRequest | null;
+        /**
+         * An optional map of data to pass into the workflow execution.
+         */
+        data?: Record<string, unknown> | null;
+        /**
+         * The ending date and time for the schedule.
+         */
+        ending_at?: string | null;
+        /**
+         * Specifies a recipient in a request. This can either be a user identifier
+         * (string), an inline user request (object), or an inline object request, which is
+         * determined by the presence of a `collection` property.
+         */
+        recipient?: RecipientsAPI.RecipientRequest;
+        /**
+         * The repeat rule for the schedule.
+         */
+        repeats?: Array<SchedulesAPI.ScheduleRepeatRule>;
+        /**
+         * The starting date and time for the schedule.
+         */
+        scheduled_at?: string | null;
+        /**
+         * An request to set a tenant inline.
+         */
+        tenant?: TenantsAPI.InlineTenantRequest | null;
+    }
+}
+export declare namespace Bulk {
+    export { type BulkCreateParams as BulkCreateParams };
+}
+//# sourceMappingURL=bulk.d.ts.map

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

@@ -0,0 +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"}

package/resources/schedules/bulk.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bulk = void 0;
+const resource_1 = require("../../core/resource.js");
+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.
+     */
+    create(body, options) {
+        return this._client.post('/v1/schedules/bulk/create', { body, ...options });
+    }
+}
+exports.Bulk = Bulk;
+//# sourceMappingURL=bulk.js.map

package/resources/schedules/bulk.js.map

@@ -0,0 +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"}

package/resources/schedules/bulk.mjs

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+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.
+     */
+    create(body, options) {
+        return this._client.post('/v1/schedules/bulk/create', { body, ...options });
+    }
+}
+//# sourceMappingURL=bulk.mjs.map

package/resources/schedules/bulk.mjs.map

@@ -0,0 +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"}

package/resources/schedules/index.d.mts

@@ -0,0 +1,3 @@
+export { Bulk, type BulkCreateParams } from "./bulk.mjs";
+export { Schedules, type Schedule, type ScheduleRepeatRule, type ScheduleCreateResponse, type ScheduleUpdateResponse, type ScheduleDeleteResponse, type ScheduleCreateParams, type ScheduleUpdateParams, type ScheduleListParams, type ScheduleDeleteParams, type SchedulesEntriesCursor, } from "./schedules.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE;OAC/B,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B"}

package/resources/schedules/index.d.ts

@@ -0,0 +1,3 @@
+export { Bulk, type BulkCreateParams } from "./bulk.js";
+export { Schedules, type Schedule, type ScheduleRepeatRule, type ScheduleCreateResponse, type ScheduleUpdateResponse, type ScheduleDeleteResponse, type ScheduleCreateParams, type ScheduleUpdateParams, type ScheduleListParams, type ScheduleDeleteParams, type SchedulesEntriesCursor, } from "./schedules.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE;OAC/B,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B"}

package/resources/schedules/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedules = exports.Bulk = void 0;
+var bulk_1 = require("./bulk.js");
+Object.defineProperty(exports, "Bulk", { enumerable: true, get: function () { return bulk_1.Bulk; } });
+var schedules_1 = require("./schedules.js");
+Object.defineProperty(exports, "Schedules", { enumerable: true, get: function () { return schedules_1.Schedules; } });
+//# sourceMappingURL=index.js.map

package/resources/schedules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/schedules/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kCAAqD;AAA5C,4FAAA,IAAI,OAAA;AACb,4CAYqB;AAXnB,sGAAA,SAAS,OAAA"}

package/resources/schedules/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Bulk } from "./bulk.mjs";
+export { Schedules, } from "./schedules.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/schedules/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/schedules/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,IAAI,EAAyB;OAC/B,EACL,SAAS,GAWV"}

package/resources/schedules/schedules.d.mts

@@ -0,0 +1,225 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as RecipientsAPI from "../recipients/recipients.mjs";
+import * as BulkAPI from "./bulk.mjs";
+import { Bulk, BulkCreateParams } from "./bulk.mjs";
+import * as TenantsAPI from "../tenants/tenants.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Schedules extends APIResource {
+    bulk: BulkAPI.Bulk;
+    /**
+     * Creates one or more schedules for a workflow with the specified recipients,
+     * timing, and data. Schedules can be one-time or recurring. This endpoint also
+     * handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     */
+    create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse>;
+    /**
+     * Updates one or more existing schedules with new timing, data, or other
+     * properties. All specified schedule IDs will be updated with the same values.
+     * This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     */
+    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.
+     */
+    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.
+     */
+    delete(body: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse>;
+}
+export type SchedulesEntriesCursor = EntriesCursor<Schedule>;
+/**
+ * A schedule represents a recurring workflow execution.
+ */
+export interface Schedule {
+    /**
+     * Unique identifier for the schedule.
+     */
+    id: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    recipient: RecipientsAPI.Recipient;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats: Array<ScheduleRepeatRule>;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * The workflow the schedule is applied to.
+     */
+    workflow: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename?: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    actor?: RecipientsAPI.Recipient | null;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The last occurrence of the schedule.
+     */
+    last_occurrence_at?: string | null;
+    /**
+     * The next occurrence of the schedule.
+     */
+    next_occurrence_at?: string | null;
+    /**
+     * The tenant to trigger the workflow for. Triggering with a tenant will use any
+     * tenant-level overrides associated with the tenant object, and all messages
+     * produced from workflow runs will be tagged with the tenant.
+     */
+    tenant?: string | null;
+}
+/**
+ * The repeat rule for the schedule.
+ */
+export interface ScheduleRepeatRule {
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The frequency of the schedule.
+     */
+    frequency: 'daily' | 'weekly' | 'monthly' | 'hourly';
+    /**
+     * The day of the month to repeat the schedule.
+     */
+    day_of_month?: number | null;
+    /**
+     * The days of the week to repeat the schedule.
+     */
+    days?: Array<'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun'> | null;
+    /**
+     * The hour of the day to repeat the schedule.
+     */
+    hours?: number | null;
+    /**
+     * The interval of the schedule.
+     */
+    interval?: number;
+    /**
+     * The minute of the hour to repeat the schedule.
+     */
+    minutes?: number | null;
+}
+/**
+ * A list of schedules.
+ */
+export type ScheduleCreateResponse = Array<Schedule>;
+/**
+ * A list of schedules.
+ */
+export type ScheduleUpdateResponse = Array<Schedule>;
+/**
+ * A list of schedules.
+ */
+export type ScheduleDeleteResponse = Array<Schedule>;
+export interface ScheduleCreateParams {
+    /**
+     * The recipients to trigger the workflow for. Can inline identify users, objects,
+     * or use a list of user IDs. Limited to 1,000 recipients.
+     */
+    recipients: Array<RecipientsAPI.RecipientRequest>;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats: Array<ScheduleRepeatRule>;
+    /**
+     * The key of the workflow.
+     */
+    workflow: string;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The ending date and time for the schedule.
+     */
+    ending_at?: string | null;
+    /**
+     * The starting date and time for the schedule.
+     */
+    scheduled_at?: string | null;
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+export interface ScheduleUpdateParams {
+    /**
+     * A list of schedule IDs.
+     */
+    schedule_ids: Array<string>;
+    /**
+     * A reference to a recipient, either a user identifier (string) or an object
+     * reference (ID, collection).
+     */
+    actor?: RecipientsAPI.RecipientReference | null;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The ending date and time for the schedule.
+     */
+    ending_at?: string | null;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats?: Array<ScheduleRepeatRule>;
+    /**
+     * The starting date and time for the schedule.
+     */
+    scheduled_at?: string | null;
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+export interface ScheduleListParams extends EntriesCursorParams {
+    /**
+     * Filter by workflow key.
+     */
+    workflow: string;
+    /**
+     * Filter by recipient IDs.
+     */
+    recipients?: Array<string>;
+    /**
+     * Filter by tenant ID.
+     */
+    tenant?: string;
+}
+export interface ScheduleDeleteParams {
+    /**
+     * A list of schedule IDs.
+     */
+    schedule_ids: Array<string>;
+}
+export declare namespace Schedules {
+    export { type Schedule as Schedule, type ScheduleRepeatRule as ScheduleRepeatRule, type ScheduleCreateResponse as ScheduleCreateResponse, type ScheduleUpdateResponse as ScheduleUpdateResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type SchedulesEntriesCursor as SchedulesEntriesCursor, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleUpdateParams as ScheduleUpdateParams, type ScheduleListParams as ScheduleListParams, type ScheduleDeleteParams as ScheduleDeleteParams, };
+    export { Bulk as Bulk, type BulkCreateParams as BulkCreateParams };
+}
+//# sourceMappingURL=schedules.d.mts.map

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

@@ -0,0 +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"}

package/resources/schedules/schedules.d.ts

@@ -0,0 +1,225 @@
+import { APIResource } from "../../core/resource.js";
+import * as RecipientsAPI from "../recipients/recipients.js";
+import * as BulkAPI from "./bulk.js";
+import { Bulk, BulkCreateParams } from "./bulk.js";
+import * as TenantsAPI from "../tenants/tenants.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Schedules extends APIResource {
+    bulk: BulkAPI.Bulk;
+    /**
+     * Creates one or more schedules for a workflow with the specified recipients,
+     * timing, and data. Schedules can be one-time or recurring. This endpoint also
+     * handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     */
+    create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse>;
+    /**
+     * Updates one or more existing schedules with new timing, data, or other
+     * properties. All specified schedule IDs will be updated with the same values.
+     * This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     */
+    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.
+     */
+    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.
+     */
+    delete(body: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse>;
+}
+export type SchedulesEntriesCursor = EntriesCursor<Schedule>;
+/**
+ * A schedule represents a recurring workflow execution.
+ */
+export interface Schedule {
+    /**
+     * Unique identifier for the schedule.
+     */
+    id: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    recipient: RecipientsAPI.Recipient;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats: Array<ScheduleRepeatRule>;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * The workflow the schedule is applied to.
+     */
+    workflow: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename?: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    actor?: RecipientsAPI.Recipient | null;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The last occurrence of the schedule.
+     */
+    last_occurrence_at?: string | null;
+    /**
+     * The next occurrence of the schedule.
+     */
+    next_occurrence_at?: string | null;
+    /**
+     * The tenant to trigger the workflow for. Triggering with a tenant will use any
+     * tenant-level overrides associated with the tenant object, and all messages
+     * produced from workflow runs will be tagged with the tenant.
+     */
+    tenant?: string | null;
+}
+/**
+ * The repeat rule for the schedule.
+ */
+export interface ScheduleRepeatRule {
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The frequency of the schedule.
+     */
+    frequency: 'daily' | 'weekly' | 'monthly' | 'hourly';
+    /**
+     * The day of the month to repeat the schedule.
+     */
+    day_of_month?: number | null;
+    /**
+     * The days of the week to repeat the schedule.
+     */
+    days?: Array<'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun'> | null;
+    /**
+     * The hour of the day to repeat the schedule.
+     */
+    hours?: number | null;
+    /**
+     * The interval of the schedule.
+     */
+    interval?: number;
+    /**
+     * The minute of the hour to repeat the schedule.
+     */
+    minutes?: number | null;
+}
+/**
+ * A list of schedules.
+ */
+export type ScheduleCreateResponse = Array<Schedule>;
+/**
+ * A list of schedules.
+ */
+export type ScheduleUpdateResponse = Array<Schedule>;
+/**
+ * A list of schedules.
+ */
+export type ScheduleDeleteResponse = Array<Schedule>;
+export interface ScheduleCreateParams {
+    /**
+     * The recipients to trigger the workflow for. Can inline identify users, objects,
+     * or use a list of user IDs. Limited to 1,000 recipients.
+     */
+    recipients: Array<RecipientsAPI.RecipientRequest>;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats: Array<ScheduleRepeatRule>;
+    /**
+     * The key of the workflow.
+     */
+    workflow: string;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The ending date and time for the schedule.
+     */
+    ending_at?: string | null;
+    /**
+     * The starting date and time for the schedule.
+     */
+    scheduled_at?: string | null;
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+export interface ScheduleUpdateParams {
+    /**
+     * A list of schedule IDs.
+     */
+    schedule_ids: Array<string>;
+    /**
+     * A reference to a recipient, either a user identifier (string) or an object
+     * reference (ID, collection).
+     */
+    actor?: RecipientsAPI.RecipientReference | null;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The ending date and time for the schedule.
+     */
+    ending_at?: string | null;
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats?: Array<ScheduleRepeatRule>;
+    /**
+     * The starting date and time for the schedule.
+     */
+    scheduled_at?: string | null;
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+export interface ScheduleListParams extends EntriesCursorParams {
+    /**
+     * Filter by workflow key.
+     */
+    workflow: string;
+    /**
+     * Filter by recipient IDs.
+     */
+    recipients?: Array<string>;
+    /**
+     * Filter by tenant ID.
+     */
+    tenant?: string;
+}
+export interface ScheduleDeleteParams {
+    /**
+     * A list of schedule IDs.
+     */
+    schedule_ids: Array<string>;
+}
+export declare namespace Schedules {
+    export { type Schedule as Schedule, type ScheduleRepeatRule as ScheduleRepeatRule, type ScheduleCreateResponse as ScheduleCreateResponse, type ScheduleUpdateResponse as ScheduleUpdateResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type SchedulesEntriesCursor as SchedulesEntriesCursor, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleUpdateParams as ScheduleUpdateParams, type ScheduleListParams as ScheduleListParams, type ScheduleDeleteParams as ScheduleDeleteParams, };
+    export { Bulk as Bulk, type BulkCreateParams as BulkCreateParams };
+}
+//# sourceMappingURL=schedules.d.ts.map

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

@@ -0,0 +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"}