@knocklabs/node 0.6.19 → 1.1.0

package/resources/messages/batch.mjs

@@ -0,0 +1,143 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+export class Batch extends APIResource {
+    /**
+     * Marks the given messages as archived. Archived messages are hidden from the
+     * default message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.archive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    archive(body, options) {
+        return this._client.post('/v1/messages/batch/archived', { body, ...options });
+    }
+    /**
+     * Get the contents of multiple messages in a single request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.batch.getContent({
+     *   message_ids: ['string'],
+     * });
+     * ```
+     */
+    getContent(query, options) {
+        return this._client.get('/v1/messages/batch/content', { query, ...options });
+    }
+    /**
+     * Marks the given messages as interacted with by the user. This can include any
+     * user action on the message, with optional metadata about the specific
+     * interaction. Cannot include more than 5 key-value pairs, must not contain nested
+     * data. Read more about message engagement statuses
+     * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages =
+     *   await client.messages.batch.markAsInteracted({
+     *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+     *     metadata: { key: 'value' },
+     *   });
+     * ```
+     */
+    markAsInteracted(body, options) {
+        return this._client.post('/v1/messages/batch/interacted', { body, ...options });
+    }
+    /**
+     * Marks the given messages as `read`. Read more about message engagement statuses
+     * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsRead({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    markAsRead(body, options) {
+        return this._client.post('/v1/messages/batch/read', { body, ...options });
+    }
+    /**
+     * Marks the given messages as `seen`. This indicates that the user has viewed the
+     * message in their feed or inbox. Read more about message engagement statuses
+     * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsSeen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    markAsSeen(body, options) {
+        return this._client.post('/v1/messages/batch/seen', { body, ...options });
+    }
+    /**
+     * Marks the given messages as `unread`. This reverses the `read` state. Read more
+     * about message engagement statuses
+     * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnread({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    markAsUnread(body, options) {
+        return this._client.post('/v1/messages/batch/unread', { body, ...options });
+    }
+    /**
+     * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
+     * about message engagement statuses
+     * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnseen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    markAsUnseen(body, options) {
+        return this._client.post('/v1/messages/batch/unseen', { body, ...options });
+    }
+    /**
+     * Marks the given messages as unarchived. This reverses the `archived` state.
+     * Archived messages are hidden from the default message list in the feed but can
+     * still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.unarchive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
+     */
+    unarchive(body, options) {
+        return this._client.post('/v1/messages/batch/unarchived', { body, ...options });
+    }
+}
+//# sourceMappingURL=batch.mjs.map

package/resources/messages/batch.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.mjs","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}

package/resources/messages/index.d.mts

@@ -0,0 +1,4 @@
+export { Activities, type ActivityListParams } from "./activities.mjs";
+export { Batch, type BatchArchiveResponse, type BatchGetContentResponse, type BatchMarkAsInteractedResponse, type BatchMarkAsReadResponse, type BatchMarkAsSeenResponse, type BatchMarkAsUnreadResponse, type BatchMarkAsUnseenResponse, type BatchUnarchiveResponse, type BatchArchiveParams, type BatchGetContentParams, type BatchMarkAsInteractedParams, type BatchMarkAsReadParams, type BatchMarkAsSeenParams, type BatchMarkAsUnreadParams, type BatchMarkAsUnseenParams, type BatchUnarchiveParams, } from "./batch.mjs";
+export { Messages, type Activity, type Message, type MessageDeliveryLog, type MessageEvent, type MessageGetContentResponse, type MessageListParams, type MessageListActivitiesParams, type MessageListDeliveryLogsParams, type MessageListEventsParams, type MessageMarkAsInteractedParams, type MessagesEntriesCursor, type ActivitiesItemsCursor, type MessageDeliveryLogsEntriesCursor, type MessageEventsEntriesCursor, } from "./messages.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/messages/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE;OACvC,EACL,KAAK,EACL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,GAC1B;OACM,EACL,QAAQ,EACR,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,gCAAgC,EACrC,KAAK,0BAA0B,GAChC"}

package/resources/messages/index.d.ts

@@ -0,0 +1,4 @@
+export { Activities, type ActivityListParams } from "./activities.js";
+export { Batch, type BatchArchiveResponse, type BatchGetContentResponse, type BatchMarkAsInteractedResponse, type BatchMarkAsReadResponse, type BatchMarkAsSeenResponse, type BatchMarkAsUnreadResponse, type BatchMarkAsUnseenResponse, type BatchUnarchiveResponse, type BatchArchiveParams, type BatchGetContentParams, type BatchMarkAsInteractedParams, type BatchMarkAsReadParams, type BatchMarkAsSeenParams, type BatchMarkAsUnreadParams, type BatchMarkAsUnseenParams, type BatchUnarchiveParams, } from "./batch.js";
+export { Messages, type Activity, type Message, type MessageDeliveryLog, type MessageEvent, type MessageGetContentResponse, type MessageListParams, type MessageListActivitiesParams, type MessageListDeliveryLogsParams, type MessageListEventsParams, type MessageMarkAsInteractedParams, type MessagesEntriesCursor, type ActivitiesItemsCursor, type MessageDeliveryLogsEntriesCursor, type MessageEventsEntriesCursor, } from "./messages.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/messages/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE;OACvC,EACL,KAAK,EACL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,GAC1B;OACM,EACL,QAAQ,EACR,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,gCAAgC,EACrC,KAAK,0BAA0B,GAChC"}

package/resources/messages/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Messages = exports.Batch = exports.Activities = void 0;
+var activities_1 = require("./activities.js");
+Object.defineProperty(exports, "Activities", { enumerable: true, get: function () { return activities_1.Activities; } });
+var batch_1 = require("./batch.js");
+Object.defineProperty(exports, "Batch", { enumerable: true, get: function () { return batch_1.Batch; } });
+var messages_1 = require("./messages.js");
+Object.defineProperty(exports, "Messages", { enumerable: true, get: function () { return messages_1.Messages; } });
+//# sourceMappingURL=index.js.map

package/resources/messages/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/messages/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAAmE;AAA1D,wGAAA,UAAU,OAAA;AACnB,oCAkBiB;AAjBf,8FAAA,KAAK,OAAA;AAkBP,0CAgBoB;AAflB,oGAAA,QAAQ,OAAA"}

package/resources/messages/index.mjs

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Activities } from "./activities.mjs";
+export { Batch, } from "./batch.mjs";
+export { Messages, } from "./messages.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/messages/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/messages/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,UAAU,EAA2B;OACvC,EACL,KAAK,GAiBN;OACM,EACL,QAAQ,GAeT"}