@augno/sdk 0.13.4 → 0.14.0

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

@@ -0,0 +1,449 @@
+import { APIResource } from "../../../core/resource.js";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
+import * as ActionsAPI from "./actions.js";
+import { ActionBulkUpsertParams, Actions, BulkUpsertUnitsRequest, UpsertUnitInput } from "./actions.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * List and manage units.
+ */
+export declare class Units extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * 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 listUnit = await client.catalog.units.list();
+     * ```
+     */
+    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(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: UnitRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Unit>;
+    /**
+     * Creates a unit of measurement owned by your account, in addition to the system
+     * units the platform already provides.
+     *
+     * The name and abbreviation must each be unique within the account. A unit created
+     * here is never a base unit, so its conversion ratio is interpreted relative to
+     * the base unit of the chosen dimension.
+     *
+     * This endpoint requires the permission: `units:create`.
+     *
+     * @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',
+     * });
+     * ```
+     */
+    create(params: UnitCreateParams, options?: RequestOptions): APIPromise<Unit>;
+    /**
+     * Partially updates a unit owned by your account.
+     *
+     * System units cannot be modified, and a unit's dimension is fixed once it is
+     * created.
+     *
+     * This endpoint requires the permission: `units:update`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.update(
+     *   'un_82bd37dae5po',
+     *   {
+     *     abbreviation: 'kg',
+     *     name: 'Kilogram',
+     *     offset_denominator: '1',
+     *     offset_numerator: '0',
+     *     ratio_denominator: '1',
+     *     ratio_numerator: '1000',
+     *   },
+     * );
+     * ```
+     */
+    update(id: string, params?: UnitUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Unit>;
+    /**
+     * Deletes a unit owned by your account.
+     *
+     * The unit is also removed from every unit group it belongs to. System units,
+     * which are shared across all accounts, cannot be deleted.
+     *
+     * This endpoint requires the permission: `units:delete`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.delete(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<UnitDeleteResponse>;
+}
+/**
+ * Request to create a unit.
+ */
+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;
+    /**
+     * Denominator of the conversion offset.
+     *
+     * Must not be zero, so send `1` when the unit has no offset.
+     */
+    offset_denominator: string;
+    /**
+     * Numerator of the conversion offset, applied after the ratio for scales that do
+     * not share a zero point, such as temperature.
+     *
+     * Send `0` for units that convert by ratio alone.
+     */
+    offset_numerator: string;
+    /**
+     * Denominator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * Must not be zero.
+     */
+    ratio_denominator: string;
+    /**
+     * Numerator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * A quantity is converted with
+     * `value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator)`,
+     * so a kilogram in a gram-based dimension has a numerator of `1000` and a
+     * denominator of `1`.
+     */
+    ratio_numerator: string;
+    /**
+     * The dimension this unit measures, such as mass, volume, or currency.
+     *
+     * Units can only be converted to other units of the same dimension, and the
+     * dimension cannot be changed after the unit is created.
+     */
+    type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListUnit {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Unit>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * Unit of measurement used for conversions and product quantities.
+ */
+export interface Unit {
+    /**
+     * Unit ID.
+     */
+    id: string;
+    /**
+     * Short abbreviation for the unit (e.g. "g", "kg").
+     */
+    abbreviation: string;
+    /**
+     * When this unit was created.
+     */
+    created_at: string;
+    /**
+     * Whether this is the base unit for its dimension.
+     *
+     * Every other unit's conversion ratio is expressed relative to the base unit. Base
+     * units are platform-defined; units created through the API are never base units.
+     */
+    is_base_unit: boolean;
+    /**
+     * Display name of the unit (e.g. "Gram", "Kilogram").
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'unit';
+    /**
+     * Denominator of the conversion offset applied after the ratio.
+     *
+     * Never zero; a unit with no offset carries a numerator of `0` over a denominator
+     * of `1`.
+     */
+    offset_denominator: string;
+    /**
+     * Numerator of the conversion offset, applied after the ratio for scales that do
+     * not share a zero point, such as temperature.
+     *
+     * Zero for units that convert by ratio alone.
+     */
+    offset_numerator: string;
+    /**
+     * Owner describes the provenance of a resource.
+     */
+    owner: APIKeysAPI.Owner | null;
+    /**
+     * Denominator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * Cannot be zero.
+     */
+    ratio_denominator: string;
+    /**
+     * Numerator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * A quantity is converted with
+     * `value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator)`,
+     * so a kilogram in a gram-based dimension has a numerator of `1000` and a
+     * denominator of `1`.
+     */
+    ratio_numerator: string;
+    /**
+     * The dimension this 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';
+    /**
+     * When this unit was last updated.
+     */
+    updated_at: string;
+}
+/**
+ * Request to partially update a 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;
+    /**
+     * Denominator of the conversion offset.
+     *
+     * Must not be zero.
+     */
+    offset_denominator?: string;
+    /**
+     * Numerator of the conversion offset, applied after the ratio for scales that do
+     * not share a zero point, such as temperature.
+     */
+    offset_numerator?: string;
+    /**
+     * Denominator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * Must not be zero.
+     */
+    ratio_denominator?: string;
+    /**
+     * Numerator of the ratio that converts a quantity in this unit into the
+     * dimension's base unit.
+     *
+     * A quantity is converted with
+     * `value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator)`.
+     */
+    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: Denominator of the conversion offset.
+     *
+     * Must not be zero, so send `1` when the unit has no offset.
+     */
+    offset_denominator: string;
+    /**
+     * Body param: Numerator of the conversion offset, applied after the ratio for
+     * scales that do not share a zero point, such as temperature.
+     *
+     * Send `0` for units that convert by ratio alone.
+     */
+    offset_numerator: string;
+    /**
+     * Body param: Denominator of the ratio that converts a quantity in this unit into
+     * the dimension's base unit.
+     *
+     * Must not be zero.
+     */
+    ratio_denominator: string;
+    /**
+     * Body param: Numerator of the ratio that converts a quantity in this unit into
+     * the dimension's base unit.
+     *
+     * A quantity is converted with
+     * `value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator)`,
+     * so a kilogram in a gram-based dimension has a numerator of `1000` and a
+     * denominator of `1`.
+     */
+    ratio_numerator: string;
+    /**
+     * Body param: The dimension this unit measures, such as mass, volume, or currency.
+     *
+     * Units can only be converted to other units of the same dimension, and the
+     * dimension cannot be changed after the unit is created.
+     */
+    type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+    /**
+     * Query param: 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
+     * are returned as `null`.
+     */
+    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: Denominator of the conversion offset.
+     *
+     * Must not be zero.
+     */
+    offset_denominator?: string;
+    /**
+     * Body param: Numerator of the conversion offset, applied after the ratio for
+     * scales that do not share a zero point, such as temperature.
+     */
+    offset_numerator?: string;
+    /**
+     * Body param: Denominator of the ratio that converts a quantity in this unit into
+     * the dimension's base unit.
+     *
+     * Must not be zero.
+     */
+    ratio_denominator?: string;
+    /**
+     * Body param: Numerator of the ratio that converts a quantity in this unit into
+     * the dimension's base unit.
+     *
+     * A quantity is converted with
+     * `value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator)`.
+     */
+    ratio_numerator?: 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 UnitListParams as UnitListParams, type UnitRetrieveParams as UnitRetrieveParams, type UnitCreateParams as UnitCreateParams, type UnitUpdateParams as UnitUpdateParams, };
+    export { Actions as Actions, type BulkUpsertUnitsRequest as BulkUpsertUnitsRequest, type UpsertUnitInput as UpsertUnitInput, type ActionBulkUpsertParams as ActionBulkUpsertParams, };
+}
+//# sourceMappingURL=units.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/units/units.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,UAAU;OACf,EAAE,sBAAsB,EAAE,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE;OAC5E,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;;;;;;;;;;;;;;OAsBG;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;;;;;;;;;;;;;;OAcG;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;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;CAChG;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;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;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;OAQG;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;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;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;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;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;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAID,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;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/catalog/units/units.js

