@knocklabs/node 0.6.19 → 1.0.0

package/resources/audiences.d.mts

@@ -0,0 +1,123 @@
+import { APIResource } from "../core/resource.mjs";
+import * as SharedAPI from "./shared.mjs";
+import * as UsersAPI from "./users/users.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Audiences extends APIResource {
+    /**
+     * Adds one or more members to the specified audience.
+     */
+    addMembers(key: string, body: AudienceAddMembersParams, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Returns a paginated list of members for the specified audience.
+     */
+    listMembers(key: string, options?: RequestOptions): APIPromise<AudienceListMembersResponse>;
+    /**
+     * Removes one or more members from the specified audience.
+     */
+    removeMembers(key: string, body: AudienceRemoveMembersParams, options?: RequestOptions): APIPromise<string>;
+}
+/**
+ * An audience member.
+ */
+export interface AudienceMember {
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    added_at: string;
+    /**
+     * A [User](/concepts/users) represents an individual in your system who can
+     * receive notifications through Knock. Users are the most common recipients of
+     * notifications and are always referenced by your internal identifier.
+     */
+    user: UsersAPI.User;
+    /**
+     * The ID for the user that you set when identifying them in Knock.
+     */
+    user_id: string;
+    /**
+     * The unique identifier for the tenant.
+     */
+    tenant?: string | null;
+}
+/**
+ * A `204 No Content` response.
+ */
+export type AudienceAddMembersResponse = string;
+/**
+ * A paginated list of audience members.
+ */
+export interface AudienceListMembersResponse {
+    /**
+     * A list of audience members.
+     */
+    entries: Array<AudienceMember>;
+    /**
+     * Pagination information for a list of resources.
+     */
+    page_info: SharedAPI.PageInfo;
+}
+/**
+ * A `204 No Content` response.
+ */
+export type AudienceRemoveMembersResponse = string;
+export interface AudienceAddMembersParams {
+    /**
+     * A list of audience members to add.
+     */
+    members: Array<AudienceAddMembersParams.Member>;
+}
+export declare namespace AudienceAddMembersParams {
+    /**
+     * An audience member.
+     */
+    interface Member {
+        user: Member.User;
+        /**
+         * The unique identifier for the tenant.
+         */
+        tenant?: string | null;
+    }
+    namespace Member {
+        interface User {
+            /**
+             * The ID for the user that you set when identifying them in Knock.
+             */
+            id?: string;
+        }
+    }
+}
+export interface AudienceRemoveMembersParams {
+    /**
+     * A list of audience members to remove.
+     */
+    members: Array<AudienceRemoveMembersParams.Member>;
+}
+export declare namespace AudienceRemoveMembersParams {
+    /**
+     * An audience member.
+     */
+    interface Member {
+        user: Member.User;
+        /**
+         * The unique identifier for the tenant.
+         */
+        tenant?: string | null;
+    }
+    namespace Member {
+        interface User {
+            /**
+             * The ID for the user that you set when identifying them in Knock.
+             */
+            id?: string;
+        }
+    }
+}
+export declare namespace Audiences {
+    export { type AudienceMember as AudienceMember, type AudienceAddMembersResponse as AudienceAddMembersResponse, type AudienceListMembersResponse as AudienceListMembersResponse, type AudienceRemoveMembersResponse as AudienceRemoveMembersResponse, type AudienceAddMembersParams as AudienceAddMembersParams, type AudienceRemoveMembersParams as AudienceRemoveMembersParams, };
+}
+//# sourceMappingURL=audiences.d.mts.map

package/resources/audiences.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audiences.d.mts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIrG;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;OAEG;IACH,aAAa,CACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAGtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AAEnD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CACjD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;CACpD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/audiences.d.ts

