@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/resources/tenants.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./tenants/index.js"), exports);
+//# sourceMappingURL=tenants.js.map

package/resources/tenants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}

package/resources/tenants.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./tenants/index.mjs";
+//# sourceMappingURL=tenants.mjs.map

package/resources/tenants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../src/resources/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/translations.d.mts

@@ -0,0 +1,36 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Translations extends APIResource {
+    /**
+     * Get translations by locale
+     */
+    retrieve(locale: string, params: TranslationRetrieveParams, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Update a translation
+     */
+    update(locale: string, params: TranslationUpdateParams, options?: RequestOptions): APIPromise<void>;
+}
+export type TranslationRetrieveResponse = string;
+export interface TranslationRetrieveParams {
+    /**
+     * The domain you want to retrieve translations for. Only `default` is supported at
+     * the moment
+     */
+    domain: string;
+}
+export interface TranslationUpdateParams {
+    /**
+     * Path param: The domain you want to retrieve translations for. Only `default` is
+     * supported at the moment
+     */
+    domain: string;
+    /**
+     * Body param:
+     */
+    body: string;
+}
+export declare namespace Translations {
+    export { type TranslationRetrieveResponse as TranslationRetrieveResponse, type TranslationRetrieveParams as TranslationRetrieveParams, type TranslationUpdateParams as TranslationUpdateParams, };
+}
+//# sourceMappingURL=translations.d.mts.map

package/resources/translations.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.mts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAKzG;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAQpG;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAEjD,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/translations.d.ts

@@ -0,0 +1,36 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Translations extends APIResource {
+    /**
+     * Get translations by locale
+     */
+    retrieve(locale: string, params: TranslationRetrieveParams, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Update a translation
+     */
+    update(locale: string, params: TranslationUpdateParams, options?: RequestOptions): APIPromise<void>;
+}
+export type TranslationRetrieveResponse = string;
+export interface TranslationRetrieveParams {
+    /**
+     * The domain you want to retrieve translations for. Only `default` is supported at
+     * the moment
+     */
+    domain: string;
+}
+export interface TranslationUpdateParams {
+    /**
+     * Path param: The domain you want to retrieve translations for. Only `default` is
+     * supported at the moment
+     */
+    domain: string;
+    /**
+     * Body param:
+     */
+    body: string;
+}
+export declare namespace Translations {
+    export { type TranslationRetrieveResponse as TranslationRetrieveResponse, type TranslationRetrieveParams as TranslationRetrieveParams, type TranslationUpdateParams as TranslationUpdateParams, };
+}
+//# sourceMappingURL=translations.d.ts.map

package/resources/translations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAKzG;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAQpG;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAEjD,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/translations.js

@@ -0,0 +1,29 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Translations = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+class Translations extends resource_1.APIResource {
+    /**
+     * Get translations by locale
+     */
+    retrieve(locale, params, options) {
+        const { domain } = params;
+        return this._client.get((0, path_1.path) `/translations/${domain}/${locale}`, options);
+    }
+    /**
+     * Update a translation
+     */
+    update(locale, params, options) {
+        const { domain, body } = params;
+        return this._client.put((0, path_1.path) `/translations/${domain}/${locale}`, {
+            body: body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Translations = Translations;
+//# sourceMappingURL=translations.js.map

package/resources/translations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.js","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAc,EAAE,MAAiC,EAAE,OAAwB;QAClF,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,IAAI,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,MAA+B,EAAE,OAAwB;QAC9E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,IAAI,MAAM,EAAE,EAAE;YAC/D,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AApBD,oCAoBC"}

package/resources/translations.mjs

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Translations extends APIResource {
+    /**
+     * Get translations by locale
+     */
+    retrieve(locale, params, options) {
+        const { domain } = params;
+        return this._client.get(path `/translations/${domain}/${locale}`, options);
+    }
+    /**
+     * Update a translation
+     */
+    update(locale, params, options) {
+        const { domain, body } = params;
+        return this._client.put(path `/translations/${domain}/${locale}`, {
+            body: body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=translations.mjs.map

package/resources/translations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.mjs","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CAAC,MAAc,EAAE,MAAiC,EAAE,OAAwB;QAClF,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,MAAM,IAAI,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,MAA+B,EAAE,OAAwB;QAC9E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,MAAM,IAAI,MAAM,EAAE,EAAE;YAC/D,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/users/index.d.mts

@@ -0,0 +1,5 @@
+export { Preferences, type PreferenceStatus, type TopicPreference, type PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams, type PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams, } from "./preferences.mjs";
+export { Tenants, type TenantAssociation, type TenantListResponse, type TenantListParams, type TenantAddMultipleParams, type TenantAddSingleParams, type TenantRemoveSingleParams, } from "./tenants.mjs";
+export { Tokens, type UserToken, type TokenRetrieveResponse, type TokenListResponse, type TokenRetrieveParams, type TokenUpdateParams, type TokenDeleteParams, type TokenAddSingleParams, } from "./tokens.mjs";
+export { Users } from "./users.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,qCAAqC,EAC1C,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,mCAAmC,GACzC;OACM,EACL,OAAO,EACP,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,GAC9B;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B;OACM,EAAE,KAAK,EAAE"}

package/resources/users/index.d.ts

@@ -0,0 +1,5 @@
+export { Preferences, type PreferenceStatus, type TopicPreference, type PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams, type PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams, } from "./preferences.js";
+export { Tenants, type TenantAssociation, type TenantListResponse, type TenantListParams, type TenantAddMultipleParams, type TenantAddSingleParams, type TenantRemoveSingleParams, } from "./tenants.js";
+export { Tokens, type UserToken, type TokenRetrieveResponse, type TokenListResponse, type TokenRetrieveParams, type TokenUpdateParams, type TokenDeleteParams, type TokenAddSingleParams, } from "./tokens.js";
+export { Users } from "./users.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,qCAAqC,EAC1C,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,mCAAmC,GACzC;OACM,EACL,OAAO,EACP,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,GAC9B;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B;OACM,EAAE,KAAK,EAAE"}

package/resources/users/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = exports.Tokens = exports.Tenants = exports.Preferences = void 0;
+var preferences_1 = require("./preferences.js");
+Object.defineProperty(exports, "Preferences", { enumerable: true, get: function () { return preferences_1.Preferences; } });
+var tenants_1 = require("./tenants.js");
+Object.defineProperty(exports, "Tenants", { enumerable: true, get: function () { return tenants_1.Tenants; } });
+var tokens_1 = require("./tokens.js");
+Object.defineProperty(exports, "Tokens", { enumerable: true, get: function () { return tokens_1.Tokens; } });
+var users_1 = require("./users.js");
+Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
+//# sourceMappingURL=index.js.map

package/resources/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAUuB;AATrB,0GAAA,WAAW,OAAA;AAUb,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,sCASkB;AARhB,gGAAA,MAAM,OAAA;AASR,oCAAgC;AAAvB,8FAAA,KAAK,OAAA"}

package/resources/users/index.mjs

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Preferences, } from "./preferences.mjs";
+export { Tenants, } from "./tenants.mjs";
+export { Tokens, } from "./tokens.mjs";
+export { Users } from "./users.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/users/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GASZ;OACM,EACL,OAAO,GAOR;OACM,EACL,MAAM,GAQP;OACM,EAAE,KAAK,EAAE"}

package/resources/users/preferences.d.mts

@@ -0,0 +1,125 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as PreferencesAPI from "./preferences.mjs";
+import * as AudiencesAPI from "../audiences.mjs";
+import * as ItemsAPI from "../tenants/default-preferences/items.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Preferences extends APIResource {
+    /**
+     * Fetch all user preferences.
+     *
+     * @example
+     * ```ts
+     * const preference = await client.users.preferences.retrieve(
+     *   'user_id',
+     * );
+     * ```
+     */
+    retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
+    /**
+     * Fetch user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.retrieveTopic('topic_id', {
+     *     user_id: 'user_id',
+     *   });
+     * ```
+     */
+    retrieveTopic(topicID: string, params: PreferenceRetrieveTopicParams, options?: RequestOptions): APIPromise<PreferenceRetrieveTopicResponse>;
+    /**
+     * Update or Create user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.updateOrCreateTopic(
+     *     'topic_id',
+     *     {
+     *       user_id: 'user_id',
+     *       topic: {
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    updateOrCreateTopic(topicID: string, params: PreferenceUpdateOrCreateTopicParams, options?: RequestOptions): APIPromise<PreferenceUpdateOrCreateTopicResponse>;
+}
+export type PreferenceStatus = 'OPTED_IN' | 'OPTED_OUT' | 'REQUIRED';
+export interface TopicPreference {
+    default_status: PreferenceStatus;
+    status: PreferenceStatus;
+    topic_id: string;
+    topic_name: string;
+    /**
+     * The Channels a user has chosen to receive notifications through for this topic
+     */
+    custom_routing?: Array<ItemsAPI.ChannelClassification> | null;
+    has_custom_routing?: boolean | null;
+}
+export interface PreferenceRetrieveResponse {
+    /**
+     * The Preferences associated with the user_id.
+     */
+    items: Array<TopicPreference>;
+    /**
+     * Deprecated - Paging not implemented on this endpoint
+     */
+    paging: AudiencesAPI.Paging;
+}
+export interface PreferenceRetrieveTopicResponse {
+    topic: TopicPreference;
+}
+export interface PreferenceUpdateOrCreateTopicResponse {
+    message: string;
+}
+export interface PreferenceRetrieveParams {
+    /**
+     * Query the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export interface PreferenceRetrieveTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to retrieve.
+     */
+    user_id: string;
+    /**
+     * Query param: Query the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export interface PreferenceUpdateOrCreateTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to retrieve.
+     */
+    user_id: string;
+    /**
+     * Body param:
+     */
+    topic: PreferenceUpdateOrCreateTopicParams.Topic;
+    /**
+     * Query param: Update the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceUpdateOrCreateTopicParams {
+    interface Topic {
+        status: PreferencesAPI.PreferenceStatus;
+        /**
+         * The Channels a user has chosen to receive notifications through for this topic
+         */
+        custom_routing?: Array<ItemsAPI.ChannelClassification> | null;
+        has_custom_routing?: boolean | null;
+    }
+}
+export declare namespace Preferences {
+    export { type PreferenceStatus as PreferenceStatus, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
+}
+//# sourceMappingURL=preferences.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAK9C;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,CAAC;AAErE,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,gBAAgB,CAAC;IAEjC,MAAM,EAAE,gBAAgB,CAAC;IAEzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE9D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,mCAAmC,CAAC,KAAK,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mCAAmC,CAAC;IACnD,UAAiB,KAAK;QACpB,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC;QAExC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE9D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/users/preferences.d.ts

@@ -0,0 +1,125 @@
+import { APIResource } from "../../core/resource.js";
+import * as PreferencesAPI from "./preferences.js";
+import * as AudiencesAPI from "../audiences.js";
+import * as ItemsAPI from "../tenants/default-preferences/items.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Preferences extends APIResource {
+    /**
+     * Fetch all user preferences.
+     *
+     * @example
+     * ```ts
+     * const preference = await client.users.preferences.retrieve(
+     *   'user_id',
+     * );
+     * ```
+     */
+    retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
+    /**
+     * Fetch user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.retrieveTopic('topic_id', {
+     *     user_id: 'user_id',
+     *   });
+     * ```
+     */
+    retrieveTopic(topicID: string, params: PreferenceRetrieveTopicParams, options?: RequestOptions): APIPromise<PreferenceRetrieveTopicResponse>;
+    /**
+     * Update or Create user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.updateOrCreateTopic(
+     *     'topic_id',
+     *     {
+     *       user_id: 'user_id',
+     *       topic: {
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    updateOrCreateTopic(topicID: string, params: PreferenceUpdateOrCreateTopicParams, options?: RequestOptions): APIPromise<PreferenceUpdateOrCreateTopicResponse>;
+}
+export type PreferenceStatus = 'OPTED_IN' | 'OPTED_OUT' | 'REQUIRED';
+export interface TopicPreference {
+    default_status: PreferenceStatus;
+    status: PreferenceStatus;
+    topic_id: string;
+    topic_name: string;
+    /**
+     * The Channels a user has chosen to receive notifications through for this topic
+     */
+    custom_routing?: Array<ItemsAPI.ChannelClassification> | null;
+    has_custom_routing?: boolean | null;
+}
+export interface PreferenceRetrieveResponse {
+    /**
+     * The Preferences associated with the user_id.
+     */
+    items: Array<TopicPreference>;
+    /**
+     * Deprecated - Paging not implemented on this endpoint
+     */
+    paging: AudiencesAPI.Paging;
+}
+export interface PreferenceRetrieveTopicResponse {
+    topic: TopicPreference;
+}
+export interface PreferenceUpdateOrCreateTopicResponse {
+    message: string;
+}
+export interface PreferenceRetrieveParams {
+    /**
+     * Query the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export interface PreferenceRetrieveTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to retrieve.
+     */
+    user_id: string;
+    /**
+     * Query param: Query the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export interface PreferenceUpdateOrCreateTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to retrieve.
+     */
+    user_id: string;
+    /**
+     * Body param:
+     */
+    topic: PreferenceUpdateOrCreateTopicParams.Topic;
+    /**
+     * Query param: Update the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceUpdateOrCreateTopicParams {
+    interface Topic {
+        status: PreferencesAPI.PreferenceStatus;
+        /**
+         * The Channels a user has chosen to receive notifications through for this topic
+         */
+        custom_routing?: Array<ItemsAPI.ChannelClassification> | null;
+        has_custom_routing?: boolean | null;
+    }
+}
+export declare namespace Preferences {
+    export { type PreferenceStatus as PreferenceStatus, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
+}
+//# sourceMappingURL=preferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAK9C;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,CAAC;AAErE,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,gBAAgB,CAAC;IAEjC,MAAM,EAAE,gBAAgB,CAAC;IAEzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE9D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,mCAAmC,CAAC,KAAK,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mCAAmC,CAAC;IACnD,UAAiB,KAAK;QACpB,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC;QAExC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE9D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/users/preferences.js

@@ -0,0 +1,65 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Preferences = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Preferences extends resource_1.APIResource {
+    /**
+     * Fetch all user preferences.
+     *
+     * @example
+     * ```ts
+     * const preference = await client.users.preferences.retrieve(
+     *   'user_id',
+     * );
+     * ```
+     */
+    retrieve(userID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/users/${userID}/preferences`, { query, ...options });
+    }
+    /**
+     * Fetch user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.retrieveTopic('topic_id', {
+     *     user_id: 'user_id',
+     *   });
+     * ```
+     */
+    retrieveTopic(topicID, params, options) {
+        const { user_id, ...query } = params;
+        return this._client.get((0, path_1.path) `/users/${user_id}/preferences/${topicID}`, { query, ...options });
+    }
+    /**
+     * Update or Create user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.updateOrCreateTopic(
+     *     'topic_id',
+     *     {
+     *       user_id: 'user_id',
+     *       topic: {
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    updateOrCreateTopic(topicID, params, options) {
+        const { user_id, tenant_id, ...body } = params;
+        return this._client.put((0, path_1.path) `/users/${user_id}/preferences/${topicID}`, {
+            query: { tenant_id },
+            body,
+            ...options,
+        });
+    }
+}
+exports.Preferences = Preferences;
+//# sourceMappingURL=preferences.js.map

package/resources/users/preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAe,EACf,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtED,kCAsEC"}

package/resources/users/preferences.mjs

@@ -0,0 +1,61 @@
+// 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 Preferences extends APIResource {
+    /**
+     * Fetch all user preferences.
+     *
+     * @example
+     * ```ts
+     * const preference = await client.users.preferences.retrieve(
+     *   'user_id',
+     * );
+     * ```
+     */
+    retrieve(userID, query = {}, options) {
+        return this._client.get(path `/users/${userID}/preferences`, { query, ...options });
+    }
+    /**
+     * Fetch user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.retrieveTopic('topic_id', {
+     *     user_id: 'user_id',
+     *   });
+     * ```
+     */
+    retrieveTopic(topicID, params, options) {
+        const { user_id, ...query } = params;
+        return this._client.get(path `/users/${user_id}/preferences/${topicID}`, { query, ...options });
+    }
+    /**
+     * Update or Create user preferences for a specific subscription topic.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.preferences.updateOrCreateTopic(
+     *     'topic_id',
+     *     {
+     *       user_id: 'user_id',
+     *       topic: {
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    updateOrCreateTopic(topicID, params, options) {
+        const { user_id, tenant_id, ...body } = params;
+        return this._client.put(path `/users/${user_id}/preferences/${topicID}`, {
+            query: { tenant_id },
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=preferences.mjs.map

package/resources/users/preferences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAe,EACf,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}