@knocklabs/node 0.6.19 → 1.0.0

package/resources/users/bulk.d.mts

@@ -0,0 +1,51 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as BulkOperationsAPI from "../bulk-operations.mjs";
+import * as PreferencesAPI from "../recipients/preferences.mjs";
+import * as UsersAPI from "./users.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Bulk extends APIResource {
+    /**
+     * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+     * delete and returns a bulk operation that can be queried for progress.
+     */
+    delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Identifies multiple users in a single operation. Allows creating or updating up
+     * to 100 users in a single batch with various properties, preferences, and channel
+     * data.
+     */
+    identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Sets preferences for multiple users in a single operation. Supports either
+     * setting the same preferences for multiple users or specific preferences for each
+     * user.
+     */
+    setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+}
+export interface BulkDeleteParams {
+    /**
+     * A list of user IDs.
+     */
+    user_ids: Array<string>;
+}
+export interface BulkIdentifyParams {
+    /**
+     * A list of users.
+     */
+    users: Array<UsersAPI.InlineIdentifyUserRequest>;
+}
+export interface BulkSetPreferencesParams {
+    /**
+     * A request to set a preference set for a recipient.
+     */
+    preferences: PreferencesAPI.PreferenceSetRequest;
+    /**
+     * A list of user IDs.
+     */
+    user_ids: Array<string>;
+}
+export declare namespace Bulk {
+    export { type BulkDeleteParams as BulkDeleteParams, type BulkIdentifyParams as BulkIdentifyParams, type BulkSetPreferencesParams as BulkSetPreferencesParams, };
+}
+//# sourceMappingURL=bulk.d.mts.map

package/resources/users/bulk.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/users/bulk.d.ts

@@ -0,0 +1,51 @@
+import { APIResource } from "../../core/resource.js";
+import * as BulkOperationsAPI from "../bulk-operations.js";
+import * as PreferencesAPI from "../recipients/preferences.js";
+import * as UsersAPI from "./users.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Bulk extends APIResource {
+    /**
+     * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+     * delete and returns a bulk operation that can be queried for progress.
+     */
+    delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Identifies multiple users in a single operation. Allows creating or updating up
+     * to 100 users in a single batch with various properties, preferences, and channel
+     * data.
+     */
+    identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+    /**
+     * Sets preferences for multiple users in a single operation. Supports either
+     * setting the same preferences for multiple users or specific preferences for each
+     * user.
+     */
+    setPreferences(body: BulkSetPreferencesParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+}
+export interface BulkDeleteParams {
+    /**
+     * A list of user IDs.
+     */
+    user_ids: Array<string>;
+}
+export interface BulkIdentifyParams {
+    /**
+     * A list of users.
+     */
+    users: Array<UsersAPI.InlineIdentifyUserRequest>;
+}
+export interface BulkSetPreferencesParams {
+    /**
+     * A request to set a preference set for a recipient.
+     */
+    preferences: PreferencesAPI.PreferenceSetRequest;
+    /**
+     * A list of user IDs.
+     */
+    user_ids: Array<string>;
+}
+export declare namespace Bulk {
+    export { type BulkDeleteParams as BulkDeleteParams, type BulkIdentifyParams as BulkIdentifyParams, type BulkSetPreferencesParams as BulkSetPreferencesParams, };
+}
+//# sourceMappingURL=bulk.d.ts.map

package/resources/users/bulk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,cAAc;OACnB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIrG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAIzG;;;;OAIG;IACH,cAAc,CACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC,oBAAoB,CAAC;IAEjD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/users/bulk.js

@@ -0,0 +1,32 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bulk = void 0;
+const resource_1 = require("../../core/resource.js");
+class Bulk extends resource_1.APIResource {
+    /**
+     * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+     * delete and returns a bulk operation that can be queried for progress.
+     */
+    delete(body, options) {
+        return this._client.post('/v1/users/bulk/delete', { body, ...options });
+    }
+    /**
+     * Identifies multiple users in a single operation. Allows creating or updating up
+     * to 100 users in a single batch with various properties, preferences, and channel
+     * data.
+     */
+    identify(body, options) {
+        return this._client.post('/v1/users/bulk/identify', { body, ...options });
+    }
+    /**
+     * Sets preferences for multiple users in a single operation. Supports either
+     * setting the same preferences for multiple users or specific preferences for each
+     * user.
+     */
+    setPreferences(body, options) {
+        return this._client.post('/v1/users/bulk/preferences', { body, ...options });
+    }
+}
+exports.Bulk = Bulk;
+//# sourceMappingURL=bulk.js.map

package/resources/users/bulk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA7BD,oBA6BC"}

