@augno/sdk 0.7.0 → 0.7.1

package/resources/messaging/announcements/actions.js

@@ -0,0 +1,73 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * List, read, and manage broadcast announcements.
+ */
+class Actions extends resource_1.APIResource {
+    /**
+     * Marks an announcement as seen for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.seen(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    seen(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post((0, path_1.path) `/v1/messaging/announcements/${id}/actions/seen`, {
+            query: { include },
+            ...options,
+        });
+    }
+    /**
+     * Marks an announcement as read for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.read(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    read(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post((0, path_1.path) `/v1/messaging/announcements/${id}/actions/read`, {
+            query: { include },
+            ...options,
+        });
+    }
+    /**
+     * Marks an announcement as dismissed for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.dismiss(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    dismiss(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post((0, path_1.path) `/v1/messaging/announcements/${id}/actions/dismiss`, {
+            query: { include },
+            ...options,
+        });
+    }
+}
+exports.Actions = Actions;
+//# sourceMappingURL=actions.js.map

package/resources/messaging/announcements/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,eAAe,EAAE;YAC7E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,eAAe,EAAE;YAC7E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,kBAAkB,EAAE;YAChF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3ED,0BA2EC"}

package/resources/messaging/announcements/actions.mjs

@@ -0,0 +1,69 @@
+// 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";
+/**
+ * List, read, and manage broadcast announcements.
+ */
+export class Actions extends APIResource {
+    /**
+     * Marks an announcement as seen for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.seen(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    seen(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post(path `/v1/messaging/announcements/${id}/actions/seen`, {
+            query: { include },
+            ...options,
+        });
+    }
+    /**
+     * Marks an announcement as read for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.read(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    read(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post(path `/v1/messaging/announcements/${id}/actions/read`, {
+            query: { include },
+            ...options,
+        });
+    }
+    /**
+     * Marks an announcement as dismissed for the calling actor.
+     *
+     * This endpoint requires the permission: `messaging:update`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.actions.dismiss(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    dismiss(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post(path `/v1/messaging/announcements/${id}/actions/dismiss`, {
+            query: { include },
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=actions.mjs.map

package/resources/messaging/announcements/actions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,+BAA+B,EAAE,eAAe,EAAE;YAC7E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,+BAA+B,EAAE,eAAe,EAAE;YAC7E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,+BAA+B,EAAE,kBAAkB,EAAE;YAChF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/messaging/announcements/announcements.d.mts

@@ -0,0 +1,173 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as CoreAPI from "../../core/core.mjs";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { ActionDismissParams, ActionReadParams, ActionSeenParams, Actions } from "./actions.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * List, read, and manage broadcast announcements.
+ */
+export declare class Announcements extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * Returns the broadcast announcements currently active for the caller, most recent
+     * first.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listAnnouncement =
+     *   await client.messaging.announcements.list();
+     * ```
+     */
+    list(query?: AnnouncementListParams | null | undefined, options?: RequestOptions): APIPromise<ListAnnouncement>;
+    /**
+     * Returns one active announcement by ID.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.retrieve(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: AnnouncementRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Announcement>;
+}
+/**
+ * A broadcast announcement shown in the bell feed, with the caller's per-user read
+ * state.
+ */
+export interface Announcement {
+    /**
+     * Announcement ID.
+     */
+    id: string;
+    /**
+     * Preview/body text.
+     */
+    body: string | null;
+    /**
+     * Category of the announcement.
+     */
+    category: 'chat.message' | 'chat.mention' | 'chat.added' | 'order.updated' | 'agent.run_completed' | 'agent.alert' | 'system.broadcast';
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * When the calling actor dismissed the announcement.
+     */
+    dismissed_at: string | null;
+    /**
+     * When the announcement stops being shown.
+     */
+    expires_at: string | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'announcement';
+    /**
+     * Delivery priority.
+     */
+    priority: 'low' | 'normal' | 'high' | 'urgent';
+    /**
+     * When the announcement becomes visible in the feed.
+     */
+    publish_at: string;
+    /**
+     * When the calling actor opened the announcement.
+     */
+    read_at: string | null;
+    /**
+     * Entity is a polymorphic reference to any resource in the system.
+     */
+    resource: CoreAPI.Entity | null;
+    /**
+     * Reach of the announcement.
+     *
+     * - `account`: shown only to users within this account.
+     * - `platform`: shown to every user across all accounts.
+     */
+    scope: 'account' | 'platform';
+    /**
+     * When the calling actor first saw the announcement.
+     */
+    seen_at: string | null;
+    /**
+     * Lifecycle status of the announcement for the calling actor, derived from their
+     * seen/read/dismissed receipt.
+     *
+     * - `unseen`: not yet surfaced in the caller's feed.
+     * - `seen`: surfaced in the feed but not yet opened.
+     * - `read`: opened by the caller.
+     * - `dismissed`: dismissed by the caller.
+     */
+    status: 'unseen' | 'seen' | 'read' | 'dismissed';
+    /**
+     * Human-readable title.
+     */
+    title: string;
+    /**
+     * Last update timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAnnouncement {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Announcement>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+export interface AnnouncementListParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'resource'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export interface AnnouncementRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'resource'>;
+}
+export declare namespace Announcements {
+    export { type Announcement as Announcement, type ListAnnouncement as ListAnnouncement, type AnnouncementListParams as AnnouncementListParams, type AnnouncementRetrieveParams as AnnouncementRetrieveParams, };
+    export { Actions as Actions, type ActionSeenParams as ActionSeenParams, type ActionReadParams as ActionReadParams, type ActionDismissParams as ActionDismissParams, };
+}
+//# sourceMappingURL=announcements.d.mts.map

package/resources/messaging/announcements/announcements.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcements.d.mts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/announcements.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,KAAK,UAAU;OACf,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,EAAE;OACpE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;CAG5B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,QAAQ,EACJ,cAAc,GACd,cAAc,GACd,YAAY,GACZ,eAAe,GACf,qBAAqB,GACrB,aAAa,GACb,kBAAkB,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;;;OAQG;IACH,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;IAEjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/messaging/announcements/announcements.d.ts

@@ -0,0 +1,173 @@
+import { APIResource } from "../../../core/resource.js";
+import * as CoreAPI from "../../core/core.js";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
+import * as ActionsAPI from "./actions.js";
+import { ActionDismissParams, ActionReadParams, ActionSeenParams, Actions } from "./actions.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * List, read, and manage broadcast announcements.
+ */
+export declare class Announcements extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * Returns the broadcast announcements currently active for the caller, most recent
+     * first.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listAnnouncement =
+     *   await client.messaging.announcements.list();
+     * ```
+     */
+    list(query?: AnnouncementListParams | null | undefined, options?: RequestOptions): APIPromise<ListAnnouncement>;
+    /**
+     * Returns one active announcement by ID.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.retrieve(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    retrieve(id: string, query?: AnnouncementRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Announcement>;
+}
+/**
+ * A broadcast announcement shown in the bell feed, with the caller's per-user read
+ * state.
+ */
+export interface Announcement {
+    /**
+     * Announcement ID.
+     */
+    id: string;
+    /**
+     * Preview/body text.
+     */
+    body: string | null;
+    /**
+     * Category of the announcement.
+     */
+    category: 'chat.message' | 'chat.mention' | 'chat.added' | 'order.updated' | 'agent.run_completed' | 'agent.alert' | 'system.broadcast';
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * When the calling actor dismissed the announcement.
+     */
+    dismissed_at: string | null;
+    /**
+     * When the announcement stops being shown.
+     */
+    expires_at: string | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'announcement';
+    /**
+     * Delivery priority.
+     */
+    priority: 'low' | 'normal' | 'high' | 'urgent';
+    /**
+     * When the announcement becomes visible in the feed.
+     */
+    publish_at: string;
+    /**
+     * When the calling actor opened the announcement.
+     */
+    read_at: string | null;
+    /**
+     * Entity is a polymorphic reference to any resource in the system.
+     */
+    resource: CoreAPI.Entity | null;
+    /**
+     * Reach of the announcement.
+     *
+     * - `account`: shown only to users within this account.
+     * - `platform`: shown to every user across all accounts.
+     */
+    scope: 'account' | 'platform';
+    /**
+     * When the calling actor first saw the announcement.
+     */
+    seen_at: string | null;
+    /**
+     * Lifecycle status of the announcement for the calling actor, derived from their
+     * seen/read/dismissed receipt.
+     *
+     * - `unseen`: not yet surfaced in the caller's feed.
+     * - `seen`: surfaced in the feed but not yet opened.
+     * - `read`: opened by the caller.
+     * - `dismissed`: dismissed by the caller.
+     */
+    status: 'unseen' | 'seen' | 'read' | 'dismissed';
+    /**
+     * Human-readable title.
+     */
+    title: string;
+    /**
+     * Last update timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAnnouncement {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Announcement>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+export interface AnnouncementListParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'resource'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export interface AnnouncementRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'resource'>;
+}
+export declare namespace Announcements {
+    export { type Announcement as Announcement, type ListAnnouncement as ListAnnouncement, type AnnouncementListParams as AnnouncementListParams, type AnnouncementRetrieveParams as AnnouncementRetrieveParams, };
+    export { Actions as Actions, type ActionSeenParams as ActionSeenParams, type ActionReadParams as ActionReadParams, type ActionDismissParams as ActionDismissParams, };
+}
+//# sourceMappingURL=announcements.d.ts.map

package/resources/messaging/announcements/announcements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcements.d.ts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/announcements.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,KAAK,UAAU;OACf,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,EAAE;OACpE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;CAG5B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,QAAQ,EACJ,cAAc,GACd,cAAc,GACd,YAAY,GACZ,eAAe,GACf,qBAAqB,GACrB,aAAa,GACb,kBAAkB,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;;;;OAQG;IACH,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;IAEjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/messaging/announcements/announcements.js

@@ -0,0 +1,52 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Announcements = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ActionsAPI = tslib_1.__importStar(require("./actions.js"));
+const actions_1 = require("./actions.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * List, read, and manage broadcast announcements.
+ */
+class Announcements extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * Returns the broadcast announcements currently active for the caller, most recent
+     * first.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listAnnouncement =
+     *   await client.messaging.announcements.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/messaging/announcements', { query, ...options });
+    }
+    /**
+     * Returns one active announcement by ID.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.retrieve(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/messaging/announcements/${id}`, { query, ...options });
+    }
+}
+exports.Announcements = Announcements;
+Announcements.Actions = actions_1.Actions;
+//# sourceMappingURL=announcements.js.map

package/resources/messaging/announcements/announcements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcements.js","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/announcements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAGrD,iEAAwC;AACxC,0CAA6F;AAG7F,0DAAoD;AAEpD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAA9C;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyCrE,CAAC;IAvCC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA1CD,sCA0CC;AAiKD,aAAa,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/messaging/announcements/announcements.mjs

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { Actions } from "./actions.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * List, read, and manage broadcast announcements.
+ */
+export class Announcements extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * Returns the broadcast announcements currently active for the caller, most recent
+     * first.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const listAnnouncement =
+     *   await client.messaging.announcements.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/messaging/announcements', { query, ...options });
+    }
+    /**
+     * Returns one active announcement by ID.
+     *
+     * This endpoint requires the permission: `messaging:read`.
+     *
+     * @example
+     * ```ts
+     * const announcement =
+     *   await client.messaging.announcements.retrieve(
+     *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+     *   );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/v1/messaging/announcements/${id}`, { query, ...options });
+    }
+}
+Announcements.Actions = Actions;
+//# sourceMappingURL=announcements.mjs.map

package/resources/messaging/announcements/announcements.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"announcements.mjs","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/announcements.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,UAAU;OACf,EAA2D,OAAO,EAAE;OAGpE,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyCrE,CAAC;IAvCC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAiKD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/resources/messaging/announcements/index.d.mts

@@ -0,0 +1,3 @@
+export { Actions, type ActionSeenParams, type ActionReadParams, type ActionDismissParams } from "./actions.mjs";
+export { Announcements, type Announcement, type ListAnnouncement, type AnnouncementListParams, type AnnouncementRetrieveParams, } from "./announcements.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/messaging/announcements/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE;OACnF,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,GAChC"}

package/resources/messaging/announcements/index.d.ts

@@ -0,0 +1,3 @@
+export { Actions, type ActionSeenParams, type ActionReadParams, type ActionDismissParams } from "./actions.js";
+export { Announcements, type Announcement, type ListAnnouncement, type AnnouncementListParams, type AnnouncementRetrieveParams, } from "./announcements.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/messaging/announcements/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE;OACnF,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,GAChC"}

package/resources/messaging/announcements/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Announcements = exports.Actions = void 0;
+var actions_1 = require("./actions.js");
+Object.defineProperty(exports, "Actions", { enumerable: true, get: function () { return actions_1.Actions; } });
+var announcements_1 = require("./announcements.js");
+Object.defineProperty(exports, "Announcements", { enumerable: true, get: function () { return announcements_1.Announcements; } });
+//# sourceMappingURL=index.js.map

package/resources/messaging/announcements/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAA4G;AAAnG,kGAAA,OAAO,OAAA;AAChB,oDAMyB;AALvB,8GAAA,aAAa,OAAA"}

package/resources/messaging/announcements/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Actions } from "./actions.mjs";
+export { Announcements, } from "./announcements.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/messaging/announcements/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,OAAO,EAA0E;OACnF,EACL,aAAa,GAKd"}

package/resources/messaging/announcements.d.mts

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

package/resources/messaging/announcements.d.mts.map

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