@@ -0,0 +1,122 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Units = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ActionsAPI = tslib_1.__importStar(require("./actions.js"));
+const actions_1 = require("./actions.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * List and manage units.
+ */
+class Units extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * 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 listUnit = await client.catalog.units.list();
+     * ```
+     */
+    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.
+     *
+     * This endpoint requires the permission: `units:read`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.retrieve(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/catalog/units/${id}`, { query, ...options });
+    }
+    /**
+     * Creates a unit of measurement owned by your account, in addition to the system
+     * units the platform already provides.
+     *
+     * The name and abbreviation must each be unique within the account. A unit created
+     * here is never a base unit, so its conversion ratio is interpreted relative to
+     * the base unit of the chosen dimension.
+     *
+     * This endpoint requires the permission: `units:create`.
+     *
+     * @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',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
+    }
+    /**
+     * Partially updates a unit owned by your account.
+     *
+     * System units cannot be modified, and a unit's dimension is fixed once it is
+     * created.
+     *
+     * This endpoint requires the permission: `units:update`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.update(
+     *   'un_82bd37dae5po',
+     *   {
+     *     abbreviation: 'kg',
+     *     name: 'Kilogram',
+     *     offset_denominator: '1',
+     *     offset_numerator: '0',
+     *     ratio_denominator: '1',
+     *     ratio_numerator: '1000',
+     *   },
+     * );
+     * ```
+     */
+    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 a unit owned by your account.
+     *
+     * The unit is also removed from every unit group it belongs to. System units,
+     * which are shared across all accounts, cannot be deleted.
+     *
+     * This endpoint requires the permission: `units:delete`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.delete(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/catalog/units/${id}`, options);
+    }
+}
+exports.Units = Units;
+Units.Actions = actions_1.Actions;
+//# sourceMappingURL=units.js.map

package/resources/catalog/units/units.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../../../src/resources/catalog/units/units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,iEAAwC;AACxC,0CAAqG;AAGrG,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmHrE,CAAC;IAjHC;;;;;;;;;;OAUG;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;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;;;;;;;;;;;;;;OAcG;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;AApHD,sBAoHC;AA4YD,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/catalog/units/units.mjs

@@ -0,0 +1,117 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { Actions } from "./actions.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * List and manage units.
+ */
+export class Units extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * 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 listUnit = await client.catalog.units.list();
+     * ```
+     */
+    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.
+     *
+     * This endpoint requires the permission: `units:read`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.retrieve(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/v1/catalog/units/${id}`, { query, ...options });
+    }
+    /**
+     * Creates a unit of measurement owned by your account, in addition to the system
+     * units the platform already provides.
+     *
+     * The name and abbreviation must each be unique within the account. A unit created
+     * here is never a base unit, so its conversion ratio is interpreted relative to
+     * the base unit of the chosen dimension.
+     *
+     * This endpoint requires the permission: `units:create`.
+     *
+     * @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',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/units', { query: { include }, body, ...options });
+    }
+    /**
+     * Partially updates a unit owned by your account.
+     *
+     * System units cannot be modified, and a unit's dimension is fixed once it is
+     * created.
+     *
+     * This endpoint requires the permission: `units:update`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.update(
+     *   'un_82bd37dae5po',
+     *   {
+     *     abbreviation: 'kg',
+     *     name: 'Kilogram',
+     *     offset_denominator: '1',
+     *     offset_numerator: '0',
+     *     ratio_denominator: '1',
+     *     ratio_numerator: '1000',
+     *   },
+     * );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/catalog/units/${id}`, { query: { include }, body, ...options });
+    }
+    /**
+     * Deletes a unit owned by your account.
+     *
+     * The unit is also removed from every unit group it belongs to. System units,
+     * which are shared across all accounts, cannot be deleted.
+     *
+     * This endpoint requires the permission: `units:delete`.
+     *
+     * @example
+     * ```ts
+     * const unit = await client.catalog.units.delete(
+     *   'un_82bd37dae5po',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/v1/catalog/units/${id}`, options);
+    }
+}
+Units.Actions = Actions;
+//# sourceMappingURL=units.mjs.map