@augno/sdk 0.1.6

package/src/resources/catalog/unit-groups/units.ts

@@ -0,0 +1,284 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as UnitGroupsAPI from './unit-groups';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage unit groups and their associated units.
+ */
+export class Units extends APIResource {
+  /**
+   * Creates an associated unit within a unit group.
+   *
+   * @example
+   * ```ts
+   * const unitGroupUnit =
+   *   await client.catalog.unitGroups.units.create(
+   *     'ug_01aad07abb8e41fd392d2d7013',
+   *     {
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *       customer_portal_visibility: 'visible',
+   *       discount_percentage: 1,
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    unitGroupID: string,
+    params: UnitCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<UnitGroupsAPI.UnitGroupUnit> {
+    const { include, ...body } = params;
+    return this._client.post(path`/v1/catalog/unit-groups/${unitGroupID}/units`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns an associated unit within a unit group by ID.
+   *
+   * @example
+   * ```ts
+   * const unitGroupUnit =
+   *   await client.catalog.unitGroups.units.retrieve(
+   *     'un_01966263f74a5a0cae356000a1',
+   *     { unit_group_id: 'ug_01aad07abb8e41fd392d2d7013' },
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: UnitRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<UnitGroupsAPI.UnitGroupUnit> {
+    const { unit_group_id, ...query } = params;
+    return this._client.get(path`/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Partially updates an associated unit within a unit group.
+   *
+   * @example
+   * ```ts
+   * const unitGroupUnit =
+   *   await client.catalog.unitGroups.units.update(
+   *     'un_01966263f74a5a0cae356000a1',
+   *     {
+   *       unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *       discount_percentage: 0.9,
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: UnitUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<UnitGroupsAPI.UnitGroupUnit> {
+    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,
+    });
+  }
+
+  /**
+   * Returns a list of associated units within a unit group.
+   *
+   * @example
+   * ```ts
+   * const listUnitGroupUnit =
+   *   await client.catalog.unitGroups.units.list(
+   *     'ug_01aad07abb8e41fd392d2d7013',
+   *   );
+   * ```
+   */
+  list(
+    unitGroupID: string,
+    query: UnitListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UnitGroupsAPI.ListUnitGroupUnit> {
+    return this._client.get(path`/v1/catalog/unit-groups/${unitGroupID}/units`, { query, ...options });
+  }
+
+  /**
+   * Deletes an associated unit from a unit group.
+   *
+   * @example
+   * ```ts
+   * const unit = await client.catalog.unitGroups.units.delete(
+   *   'un_01966263f74a5a0cae356000a1',
+   *   { unit_group_id: 'ug_01aad07abb8e41fd392d2d7013' },
+   * );
+   * ```
+   */
+  delete(id: string, params: UnitDeleteParams, options?: RequestOptions): APIPromise<UnitDeleteResponse> {
+    const { unit_group_id } = params;
+    return this._client.delete(path`/v1/catalog/unit-groups/${unit_group_id}/units/${id}`, options);
+  }
+}
+
+/**
+ * CreateUnitGroupUnitRequest is a request to create an associated unit within a
+ * unit group.
+ */
+export interface CreateUnitGroupUnitRequest {
+  /**
+   * Unit ID.
+   */
+  unit_id: string;
+
+  /**
+   * Customer portal visibility.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Fixed discount amount.
+   */
+  discount_fixed?: number;
+
+  /**
+   * Discount percentage.
+   */
+  discount_percentage?: number;
+}
+
+/**
+ * UpdateUnitGroupUnitRequest is a request to update an associated unit.
+ */
+export interface UpdateUnitGroupUnitRequest {
+  /**
+   * Customer portal visibility.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Fixed discount amount.
+   */
+  discount_fixed?: number;
+
+  /**
+   * Discount percentage.
+   */
+  discount_percentage?: number;
+
+  /**
+   * Unit ID.
+   */
+  unit_id?: string;
+}
+
+export interface UnitDeleteResponse {}
+
+export interface UnitCreateParams {
+  /**
+   * Body param: Unit ID.
+   */
+  unit_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'unit'>;
+
+  /**
+   * Body param: Customer portal visibility.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Body param: Fixed discount amount.
+   */
+  discount_fixed?: number;
+
+  /**
+   * Body param: Discount percentage.
+   */
+  discount_percentage?: number;
+}
+
+export interface UnitRetrieveParams {
+  /**
+   * Path param: Unit group ID.
+   */
+  unit_group_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'unit'>;
+}
+
+export interface UnitUpdateParams {
+  /**
+   * Path param: Unit group ID.
+   */
+  unit_group_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'unit'>;
+
+  /**
+   * Body param: Customer portal visibility.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Body param: Fixed discount amount.
+   */
+  discount_fixed?: number;
+
+  /**
+   * Body param: Discount percentage.
+   */
+  discount_percentage?: number;
+
+  /**
+   * Body param: Unit ID.
+   */
+  unit_id?: string;
+}
+
+export interface UnitListParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'unit'>;
+}
+
+export interface UnitDeleteParams {
+  /**
+   * Unit group ID.
+   */
+  unit_group_id: string;
+}
+
+export declare namespace Units {
+  export {
+    type CreateUnitGroupUnitRequest as CreateUnitGroupUnitRequest,
+    type UpdateUnitGroupUnitRequest as UpdateUnitGroupUnitRequest,
+    type UnitDeleteResponse as UnitDeleteResponse,
+    type UnitCreateParams as UnitCreateParams,
+    type UnitRetrieveParams as UnitRetrieveParams,
+    type UnitUpdateParams as UnitUpdateParams,
+    type UnitListParams as UnitListParams,
+    type UnitDeleteParams as UnitDeleteParams,
+  };
+}

