@knocklabs/node 0.6.19 → 1.0.0

package/resources/users/users.mjs

@@ -0,0 +1,118 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as BulkAPI from "./bulk.mjs";
+import { Bulk } from "./bulk.mjs";
+import * as FeedsAPI from "./feeds.mjs";
+import { Feeds, } from "./feeds.mjs";
+import * as GuidesAPI from "./guides.mjs";
+import { Guides, } from "./guides.mjs";
+import { EntriesCursor } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Users extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.feeds = new FeedsAPI.Feeds(this._client);
+        this.guides = new GuidesAPI.Guides(this._client);
+        this.bulk = new BulkAPI.Bulk(this._client);
+    }
+    /**
+     * Create or update a user with the provided identification data. When you identify
+     * an existing user, the system merges the properties you specific with what is
+     * currently set on the user, updating only the fields included in your requests.
+     */
+    update(userID, body, options) {
+        return this._client.put(path `/v1/users/${userID}`, { body, ...options });
+    }
+    /**
+     * Retrieve a paginated list of users in the environment. Defaults to 50 users per
+     * page.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/users', (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Permanently delete a user and all associated data.
+     */
+    delete(userID, options) {
+        return this._client.delete(path `/v1/users/${userID}`, options);
+    }
+    /**
+     * Retrieve a specific user by their ID.
+     */
+    get(userID, options) {
+        return this._client.get(path `/v1/users/${userID}`, options);
+    }
+    /**
+     * Retrieves the channel data for a specific user and channel ID.
+     */
+    getChannelData(userID, channelID, options) {
+        return this._client.get(path `/v1/users/${userID}/channel_data/${channelID}`, options);
+    }
+    /**
+     * Retrieves a specific preference set for a user identified by the preference set
+     * ID.
+     */
+    getPreferences(userID, id, query = {}, options) {
+        return this._client.get(path `/v1/users/${userID}/preferences/${id}`, { query, ...options });
+    }
+    /**
+     * Returns a paginated list of messages for a specific user. Allows filtering by
+     * message status and provides various sorting options. Messages outside the
+     * account's retention window will not be included in the results.
+     */
+    listMessages(userID, query = {}, options) {
+        return this._client.getAPIList(path `/v1/users/${userID}/messages`, (EntriesCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves a list of all preference sets for a specific user.
+     */
+    listPreferences(userID, options) {
+        return this._client.get(path `/v1/users/${userID}/preferences`, options);
+    }
+    /**
+     * Returns a paginated list of schedules for a specific user, in descending order.
+     */
+    listSchedules(userID, query = {}, options) {
+        return this._client.getAPIList(path `/v1/users/${userID}/schedules`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Retrieves a paginated list of subscriptions for a specific user, in descending
+     * order.
+     */
+    listSubscriptions(userID, query = {}, options) {
+        return this._client.getAPIList(path `/v1/users/${userID}/subscriptions`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Merge two users together, where the user specified with the `from_user_id` param
+     * will be merged into the user specified by `user_id`.
+     */
+    merge(userID, body, options) {
+        return this._client.post(path `/v1/users/${userID}/merge`, { body, ...options });
+    }
+    /**
+     * Updates or creates channel data for a specific user and channel ID.
+     */
+    setChannelData(userID, channelID, body, options) {
+        return this._client.put(path `/v1/users/${userID}/channel_data/${channelID}`, { body, ...options });
+    }
+    /**
+     * Updates a complete preference set for a user. This is a destructive operation
+     * that will replace the existing preference set for the user.
+     */
+    setPreferences(userID, id, body, options) {
+        return this._client.put(path `/v1/users/${userID}/preferences/${id}`, { body, ...options });
+    }
+    /**
+     * Deletes channel data for a specific user and channel ID.
+     */
+    unsetChannelData(userID, channelID, options) {
+        return this._client.delete(path `/v1/users/${userID}/channel_data/${channelID}`, options);
+    }
+}
+Users.Feeds = Feeds;
+Users.Guides = Guides;
+Users.Bulk = Bulk;
+//# sourceMappingURL=users.mjs.map

package/resources/users/users.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAUf,KAAK,OAAO;OACZ,EAAE,IAAI,EAAkE;OACxE,KAAK,QAAQ;OACb,EAKL,KAAK,GACN;OACM,KAAK,SAAS;OACd,EASL,MAAM,GACP;OAEM,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJtD,CAAC;IAvJC;;;;OAIG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,aAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,MAAM,WAAW,EAAE,CAAA,aAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,MAAc,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,aAAa,CACX,MAAc,EACd,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,YAAY,EACnC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,iBAAiB,CACf,MAAc,EACd,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,gBAAgB,EACvC,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAc,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,MAAM,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,MAAc,EACd,SAAiB,EACjB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAc,EACd,EAAU,EACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AAkaD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;AACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AACtB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC"}

package/resources/users.d.mts

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

package/resources/users.d.mts.map

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

package/resources/users.d.ts

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

package/resources/users.d.ts.map

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

package/resources/users.js

@@ -0,0 +1,19 @@
+"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("./users/index.js"), exports);
+//# sourceMappingURL=users.js.map

package/resources/users.js.map

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

package/resources/users.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./users/index.mjs";
+//# sourceMappingURL=users.mjs.map

package/resources/users.mjs.map

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

package/resources/workflows.d.mts

@@ -0,0 +1,83 @@
+import { APIResource } from "../core/resource.mjs";
+import * as RecipientsAPI from "./recipients/recipients.mjs";
+import * as TenantsAPI from "./tenants/tenants.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+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.
+     */
+    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.
+     */
+    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.mts.map

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;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;OAMG;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,83 @@
+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.
+     */
+    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.
+     */
+    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;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI7F;;;;;;OAMG;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,28 @@
+"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.
+     */
+    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.
+     */
+    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;;;;OAIG;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;;;;;;OAMG;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;AAxBD,8BAwBC"}

package/resources/workflows.mjs

@@ -0,0 +1,24 @@
+// 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.
+     */
+    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.
+     */
+    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;;;;OAIG;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;;;;;;OAMG;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,18 @@
+"use strict";
+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("./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,uDAAkC"}

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';