@@ -0,0 +1,123 @@
+import { APIResource } from "../core/resource.js";
+import * as SharedAPI from "./shared.js";
+import * as UsersAPI from "./users/users.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Audiences extends APIResource {
+    /**
+     * Adds one or more members to the specified audience.
+     */
+    addMembers(key: string, body: AudienceAddMembersParams, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Returns a paginated list of members for the specified audience.
+     */
+    listMembers(key: string, options?: RequestOptions): APIPromise<AudienceListMembersResponse>;
+    /**
+     * Removes one or more members from the specified audience.
+     */
+    removeMembers(key: string, body: AudienceRemoveMembersParams, options?: RequestOptions): APIPromise<string>;
+}
+/**
+ * An audience member.
+ */
+export interface AudienceMember {
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    added_at: string;
+    /**
+     * A [User](/concepts/users) represents an individual in your system who can
+     * receive notifications through Knock. Users are the most common recipients of
+     * notifications and are always referenced by your internal identifier.
+     */
+    user: UsersAPI.User;
+    /**
+     * The ID for the user that you set when identifying them in Knock.
+     */
+    user_id: string;
+    /**
+     * The unique identifier for the tenant.
+     */
+    tenant?: string | null;
+}
+/**
+ * A `204 No Content` response.
+ */
+export type AudienceAddMembersResponse = string;
+/**
+ * A paginated list of audience members.
+ */
+export interface AudienceListMembersResponse {
+    /**
+     * A list of audience members.
+     */
+    entries: Array<AudienceMember>;
+    /**
+     * Pagination information for a list of resources.
+     */
+    page_info: SharedAPI.PageInfo;
+}
+/**
+ * A `204 No Content` response.
+ */
+export type AudienceRemoveMembersResponse = string;
+export interface AudienceAddMembersParams {
+    /**
+     * A list of audience members to add.
+     */
+    members: Array<AudienceAddMembersParams.Member>;
+}
+export declare namespace AudienceAddMembersParams {
+    /**
+     * An audience member.
+     */
+    interface Member {
+        user: Member.User;
+        /**
+         * The unique identifier for the tenant.
+         */
+        tenant?: string | null;
+    }
+    namespace Member {
+        interface User {
+            /**
+             * The ID for the user that you set when identifying them in Knock.
+             */
+            id?: string;
+        }
+    }
+}
+export interface AudienceRemoveMembersParams {
+    /**
+     * A list of audience members to remove.
+     */
+    members: Array<AudienceRemoveMembersParams.Member>;
+}
+export declare namespace AudienceRemoveMembersParams {
+    /**
+     * An audience member.
+     */
+    interface Member {
+        user: Member.User;
+        /**
+         * The unique identifier for the tenant.
+         */
+        tenant?: string | null;
+    }
+    namespace Member {
+        interface User {
+            /**
+             * The ID for the user that you set when identifying them in Knock.
+             */
+            id?: string;
+        }
+    }
+}
+export declare namespace Audiences {
+    export { type AudienceMember as AudienceMember, type AudienceAddMembersResponse as AudienceAddMembersResponse, type AudienceListMembersResponse as AudienceListMembersResponse, type AudienceRemoveMembersResponse as AudienceRemoveMembersResponse, type AudienceAddMembersParams as AudienceAddMembersParams, type AudienceRemoveMembersParams as AudienceRemoveMembersParams, };
+}
+//# sourceMappingURL=audiences.d.ts.map

package/resources/audiences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audiences.d.ts","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIrG;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;OAEG;IACH,aAAa,CACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAGtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AAEnD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CACjD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;CACpD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/audiences.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.Audiences = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Audiences extends resource_1.APIResource {
+    /**
+     * Adds one or more members to the specified audience.
+     */
+    addMembers(key, body, options) {
+        return this._client.post((0, path_1.path) `/v1/audiences/${key}/members`, { body, ...options });
+    }
+    /**
+     * Returns a paginated list of members for the specified audience.
+     */
+    listMembers(key, options) {
+        return this._client.get((0, path_1.path) `/v1/audiences/${key}/members`, options);
+    }
+    /**
+     * Removes one or more members from the specified audience.
+     */
+    removeMembers(key, body, options) {
+        return this._client.delete((0, path_1.path) `/v1/audiences/${key}/members`, { body, ...options });
+    }
+}
+exports.Audiences = Audiences;
+//# sourceMappingURL=audiences.js.map

package/resources/audiences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audiences.js","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,UAAU,CAAC,GAAW,EAAE,IAA8B,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,aAAa,CACX,GAAW,EACX,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AAzBD,8BAyBC"}