package/resources/users/bulk.mjs

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+export class Bulk extends APIResource {
+    /**
+     * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+     * delete and returns a bulk operation that can be queried for progress.
+     */
+    delete(body, options) {
+        return this._client.post('/v1/users/bulk/delete', { body, ...options });
+    }
+    /**
+     * Identifies multiple users in a single operation. Allows creating or updating up
+     * to 100 users in a single batch with various properties, preferences, and channel
+     * data.
+     */
+    identify(body, options) {
+        return this._client.post('/v1/users/bulk/identify', { body, ...options });
+    }
+    /**
+     * Sets preferences for multiple users in a single operation. Supports either
+     * setting the same preferences for multiple users or specific preferences for each
+     * user.
+     */
+    setPreferences(body, options) {
+        return this._client.post('/v1/users/bulk/preferences', { body, ...options });
+    }
+}
+//# sourceMappingURL=bulk.mjs.map

package/resources/users/bulk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/users/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAOtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;OAGG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/users/feeds.d.mts

@@ -0,0 +1,229 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as MessagesAPI from "../messages/messages.mjs";
+import * as RecipientsAPI from "../recipients/recipients.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Feeds extends APIResource {
+    /**
+     * Returns the feed settings for a user.
+     */
+    getSettings(userID: string, id: string, options?: RequestOptions): APIPromise<FeedGetSettingsResponse>;
+    /**
+     * Returns a paginated list of feed items for a user, including metadata about the
+     * feed.
+     */
+    listItems(userID: string, id: string, query?: FeedListItemsParams | null | undefined, options?: RequestOptions): PagePromise<FeedListItemsResponsesEntriesCursor, FeedListItemsResponse>;
+}
+export type FeedListItemsResponsesEntriesCursor = EntriesCursor<FeedListItemsResponse>;
+/**
+ * The response for the user's feed settings.
+ */
+export interface FeedGetSettingsResponse {
+    /**
+     * Features configuration for the user's feed.
+     */
+    features: FeedGetSettingsResponse.Features;
+}
+export declare namespace FeedGetSettingsResponse {
+    /**
+     * Features configuration for the user's feed.
+     */
+    interface Features {
+        /**
+         * Whether branding is required for the user's feed.
+         */
+        branding_required: boolean;
+    }
+}
+/**
+ * An in-app feed message in a user's feed.
+ */
+export interface FeedListItemsResponse {
+    /**
+     * Unique identifier for the feed.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * List of activities associated with this feed item.
+     */
+    activities: Array<MessagesAPI.Activity>;
+    /**
+     * List of actors associated with this feed item.
+     */
+    actors: Array<RecipientsAPI.Recipient>;
+    /**
+     * Content blocks that make up the feed item.
+     */
+    blocks: Array<FeedListItemsResponse.MessageInAppFeedContentBlock | FeedListItemsResponse.MessageInAppFeedButtonSetBlock>;
+    /**
+     * Additional data associated with the feed item.
+     */
+    data: Record<string, unknown> | null;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * Source information for the feed item.
+     */
+    source: FeedListItemsResponse.Source;
+    /**
+     * Tenant ID that the feed item belongs to.
+     */
+    tenant: string | null;
+    /**
+     * Total number of activities related to this feed item.
+     */
+    total_activities: number;
+    /**
+     * Total number of actors related to this feed item.
+     */
+    total_actors: number;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * Timestamp when the feed item was archived.
+     */
+    archived_at?: string | null;
+    /**
+     * Timestamp when the feed item was clicked.
+     */
+    clicked_at?: string | null;
+    /**
+     * Timestamp when the feed item was interacted with.
+     */
+    interacted_at?: string | null;
+    /**
+     * Timestamp when a link within the feed item was clicked.
+     */
+    link_clicked_at?: string | null;
+    /**
+     * Timestamp when the feed item was marked as read.
+     */
+    read_at?: string | null;
+    /**
+     * Timestamp when the feed item was marked as seen.
+     */
+    seen_at?: string | null;
+}
+export declare namespace FeedListItemsResponse {
+    /**
+     * A block in a message in an app feed.
+     */
+    interface MessageInAppFeedContentBlock {
+        /**
+         * The content of the block in a message in an app feed.
+         */
+        content: string;
+        /**
+         * The name of the block in a message in an app feed.
+         */
+        name: string;
+        /**
+         * The rendered HTML version of the content.
+         */
+        rendered: string;
+        /**
+         * The type of block in a message in an app feed.
+         */
+        type: 'markdown' | 'text';
+    }
+    /**
+     * A button set block in a message in an app feed.
+     */
+    interface MessageInAppFeedButtonSetBlock {
+        /**
+         * A list of buttons in an in app feed message.
+         */
+        buttons: Array<MessageInAppFeedButtonSetBlock.Button>;
+        /**
+         * The name of the button set in a message in an app feed.
+         */
+        name: string;
+        /**
+         * The type of block in a message in an app feed.
+         */
+        type: 'button_set';
+    }
+    namespace MessageInAppFeedButtonSetBlock {
+        /**
+         * A button in an in app feed message.
+         */
+        interface Button {
+            /**
+             * The action to take when the button is clicked.
+             */
+            action: string;
+            /**
+             * The label of the button.
+             */
+            label: string;
+            /**
+             * The name of the button.
+             */
+            name: string;
+        }
+    }
+    /**
+     * Source information for the feed item.
+     */
+    interface Source {
+        /**
+         * The typename of the schema.
+         */
+        __typename: string;
+        /**
+         * Categories this workflow belongs to.
+         */
+        categories: Array<string>;
+        /**
+         * The key of the workflow.
+         */
+        key: string;
+        /**
+         * The workflow version ID.
+         */
+        version_id: string;
+    }
+}
+export interface FeedListItemsParams extends EntriesCursorParams {
+    /**
+     * The archived status of the feed items.
+     */
+    archived?: 'exclude' | 'include' | 'only';
+    /**
+     * Whether the feed items have a tenant.
+     */
+    has_tenant?: boolean;
+    /**
+     * The source of the feed items.
+     */
+    source?: string;
+    /**
+     * The status of the feed items.
+     */
+    status?: 'unread' | 'read' | 'unseen' | 'seen' | 'all';
+    /**
+     * The tenant associated with the feed items.
+     */
+    tenant?: string;
+    /**
+     * The trigger data of the feed items (as a JSON string).
+     */
+    trigger_data?: string;
+    /**
+     * The workflow categories of the feed items.
+     */
+    workflow_categories?: Array<string>;
+}
+export declare namespace Feeds {
+    export { type FeedGetSettingsResponse as FeedGetSettingsResponse, type FeedListItemsResponse as FeedListItemsResponse, type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor, type FeedListItemsParams as FeedListItemsParams, };
+}
+//# sourceMappingURL=feeds.d.mts.map

