@augno/sdk 0.13.4 → 0.15.0

package/src/resources/catalog/units.ts

@@ -1,534 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as APIKeysAPI from '../auth/api-keys/api-keys';
-import { APIPromise } from '../../core/api-promise';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-/**
- * List and manage units.
- */
-export class Units extends APIResource {
-  /**
-   * 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> {
-    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: string,
-    query: UnitRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Unit> {
-    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: UnitCreateParams, options?: RequestOptions): APIPromise<Unit> {
-    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: string,
-    params: UnitUpdateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Unit> {
-    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: string, options?: RequestOptions): APIPromise<UnitDeleteResponse> {
-    return this._client.delete(path`/v1/catalog/units/${id}`, options);
-  }
-}
-
-/**
- * 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 * from './units/index';