package/src/resources/catalog/unit-groups.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './unit-groups/index';

package/src/resources/catalog/units.ts

@@ -0,0 +1,410 @@
+// 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 {
+  /**
+   * Creates an account-owned unit.
+   *
+   * @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 });
+  }
+
+  /**
+   * Returns a unit by ID, including both account-owned and global system units.
+   *
+   * @example
+   * ```ts
+   * const unit = await client.catalog.units.retrieve(
+   *   'un_01966263f74a5a0cae356000a1',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: UnitRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Unit> {
+    return this._client.get(path`/v1/catalog/units/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates an account-owned unit; system units cannot be updated.
+   *
+   * @example
+   * ```ts
+   * const unit = await client.catalog.units.update(
+   *   'un_01966263f74a5a0cae356000a1',
+   *   { abbreviation: 'kg', name: 'Kilogram' },
+   * );
+   * ```
+   */
+  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 });
+  }
+
+  /**
+   * Returns a paginated list of units for the current account, including both
+   * account-owned and global system units.
+   *
+   * @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 });
+  }
+
+  /**
+   * Deletes an account-owned unit. Associated unit group memberships are also
+   * removed, and system units cannot be deleted.
+   *
+   * @example
+   * ```ts
+   * const unit = await client.catalog.units.delete(
+   *   'un_01966263f74a5a0cae356000a1',
+   * );
+   * ```
+   */
+  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").
+   */
+  abbreviation: string;
+
+  /**
+   * Display name of the unit (e.g. "Gram").
+   */
+  name: string;
+
+  /**
+   * Conversion offset denominator, as a decimal string. Must not be zero.
+   */
+  offset_denominator: string;
+
+  /**
+   * Conversion offset numerator, as a decimal string.
+   */
+  offset_numerator: string;
+
+  /**
+   * Conversion ratio denominator relative to the base unit, as a decimal string.
+   * Must not be zero.
+   */
+  ratio_denominator: string;
+
+  /**
+   * Conversion ratio numerator relative to the base unit, as a decimal string.
+   */
+  ratio_numerator: string;
+
+  /**
+   * Unit dimension code.
+   */
+  type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListUnit {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Unit>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  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. Conversion ratios are relative
+   * to this unit.
+   */
+  is_base_unit: boolean;
+
+  /**
+   * Display name of the unit (e.g. "Gram", "Kilogram").
+   */
+  name: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'unit';
+
+  /**
+   * Conversion offset denominator. Typically 1. Cannot be zero.
+   */
+  offset_denominator: string;
+
+  /**
+   * Conversion offset numerator, used for temperature-like conversions. Zero for
+   * most unit types.
+   */
+  offset_numerator: string;
+
+  /**
+   * Owner describes the provenance of a resource.
+   */
+  owner: APIKeysAPI.Owner | null;
+
+  /**
+   * Conversion ratio denominator relative to the base unit in the same dimension.
+   * Cannot be zero.
+   */
+  ratio_denominator: string;
+
+  /**
+   * Conversion ratio numerator relative to the base unit in the same dimension.
+   */
+  ratio_numerator: string;
+
+  /**
+   * Unit dimension.
+   */
+  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.
+   */
+  abbreviation?: string;
+
+  /**
+   * Display name of the unit.
+   */
+  name?: string;
+
+  /**
+   * Conversion offset denominator, as a decimal string. Must not be zero.
+   */
+  offset_denominator?: string;
+
+  /**
+   * Conversion offset numerator, as a decimal string.
+   */
+  offset_numerator?: string;
+
+  /**
+   * Conversion ratio denominator, as a decimal string. Must not be zero.
+   */
+  ratio_denominator?: string;
+
+  /**
+   * Conversion ratio numerator, as a decimal string.
+   */
+  ratio_numerator?: string;
+}
+
+export interface UnitDeleteResponse {}
+
+export interface UnitCreateParams {
+  /**
+   * Body param: Short abbreviation for the unit (e.g. "g").
+   */
+  abbreviation: string;
+
+  /**
+   * Body param: Display name of the unit (e.g. "Gram").
+   */
+  name: string;
+
+  /**
+   * Body param: Conversion offset denominator, as a decimal string. Must not be
+   * zero.
+   */
+  offset_denominator: string;
+
+  /**
+   * Body param: Conversion offset numerator, as a decimal string.
+   */
+  offset_numerator: string;
+
+  /**
+   * Body param: Conversion ratio denominator relative to the base unit, as a decimal
+   * string. Must not be zero.
+   */
+  ratio_denominator: string;
+
+  /**
+   * Body param: Conversion ratio numerator relative to the base unit, as a decimal
+   * string.
+   */
+  ratio_numerator: string;
+
+  /**
+   * Body param: Unit dimension code.
+   */
+  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 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
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account'>;
+
+  /**
+   * Body param: Short abbreviation for the unit.
+   */
+  abbreviation?: string;
+
+  /**
+   * Body param: Display name of the unit.
+   */
+  name?: string;
+
+  /**
+   * Body param: Conversion offset denominator, as a decimal string. Must not be
+   * zero.
+   */
+  offset_denominator?: string;
+
+  /**
+   * Body param: Conversion offset numerator, as a decimal string.
+   */
+  offset_numerator?: string;
+
+  /**
+   * Body param: Conversion ratio denominator, as a decimal string. Must not be zero.
+   */
+  ratio_denominator?: string;
+
+  /**
+   * Body param: Conversion ratio numerator, as a decimal string.
+   */
+  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,
+  };
+}

package/src/resources/catalog.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './catalog/index';