@augno/sdk 0.1.9 → 0.7.0

package/resources/catalog/units.d.ts

@@ -7,22 +7,15 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class Units extends APIResource {
     /**
-     * Creates an account-owned unit.
+     * Returns a paginated list of units for the current account, including both
+     * account-owned and global system units.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.create({
-     *   abbreviation: 'g',
-     *   name: 'Gram',
-     *   offset_denominator: '1',
-     *   offset_numerator: '0',
-     *   ratio_denominator: '1',
-     *   ratio_numerator: '1',
-     *   type: 'mass',
-     * });
+     * const listUnit = await client.catalog.units.list();
      * ```
      */
-    create(params: UnitCreateParams, options?: RequestOptions): APIPromise<Unit>;
+    list(query?: UnitListParams | null | undefined, options?: RequestOptions): APIPromise<ListUnit>;
     /**
      * Returns a unit by ID, including both account-owned and global system units.
      *
@@ -35,26 +28,34 @@ export declare class Units extends APIResource {
      */
     retrieve(id: string, query?: UnitRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Unit>;
     /**
-     * Partially updates an account-owned unit; system units cannot be updated.
+     * Creates an account-owned unit.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.update(
-     *   'un_01966263f74a5a0cae356000a1',
-     * );
+     * const unit = await client.catalog.units.create({
+     *   abbreviation: 'g',
+     *   name: 'Gram',
+     *   offset_denominator: '1',
+     *   offset_numerator: '0',
+     *   ratio_denominator: '1',
+     *   ratio_numerator: '1',
+     *   type: 'mass',
+     * });
      * ```
      */
-    update(id: string, params?: UnitUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Unit>;
+    create(params: UnitCreateParams, options?: RequestOptions): APIPromise<Unit>;
     /**
-     * Returns a paginated list of units for the current account, including both
-     * account-owned and global system units.
+     * Partially updates an account-owned unit; system units cannot be updated.
      *
      * @example
      * ```ts
-     * const listUnit = await client.catalog.units.list();
+     * const unit = await client.catalog.units.update(
+     *   'un_01966263f74a5a0cae356000a1',
+     *   { abbreviation: 'kg', name: 'Kilogram' },
+     * );
      * ```
      */
-    list(query?: UnitListParams | null | undefined, options?: RequestOptions): APIPromise<ListUnit>;
+    update(id: string, params?: UnitUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Unit>;
     /**
      * Deletes an account-owned unit. Associated unit group memberships are also
      * removed, and system units cannot be deleted.
@@ -74,10 +75,14 @@ export declare class Units extends APIResource {
 export interface CreateUnitRequest {
     /**
      * Short abbreviation for the unit (e.g. "g").
+     *
+     * Must be unique within the account.
      */
     abbreviation: string;
     /**
      * Display name of the unit (e.g. "Gram").
+     *
+     * Must be unique within the account.
      */
     name: string;
     /**
@@ -98,7 +103,9 @@ export interface CreateUnitRequest {
      */
     ratio_numerator: string;
     /**
-     * Unit dimension code.
+     * Unit dimension (e.g. `mass`, `volume`, `currency`).
+     *
+     * Units can only be converted to other units of the same dimension.
      */
     type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
 }
@@ -136,8 +143,10 @@ export interface Unit {
      */
     created_at: string;
     /**
-     * Whether this is the base unit for its dimension. Conversion ratios are relative
-     * to this unit.
+     * Whether this is the base unit for its dimension.
+     *
+     * Conversion ratios are relative to this unit. Base units are platform-defined;
+     * account-created units always have this set to `false`.
      */
     is_base_unit: boolean;
     /**
@@ -149,12 +158,15 @@ export interface Unit {
      */
     object: 'unit';
     /**
-     * Conversion offset denominator. Typically 1. Cannot be zero.
+     * Conversion offset denominator.
+     *
+     * Typically 1. Cannot be zero.
      */
     offset_denominator: string;
     /**
-     * Conversion offset numerator, used for temperature-like conversions. Zero for
-     * most unit types.
+     * Conversion offset numerator, used for temperature-like conversions.
+     *
+     * Zero for most unit types.
      */
     offset_numerator: string;
     /**
@@ -163,6 +175,7 @@ export interface Unit {
     owner: APIKeysAPI.Owner | null;
     /**
      * Conversion ratio denominator relative to the base unit in the same dimension.
+     *
      * Cannot be zero.
      */
     ratio_denominator: string;
@@ -171,7 +184,11 @@ export interface Unit {
      */
     ratio_numerator: string;
     /**
-     * Unit dimension.
+     * Physical dimension the unit measures, such as mass, volume, or currency.
+     *
+     * A unit can only be converted to another unit of the same dimension. The
+     * `quantity` dimension is for discrete countable items rather than a physical
+     * measure.
      */
     type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
     /**
@@ -185,10 +202,14 @@ export interface Unit {
 export interface UpdateUnitRequest {
     /**
      * Short abbreviation for the unit.
+     *
+     * Must be unique within the account.
      */
     abbreviation?: string;
     /**
      * Display name of the unit.
+     *
+     * Must be unique within the account.
      */
     name?: string;
     /**
@@ -210,13 +231,57 @@ export interface UpdateUnitRequest {
 }
 export interface UnitDeleteResponse {
 }
+export interface UnitListParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+    /**
+     * Filter by unit dimension (e.g. `mass`).
+     */
+    type?: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+    /**
+     * Return only units that belong to at least one of the given unit groups.
+     */
+    unit_group_ids?: Array<string>;
+}
+export interface UnitRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account'>;
+}
 export interface UnitCreateParams {
     /**
      * Body param: Short abbreviation for the unit (e.g. "g").
+     *
+     * Must be unique within the account.
      */
     abbreviation: string;
     /**
      * Body param: Display name of the unit (e.g. "Gram").
+     *
+     * Must be unique within the account.
      */
     name: string;
     /**
@@ -239,7 +304,9 @@ export interface UnitCreateParams {
      */
     ratio_numerator: string;
     /**
-     * Body param: Unit dimension code.
+     * Body param: Unit dimension (e.g. `mass`, `volume`, `currency`).
+     *
+     * Units can only be converted to other units of the same dimension.
      */
     type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
     /**
@@ -248,13 +315,6 @@ export interface UnitCreateParams {
      */
     include?: Array<'owner' | 'owner.account'>;
 }
-export interface UnitRetrieveParams {
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account'>;
-}
 export interface UnitUpdateParams {
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
@@ -263,10 +323,14 @@ export interface UnitUpdateParams {
     include?: Array<'owner' | 'owner.account'>;
     /**
      * Body param: Short abbreviation for the unit.
+     *
+     * Must be unique within the account.
      */
     abbreviation?: string;
     /**
      * Body param: Display name of the unit.
+     *
+     * Must be unique within the account.
      */
     name?: string;
     /**
@@ -287,34 +351,7 @@ export interface UnitUpdateParams {
      */
     ratio_numerator?: string;
 }
-export interface UnitListParams {
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account'>;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-    /**
-     * Filter by unit dimension code.
-     */
-    type?: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
-    /**
-     * Filter by unit group membership.
-     */
-    unit_group_ids?: Array<string>;
-}
 export declare namespace Units {
-    export { type CreateUnitRequest as CreateUnitRequest, type ListUnit as ListUnit, type Unit as Unit, type UpdateUnitRequest as UpdateUnitRequest, type UnitDeleteResponse as UnitDeleteResponse, type UnitCreateParams as UnitCreateParams, type UnitRetrieveParams as UnitRetrieveParams, type UnitUpdateParams as UnitUpdateParams, type UnitListParams as UnitListParams, };
+    export { type CreateUnitRequest as CreateUnitRequest, type ListUnit as ListUnit, type Unit as Unit, type UpdateUnitRequest as UpdateUnitRequest, type UnitDeleteResponse as UnitDeleteResponse, type UnitListParams as UnitListParams, type UnitRetrieveParams as UnitRetrieveParams, type UnitCreateParams as UnitCreateParams, type UnitUpdateParams as UnitUpdateParams, };
 }
 //# sourceMappingURL=units.d.ts.map

package/resources/catalog/units.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAKnB;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;CAChG;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/F;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/F;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAEhG;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAKnB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;CAChG;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/F;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAEhG;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/F;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC;IAE3C;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/catalog/units.js

@@ -9,24 +9,16 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class Units extends resource_1.APIResource {
     /**
-     * Creates an account-owned unit.
+     * Returns a paginated list of units for the current account, including both
+     * account-owned and global system units.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.create({
-     *   abbreviation: 'g',
-     *   name: 'Gram',
-     *   offset_denominator: '1',
-     *   offset_numerator: '0',
-     *   ratio_denominator: '1',
-     *   ratio_numerator: '1',
-     *   type: 'mass',
-     * });
+     * const listUnit = await client.catalog.units.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/units', { query, ...options });
     }
     /**
      * Returns a unit by ID, including both account-owned and global system units.
@@ -42,30 +34,39 @@ class Units extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/catalog/units/${id}`, { query, ...options });
     }
     /**
-     * Partially updates an account-owned unit; system units cannot be updated.
+     * Creates an account-owned unit.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.update(
-     *   'un_01966263f74a5a0cae356000a1',
-     * );
+     * const unit = await client.catalog.units.create({
+     *   abbreviation: 'g',
+     *   name: 'Gram',
+     *   offset_denominator: '1',
+     *   offset_numerator: '0',
+     *   ratio_denominator: '1',
+     *   ratio_numerator: '1',
+     *   type: 'mass',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch((0, path_1.path) `/v1/catalog/units/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of units for the current account, including both
-     * account-owned and global system units.
+     * Partially updates an account-owned unit; system units cannot be updated.
      *
      * @example
      * ```ts
-     * const listUnit = await client.catalog.units.list();
+     * const unit = await client.catalog.units.update(
+     *   'un_01966263f74a5a0cae356000a1',
+     *   { abbreviation: 'kg', name: 'Kilogram' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/units', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/catalog/units/${id}`, { query: { include }, body, ...options });
     }
     /**
      * Deletes an account-owned unit. Associated unit group memberships are also

package/resources/catalog/units.js.map

@@ -1 +1 @@
-{"version":3,"file":"units.js","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAtFD,sBAsFC"}
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;OAQG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAvFD,sBAuFC"}

package/resources/catalog/units.mjs

@@ -6,24 +6,16 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class Units extends APIResource {
     /**
-     * Creates an account-owned unit.
+     * Returns a paginated list of units for the current account, including both
+     * account-owned and global system units.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.create({
-     *   abbreviation: 'g',
-     *   name: 'Gram',
-     *   offset_denominator: '1',
-     *   offset_numerator: '0',
-     *   ratio_denominator: '1',
-     *   ratio_numerator: '1',
-     *   type: 'mass',
-     * });
+     * const listUnit = await client.catalog.units.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/units', { query, ...options });
     }
     /**
      * Returns a unit by ID, including both account-owned and global system units.
@@ -39,30 +31,39 @@ export class Units extends APIResource {
         return this._client.get(path `/v1/catalog/units/${id}`, { query, ...options });
     }
     /**
-     * Partially updates an account-owned unit; system units cannot be updated.
+     * Creates an account-owned unit.
      *
      * @example
      * ```ts
-     * const unit = await client.catalog.units.update(
-     *   'un_01966263f74a5a0cae356000a1',
-     * );
+     * const unit = await client.catalog.units.create({
+     *   abbreviation: 'g',
+     *   name: 'Gram',
+     *   offset_denominator: '1',
+     *   offset_numerator: '0',
+     *   ratio_denominator: '1',
+     *   ratio_numerator: '1',
+     *   type: 'mass',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch(path `/v1/catalog/units/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of units for the current account, including both
-     * account-owned and global system units.
+     * Partially updates an account-owned unit; system units cannot be updated.
      *
      * @example
      * ```ts
-     * const listUnit = await client.catalog.units.list();
+     * const unit = await client.catalog.units.update(
+     *   'un_01966263f74a5a0cae356000a1',
+     *   { abbreviation: 'kg', name: 'Kilogram' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/units', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/catalog/units/${id}`, { query: { include }, body, ...options });
     }
     /**
      * Deletes an account-owned unit. Associated unit group memberships are also

package/resources/catalog/units.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"units.mjs","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"units.mjs","sourceRoot":"","sources":["../../src/resources/catalog/units.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;OAQG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}

package/resources/catalog.d.mts.map

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

package/resources/catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/resources/catalog.ts"],"names":[],"mappings":"AAEA,mCAAgC"}
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/resources/catalog.ts"],"names":[],"mappings":""}

package/resources/catalog.mjs.map

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

package/resources/core/addresses/actions.d.mts

@@ -73,7 +73,7 @@ export interface ValidateAddressRequest {
      */
     city: string;
     /**
-     * Country name or code.
+     * Country name or two-letter country code (for example `United States` or `US`).
      */
     country: string;
     /**
@@ -98,7 +98,10 @@ export interface ValidatedAddress {
      */
     components: AddressComponents | null;
     /**
-     * Formatted address from the validation service.
+     * Formatted, single-line address as standardized by the validation service.
+     *
+     * The validation service may omit this regardless of `status`, so it can be absent
+     * even for a `valid` address.
      */
     formatted_address: string | null;
     /**
@@ -106,11 +109,15 @@ export interface ValidatedAddress {
      */
     object: 'validated_address';
     /**
-     * Address validation status.
+     * Whether the address could be validated.
      */
     status: 'valid' | 'invalid';
     /**
-     * Validation messages for issues found.
+     * Human-readable messages describing issues found during validation.
+     *
+     * May be non-empty even when `status` is `valid`, for example when components were
+     * inferred or replaced with standardized values. Empty when no issues were
+     * reported.
      */
     validation_messages: Array<string>;
 }
@@ -124,7 +131,7 @@ export interface ActionValidateParams {
      */
     city: string;
     /**
-     * Country name or code.
+     * Country name or two-letter country code (for example `United States` or `US`).
      */
     country: string;
     /**

package/resources/core/addresses/actions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAEnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;;;;;OAMG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/core/addresses/actions.d.ts

@@ -73,7 +73,7 @@ export interface ValidateAddressRequest {
      */
     city: string;
     /**
-     * Country name or code.
+     * Country name or two-letter country code (for example `United States` or `US`).
      */
     country: string;
     /**
@@ -98,7 +98,10 @@ export interface ValidatedAddress {
      */
     components: AddressComponents | null;
     /**
-     * Formatted address from the validation service.
+     * Formatted, single-line address as standardized by the validation service.
+     *
+     * The validation service may omit this regardless of `status`, so it can be absent
+     * even for a `valid` address.
      */
     formatted_address: string | null;
     /**
@@ -106,11 +109,15 @@ export interface ValidatedAddress {
      */
     object: 'validated_address';
     /**
-     * Address validation status.
+     * Whether the address could be validated.
      */
     status: 'valid' | 'invalid';
     /**
-     * Validation messages for issues found.
+     * Human-readable messages describing issues found during validation.
+     *
+     * May be non-empty even when `status` is `valid`, for example when components were
+     * inferred or replaced with standardized values. Empty when no issues were
+     * reported.
      */
     validation_messages: Array<string>;
 }
@@ -124,7 +131,7 @@ export interface ActionValidateParams {
      */
     city: string;
     /**
-     * Country name or code.
+     * Country name or two-letter country code (for example `United States` or `US`).
      */
     country: string;
     /**

package/resources/core/addresses/actions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B;;;;;;OAMG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/core/addresses/actions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/core/addresses/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}