@knocklabs/node 0.6.19 → 1.1.0

package/src/resources/users.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './users/index';

package/src/resources/workflows.ts

@@ -0,0 +1,140 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as RecipientsAPI from './recipients/recipients';
+import * as TenantsAPI from './tenants/tenants';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+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: string, body: WorkflowCancelParams, options?: RequestOptions): APIPromise<string> {
+    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: string,
+    body: WorkflowTriggerParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkflowTriggerResponse> {
+    return this._client.post(path`/v1/workflows/${key}/trigger`, { body, ...options });
+  }
+}
+
+/**
+ * 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,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

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

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '1.1.0'; // x-release-please-version

package/uploads.d.mts

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

package/uploads.d.mts.map

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

package/uploads.d.ts

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

package/uploads.d.ts.map

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

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

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

package/uploads.mjs.map

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

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.1.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.1.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '1.1.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '1.1.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/dist/package.json

@@ -1,48 +0,0 @@
-{
-    "name": "@knocklabs/node",
-    "version": "0.6.19",
-    "description": "Library for interacting with the Knock API",
-    "homepage": "https://github.com/knocklabs/knock-node",
-    "author": "@knocklabs",
-    "license": "MIT",
-    "keywords": [
-        "knock",
-        "knocklabs",
-        "notify"
-    ],
-    "main": "./dist/src/index.js",
-    "files": [
-        "dist/**/*"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/knocklabs/knock-node.git"
-    },
-    "bugs": {
-        "url": "https://github.com/knocklabs/knock-node/issues"
-    },
-    "scripts": {
-        "build": "tsc -p tsconfig.json",
-        "lint": "tslint -p tsconfig.json -c tslint.json",
-        "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
-        "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check",
-        "test": "vitest",
-        "coverage": "vitest run --coverage",
-        "prepublishOnly": "npm run build"
-    },
-    "devDependencies": {
-        "@types/node": "^15.0.1",
-        "@types/pluralize": "0.0.29",
-        "msw": "^2.1.5",
-        "prettier": "2.2.1",
-        "tslint": "6.1.3",
-        "typescript": "^5.3.3",
-        "vitest": "^1.2.1"
-    },
-    "dependencies": {
-        "jose": "^5.2.0"
-    },
-    "engines": {
-        "node": ">=17.5.0"
-    }
-}

package/dist/src/common/exceptions.d.ts

@@ -1,48 +0,0 @@
-import { HttpException, UnprocessableEntityError } from "./interfaces";
-export declare class NoApiKeyProvidedException extends Error {
-    readonly status: number;
-    readonly name: string;
-    readonly message: string;
-}
-export declare class NoSigningKeyProvidedException extends Error {
-    readonly status: number;
-    readonly name: string;
-    readonly message: string;
-}
-export declare class GenericServerException implements HttpException {
-    readonly status: number;
-    readonly requestID: string;
-    readonly name: string;
-    readonly message: string;
-    constructor(status: number, message: string | undefined, requestID: string);
-}
-export declare class UnauthorizedException implements HttpException {
-    readonly code: string;
-    readonly message: string;
-    readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
-    constructor(code: string, message: string, requestID: string);
-}
-export declare class NotFoundException implements HttpException {
-    readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
-    readonly message: string;
-    constructor(path: string, requestID: string);
-}
-export declare class UnprocessableEntityException implements HttpException {
-    readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
-    readonly message: string;
-    constructor(errors: UnprocessableEntityError[], requestID: string);
-}
-export declare class BadRequestException implements HttpException {
-    readonly code: string;
-    readonly message: string;
-    readonly requestID: string;
-    readonly status: number;
-    readonly name: string;
-    constructor(code: string, message: string, requestID: string);
-}

