@trycourier/courier 7.20.0 → 7.22.0

package/resources/tenants/tenants.js

@@ -10,6 +10,9 @@ const TemplatesAPI = tslib_1.__importStar(require("./templates/templates.js"));
 const templates_1 = require("./templates/templates.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
+/**
+ * Manage tenants — the organizations, teams, or accounts your users belong to — along with their users and default preferences.
+ */
 class Tenants extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -17,7 +20,8 @@ class Tenants extends resource_1.APIResource {
         this.templates = new TemplatesAPI.Templates(this._client);
     }
     /**
-     * Get a Tenant
+     * Returns one tenant with its name, parent tenant id, default preferences,
+     * properties, and the user profile applied to its members.
      *
      * @example
      * ```ts
@@ -28,7 +32,8 @@ class Tenants extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/tenants/${tenantID}`, options);
     }
     /**
-     * Create or Replace a Tenant
+     * Creates or replaces a tenant from a name, parent, brand, properties, and default
+     * preferences supplied in the request body.
      *
      * @example
      * ```ts
@@ -41,7 +46,8 @@ class Tenants extends resource_1.APIResource {
         return this._client.put((0, path_1.path) `/tenants/${tenantID}`, { body, ...options });
     }
     /**
-     * Get a List of Tenants
+     * Lists the workspace's tenants, each carrying a name, parent tenant, properties,
+     * and default preferences. Paged.
      *
      * @example
      * ```ts
@@ -52,7 +58,8 @@ class Tenants extends resource_1.APIResource {
         return this._client.get('/tenants', { query, ...options });
     }
     /**
-     * Delete a Tenant
+     * Deletes a tenant. Its members' workspace-level profiles and preferences live
+     * outside the tenant and are managed separately.
      *
      * @example
      * ```ts
@@ -66,7 +73,8 @@ class Tenants extends resource_1.APIResource {
         });
     }
     /**
-     * Get Users in Tenant
+     * Returns the users belonging to a tenant with cursor paging. Use it to see who a
+     * tenant-scoped send will reach.
      *
      * @example
      * ```ts

package/resources/tenants/tenants.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,qFAA4D;AAC5D,8DAAwD;AACxD,+EAAsD;AACtD,wDAQ+B;AAE/B,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2E/E,CAAC;IAzEC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,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;IAED;;;;;;;;;OASG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA7ED,0BA6EC;AAkVD,OAAO,CAAC,WAAW,GAAG,yBAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,qBAAS,CAAC"}
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,qFAA4D;AAC5D,8DAAwD;AACxD,+EAAsD;AACtD,wDAQ+B;AAE/B,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgF/E,CAAC;IA9EC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,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;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAlFD,0BAkFC;AAkVD,OAAO,CAAC,WAAW,GAAG,yBAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,qBAAS,CAAC"}

package/resources/tenants/tenants.mjs

@@ -6,6 +6,9 @@ import * as TemplatesAPI from "./templates/templates.mjs";
 import { Templates, } from "./templates/templates.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
+/**
+ * Manage tenants — the organizations, teams, or accounts your users belong to — along with their users and default preferences.
+ */
 export class Tenants extends APIResource {
     constructor() {
         super(...arguments);
@@ -13,7 +16,8 @@ export class Tenants extends APIResource {
         this.templates = new TemplatesAPI.Templates(this._client);
     }
     /**
-     * Get a Tenant
+     * Returns one tenant with its name, parent tenant id, default preferences,
+     * properties, and the user profile applied to its members.
      *
      * @example
      * ```ts
@@ -24,7 +28,8 @@ export class Tenants extends APIResource {
         return this._client.get(path `/tenants/${tenantID}`, options);
     }
     /**
-     * Create or Replace a Tenant
+     * Creates or replaces a tenant from a name, parent, brand, properties, and default
+     * preferences supplied in the request body.
      *
      * @example
      * ```ts
@@ -37,7 +42,8 @@ export class Tenants extends APIResource {
         return this._client.put(path `/tenants/${tenantID}`, { body, ...options });
     }
     /**
-     * Get a List of Tenants
+     * Lists the workspace's tenants, each carrying a name, parent tenant, properties,
+     * and default preferences. Paged.
      *
      * @example
      * ```ts
@@ -48,7 +54,8 @@ export class Tenants extends APIResource {
         return this._client.get('/tenants', { query, ...options });
     }
     /**
-     * Delete a Tenant
+     * Deletes a tenant. Its members' workspace-level profiles and preferences live
+     * outside the tenant and are managed separately.
      *
      * @example
      * ```ts
@@ -62,7 +69,8 @@ export class Tenants extends APIResource {
         });
     }
     /**
-     * Get Users in Tenant
+     * Returns the users belonging to a tenant with cursor paging. Use it to see who a
+     * tenant-scoped send will reach.
      *
      * @example
      * ```ts

package/resources/tenants/tenants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,cAAc,sCAAkC;AAC5D,OAAO,EAAE,WAAW,EAAE,sCAAkC;AACxD,OAAO,KAAK,YAAY,kCAA8B;AACtD,OAAO,EAOL,SAAS,GACV,kCAA8B;AAE/B,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2E/E,CAAC;IAzEC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAkVD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/tenants/tenants.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,cAAc,sCAAkC;AAC5D,OAAO,EAAE,WAAW,EAAE,sCAAkC;AACxD,OAAO,KAAK,YAAY,kCAA8B;AACtD,OAAO,EAOL,SAAS,GACV,kCAA8B;AAE/B,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgF/E,CAAC;IA9EC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,QAAgB,EAChB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAkVD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/resources/translations.d.mts

@@ -1,13 +1,18 @@
 import { APIResource } from "../core/resource.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Store and retrieve the translation strings Courier uses to render localized template content.
+ */
 export declare class Translations extends APIResource {
     /**
-     * Get translations by locale
+     * Returns the translation strings stored for one domain and locale, for use in
+     * localized notification content.
      */
     retrieve(locale: string, params: TranslationRetrieveParams, options?: RequestOptions): APIPromise<string>;
     /**
-     * Update a translation
+     * Uploads the translation strings for one domain and locale. Courier uses them to
+     * render localized content for recipients in that locale.
      */
     update(locale: string, params: TranslationUpdateParams, options?: RequestOptions): APIPromise<void>;
 }

package/resources/translations.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"translations.d.mts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,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"}
+{"version":3,"file":"translations.d.mts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAKzG;;;OAGG;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

@@ -1,13 +1,18 @@
 import { APIResource } from "../core/resource.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Store and retrieve the translation strings Courier uses to render localized template content.
+ */
 export declare class Translations extends APIResource {
     /**
-     * Get translations by locale
+     * Returns the translation strings stored for one domain and locale, for use in
+     * localized notification content.
      */
     retrieve(locale: string, params: TranslationRetrieveParams, options?: RequestOptions): APIPromise<string>;
     /**
-     * Update a translation
+     * Uploads the translation strings for one domain and locale. Courier uses them to
+     * render localized content for recipients in that locale.
      */
     update(locale: string, params: TranslationUpdateParams, options?: RequestOptions): APIPromise<void>;
 }

package/resources/translations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,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"}
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAKzG;;;OAGG;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

@@ -5,16 +5,21 @@ 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");
+/**
+ * Store and retrieve the translation strings Courier uses to render localized template content.
+ */
 class Translations extends resource_1.APIResource {
     /**
-     * Get translations by locale
+     * Returns the translation strings stored for one domain and locale, for use in
+     * localized notification content.
      */
     retrieve(locale, params, options) {
         const { domain } = params;
         return this._client.get((0, path_1.path) `/translations/${domain}/${locale}`, options);
     }
     /**
-     * Update a translation
+     * Uploads the translation strings for one domain and locale. Courier uses them to
+     * render localized content for recipients in that locale.
      */
     update(locale, params, options) {
         const { domain, body } = params;

package/resources/translations.js.map

@@ -1 +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"}
+{"version":3,"file":"translations.js","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;OAGG;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;;;OAGG;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;AAtBD,oCAsBC"}

package/resources/translations.mjs

@@ -2,16 +2,21 @@
 import { APIResource } from "../core/resource.mjs";
 import { buildHeaders } from "../internal/headers.mjs";
 import { path } from "../internal/utils/path.mjs";
+/**
+ * Store and retrieve the translation strings Courier uses to render localized template content.
+ */
 export class Translations extends APIResource {
     /**
-     * Get translations by locale
+     * Returns the translation strings stored for one domain and locale, for use in
+     * localized notification content.
      */
     retrieve(locale, params, options) {
         const { domain } = params;
         return this._client.get(path `/translations/${domain}/${locale}`, options);
     }
     /**
-     * Update a translation
+     * Uploads the translation strings for one domain and locale. Courier uses them to
+     * render localized content for recipients in that locale.
      */
     update(locale, params, options) {
         const { domain, body } = params;

package/resources/translations.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"translations.mjs","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,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"}
+{"version":3,"file":"translations.mjs","sourceRoot":"","sources":["../src/resources/translations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;OAGG;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;;;OAGG;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/preferences.d.mts

@@ -2,9 +2,13 @@ import { APIResource } from "../../core/resource.mjs";
 import * as Shared from "../shared.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Read and write a single user's notification preferences, per topic and per channel.
+ */
 export declare class Preferences extends APIResource {
     /**
-     * Fetch all user preferences.
+     * Returns a user's preference overrides with paging, one entry per subscription
+     * topic they have set a choice for.
      *
      * @example
      * ```ts
@@ -15,23 +19,8 @@ export declare class Preferences extends APIResource {
      */
     retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
     /**
-     * Replace a user's complete set of preference overrides in a single request. The
-     * topics in the request body become the recipient's entire set of overrides:
-     * listed topics are created or updated, and every existing override that is not
-     * included in the body is reset to its topic default. Submitting an empty `topics`
-     * array is a valid clear-all that resets every existing override.
-     *
-     * This operation is validation-atomic (all-or-nothing): structural validation
-     * fails fast with a single `400`, and if any topic is semantically invalid (an
-     * unknown topic, a `REQUIRED` topic that cannot be opted out, or a custom routing
-     * request that is not available on the workspace's plan) the request returns a
-     * single `400` aggregating every failure in `errors` and writes nothing. On
-     * success it returns `200` with `items` (the complete resulting override set) and
-     * `deleted` (the ids of the overrides that were reset to default).
-     *
-     * Every `topic_id` in the response — in `items`, `deleted`, and any `errors` — is
-     * returned in Courier's canonical topic id form, regardless of the form supplied
-     * in the request.
+     * Replaces a user's entire set of preference overrides. Any topic you leave out is
+     * reset to its default, so send the full set rather than a subset.
      *
      * @example
      * ```ts
@@ -52,23 +41,8 @@ export declare class Preferences extends APIResource {
      */
     bulkReplace(userID: string, params: PreferenceBulkReplaceParams, options?: RequestOptions): APIPromise<PreferenceBulkReplaceResponse>;
     /**
-     * Additively create or update a user's preferences for one or more subscription
-     * topics in a single request. Only the topics included in the request body are
-     * created or updated; any existing overrides for topics not listed are left
-     * untouched.
-     *
-     * Structural validation of the request body fails fast with a single `400`. Beyond
-     * that, each topic is processed independently (partial-success, not
-     * all-or-nothing): valid topics are written and returned in `items`, while topics
-     * that cannot be applied are collected in `errors` with a per-topic `reason` (for
-     * example an unknown topic, a `REQUIRED` topic that cannot be opted out, a custom
-     * routing request that is not available on the workspace's plan, or a write
-     * failure). The request therefore returns `200` with both lists whenever the body
-     * is structurally valid.
-     *
-     * Every `topic_id` in the response — in both `items` and `errors` — is returned in
-     * Courier's canonical topic id form, regardless of the form supplied in the
-     * request.
+     * Adds or updates a user's preferences for several subscription topics at once.
+     * Topics you leave out keep whatever they were set to before.
      *
      * @example
      * ```ts
@@ -93,9 +67,8 @@ export declare class Preferences extends APIResource {
      */
     bulkUpdate(userID: string, params: PreferenceBulkUpdateParams, options?: RequestOptions): APIPromise<PreferenceBulkUpdateResponse>;
     /**
-     * Remove a user's preferences for a specific subscription topic, resetting the
-     * topic to its effective default. This operation is idempotent: deleting a
-     * preference that does not exist succeeds with no error.
+     * Removes a user's override for one subscription topic, resetting it to the
+     * effective default from the tenant or workspace.
      *
      * @example
      * ```ts
@@ -106,7 +79,8 @@ export declare class Preferences extends APIResource {
      */
     deleteTopic(topicID: string, params: PreferenceDeleteTopicParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Fetch user preferences for a specific subscription topic.
+     * Returns a user's opt-in status and channel choices for one subscription topic,
+     * or the effective default if they have set no override.
      *
      * @example
      * ```ts
@@ -118,7 +92,8 @@ export declare class Preferences extends APIResource {
      */
     retrieveTopic(topicID: string, params: PreferenceRetrieveTopicParams, options?: RequestOptions): APIPromise<PreferenceRetrieveTopicResponse>;
     /**
-     * Update or Create user preferences for a specific subscription topic.
+     * Sets a user's opt-in status and channel choices for one subscription topic,
+     * overriding the tenant default for that topic only.
      *
      * @example
      * ```ts
@@ -152,14 +127,35 @@ export interface BulkPreferenceTopic {
     topic_id: string;
 }
 export interface TopicPreference {
+    /**
+     * The topic's default status, returned on reads. It applies whenever the user has
+     * no override of their own (status equals this value).
+     */
     default_status: Shared.PreferenceStatus;
+    /**
+     * The user's subscription status for this topic. OPTED_IN or OPTED_OUT reflect the
+     * user's own choice; REQUIRED is a topic-level default set in the preferences
+     * editor, not a user choice.
+     */
     status: Shared.PreferenceStatus;
+    /**
+     * The unique identifier of the subscription topic this preference applies to.
+     */
     topic_id: string;
+    /**
+     * The display name of the subscription topic, returned on reads.
+     */
     topic_name: string;
     /**
-     * The Channels a user has chosen to receive notifications through for this topic
+     * The channels the user has chosen to receive this topic on, present only when
+     * has_custom_routing is true. One or more of: direct_message, email, push, sms,
+     * webhook, inbox.
      */
     custom_routing?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Whether the user has chosen specific delivery channels for this topic (listed in
+     * custom_routing) rather than the topic's default routing.
+     */
     has_custom_routing?: boolean | null;
 }
 export interface PreferenceRetrieveResponse {
@@ -258,6 +254,22 @@ export interface PreferenceBulkUpdateParams {
      * Query param: Update the preferences of a user for this specific tenant context.
      */
     tenant_id?: string | null;
+    /**
+     * Header param: A unique key that makes this request idempotent. If Courier
+     * receives another request with the same `Idempotency-Key`, it returns the stored
+     * response from the first request without performing the operation again
+     * (including the original status code and any error). Use it to safely retry
+     * `POST` requests after network failures without risking duplicate sends. The key
+     * is scoped to this endpoint.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: How long the idempotency key remains valid, as a Unix epoch
+     * timestamp in seconds or an ISO 8601 date string. Only applies when
+     * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
+     * maximum is 1 year.
+     */
+    'x-idempotency-expiration'?: string;
 }
 export declare namespace PreferenceBulkUpdateParams {
     interface Topic {
@@ -318,11 +330,21 @@ export interface PreferenceUpdateOrCreateTopicParams {
 }
 export declare namespace PreferenceUpdateOrCreateTopicParams {
     interface Topic {
+        /**
+         * The subscription status to set: OPTED_IN or OPTED_OUT. REQUIRED is a topic-level
+         * default, not a user choice; the API rejects opting a user out of a REQUIRED
+         * topic.
+         */
         status: Shared.PreferenceStatus;
         /**
-         * The Channels a user has chosen to receive notifications through for this topic
+         * The channels to deliver this topic on when has_custom_routing is true. One or
+         * more of: direct_message, email, push, sms, webhook, inbox.
          */
         custom_routing?: Array<Shared.ChannelClassification> | null;
+        /**
+         * Set to true to route this topic to the channels in custom_routing instead of the
+         * topic's default routing.
+         */
         has_custom_routing?: boolean | null;
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;;;;OAWG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;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;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEpD,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IAEjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAExC,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE5D,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,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;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,2BAA2B;IAC1C;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;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,MAAM,CAAC,gBAAgB,CAAC;QAEhC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE5D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
+{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAuB3C;;;;;;;;;;OAUG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;;OAWG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAK9C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEpD,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IAEjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAExC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,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,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;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,2BAA2B;IAC1C;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;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;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE5D;;;WAGG;QACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/users/preferences.d.ts

@@ -2,9 +2,13 @@ import { APIResource } from "../../core/resource.js";
 import * as Shared from "../shared.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Read and write a single user's notification preferences, per topic and per channel.
+ */
 export declare class Preferences extends APIResource {
     /**
-     * Fetch all user preferences.
+     * Returns a user's preference overrides with paging, one entry per subscription
+     * topic they have set a choice for.
      *
      * @example
      * ```ts
@@ -15,23 +19,8 @@ export declare class Preferences extends APIResource {
      */
     retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
     /**
-     * Replace a user's complete set of preference overrides in a single request. The
-     * topics in the request body become the recipient's entire set of overrides:
-     * listed topics are created or updated, and every existing override that is not
-     * included in the body is reset to its topic default. Submitting an empty `topics`
-     * array is a valid clear-all that resets every existing override.
-     *
-     * This operation is validation-atomic (all-or-nothing): structural validation
-     * fails fast with a single `400`, and if any topic is semantically invalid (an
-     * unknown topic, a `REQUIRED` topic that cannot be opted out, or a custom routing
-     * request that is not available on the workspace's plan) the request returns a
-     * single `400` aggregating every failure in `errors` and writes nothing. On
-     * success it returns `200` with `items` (the complete resulting override set) and
-     * `deleted` (the ids of the overrides that were reset to default).
-     *
-     * Every `topic_id` in the response — in `items`, `deleted`, and any `errors` — is
-     * returned in Courier's canonical topic id form, regardless of the form supplied
-     * in the request.
+     * Replaces a user's entire set of preference overrides. Any topic you leave out is
+     * reset to its default, so send the full set rather than a subset.
      *
      * @example
      * ```ts
@@ -52,23 +41,8 @@ export declare class Preferences extends APIResource {
      */
     bulkReplace(userID: string, params: PreferenceBulkReplaceParams, options?: RequestOptions): APIPromise<PreferenceBulkReplaceResponse>;
     /**
-     * Additively create or update a user's preferences for one or more subscription
-     * topics in a single request. Only the topics included in the request body are
-     * created or updated; any existing overrides for topics not listed are left
-     * untouched.
-     *
-     * Structural validation of the request body fails fast with a single `400`. Beyond
-     * that, each topic is processed independently (partial-success, not
-     * all-or-nothing): valid topics are written and returned in `items`, while topics
-     * that cannot be applied are collected in `errors` with a per-topic `reason` (for
-     * example an unknown topic, a `REQUIRED` topic that cannot be opted out, a custom
-     * routing request that is not available on the workspace's plan, or a write
-     * failure). The request therefore returns `200` with both lists whenever the body
-     * is structurally valid.
-     *
-     * Every `topic_id` in the response — in both `items` and `errors` — is returned in
-     * Courier's canonical topic id form, regardless of the form supplied in the
-     * request.
+     * Adds or updates a user's preferences for several subscription topics at once.
+     * Topics you leave out keep whatever they were set to before.
      *
      * @example
      * ```ts
@@ -93,9 +67,8 @@ export declare class Preferences extends APIResource {
      */
     bulkUpdate(userID: string, params: PreferenceBulkUpdateParams, options?: RequestOptions): APIPromise<PreferenceBulkUpdateResponse>;
     /**
-     * Remove a user's preferences for a specific subscription topic, resetting the
-     * topic to its effective default. This operation is idempotent: deleting a
-     * preference that does not exist succeeds with no error.
+     * Removes a user's override for one subscription topic, resetting it to the
+     * effective default from the tenant or workspace.
      *
      * @example
      * ```ts
@@ -106,7 +79,8 @@ export declare class Preferences extends APIResource {
      */
     deleteTopic(topicID: string, params: PreferenceDeleteTopicParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Fetch user preferences for a specific subscription topic.
+     * Returns a user's opt-in status and channel choices for one subscription topic,
+     * or the effective default if they have set no override.
      *
      * @example
      * ```ts
@@ -118,7 +92,8 @@ export declare class Preferences extends APIResource {
      */
     retrieveTopic(topicID: string, params: PreferenceRetrieveTopicParams, options?: RequestOptions): APIPromise<PreferenceRetrieveTopicResponse>;
     /**
-     * Update or Create user preferences for a specific subscription topic.
+     * Sets a user's opt-in status and channel choices for one subscription topic,
+     * overriding the tenant default for that topic only.
      *
      * @example
      * ```ts
@@ -152,14 +127,35 @@ export interface BulkPreferenceTopic {
     topic_id: string;
 }
 export interface TopicPreference {
+    /**
+     * The topic's default status, returned on reads. It applies whenever the user has
+     * no override of their own (status equals this value).
+     */
     default_status: Shared.PreferenceStatus;
+    /**
+     * The user's subscription status for this topic. OPTED_IN or OPTED_OUT reflect the
+     * user's own choice; REQUIRED is a topic-level default set in the preferences
+     * editor, not a user choice.
+     */
     status: Shared.PreferenceStatus;
+    /**
+     * The unique identifier of the subscription topic this preference applies to.
+     */
     topic_id: string;
+    /**
+     * The display name of the subscription topic, returned on reads.
+     */
     topic_name: string;
     /**
-     * The Channels a user has chosen to receive notifications through for this topic
+     * The channels the user has chosen to receive this topic on, present only when
+     * has_custom_routing is true. One or more of: direct_message, email, push, sms,
+     * webhook, inbox.
      */
     custom_routing?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Whether the user has chosen specific delivery channels for this topic (listed in
+     * custom_routing) rather than the topic's default routing.
+     */
     has_custom_routing?: boolean | null;
 }
 export interface PreferenceRetrieveResponse {
@@ -258,6 +254,22 @@ export interface PreferenceBulkUpdateParams {
      * Query param: Update the preferences of a user for this specific tenant context.
      */
     tenant_id?: string | null;
+    /**
+     * Header param: A unique key that makes this request idempotent. If Courier
+     * receives another request with the same `Idempotency-Key`, it returns the stored
+     * response from the first request without performing the operation again
+     * (including the original status code and any error). Use it to safely retry
+     * `POST` requests after network failures without risking duplicate sends. The key
+     * is scoped to this endpoint.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: How long the idempotency key remains valid, as a Unix epoch
+     * timestamp in seconds or an ISO 8601 date string. Only applies when
+     * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
+     * maximum is 1 year.
+     */
+    'x-idempotency-expiration'?: string;
 }
 export declare namespace PreferenceBulkUpdateParams {
     interface Topic {
@@ -318,11 +330,21 @@ export interface PreferenceUpdateOrCreateTopicParams {
 }
 export declare namespace PreferenceUpdateOrCreateTopicParams {
     interface Topic {
+        /**
+         * The subscription status to set: OPTED_IN or OPTED_OUT. REQUIRED is a topic-level
+         * default, not a user choice; the API rejects opting a user out of a REQUIRED
+         * topic.
+         */
         status: Shared.PreferenceStatus;
         /**
-         * The Channels a user has chosen to receive notifications through for this topic
+         * The channels to deliver this topic on when has_custom_routing is true. One or
+         * more of: direct_message, email, push, sms, webhook, inbox.
          */
         custom_routing?: Array<Shared.ChannelClassification> | null;
+        /**
+         * Set to true to route this topic to the channels in custom_routing instead of the
+         * topic's default routing.
+         */
         has_custom_routing?: boolean | null;
     }
 }