package/resources/audiences.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 Audiences extends APIResource {
+    /**
+     * Adds one or more members to the specified audience.
+     */
+    addMembers(key, body, options) {
+        return this._client.post(path `/v1/audiences/${key}/members`, { body, ...options });
+    }
+    /**
+     * Returns a paginated list of members for the specified audience.
+     */
+    listMembers(key, options) {
+        return this._client.get(path `/v1/audiences/${key}/members`, options);
+    }
+    /**
+     * Removes one or more members from the specified audience.
+     */
+    removeMembers(key, body, options) {
+        return this._client.delete(path `/v1/audiences/${key}/members`, { body, ...options });
+    }
+}
+//# sourceMappingURL=audiences.mjs.map

package/resources/audiences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"audiences.mjs","sourceRoot":"","sources":["../src/resources/audiences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,UAAU,CAAC,GAAW,EAAE,IAA8B,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,aAAa,CACX,GAAW,EACX,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,GAAG,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}

package/resources/bulk-operations.d.mts

@@ -0,0 +1,90 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class BulkOperations extends APIResource {
+    /**
+     * Retrieves a bulk operation (if it exists) and displays the current state of it.
+     */
+    get(id: string, options?: RequestOptions): APIPromise<BulkOperation>;
+}
+/**
+ * A bulk operation entity.
+ */
+export interface BulkOperation {
+    /**
+     * Unique identifier for the bulk operation.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The estimated total number of rows to process.
+     */
+    estimated_total_rows: number;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * The name of the bulk operation.
+     */
+    name: string;
+    /**
+     * The number of rows processed so far.
+     */
+    processed_rows: number;
+    /**
+     * The status of the bulk operation.
+     */
+    status: 'queued' | 'processing' | 'completed' | 'failed';
+    /**
+     * The number of successful operations.
+     */
+    success_count: number;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * Timestamp when the bulk operation was completed.
+     */
+    completed_at?: string | null;
+    /**
+     * The number of failed operations.
+     */
+    error_count?: number;
+    /**
+     * A list of items that failed to be processed.
+     */
+    error_items?: Array<BulkOperation.ErrorItem>;
+    /**
+     * Timestamp when the bulk operation failed.
+     */
+    failed_at?: string | null;
+    /**
+     * The URI to the bulk operation's progress.
+     */
+    progress_path?: string;
+    /**
+     * Timestamp when the bulk operation was started.
+     */
+    started_at?: string | null;
+}
+export declare namespace BulkOperation {
+    interface ErrorItem {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+        /**
+         * The collection this object belongs to.
+         */
+        collection?: string | null;
+    }
+}
+export declare namespace BulkOperations {
+    export { type BulkOperation as BulkOperation };
+}
+//# sourceMappingURL=bulk-operations.d.mts.map

package/resources/bulk-operations.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-operations.d.mts","sourceRoot":"","sources":["../src/resources/bulk-operations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGrE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAChD"}

package/resources/bulk-operations.d.ts

@@ -0,0 +1,90 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class BulkOperations extends APIResource {
+    /**
+     * Retrieves a bulk operation (if it exists) and displays the current state of it.
+     */
+    get(id: string, options?: RequestOptions): APIPromise<BulkOperation>;
+}
+/**
+ * A bulk operation entity.
+ */
+export interface BulkOperation {
+    /**
+     * Unique identifier for the bulk operation.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The estimated total number of rows to process.
+     */
+    estimated_total_rows: number;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * The name of the bulk operation.
+     */
+    name: string;
+    /**
+     * The number of rows processed so far.
+     */
+    processed_rows: number;
+    /**
+     * The status of the bulk operation.
+     */
+    status: 'queued' | 'processing' | 'completed' | 'failed';
+    /**
+     * The number of successful operations.
+     */
+    success_count: number;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * Timestamp when the bulk operation was completed.
+     */
+    completed_at?: string | null;
+    /**
+     * The number of failed operations.
+     */
+    error_count?: number;
+    /**
+     * A list of items that failed to be processed.
+     */
+    error_items?: Array<BulkOperation.ErrorItem>;
+    /**
+     * Timestamp when the bulk operation failed.
+     */
+    failed_at?: string | null;
+    /**
+     * The URI to the bulk operation's progress.
+     */
+    progress_path?: string;
+    /**
+     * Timestamp when the bulk operation was started.
+     */
+    started_at?: string | null;
+}
+export declare namespace BulkOperation {
+    interface ErrorItem {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+        /**
+         * The collection this object belongs to.
+         */
+        collection?: string | null;
+    }
+}
+export declare namespace BulkOperations {
+    export { type BulkOperation as BulkOperation };
+}
+//# sourceMappingURL=bulk-operations.d.ts.map

package/resources/bulk-operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-operations.d.ts","sourceRoot":"","sources":["../src/resources/bulk-operations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGrE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CAChD"}

package/resources/bulk-operations.js

@@ -0,0 +1,16 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkOperations = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class BulkOperations extends resource_1.APIResource {
+    /**
+     * Retrieves a bulk operation (if it exists) and displays the current state of it.
+     */
+    get(id, options) {
+        return this._client.get((0, path_1.path) `/v1/bulk_operations/${id}`, options);
+    }
+}
+exports.BulkOperations = BulkOperations;
+//# sourceMappingURL=bulk-operations.js.map

package/resources/bulk-operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-operations.js","sourceRoot":"","sources":["../src/resources/bulk-operations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAPD,wCAOC"}

package/resources/bulk-operations.mjs

@@ -0,0 +1,12 @@
+// 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 BulkOperations extends APIResource {
+    /**
+     * Retrieves a bulk operation (if it exists) and displays the current state of it.
+     */
+    get(id, options) {
+        return this._client.get(path `/v1/bulk_operations/${id}`, options);
+    }
+}
+//# sourceMappingURL=bulk-operations.mjs.map