package/dist/src/common/exceptions.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BadRequestException = exports.UnprocessableEntityException = exports.NotFoundException = exports.UnauthorizedException = exports.GenericServerException = exports.NoSigningKeyProvidedException = exports.NoApiKeyProvidedException = void 0;
-class NoApiKeyProvidedException extends Error {
-    constructor() {
-        super(...arguments);
-        this.status = 500;
-        this.name = "NoApiKeyProvidedException";
-        this.message = `Missing API key. Pass it to the constructor (new Knock("sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU")) ` +
-            `or define it in the KNOCK_API_KEY environment variable.`;
-    }
-}
-exports.NoApiKeyProvidedException = NoApiKeyProvidedException;
-class NoSigningKeyProvidedException extends Error {
-    constructor() {
-        super(...arguments);
-        this.status = 500;
-        this.name = "NoSigningKeyProvidedException";
-        this.message = `Missing or invalid signing key key. Pass it as an option to Knock.signUserToken(userId, {signingKey: "S25vY2sga25vY2sh..."}) ` +
-            `or define it in the KNOCK_SIGNING_KEY environment variable. The signing key can either be a Base-64 encoded string ` +
-            `or a PEM-encoded certificate. For more information, see https://docs.knock.app/in-app-ui/security-and-authentication#authentication-with-enhanced-security-enabled`;
-    }
-}
-exports.NoSigningKeyProvidedException = NoSigningKeyProvidedException;
-class GenericServerException {
-    constructor(status, message, requestID) {
-        this.status = status;
-        this.requestID = requestID;
-        this.name = "GenericServerException";
-        this.message = "The request could not be completed.";
-        if (message) {
-            this.message = message;
-        }
-    }
-}
-exports.GenericServerException = GenericServerException;
-class UnauthorizedException {
-    constructor(code, message, requestID) {
-        this.code = code;
-        this.message = message;
-        this.requestID = requestID;
-        this.status = 401;
-        this.name = "UnauthorizedException";
-    }
-}
-exports.UnauthorizedException = UnauthorizedException;
-class NotFoundException {
-    constructor(path, requestID) {
-        this.requestID = requestID;
-        this.status = 404;
-        this.name = "NotFoundException";
-        this.message = `The requested path '${path}' could not be found.`;
-    }
-}
-exports.NotFoundException = NotFoundException;
-class UnprocessableEntityException {
-    constructor(errors, requestID) {
-        this.requestID = requestID;
-        this.status = 422;
-        this.name = "UnprocessableEntityException";
-        this.message = `The following errors occurred:\n`;
-        for (const { type, field, message } of errors) {
-            this.message = this.message.concat(`\t${field}(${type}): ${message}\n`);
-        }
-    }
-}
-exports.UnprocessableEntityException = UnprocessableEntityException;
-class BadRequestException {
-    constructor(code, message, requestID) {
-        this.code = code;
-        this.message = message;
-        this.requestID = requestID;
-        this.status = 400;
-        this.name = "BadRequestException";
-        this.message = `A ${code} error occurred: ${message}`;
-    }
-}
-exports.BadRequestException = BadRequestException;

package/dist/src/common/fetchClient.d.ts

@@ -1,28 +0,0 @@
-export interface FetchClientConfig {
-    baseURL?: string;
-    headers?: Record<string, string>;
-}
-export interface FetchRequestConfig<D = any> {
-    params?: Record<string, string>;
-    headers?: Record<string, string>;
-    body?: D;
-}
-export interface FetchResponse<T = any> extends Response {
-    data: T;
-}
-export declare class FetchResponseError extends Error {
-    readonly response: FetchResponse;
-    constructor(response: FetchResponse);
-}
-export default class FetchClient {
-    config: FetchClientConfig;
-    constructor(config?: FetchClientConfig);
-    get(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
-    post(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
-    put(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
-    delete(path: string, config: FetchRequestConfig): Promise<FetchResponse>;
-    private request;
-    private buildUrl;
-    private prepareRequestBody;
-    private getResponseData;
-}

package/dist/src/common/fetchClient.js

@@ -1,148 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchResponseError = void 0;
-class FetchResponseError extends Error {
-    constructor(response) {
-        super();
-        this.response = response;
-    }
-}
-exports.FetchResponseError = FetchResponseError;
-const defaultConfig = {
-    baseURL: "",
-    headers: {},
-};
-class FetchClient {
-    constructor(config) {
-        this.config = Object.assign(Object.assign({}, defaultConfig), config);
-    }
-    get(path, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.request("GET", path, config);
-        });
-    }
-    post(path, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.request("POST", path, config);
-        });
-    }
-    put(path, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.request("PUT", path, config);
-        });
-    }
-    delete(path, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.request("DELETE", path, config);
-        });
-    }
-    request(method, path, config = {}) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = this.buildUrl(path, config.params);
-            const headers = Object.assign(Object.assign({}, this.config.headers), ((_a = config.headers) !== null && _a !== void 0 ? _a : {}));
-            const response = yield fetch(url, {
-                method,
-                headers,
-                body: config.body ? this.prepareRequestBody(config.body) : undefined,
-            });
-            const data = yield this.getResponseData(response);
-            // Assign data to the response as other methods of returning the response
-            // like return { ...response, data } drop the response methods
-            const fetchResponse = Object.assign(response, {
-                data,
-            });
-            if (!response.ok) {
-                throw new FetchResponseError(fetchResponse);
-            }
-            return fetchResponse;
-        });
-    }
-    buildUrl(path, params) {
-        const url = new URL(this.config.baseURL + path);
-        function containsObject(array) {
-            return array.some((item) => typeof item === "object" && item !== null);
-        }
-        function appendParams(key, value, parentKey) {
-            const fullKey = parentKey ? `${parentKey}[${key}]` : key;
-            // Skip undefined values
-            if (value === undefined)
-                return;
-            if (typeof value === "object" &&
-                value !== null &&
-                !(value instanceof Date) &&
-                !(value instanceof Array)) {
-                // If value is an object, recurse
-                Object.entries(value).forEach(([nestedKey, nestedValue]) => {
-                    appendParams(nestedKey, nestedValue, fullKey);
-                });
-            }
-            else if (Array.isArray(value) && containsObject(value)) {
-                // Send array values as individual values with identifier
-                // e.g. key[0]=user1&key[1]=userid2&key[3][field1Key]=field1Value&key[3][field2Key]=field2Value
-                value.forEach((item, index) => {
-                    const indexKey = index.toString();
-                    if (typeof item === "string") {
-                        url.searchParams.append(`${fullKey}[${indexKey}]`, item);
-                    }
-                    else if (typeof item === "object" && item !== null) {
-                        Object.entries(item).forEach(([key, val]) => {
-                            const strVal = val;
-                            url.searchParams.append(`${fullKey}[${indexKey}][${key}]`, strVal);
-                        });
-                    }
-                });
-            }
-            else if (Array.isArray(value)) {
-                // Send array values as individual values instead of a comma separated list
-                // e.g. key[]=1&key[]=2&key[]=3 instead of key=1,2,3
-                value.forEach((val) => url.searchParams.append(`${fullKey}[]`, val));
-            }
-            else {
-                // For primitive values, simply append them
-                url.searchParams.append(fullKey, value);
-            }
-        }
-        if (params) {
-            Object.entries(params).forEach(([key, value]) => {
-                appendParams(key, value);
-            });
-        }
-        return url;
-    }
-    prepareRequestBody(data) {
-        if (typeof data === "string" || data instanceof FormData) {
-            return data;
-        }
-        return JSON.stringify(data);
-    }
-    getResponseData(response) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!response.body) {
-                return undefined;
-            }
-            let data;
-            const contentType = response.headers.get("content-type");
-            if (contentType && contentType.includes("application/json")) {
-                data = yield response.json();
-            }
-            else if (contentType && contentType.includes("text")) {
-                data = yield response.text();
-            }
-            else {
-                data = yield response.blob();
-            }
-            return data;
-        });
-    }
-}
-exports.default = FetchClient;

