@trycourier/courier 7.21.0 → 7.22.0

package/resources/brands.d.mts

@@ -3,10 +3,13 @@ import * as BrandsAPI from "./brands.mjs";
 import * as Shared from "./shared.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Manage the logos, colors, and layout that give the templates you send a consistent look.
+ */
 export declare class Brands extends APIResource {
     /**
-     * Create a new brand. Requires `name` and `settings` (with at least
-     * `colors.primary` and `colors.secondary`).
+     * Creates a brand from a name and settings, including primary and secondary
+     * colors. Brands supply the logo, colors, and styling that templates render with.
      *
      * @example
      * ```ts
@@ -18,9 +21,10 @@ export declare class Brands extends APIResource {
      * });
      * ```
      */
-    create(body: BrandCreateParams, options?: RequestOptions): APIPromise<Brand>;
+    create(params: BrandCreateParams, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Fetch a specific brand by brand ID.
+     * Returns one brand by id, including its colors, logo and styling settings,
+     * Handlebars snippets, and published version.
      *
      * @example
      * ```ts
@@ -29,7 +33,8 @@ export declare class Brands extends APIResource {
      */
     retrieve(brandID: string, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Replace an existing brand with the supplied values.
+     * Replaces a brand with the values you supply, so send the complete settings and
+     * snippets rather than only the fields you want changed.
      *
      * @example
      * ```ts
@@ -40,7 +45,8 @@ export declare class Brands extends APIResource {
      */
     update(brandID: string, body: BrandUpdateParams, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Get the list of brands.
+     * Lists the workspace's brands. Every entry carries its name, styling settings,
+     * snippets, and published version.
      *
      * @example
      * ```ts
@@ -49,7 +55,8 @@ export declare class Brands extends APIResource {
      */
     list(query?: BrandListParams | null | undefined, options?: RequestOptions): APIPromise<BrandListResponse>;
     /**
-     * Delete a brand by brand ID.
+     * Deletes a brand by id. Reassign any template or tenant that references it before
+     * deleting to keep their styling intact.
      *
      * @example
      * ```ts
@@ -146,10 +153,38 @@ export interface BrandListResponse {
     results: Array<Brand>;
 }
 export interface BrandCreateParams {
+    /**
+     * Body param
+     */
     name: string;
+    /**
+     * Body param
+     */
     settings: BrandSettings;
+    /**
+     * Body param
+     */
     id?: string | null;
+    /**
+     * Body param
+     */
     snippets?: BrandSnippets | 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 interface BrandUpdateParams {
     /**

package/resources/brands.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"brands.d.mts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI7F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMpE;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,gBAAiB,SAAQ,SAAS,CAAC,aAAa;QAC/D,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;QAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IAEpB,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IAEX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,aAAa,CAAC;IAExB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
+{"version":3,"file":"brands.d.mts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAqB9E;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI7F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMpE;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,gBAAiB,SAAQ,SAAS,CAAC,aAAa;QAC/D,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;QAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IAEpB,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IAEX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/brands.d.ts

@@ -3,10 +3,13 @@ import * as BrandsAPI from "./brands.js";
 import * as Shared from "./shared.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Manage the logos, colors, and layout that give the templates you send a consistent look.
+ */
 export declare class Brands extends APIResource {
     /**
-     * Create a new brand. Requires `name` and `settings` (with at least
-     * `colors.primary` and `colors.secondary`).
+     * Creates a brand from a name and settings, including primary and secondary
+     * colors. Brands supply the logo, colors, and styling that templates render with.
      *
      * @example
      * ```ts
@@ -18,9 +21,10 @@ export declare class Brands extends APIResource {
      * });
      * ```
      */
-    create(body: BrandCreateParams, options?: RequestOptions): APIPromise<Brand>;
+    create(params: BrandCreateParams, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Fetch a specific brand by brand ID.
+     * Returns one brand by id, including its colors, logo and styling settings,
+     * Handlebars snippets, and published version.
      *
      * @example
      * ```ts
@@ -29,7 +33,8 @@ export declare class Brands extends APIResource {
      */
     retrieve(brandID: string, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Replace an existing brand with the supplied values.
+     * Replaces a brand with the values you supply, so send the complete settings and
+     * snippets rather than only the fields you want changed.
      *
      * @example
      * ```ts
@@ -40,7 +45,8 @@ export declare class Brands extends APIResource {
      */
     update(brandID: string, body: BrandUpdateParams, options?: RequestOptions): APIPromise<Brand>;
     /**
-     * Get the list of brands.
+     * Lists the workspace's brands. Every entry carries its name, styling settings,
+     * snippets, and published version.
      *
      * @example
      * ```ts
@@ -49,7 +55,8 @@ export declare class Brands extends APIResource {
      */
     list(query?: BrandListParams | null | undefined, options?: RequestOptions): APIPromise<BrandListResponse>;
     /**
-     * Delete a brand by brand ID.
+     * Deletes a brand by id. Reassign any template or tenant that references it before
+     * deleting to keep their styling intact.
      *
      * @example
      * ```ts
@@ -146,10 +153,38 @@ export interface BrandListResponse {
     results: Array<Brand>;
 }
 export interface BrandCreateParams {
+    /**
+     * Body param
+     */
     name: string;
+    /**
+     * Body param
+     */
     settings: BrandSettings;
+    /**
+     * Body param
+     */
     id?: string | null;
+    /**
+     * Body param
+     */
     snippets?: BrandSnippets | 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 interface BrandUpdateParams {
     /**

package/resources/brands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI7F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMpE;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,gBAAiB,SAAQ,SAAS,CAAC,aAAa;QAC/D,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;QAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IAEpB,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IAEX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,aAAa,CAAC;IAExB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}
+{"version":3,"file":"brands.d.ts","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAqB9E;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI7F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMpE;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAC/D;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,gBAAiB,SAAQ,SAAS,CAAC,aAAa;QAC/D,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;QAE9B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IAEpB,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IAEjB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IAEX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/brands.js

@@ -5,10 +5,13 @@ exports.Brands = void 0;
 const resource_1 = require("../core/resource.js");
 const headers_1 = require("../internal/headers.js");
 const path_1 = require("../internal/utils/path.js");
+/**
+ * Manage the logos, colors, and layout that give the templates you send a consistent look.
+ */
 class Brands extends resource_1.APIResource {
     /**
-     * Create a new brand. Requires `name` and `settings` (with at least
-     * `colors.primary` and `colors.secondary`).
+     * Creates a brand from a name and settings, including primary and secondary
+     * colors. Brands supply the logo, colors, and styling that templates render with.
      *
      * @example
      * ```ts
@@ -20,11 +23,25 @@ class Brands extends resource_1.APIResource {
      * });
      * ```
      */
-    create(body, options) {
-        return this._client.post('/brands', { body, ...options });
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
+        return this._client.post('/brands', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xIdempotencyExpiration != null ?
+                        { 'x-idempotency-expiration': xIdempotencyExpiration }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Fetch a specific brand by brand ID.
+     * Returns one brand by id, including its colors, logo and styling settings,
+     * Handlebars snippets, and published version.
      *
      * @example
      * ```ts
@@ -35,7 +52,8 @@ class Brands extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/brands/${brandID}`, options);
     }
     /**
-     * Replace an existing brand with the supplied values.
+     * Replaces a brand with the values you supply, so send the complete settings and
+     * snippets rather than only the fields you want changed.
      *
      * @example
      * ```ts
@@ -48,7 +66,8 @@ class Brands extends resource_1.APIResource {
         return this._client.put((0, path_1.path) `/brands/${brandID}`, { body, ...options });
     }
     /**
-     * Get the list of brands.
+     * Lists the workspace's brands. Every entry carries its name, styling settings,
+     * snippets, and published version.
      *
      * @example
      * ```ts
@@ -59,7 +78,8 @@ class Brands extends resource_1.APIResource {
         return this._client.get('/brands', { query, ...options });
     }
     /**
-     * Delete a brand by brand ID.
+     * Deletes a brand by id. Reassign any template or tenant that references it before
+     * deleting to keep their styling intact.
      *
      * @example
      * ```ts

package/resources/brands.js.map

@@ -1 +1 @@
-{"version":3,"file":"brands.js","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE;YACnD,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;AA1ED,wBA0EC"}
+{"version":3,"file":"brands.js","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,EAAE,EAAE;YACnD,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;AA/FD,wBA+FC"}

package/resources/brands.mjs

@@ -2,10 +2,13 @@
 import { APIResource } from "../core/resource.mjs";
 import { buildHeaders } from "../internal/headers.mjs";
 import { path } from "../internal/utils/path.mjs";
+/**
+ * Manage the logos, colors, and layout that give the templates you send a consistent look.
+ */
 export class Brands extends APIResource {
     /**
-     * Create a new brand. Requires `name` and `settings` (with at least
-     * `colors.primary` and `colors.secondary`).
+     * Creates a brand from a name and settings, including primary and secondary
+     * colors. Brands supply the logo, colors, and styling that templates render with.
      *
      * @example
      * ```ts
@@ -17,11 +20,25 @@ export class Brands extends APIResource {
      * });
      * ```
      */
-    create(body, options) {
-        return this._client.post('/brands', { body, ...options });
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
+        return this._client.post('/brands', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xIdempotencyExpiration != null ?
+                        { 'x-idempotency-expiration': xIdempotencyExpiration }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * Fetch a specific brand by brand ID.
+     * Returns one brand by id, including its colors, logo and styling settings,
+     * Handlebars snippets, and published version.
      *
      * @example
      * ```ts
@@ -32,7 +49,8 @@ export class Brands extends APIResource {
         return this._client.get(path `/brands/${brandID}`, options);
     }
     /**
-     * Replace an existing brand with the supplied values.
+     * Replaces a brand with the values you supply, so send the complete settings and
+     * snippets rather than only the fields you want changed.
      *
      * @example
      * ```ts
@@ -45,7 +63,8 @@ export class Brands extends APIResource {
         return this._client.put(path `/brands/${brandID}`, { body, ...options });
     }
     /**
-     * Get the list of brands.
+     * Lists the workspace's brands. Every entry carries its name, styling settings,
+     * snippets, and published version.
      *
      * @example
      * ```ts
@@ -56,7 +75,8 @@ export class Brands extends APIResource {
         return this._client.get('/brands', { query, ...options });
     }
     /**
-     * Delete a brand by brand ID.
+     * Deletes a brand by id. Reassign any template or tenant that references it before
+     * deleting to keep their styling intact.
      *
      * @example
      * ```ts

package/resources/brands.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"brands.mjs","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE;YACnD,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":"brands.mjs","sourceRoot":"","sources":["../src/resources/brands.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,OAAO,EAAE,EAAE;YACnD,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/digests/schedules.d.mts

@@ -2,11 +2,13 @@ import { APIResource } from "../../core/resource.mjs";
 import * as DigestsAPI from "./digests.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Inspect what has accumulated in a digest schedule and release a digest ahead of its next scheduled delivery.
+ */
 export declare class Schedules extends APIResource {
     /**
-     * List the digest instances for a schedule. Each instance represents the events
-     * accumulated for a single user against the schedule, and can be used to monitor
-     * digest accumulation before the digest is released.
+     * Returns the digest instances for a schedule, one per user, with cursor paging.
+     * Use it to see what has accumulated before a digest releases.
      */
     listInstances(scheduleID: string, query?: ScheduleListInstancesParams | null | undefined, options?: RequestOptions): APIPromise<DigestsAPI.DigestInstanceListResponse>;
     /**

package/resources/digests/schedules.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.d.mts","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIpD;;;OAGG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"schedules.d.mts","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIpD;;;OAGG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/digests/schedules.d.ts

@@ -2,11 +2,13 @@ import { APIResource } from "../../core/resource.js";
 import * as DigestsAPI from "./digests.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Inspect what has accumulated in a digest schedule and release a digest ahead of its next scheduled delivery.
+ */
 export declare class Schedules extends APIResource {
     /**
-     * List the digest instances for a schedule. Each instance represents the events
-     * accumulated for a single user against the schedule, and can be used to monitor
-     * digest accumulation before the digest is released.
+     * Returns the digest instances for a schedule, one per user, with cursor paging.
+     * Use it to see what has accumulated before a digest releases.
      */
     listInstances(scheduleID: string, query?: ScheduleListInstancesParams | null | undefined, options?: RequestOptions): APIPromise<DigestsAPI.DigestInstanceListResponse>;
     /**

package/resources/digests/schedules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIpD;;;OAGG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIpD;;;OAGG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/digests/schedules.js

@@ -5,11 +5,13 @@ exports.Schedules = void 0;
 const resource_1 = require("../../core/resource.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
+/**
+ * Inspect what has accumulated in a digest schedule and release a digest ahead of its next scheduled delivery.
+ */
 class Schedules extends resource_1.APIResource {
     /**
-     * List the digest instances for a schedule. Each instance represents the events
-     * accumulated for a single user against the schedule, and can be used to monitor
-     * digest accumulation before the digest is released.
+     * Returns the digest instances for a schedule, one per user, with cursor paging.
+     * Use it to see what has accumulated before a digest releases.
      */
     listInstances(scheduleID, query = {}, options) {
         return this._client.get((0, path_1.path) `/digests/schedules/${scheduleID}/instances`, { query, ...options });

package/resources/digests/schedules.js.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,UAAU,UAAU,EAAE;YACvE,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;AAxBD,8BAwBC"}
+{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;OAGG;IACH,aAAa,CACX,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,UAAU,UAAU,EAAE;YACvE,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;AAvBD,8BAuBC"}

package/resources/digests/schedules.mjs

@@ -2,11 +2,13 @@
 import { APIResource } from "../../core/resource.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
+/**
+ * Inspect what has accumulated in a digest schedule and release a digest ahead of its next scheduled delivery.
+ */
 export class Schedules extends APIResource {
     /**
-     * List the digest instances for a schedule. Each instance represents the events
-     * accumulated for a single user against the schedule, and can be used to monitor
-     * digest accumulation before the digest is released.
+     * Returns the digest instances for a schedule, one per user, with cursor paging.
+     * Use it to see what has accumulated before a digest releases.
      */
     listInstances(scheduleID, query = {}, options) {
         return this._client.get(path `/digests/schedules/${scheduleID}/instances`, { query, ...options });

package/resources/digests/schedules.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"schedules.mjs","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,UAAU,UAAU,EAAE;YACvE,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":"schedules.mjs","sourceRoot":"","sources":["../../src/resources/digests/schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,aAAa,CACX,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,UAAU,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,UAAU,UAAU,EAAE;YACvE,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/inbound.d.mts

@@ -1,9 +1,13 @@
 import { APIResource } from "../core/resource.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Record an inbound event that triggers the journeys and automations mapped to it.
+ */
 export declare class Inbound extends APIResource {
     /**
-     * Courier Track Event
+     * Records an inbound event that can trigger a journey. Requires an event name, a
+     * messageId you generate, a type, and a properties object.
      *
      * @example
      * ```ts

package/resources/inbound.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"inbound.d.mts","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG3G;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"inbound.d.mts","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG3G;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/inbound.d.ts

@@ -1,9 +1,13 @@
 import { APIResource } from "../core/resource.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Record an inbound event that triggers the journeys and automations mapped to it.
+ */
 export declare class Inbound extends APIResource {
     /**
-     * Courier Track Event
+     * Records an inbound event that can trigger a journey. Requires an event name, a
+     * messageId you generate, a type, and a properties object.
      *
      * @example
      * ```ts

package/resources/inbound.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inbound.d.ts","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG3G;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"inbound.d.ts","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG3G;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/inbound.js

@@ -3,9 +3,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Inbound = void 0;
 const resource_1 = require("../core/resource.js");
+/**
+ * Record an inbound event that triggers the journeys and automations mapped to it.
+ */
 class Inbound extends resource_1.APIResource {
     /**
-     * Courier Track Event
+     * Records an inbound event that can trigger a journey. Requires an event name, a
+     * messageId you generate, a type, and a properties object.
      *
      * @example
      * ```ts

package/resources/inbound.js.map

@@ -1 +1 @@
-{"version":3,"file":"inbound.js","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAtBD,0BAsBC"}
+{"version":3,"file":"inbound.js","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAvBD,0BAuBC"}

package/resources/inbound.mjs

@@ -1,8 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../core/resource.mjs";
+/**
+ * Record an inbound event that triggers the journeys and automations mapped to it.
+ */
 export class Inbound extends APIResource {
     /**
-     * Courier Track Event
+     * Records an inbound event that can trigger a journey. Requires an event name, a
+     * messageId you generate, a type, and a properties object.
      *
      * @example
      * ```ts

package/resources/inbound.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"inbound.mjs","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"inbound.mjs","sourceRoot":"","sources":["../src/resources/inbound.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}

package/resources/inbox/inbox.d.mts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as MessagesAPI from "./messages.mjs";
+import { MessageRestoreParams, Messages } from "./messages.mjs";
+export declare class Inbox extends APIResource {
+    messages: MessagesAPI.Messages;
+}
+export declare namespace Inbox {
+    export { Messages as Messages, type MessageRestoreParams as MessageRestoreParams };
+}
+//# sourceMappingURL=inbox.d.mts.map

package/resources/inbox/inbox.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox.d.mts","sourceRoot":"","sources":["../../src/resources/inbox/inbox.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,uBAAmB;AAE5D,qBAAa,KAAM,SAAQ,WAAW;IACpC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;CACzE;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CACpF"}

package/resources/inbox/inbox.d.ts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../core/resource.js";
+import * as MessagesAPI from "./messages.js";
+import { MessageRestoreParams, Messages } from "./messages.js";
+export declare class Inbox extends APIResource {
+    messages: MessagesAPI.Messages;
+}
+export declare namespace Inbox {
+    export { Messages as Messages, type MessageRestoreParams as MessageRestoreParams };
+}
+//# sourceMappingURL=inbox.d.ts.map