@augno/sdk 0.1.9 → 0.7.1

package/resources/catalog/unit-groups/units.js

@@ -9,28 +9,26 @@ const path_1 = require("../../../internal/utils/path.js");
  */
 class Units extends resource_1.APIResource {
     /**
-     * Creates an associated unit within a unit group.
+     * Returns a list of associated units within a unit group.
+     *
+     * This endpoint requires the permission: `unit_groups:read`.
      *
      * @example
      * ```ts
-     * const unitGroupUnit =
-     *   await client.catalog.unitGroups.units.create(
+     * const listUnitGroupUnit =
+     *   await client.catalog.unitGroups.units.list(
      *     'ug_01aad07abb8e41fd392d2d7013',
-     *     { unit_id: 'un_01966263f74a5a0cae356000a1' },
      *   );
      * ```
      */
-    create(unitGroupID, params, options) {
-        const { include, ...body } = params;
-        return this._client.post((0, path_1.path) `/v1/catalog/unit-groups/${unitGroupID}/units`, {
-            query: { include },
-            body,
-            ...options,
-        });
+    list(unitGroupID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/catalog/unit-groups/${unitGroupID}/units`, { query, ...options });
     }
     /**
      * Returns an associated unit within a unit group by ID.
      *
+     * This endpoint requires the permission: `unit_groups:read`.
+     *
      * @example
      * ```ts
      * const unitGroupUnit =
@@ -48,41 +46,62 @@ class Units extends resource_1.APIResource {
         });
     }
     /**
-     * Partially updates an associated unit within a unit group.
+     * Adds a unit to a unit group. If the unit is already in the group, its existing
+     * association is updated with the provided settings instead.
+     *
+     * This endpoint requires the permission: `unit_groups:update`.
      *
      * @example
      * ```ts
      * const unitGroupUnit =
-     *   await client.catalog.unitGroups.units.update(
-     *     'un_01966263f74a5a0cae356000a1',
-     *     { unit_group_id: 'ug_01aad07abb8e41fd392d2d7013' },
+     *   await client.catalog.unitGroups.units.create(
+     *     'ug_01aad07abb8e41fd392d2d7013',
+     *     {
+     *       unit_id: 'un_01966263f74a5a0cae356000a1',
+     *       customer_portal_visibility: 'visible',
+     *       discount_percentage: 1,
+     *     },
      *   );
      * ```
      */
-    update(id, params, options) {
-        const { unit_group_id, include, ...body } = params;
-        return this._client.patch((0, path_1.path) `/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, {
+    create(unitGroupID, params, options) {
+        const { include, ...body } = params;
+        return this._client.post((0, path_1.path) `/v1/catalog/unit-groups/${unitGroupID}/units`, {
             query: { include },
             body,
             ...options,
         });
     }
     /**
-     * Returns a list of associated units within a unit group.
+     * Partially updates an associated unit within a unit group.
+     *
+     * This endpoint requires the permission: `unit_groups:update`.
      *
      * @example
      * ```ts
-     * const listUnitGroupUnit =
-     *   await client.catalog.unitGroups.units.list(
-     *     'ug_01aad07abb8e41fd392d2d7013',
+     * const unitGroupUnit =
+     *   await client.catalog.unitGroups.units.update(
+     *     'un_01966263f74a5a0cae356000a1',
+     *     {
+     *       unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+     *       discount_percentage: 0.9,
+     *       unit_id: 'un_01966263f74a5a0cae356000a1',
+     *     },
      *   );
      * ```
      */
-    list(unitGroupID, query = {}, options) {
-        return this._client.get((0, path_1.path) `/v1/catalog/unit-groups/${unitGroupID}/units`, { query, ...options });
+    update(id, params, options) {
+        const { unit_group_id, include, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, {
+            query: { include },
+            body,
+            ...options,
+        });
     }
     /**
-     * Deletes an associated unit from a unit group.
+     * Removes a unit from a unit group. The unit itself is not deleted.
+     *
+     * This endpoint requires the permission: `unit_groups:delete`.
      *
      * @example
      * ```ts

package/resources/catalog/unit-groups/units.js.map

@@ -1 +1 @@
-{"version":3,"file":"units.js","sourceRoot":"","sources":["../../../src/resources/catalog/unit-groups/units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,2BAA2B,WAAW,QAAQ,EAAE;YAC3E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YACpF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,WAAW,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF;AA7GD,sBA6GC"}
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../../../src/resources/catalog/unit-groups/units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,WAAW,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,2BAA2B,WAAW,QAAQ,EAAE;YAC3E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAU,EACV,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YACpF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF;AAhID,sBAgIC"}

package/resources/catalog/unit-groups/units.mjs

@@ -6,28 +6,26 @@ import { path } from "../../../internal/utils/path.mjs";
  */
 export class Units extends APIResource {
     /**
-     * Creates an associated unit within a unit group.
+     * Returns a list of associated units within a unit group.
+     *
+     * This endpoint requires the permission: `unit_groups:read`.
      *
      * @example
      * ```ts
-     * const unitGroupUnit =
-     *   await client.catalog.unitGroups.units.create(
+     * const listUnitGroupUnit =
+     *   await client.catalog.unitGroups.units.list(
      *     'ug_01aad07abb8e41fd392d2d7013',
-     *     { unit_id: 'un_01966263f74a5a0cae356000a1' },
      *   );
      * ```
      */
-    create(unitGroupID, params, options) {
-        const { include, ...body } = params;
-        return this._client.post(path `/v1/catalog/unit-groups/${unitGroupID}/units`, {
-            query: { include },
-            body,
-            ...options,
-        });
+    list(unitGroupID, query = {}, options) {
+        return this._client.get(path `/v1/catalog/unit-groups/${unitGroupID}/units`, { query, ...options });
     }
     /**
      * Returns an associated unit within a unit group by ID.
      *
+     * This endpoint requires the permission: `unit_groups:read`.
+     *
      * @example
      * ```ts
      * const unitGroupUnit =
@@ -45,41 +43,62 @@ export class Units extends APIResource {
         });
     }
     /**
-     * Partially updates an associated unit within a unit group.
+     * Adds a unit to a unit group. If the unit is already in the group, its existing
+     * association is updated with the provided settings instead.
+     *
+     * This endpoint requires the permission: `unit_groups:update`.
      *
      * @example
      * ```ts
      * const unitGroupUnit =
-     *   await client.catalog.unitGroups.units.update(
-     *     'un_01966263f74a5a0cae356000a1',
-     *     { unit_group_id: 'ug_01aad07abb8e41fd392d2d7013' },
+     *   await client.catalog.unitGroups.units.create(
+     *     'ug_01aad07abb8e41fd392d2d7013',
+     *     {
+     *       unit_id: 'un_01966263f74a5a0cae356000a1',
+     *       customer_portal_visibility: 'visible',
+     *       discount_percentage: 1,
+     *     },
      *   );
      * ```
      */
-    update(id, params, options) {
-        const { unit_group_id, include, ...body } = params;
-        return this._client.patch(path `/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, {
+    create(unitGroupID, params, options) {
+        const { include, ...body } = params;
+        return this._client.post(path `/v1/catalog/unit-groups/${unitGroupID}/units`, {
             query: { include },
             body,
             ...options,
         });
     }
     /**
-     * Returns a list of associated units within a unit group.
+     * Partially updates an associated unit within a unit group.
+     *
+     * This endpoint requires the permission: `unit_groups:update`.
      *
      * @example
      * ```ts
-     * const listUnitGroupUnit =
-     *   await client.catalog.unitGroups.units.list(
-     *     'ug_01aad07abb8e41fd392d2d7013',
+     * const unitGroupUnit =
+     *   await client.catalog.unitGroups.units.update(
+     *     'un_01966263f74a5a0cae356000a1',
+     *     {
+     *       unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+     *       discount_percentage: 0.9,
+     *       unit_id: 'un_01966263f74a5a0cae356000a1',
+     *     },
      *   );
      * ```
      */
-    list(unitGroupID, query = {}, options) {
-        return this._client.get(path `/v1/catalog/unit-groups/${unitGroupID}/units`, { query, ...options });
+    update(id, params, options) {
+        const { unit_group_id, include, ...body } = params;
+        return this._client.patch(path `/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, {
+            query: { include },
+            body,
+            ...options,
+        });
     }
     /**
-     * Deletes an associated unit from a unit group.
+     * Removes a unit from a unit group. The unit itself is not deleted.
+     *
+     * This endpoint requires the permission: `unit_groups:delete`.
      *
      * @example
      * ```ts

package/resources/catalog/unit-groups/units.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"units.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/unit-groups/units.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,2BAA2B,WAAW,QAAQ,EAAE;YAC3E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YACpF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,WAAW,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF"}
+{"version":3,"file":"units.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/unit-groups/units.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,WAAW,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,2BAA2B,WAAW,QAAQ,EAAE;YAC3E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAU,EACV,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE;YACpF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,MAAwB,EAAE,OAAwB;QACnE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,2BAA2B,aAAa,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACF"}

package/resources/catalog/unit-groups.d.mts.map

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

package/resources/catalog/unit-groups.d.ts.map

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

package/resources/catalog/unit-groups.mjs.map

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

package/resources/catalog/units.d.mts

@@ -7,25 +7,22 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 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.
+     *
+     * This endpoint requires the permission: `units:read`.
      *
      * @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.
      *
+     * This endpoint requires the permission: `units:read`.
+     *
      * @example
      * ```ts
      * const unit = await client.catalog.units.retrieve(
@@ -35,29 +32,45 @@ 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.
+     *
+     * This endpoint requires the permission: `units:create`.
      *
      * @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.
+     *
+     * This endpoint requires the permission: `units:update`.
      *
      * @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.
+     * Deletes an account-owned unit.
+     *
+     * Associated unit group memberships are also removed, and system units cannot be
+     * deleted.
+     *
+     * This endpoint requires the permission: `units:delete`.
      *
      * @example
      * ```ts
@@ -74,31 +87,40 @@ 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;
     /**
-     * Conversion offset denominator, as a decimal string. Must not be zero.
+     * Conversion offset denominator.
+     *
+     * Must not be zero.
      */
     offset_denominator: string;
     /**
-     * Conversion offset numerator, as a decimal string.
+     * Conversion offset numerator, used for temperature-like conversions.
      */
     offset_numerator: string;
     /**
-     * Conversion ratio denominator relative to the base unit, as a decimal string.
+     * Conversion ratio denominator relative to the base unit.
+     *
      * Must not be zero.
      */
     ratio_denominator: string;
     /**
-     * Conversion ratio numerator relative to the base unit, as a decimal string.
+     * Conversion ratio numerator relative to the base unit.
      */
     ratio_numerator: string;
     /**
-     * Unit dimension code.
+     * Unit dimension.
+     *
+     * Units can only be converted to other units of the same dimension.
      */
     type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
 }
@@ -136,8 +158,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 +173,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 +190,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 +199,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,61 +217,116 @@ 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;
     /**
-     * Conversion offset denominator, as a decimal string. Must not be zero.
+     * Conversion offset denominator.
+     *
+     * Must not be zero.
      */
     offset_denominator?: string;
     /**
-     * Conversion offset numerator, as a decimal string.
+     * Conversion offset numerator, used for temperature-like conversions.
      */
     offset_numerator?: string;
     /**
-     * Conversion ratio denominator, as a decimal string. Must not be zero.
+     * Conversion ratio denominator relative to the base unit.
+     *
+     * Must not be zero.
      */
     ratio_denominator?: string;
     /**
-     * Conversion ratio numerator, as a decimal string.
+     * Conversion ratio numerator relative to the base unit.
      */
     ratio_numerator?: string;
 }
 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.
+     */
+    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;
     /**
-     * Body param: Conversion offset denominator, as a decimal string. Must not be
-     * zero.
+     * Body param: Conversion offset denominator.
+     *
+     * Must not be zero.
      */
     offset_denominator: string;
     /**
-     * Body param: Conversion offset numerator, as a decimal string.
+     * Body param: Conversion offset numerator, used for temperature-like conversions.
      */
     offset_numerator: string;
     /**
-     * Body param: Conversion ratio denominator relative to the base unit, as a decimal
-     * string. Must not be zero.
+     * Body param: Conversion ratio denominator relative to the base unit.
+     *
+     * Must not be zero.
      */
     ratio_denominator: string;
     /**
-     * Body param: Conversion ratio numerator relative to the base unit, as a decimal
-     * string.
+     * Body param: Conversion ratio numerator relative to the base unit.
      */
     ratio_numerator: string;
     /**
-     * Body param: Unit dimension code.
+     * Body param: Unit dimension.
+     *
+     * Units can only be converted to other units of the same dimension.
      */
     type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
     /**
@@ -248,13 +335,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,58 +343,38 @@ 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;
     /**
-     * Body param: Conversion offset denominator, as a decimal string. Must not be
-     * zero.
+     * Body param: Conversion offset denominator.
+     *
+     * Must not be zero.
      */
     offset_denominator?: string;
     /**
-     * Body param: Conversion offset numerator, as a decimal string.
+     * Body param: Conversion offset numerator, used for temperature-like conversions.
      */
     offset_numerator?: string;
     /**
-     * Body param: Conversion ratio denominator, as a decimal string. Must not be zero.
+     * Body param: Conversion ratio denominator relative to the base unit.
+     *
+     * Must not be zero.
      */
     ratio_denominator?: string;
     /**
-     * Body param: Conversion ratio numerator, as a decimal string.
+     * Body param: Conversion ratio numerator relative to the base unit.
      */
     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.mts.map