@knocklabs/node 0.4.9 → 0.4.11

package/README.md

@@ -32,19 +32,7 @@ const knockClient = new Knock("sk_12345");
 
 ## Usage
 
-### Identifying users
-
-```javascript
-const { Knock } = require("@knocklabs/node");
-const knockClient = new Knock("sk_12345");
-
-await knockClient.users.identify("jhammond", {
-  name: "John Hammond",
-  email: "jhammond@ingen.net",
-});
-```
-
-### Sending notifies (triggering workflows)
+### Sending notifications (triggering workflows)
 
 ```javascript
 const { Knock } = require("@knocklabs/node");
@@ -54,7 +42,7 @@ const knockClient = new Knock("sk_12345");
 await knockClient.notify("dinosaurs-loose", {
   // user id of who performed the action
   actor: "dnedry",
-  // list of user ids for who should receive the notif
+  // list of user ids for who should receive the notification
   recipients: ["jhammond", "agrant", "imalcolm", "esattler"],
   // data payload to send through
   data: {
@@ -63,11 +51,35 @@ await knockClient.notify("dinosaurs-loose", {
   },
   // an optional identifier for the tenant that the notifications belong to
   tenant: "jurassic-park",
-  // an optional key to provide to cancel a notify
+  // an optional key to provide to cancel a workflow
   cancellationKey: triggerAlert.id,
 });
 ```
 
+### Canceling workflows
+
+```javascript
+const { Knock } = require("@knocklabs/node");
+const knockClient = new Knock("sk_12345");
+
+await knockClient.workflows.cancel("dinosaurs-loose", triggerAlert.id, {
+  // optionally you can specify recipients here
+  recipients: ["jhammond"],
+});
+```
+
+### Identifying users
+
+```javascript
+const { Knock } = require("@knocklabs/node");
+const knockClient = new Knock("sk_12345");
+
+await knockClient.users.identify("jhammond", {
+  name: "John Hammond",
+  email: "jhammond@ingen.net",
+});
+```
+
 ### Retrieving users
 
 ```javascript
@@ -121,18 +133,6 @@ await knockClient.users.setChannelData("jhammond", KNOCK_APNS_CHANNEL_ID, {
 await knockClient.users.getChannelData("jhammond", KNOCK_APNS_CHANNEL_ID);
 ```
 
-### Canceling workflows
-
-```javascript
-const { Knock } = require("@knocklabs/node");
-const knockClient = new Knock("sk_12345");
-
-await knockClient.workflows.cancel("dinosaurs-loose", triggerAlert.id, {
-  // optionally you can specify recipients here
-  recipients: ["jhammond"],
-});
-```
-
 ### Signing JWTs
 
 You can use the `jsonwebtoken` package to [sign JWTs easily](https://www.npmjs.com/package/jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback).

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.4.9",
+    "version": "0.4.11",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",

package/dist/src/knock.d.ts

@@ -7,6 +7,7 @@ import { TriggerWorkflowProperties } from "./resources/workflows/interfaces";
 import { BulkOperations } from "./resources/bulk_operations";
 import { Objects } from "./resources/objects";
 import { Messages } from "./resources/messages";
+import { Tenants } from "./resources/tenants";
 declare class Knock {
     readonly key?: string | undefined;
     readonly options: KnockOptions;
@@ -18,6 +19,7 @@ declare class Knock {
     readonly bulkOperations: BulkOperations;
     readonly objects: Objects;
     readonly messages: Messages;
+    readonly tenants: Tenants;
     constructor(key?: string | undefined, options?: KnockOptions);
     notify(workflowKey: string, properties: TriggerWorkflowProperties): Promise<import("./resources/workflows/interfaces").WorkflowRun>;
     post(path: string, entity: any, options?: PostAndPutOptions): Promise<AxiosResponse>;

package/dist/src/knock.js

@@ -22,6 +22,7 @@ const workflows_1 = require("./resources/workflows");
 const bulk_operations_1 = require("./resources/bulk_operations");
 const objects_1 = require("./resources/objects");
 const messages_1 = require("./resources/messages");
+const tenants_1 = require("./resources/tenants");
 const DEFAULT_HOSTNAME = "https://api.knock.app";
 class Knock {
     constructor(key, options = {}) {
@@ -34,6 +35,7 @@ class Knock {
         this.bulkOperations = new bulk_operations_1.BulkOperations(this);
         this.objects = new objects_1.Objects(this);
         this.messages = new messages_1.Messages(this);
+        this.tenants = new tenants_1.Tenants(this);
         if (!key) {
             this.key = process.env.KNOCK_API_KEY;
             if (!this.key) {

package/dist/src/resources/tenants/index.d.ts

@@ -0,0 +1,11 @@
+import { CommonMetadata, PaginatedResponse } from "../../common/interfaces";
+import { Knock } from "../../knock";
+import { Tenant, SetTenant, ListTenantsOptions } from "./interfaces";
+export declare class Tenants {
+    readonly knock: Knock;
+    constructor(knock: Knock);
+    list(filteringOptions?: ListTenantsOptions): Promise<PaginatedResponse<Tenant>>;
+    get<T = CommonMetadata>(id: string): Promise<Tenant<T>>;
+    set<T = CommonMetadata>(id: string, tenantData: SetTenant): Promise<Tenant<T>>;
+    delete(id: string): Promise<null>;
+}

package/dist/src/resources/tenants/index.js

@@ -0,0 +1,42 @@
+"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.Tenants = void 0;
+class Tenants {
+    constructor(knock) {
+        this.knock = knock;
+    }
+    list(filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get("/v1/tenants", filteringOptions);
+            return data;
+        });
+    }
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get(`/v1/tenants/${id}`);
+            return data;
+        });
+    }
+    set(id, tenantData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.put(`/v1/tenants/${id}`, tenantData);
+            return data;
+        });
+    }
+    delete(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.delete(`/v1/tenants/${id}`);
+            return data;
+        });
+    }
+}
+exports.Tenants = Tenants;

package/dist/src/resources/tenants/interfaces.d.ts

@@ -0,0 +1,30 @@
+import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
+import { SetPreferencesProperties } from "../preferences/interfaces";
+export interface TenantRef {
+    id: string;
+}
+export interface TenantBrandingSettings {
+    primary_color?: string;
+    primary_color_contrast?: string;
+    logo_url?: string;
+    icon_url?: string;
+}
+export interface TenantSettings {
+    branding?: TenantBrandingSettings;
+    preference_set?: SetPreferencesProperties;
+}
+export interface Tenant<T = CommonMetadata> {
+    id: string;
+    properties: T;
+    settings?: TenantSettings;
+    created_at?: string;
+    updated_at: string;
+}
+export interface SetTenant {
+    name?: string;
+    settings?: TenantSettings;
+}
+export interface ListTenantsOptions extends PaginationOptions {
+    tenant_id?: string;
+    name?: string;
+}

package/dist/src/resources/tenants/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/resources/workflows/interfaces.d.ts

@@ -4,7 +4,7 @@ export interface TriggerWorkflowProperties<T = {
     [key: string]: any;
 }> {
     actor?: Actor | ActorWithUpsert;
-    recipients?: Array<Recipient | RecipientWithUpsert>;
+    recipients?: (Recipient | RecipientWithUpsert)[];
     cancellationKey?: string;
     tenant?: string;
     data?: T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.4.9",
+  "version": "0.4.11",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",