@knocklabs/node 0.6.19 → 1.1.0

package/resources/workflows.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/workflows.d.ts

@@ -0,0 +1,113 @@
+import { APIResource } from "../core/resource.js";
+import * as RecipientsAPI from "./recipients/recipients.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 Workflows extends APIResource {
+    /**
+     * When invoked for a workflow using a specific workflow key and cancellation key,
+     * will cancel any queued workflow runs associated with that key/cancellation key
+     * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
+     */
+    cancel(key: string, body: WorkflowCancelParams, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Trigger a workflow (specified by the key) to run for the given recipients, using
+     * the parameters provided. Returns an identifier for the workflow run request. All
+     * workflow runs are executed asynchronously. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
+     */
+    trigger(key: string, body: WorkflowTriggerParams, options?: RequestOptions): APIPromise<WorkflowTriggerResponse>;
+}
+/**
+ * A `204 No Content` response.
+ */
+export type WorkflowCancelResponse = string;
+/**
+ * The response from triggering a workflow.
+ */
+export interface WorkflowTriggerResponse {
+    /**
+     * This value allows you to track individual messages associated with this trigger
+     * request.
+     */
+    workflow_run_id: string;
+}
+export interface WorkflowCancelParams {
+    /**
+     * An optional key that is used to reference a specific workflow trigger request
+     * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+     * request. Must be provided while triggering a workflow in order to enable
+     * subsequent cancellation. Should be unique across trigger requests to avoid
+     * unintentional cancellations.
+     */
+    cancellation_key: string;
+    /**
+     * A list of recipients to cancel the notification for. If omitted, cancels for all
+     * recipients associated with the cancellation key.
+     */
+    recipients?: Array<RecipientsAPI.RecipientReference> | null;
+}
+export interface WorkflowTriggerParams {
+    /**
+     * 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>;
+    /**
+     * 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 key that is used to reference a specific workflow trigger request
+     * when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+     * request. Must be provided while triggering a workflow in order to enable
+     * subsequent cancellation. Should be unique across trigger requests to avoid
+     * unintentional cancellations.
+     */
+    cancellation_key?: string | null;
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+export declare namespace Workflows {
+    export { type WorkflowCancelResponse as WorkflowCancelResponse, type WorkflowTriggerResponse as WorkflowTriggerResponse, type WorkflowCancelParams as WorkflowCancelParams, type WorkflowTriggerParams as WorkflowTriggerParams, };
+}
+//# sourceMappingURL=workflows.d.ts.map

package/resources/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAElD;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/workflows.js

@@ -0,0 +1,58 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Workflows = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Workflows extends resource_1.APIResource {
+    /**
+     * When invoked for a workflow using a specific workflow key and cancellation key,
+     * will cancel any queued workflow runs associated with that key/cancellation key
+     * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
+     */
+    cancel(key, body, options) {
+        return this._client.post((0, path_1.path) `/v1/workflows/${key}/cancel`, { body, ...options });
+    }
+    /**
+     * Trigger a workflow (specified by the key) to run for the given recipients, using
+     * the parameters provided. Returns an identifier for the workflow run request. All
+     * workflow runs are executed asynchronously. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
+     */
+    trigger(key, body, options) {
+        return this._client.post((0, path_1.path) `/v1/workflows/${key}/trigger`, { body, ...options });
+    }
+}
+exports.Workflows = Workflows;
+//# sourceMappingURL=workflows.js.map

package/resources/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAtDD,8BAsDC"}

package/resources/workflows.mjs

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Workflows extends APIResource {
+    /**
+     * When invoked for a workflow using a specific workflow key and cancellation key,
+     * will cancel any queued workflow runs associated with that key/cancellation key
+     * pair. Can optionally be provided one or more recipients to scope the request to.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.cancel('key', {
+     *   cancellation_key: 'cancel-workflow-123',
+     *   recipients: ['jhammond'],
+     * });
+     * ```
+     */
+    cancel(key, body, options) {
+        return this._client.post(path `/v1/workflows/${key}/cancel`, { body, ...options });
+    }
+    /**
+     * Trigger a workflow (specified by the key) to run for the given recipients, using
+     * the parameters provided. Returns an identifier for the workflow run request. All
+     * workflow runs are executed asynchronously. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `actor`, `recipient`, and `tenant` fields.
+     *
+     * @example
+     * ```ts
+     * const response = await client.workflows.trigger('key', {
+     *   recipients: ['dr_grant', 'dr_sattler', 'dr_malcolm'],
+     *   actor: 'mr_dna',
+     *   cancellation_key: 'isla_nublar_incident_1993',
+     *   data: {
+     *     affected_areas: [
+     *       'visitor_center',
+     *       'raptor_pen',
+     *       'trex_paddock',
+     *     ],
+     *     attraction_id: 'paddock_rex_01',
+     *     evacuation_protocol: 'active',
+     *     message: 'Life finds a way',
+     *     severity: 'critical',
+     *     system_status: 'fences_failing',
+     *   },
+     *   tenant: 'ingen_isla_nublar',
+     * });
+     * ```
+     */
+    trigger(key, body, options) {
+        return this._client.post(path `/v1/workflows/${key}/trigger`, { body, ...options });
+    }
+}
+//# sourceMappingURL=workflows.mjs.map

package/resources/workflows.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.mjs","sourceRoot":"","sources":["../src/resources/workflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAW,EAAE,IAA0B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,GAAW,EACX,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}

package/resources.d.mts

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.d.mts.map

package/resources.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/resources.d.ts

@@ -0,0 +1,2 @@
+export * from "./resources/index.js";
+//# sourceMappingURL=resources.d.ts.map

package/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/resources.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+tslib_1.__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}

package/resources.mjs

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.mjs.map

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/api-promise.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/api-promise instead */
+export * from './core/api-promise';