package/resources/bulk-operations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-operations.mjs","sourceRoot":"","sources":["../src/resources/bulk-operations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF"}

package/resources/channels/bulk.d.mts

@@ -0,0 +1,61 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as BulkOperationsAPI from "../bulk-operations.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Bulk extends APIResource {
+    /**
+     * Bulk update the status of messages for a specific channel. The channel is
+     * specified by the `channel_id` parameter. The action to perform is specified by
+     * the `action` parameter, where the action is a status change action (e.g.
+     * `archive`, `unarchive`).
+     */
+    updateMessageStatus(channelID: string, action: 'seen' | 'unseen' | 'read' | 'unread' | 'archived' | 'unarchived' | 'interacted' | 'archive' | 'unarchive' | 'delete', body: BulkUpdateMessageStatusParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
+}
+export interface BulkUpdateMessageStatusParams {
+    /**
+     * Limits the results to messages with the given archived status.
+     */
+    archived?: 'exclude' | 'include' | 'only';
+    /**
+     * Limits the results to messages with the given delivery status.
+     */
+    delivery_status?: 'queued' | 'sent' | 'delivered' | 'delivery_attempted' | 'undelivered' | 'not_sent' | 'bounced';
+    /**
+     * Limits the results to messages with the given engagement status.
+     */
+    engagement_status?: 'seen' | 'unseen' | 'read' | 'unread' | 'archived' | 'unarchived' | 'link_clicked' | 'interacted';
+    /**
+     * Limits the results to messages that have a tenant or not.
+     */
+    has_tenant?: boolean;
+    /**
+     * Limits the results to messages inserted after the given date.
+     */
+    newer_than?: string;
+    /**
+     * Limits the results to messages inserted before the given date.
+     */
+    older_than?: string;
+    /**
+     * Limits the results to messages with the given recipient IDs.
+     */
+    recipient_ids?: Array<string>;
+    /**
+     * Limits the results to messages with the given tenant IDs.
+     */
+    tenants?: Array<string>;
+    /**
+     * Limits the results to only messages that were generated with the given data. See
+     * [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
+     * more information.
+     */
+    trigger_data?: string;
+    /**
+     * Limits the results to messages with the given workflow keys.
+     */
+    workflows?: Array<string>;
+}
+export declare namespace Bulk {
+    export { type BulkUpdateMessageStatusParams as BulkUpdateMessageStatusParams };
+}
+//# sourceMappingURL=bulk.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/channels/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EACF,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,WAAW,GACX,QAAQ,EACZ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C;;OAEG;IACH,eAAe,CAAC,EACZ,QAAQ,GACR,MAAM,GACN,WAAW,GACX,oBAAoB,GACpB,aAAa,GACb,UAAU,GACV,SAAS,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EACd,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,cAAc,GACd,YAAY,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,6BAA6B,IAAI,6BAA6B,EAAE,CAAC;CAChF"}