package/dist/src/common/interfaces.d.ts

@@ -1,70 +0,0 @@
-import { TokenGrant } from "./userTokens";
-export interface KnockOptions {
-    host?: string;
-}
-export interface HttpException extends Error {
-    readonly status: number;
-    readonly requestID: string;
-}
-export interface PostAndPutOptions {
-    query?: {
-        [key: string]: any;
-    };
-    headers?: {
-        [key: string]: any;
-    };
-}
-export interface UnprocessableEntityError {
-    message: string;
-    type: string;
-    field: string;
-}
-export type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
-export type CommonMetadata = Record<string, any>;
-export interface ChannelData<T = CommonMetadata> {
-    channel_id: string;
-    data: T;
-}
-export interface SetChannelDataProperties {
-}
-type PageInfo = {
-    before: string;
-    after: string;
-    page_size: number;
-    total_count: number;
-};
-export interface PaginatedEntriesResponse<T> {
-    entries: T[];
-    page_info: PageInfo;
-}
-export interface PaginatedItemsResponse<T> {
-    items: T[];
-    page_info: PageInfo;
-}
-export interface PaginationOptions {
-    page_size?: number;
-    after?: string;
-    before?: string;
-}
-export interface Condition {
-    argument: string;
-    variable: string;
-    operator: string;
-}
-export interface SignUserTokenOptions {
-    /**
-     * The signing key to use to sign the token. If not provided, the KNOCK_SIGNING_KEY environment variable will be used.
-     */
-    signingKey?: string;
-    /** The expiration time of the token in seconds. Defaults to 1 hour. */
-    expiresInSeconds?: number;
-    /**
-     * A list of token grants to pass along with this token. The grants here provide permissions to
-     * the requested entities for the user
-     */
-    grants?: TokenGrant[];
-}
-export interface MethodOptions {
-    idempotencyKey?: string;
-}
-export {};

package/dist/src/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./resources/workflows/interfaces";
-export * from "./resources/users/interfaces";
-export * from "./resources/preferences/interfaces";
-export * from "./resources/slack/interfaces";
-export * from "./common/interfaces";
-export * from "./common/userTokens";
-export * from "./common/exceptions";
-export { Knock } from "./knock";