package/resources/users/feeds.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeds.d.mts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;OAGG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/users/feeds.d.ts

@@ -0,0 +1,229 @@
+import { APIResource } from "../../core/resource.js";
+import * as MessagesAPI from "../messages/messages.js";
+import * as RecipientsAPI from "../recipients/recipients.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Feeds extends APIResource {
+    /**
+     * Returns the feed settings for a user.
+     */
+    getSettings(userID: string, id: string, options?: RequestOptions): APIPromise<FeedGetSettingsResponse>;
+    /**
+     * Returns a paginated list of feed items for a user, including metadata about the
+     * feed.
+     */
+    listItems(userID: string, id: string, query?: FeedListItemsParams | null | undefined, options?: RequestOptions): PagePromise<FeedListItemsResponsesEntriesCursor, FeedListItemsResponse>;
+}
+export type FeedListItemsResponsesEntriesCursor = EntriesCursor<FeedListItemsResponse>;
+/**
+ * The response for the user's feed settings.
+ */
+export interface FeedGetSettingsResponse {
+    /**
+     * Features configuration for the user's feed.
+     */
+    features: FeedGetSettingsResponse.Features;
+}
+export declare namespace FeedGetSettingsResponse {
+    /**
+     * Features configuration for the user's feed.
+     */
+    interface Features {
+        /**
+         * Whether branding is required for the user's feed.
+         */
+        branding_required: boolean;
+    }
+}
+/**
+ * An in-app feed message in a user's feed.
+ */
+export interface FeedListItemsResponse {
+    /**
+     * Unique identifier for the feed.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * List of activities associated with this feed item.
+     */
+    activities: Array<MessagesAPI.Activity>;
+    /**
+     * List of actors associated with this feed item.
+     */
+    actors: Array<RecipientsAPI.Recipient>;
+    /**
+     * Content blocks that make up the feed item.
+     */
+    blocks: Array<FeedListItemsResponse.MessageInAppFeedContentBlock | FeedListItemsResponse.MessageInAppFeedButtonSetBlock>;
+    /**
+     * Additional data associated with the feed item.
+     */
+    data: Record<string, unknown> | null;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * Source information for the feed item.
+     */
+    source: FeedListItemsResponse.Source;
+    /**
+     * Tenant ID that the feed item belongs to.
+     */
+    tenant: string | null;
+    /**
+     * Total number of activities related to this feed item.
+     */
+    total_activities: number;
+    /**
+     * Total number of actors related to this feed item.
+     */
+    total_actors: number;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * Timestamp when the feed item was archived.
+     */
+    archived_at?: string | null;
+    /**
+     * Timestamp when the feed item was clicked.
+     */
+    clicked_at?: string | null;
+    /**
+     * Timestamp when the feed item was interacted with.
+     */
+    interacted_at?: string | null;
+    /**
+     * Timestamp when a link within the feed item was clicked.
+     */
+    link_clicked_at?: string | null;
+    /**
+     * Timestamp when the feed item was marked as read.
+     */
+    read_at?: string | null;
+    /**
+     * Timestamp when the feed item was marked as seen.
+     */
+    seen_at?: string | null;
+}
+export declare namespace FeedListItemsResponse {
+    /**
+     * A block in a message in an app feed.
+     */
+    interface MessageInAppFeedContentBlock {
+        /**
+         * The content of the block in a message in an app feed.
+         */
+        content: string;
+        /**
+         * The name of the block in a message in an app feed.
+         */
+        name: string;
+        /**
+         * The rendered HTML version of the content.
+         */
+        rendered: string;
+        /**
+         * The type of block in a message in an app feed.
+         */
+        type: 'markdown' | 'text';
+    }
+    /**
+     * A button set block in a message in an app feed.
+     */
+    interface MessageInAppFeedButtonSetBlock {
+        /**
+         * A list of buttons in an in app feed message.
+         */
+        buttons: Array<MessageInAppFeedButtonSetBlock.Button>;
+        /**
+         * The name of the button set in a message in an app feed.
+         */
+        name: string;
+        /**
+         * The type of block in a message in an app feed.
+         */
+        type: 'button_set';
+    }
+    namespace MessageInAppFeedButtonSetBlock {
+        /**
+         * A button in an in app feed message.
+         */
+        interface Button {
+            /**
+             * The action to take when the button is clicked.
+             */
+            action: string;
+            /**
+             * The label of the button.
+             */
+            label: string;
+            /**
+             * The name of the button.
+             */
+            name: string;
+        }
+    }
+    /**
+     * Source information for the feed item.
+     */
+    interface Source {
+        /**
+         * The typename of the schema.
+         */
+        __typename: string;
+        /**
+         * Categories this workflow belongs to.
+         */
+        categories: Array<string>;
+        /**
+         * The key of the workflow.
+         */
+        key: string;
+        /**
+         * The workflow version ID.
+         */
+        version_id: string;
+    }
+}
+export interface FeedListItemsParams extends EntriesCursorParams {
+    /**
+     * The archived status of the feed items.
+     */
+    archived?: 'exclude' | 'include' | 'only';
+    /**
+     * Whether the feed items have a tenant.
+     */
+    has_tenant?: boolean;
+    /**
+     * The source of the feed items.
+     */
+    source?: string;
+    /**
+     * The status of the feed items.
+     */
+    status?: 'unread' | 'read' | 'unseen' | 'seen' | 'all';
+    /**
+     * The tenant associated with the feed items.
+     */
+    tenant?: string;
+    /**
+     * The trigger data of the feed items (as a JSON string).
+     */
+    trigger_data?: string;
+    /**
+     * The workflow categories of the feed items.
+     */
+    workflow_categories?: Array<string>;
+}
+export declare namespace Feeds {
+    export { type FeedGetSettingsResponse as FeedGetSettingsResponse, type FeedListItemsResponse as FeedListItemsResponse, type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor, type FeedListItemsParams as FeedListItemsParams, };
+}
+//# sourceMappingURL=feeds.d.ts.map

package/resources/users/feeds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeds.d.ts","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE;OACxD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;OAGG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAO3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC5C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,KAAK,CACX,qBAAqB,CAAC,4BAA4B,GAAG,qBAAqB,CAAC,8BAA8B,CAC1G,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;QAEtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;KACpB;IAED,UAAiB,8BAA8B,CAAC;QAC9C;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/users/feeds.js

@@ -0,0 +1,24 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feeds = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+class Feeds extends resource_1.APIResource {
+    /**
+     * Returns the feed settings for a user.
+     */
+    getSettings(userID, id, options) {
+        return this._client.get((0, path_1.path) `/v1/users/${userID}/feeds/${id}/settings`, options);
+    }
+    /**
+     * Returns a paginated list of feed items for a user, including metadata about the
+     * feed.
+     */
+    listItems(userID, id, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/feeds/${id}`, (pagination_1.EntriesCursor), { query, ...options });
+    }
+}
+exports.Feeds = Feeds;
+//# sourceMappingURL=feeds.js.map