@augno/sdk 0.13.4 → 0.15.0

package/src/resources/catalog/properties/actions.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as JobsAPI from '../../core/jobs';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * List and manage properties and their attributes.
+ */
+export class Actions extends APIResource {
+  /**
+   * Creates or updates multiple properties and their attributes for the account,
+   * matched by name (case-insensitive), then writes asynchronously — 202 with a job
+   * to poll.
+   *
+   * @example
+   * ```ts
+   * const job =
+   *   await client.catalog.properties.actions.bulkUpsert({
+   *     properties: [
+   *       {
+   *         name: 'Color',
+   *         attributes: [{ value: 'Premium', color: 'red' }],
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  bulkUpsert(body: ActionBulkUpsertParams, options?: RequestOptions): APIPromise<JobsAPI.Job> {
+    return this._client.post('/v1/catalog/properties/actions/bulk-upsert', { body, ...options });
+  }
+}
+
+/**
+ * carries the properties to bulk upsert
+ */
+export interface BulkUpsertPropertiesRequest {
+  /**
+   * Properties to create or update, matched by name (case-insensitive) within the
+   * account.
+   */
+  properties: Array<UpsertPropertyInput>;
+}
+
+/**
+ * carries one attribute under a bulk-upserted property
+ */
+export interface UpsertPropertyAttributeInput {
+  /**
+   * The selectable value this attribute represents, such as `Red`.
+   *
+   * Must be unique across all attributes in the account, not just within the
+   * property. Leading and trailing whitespace is trimmed.
+   */
+  value: string;
+
+  /**
+   * Swatch color used to display this attribute in the UI.
+   *
+   * When omitted, one of the nine named colors is assigned. Ignored for a value the
+   * property already defines.
+   */
+  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+}
+
+/**
+ * carries one property in a bulk upsert
+ */
+export interface UpsertPropertyInput {
+  /**
+   * The selectable values to define under this property, in the order they should be
+   * arranged.
+   *
+   * Additive — values the property already defines are left as they stand, and none
+   * are removed. New values are appended after the existing ones.
+   */
+  attributes: Array<UpsertPropertyAttributeInput>;
+
+  /**
+   * Display name of the property, used to match existing properties within the
+   * account.
+   */
+  name: string;
+}
+
+export interface ActionBulkUpsertParams {
+  /**
+   * Properties to create or update, matched by name (case-insensitive) within the
+   * account.
+   */
+  properties: Array<UpsertPropertyInput>;
+}
+
+export declare namespace Actions {
+  export {
+    type BulkUpsertPropertiesRequest as BulkUpsertPropertiesRequest,
+    type UpsertPropertyAttributeInput as UpsertPropertyAttributeInput,
+    type UpsertPropertyInput as UpsertPropertyInput,
+    type ActionBulkUpsertParams as ActionBulkUpsertParams,
+  };
+}

package/src/resources/catalog/properties/index.ts

@@ -1,5 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Actions,
+  type BulkUpsertPropertiesRequest,
+  type UpsertPropertyAttributeInput,
+  type UpsertPropertyInput,
+  type ActionBulkUpsertParams,
+} from './actions';
 export {
   Attributes,
   type CreateAttributeRequest,

package/src/resources/catalog/properties/properties.ts

@@ -2,6 +2,14 @@
 
 import { APIResource } from '../../../core/resource';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ActionsAPI from './actions';
+import {
+  ActionBulkUpsertParams,
+  Actions,
+  BulkUpsertPropertiesRequest,
+  UpsertPropertyAttributeInput,
+  UpsertPropertyInput,
+} from './actions';
 import * as AttributesAPI from './attributes';
 import {
   AttributeCreateParams,
@@ -23,6 +31,7 @@ import { path } from '../../../internal/utils/path';
  */
 export class Properties extends APIResource {
   attributes: AttributesAPI.Attributes = new AttributesAPI.Attributes(this._client);
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
    * Returns a paginated list of properties for the target account.
@@ -373,6 +382,7 @@ export interface PropertyUpdateParams {
 }
 
 Properties.Attributes = Attributes;
+Properties.Actions = Actions;
 
 export declare namespace Properties {
   export {
@@ -400,4 +410,12 @@ export declare namespace Properties {
     type AttributeUpdateParams as AttributeUpdateParams,
     type AttributeDeleteParams as AttributeDeleteParams,
   };
+
+  export {
+    Actions as Actions,
+    type BulkUpsertPropertiesRequest as BulkUpsertPropertiesRequest,
+    type UpsertPropertyAttributeInput as UpsertPropertyAttributeInput,
+    type UpsertPropertyInput as UpsertPropertyInput,
+    type ActionBulkUpsertParams as ActionBulkUpsertParams,
+  };
 }

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

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as JobsAPI from '../../core/jobs';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * List and manage unit groups and their associated units.
+ */
+export class Actions extends APIResource {
+  /**
+   * Creates or updates multiple unit groups for the account, matched by name
+   * (case-insensitive), then writes asynchronously — 202 with a job to poll.
+   *
+   * @example
+   * ```ts
+   * const job =
+   *   await client.catalog.unitGroups.actions.bulkUpsert({
+   *     unit_groups: [
+   *       {
+   *         name: 'Weight',
+   *         type: 'mass',
+   *         base_unit: { id: 'un_82bd37dae5po' },
+   *         unit_conversions: [
+   *           {
+   *             unit: { id: 'un_82bd37dae5po' },
+   *             discount_percentage: 1,
+   *           },
+   *         ],
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  bulkUpsert(body: ActionBulkUpsertParams, options?: RequestOptions): APIPromise<JobsAPI.Job> {
+    return this._client.post('/v1/catalog/unit-groups/actions/bulk-upsert', { body, ...options });
+  }
+}
+
+/**
+ * BulkUpsertUnitGroupsRequest is the request to bulk upsert unit groups.
+ */
+export interface BulkUpsertUnitGroupsRequest {
+  /**
+   * Unit groups to create or update, matched by name within the account.
+   */
+  unit_groups: Array<UpsertUnitGroupInput>;
+}
+
+/**
+ * -------------------------- UNIT -------------------------- Identifies a unit by
+ * its id, its name, or its abbreviation, in that order of precedence.
+ */
+export interface UnitIdentifier {
+  /**
+   * Unit ID.
+   */
+  id: string;
+
+  /**
+   * Unit abbreviation, matched case-insensitively against the account's units.
+   */
+  abbreviation: string;
+
+  /**
+   * Unit name, matched case-insensitively against the account's units.
+   */
+  name: string;
+}
+
+/**
+ * UpsertUnitGroupConversionInput is the input for a single unit conversion within
+ * a bulk upsert unit group.
+ */
+export interface UpsertUnitGroupConversionInput {
+  /**
+   * -------------------------- UNIT -------------------------- Identifies a unit by
+   * its id, its name, or its abbreviation, in that order of precedence.
+   */
+  unit: UnitIdentifier;
+
+  /**
+   * Discount percentage to apply for this unit conversion.
+   */
+  discount_percentage?: number;
+}
+
+/**
+ * UpsertUnitGroupInput is the input for a single unit group in a bulk upsert
+ * operation.
+ */
+export interface UpsertUnitGroupInput {
+  /**
+   * -------------------------- UNIT -------------------------- Identifies a unit by
+   * its id, its name, or its abbreviation, in that order of precedence.
+   */
+  base_unit: UnitIdentifier;
+
+  /**
+   * Display name of the unit group, matched case-insensitively against existing
+   * groups. A row matching a system unit group fails — system groups cannot be
+   * modified.
+   */
+  name: string;
+
+  /**
+   * Unit dimension type. Create-only — an existing group keeps its stored type.
+   */
+  type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+
+  /**
+   * Free-form notes about the unit group. Preserved when omitted on update.
+   */
+  notes?: string;
+
+  /**
+   * Units to associate with the group. Replaces the existing set on update; the base
+   * unit is always kept.
+   */
+  unit_conversions?: Array<UpsertUnitGroupConversionInput>;
+}
+
+export interface ActionBulkUpsertParams {
+  /**
+   * Unit groups to create or update, matched by name within the account.
+   */
+  unit_groups: Array<UpsertUnitGroupInput>;
+}
+
+export declare namespace Actions {
+  export {
+    type BulkUpsertUnitGroupsRequest as BulkUpsertUnitGroupsRequest,
+    type UnitIdentifier as UnitIdentifier,
+    type UpsertUnitGroupConversionInput as UpsertUnitGroupConversionInput,
+    type UpsertUnitGroupInput as UpsertUnitGroupInput,
+    type ActionBulkUpsertParams as ActionBulkUpsertParams,
+  };
+}

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

@@ -1,5 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Actions,
+  type BulkUpsertUnitGroupsRequest,
+  type UnitIdentifier,
+  type UpsertUnitGroupConversionInput,
+  type UpsertUnitGroupInput,
+  type ActionBulkUpsertParams,
+} from './actions';
 export {
   UnitGroups,
   type CreateUnitGroupRequest,

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

@@ -1,9 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as UnitsAPI from '../units';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
-import * as UnitGroupsUnitsAPI from './units';
+import * as ActionsAPI from './actions';
+import {
+  ActionBulkUpsertParams,
+  Actions,
+  BulkUpsertUnitGroupsRequest,
+  UnitIdentifier,
+  UpsertUnitGroupConversionInput,
+  UpsertUnitGroupInput,
+} from './actions';
+import * as UnitsAPI from './units';
 import {
   CreateUnitGroupUnitRequest,
   UnitCreateParams,
@@ -15,6 +23,7 @@ import {
   Units,
   UpdateUnitGroupUnitRequest,
 } from './units';
+import * as CatalogUnitsAPI from '../units/units';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -23,7 +32,8 @@ import { path } from '../../../internal/utils/path';
  * List and manage unit groups and their associated units.
  */
 export class UnitGroups extends APIResource {
-  units: UnitGroupsUnitsAPI.Units = new UnitGroupsUnitsAPI.Units(this._client);
+  units: UnitsAPI.Units = new UnitsAPI.Units(this._client);
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
    * Returns a paginated list of unit groups, including system unit groups.
@@ -303,7 +313,7 @@ export interface UnitGroup {
   /**
    * Unit of measurement used for conversions and product quantities.
    */
-  base_unit: UnitsAPI.Unit | null;
+  base_unit: CatalogUnitsAPI.Unit | null;
 
   /**
    * Creation timestamp.
@@ -391,7 +401,7 @@ export interface UnitGroupUnit {
   /**
    * Unit of measurement used for conversions and product quantities.
    */
-  unit: UnitsAPI.Unit | null;
+  unit: CatalogUnitsAPI.Unit | null;
 
   /**
    * Last updated timestamp.
@@ -559,6 +569,7 @@ export interface UnitGroupUpdateParams {
 }
 
 UnitGroups.Units = Units;
+UnitGroups.Actions = Actions;
 
 export declare namespace UnitGroups {
   export {
@@ -587,4 +598,13 @@ export declare namespace UnitGroups {
     type UnitUpdateParams as UnitUpdateParams,
     type UnitDeleteParams as UnitDeleteParams,
   };
+
+  export {
+    Actions as Actions,
+    type BulkUpsertUnitGroupsRequest as BulkUpsertUnitGroupsRequest,
+    type UnitIdentifier as UnitIdentifier,
+    type UpsertUnitGroupConversionInput as UpsertUnitGroupConversionInput,
+    type UpsertUnitGroupInput as UpsertUnitGroupInput,
+    type ActionBulkUpsertParams as ActionBulkUpsertParams,
+  };
 }

package/src/resources/catalog/units/actions.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as JobsAPI from '../../core/jobs';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * List and manage units.
+ */
+export class Actions extends APIResource {
+  /**
+   * Creates or updates multiple units of measure for the account, matched by name or
+   * abbreviation, then writes asynchronously — 202 with a job to poll.
+   *
+   * @example
+   * ```ts
+   * const job = await client.catalog.units.actions.bulkUpsert({
+   *   units: [
+   *     {
+   *       name: 'Kilogram',
+   *       abbreviation: 'kg',
+   *       type: 'mass',
+   *       ratio_numerator: '1000',
+   *       ratio_denominator: '1',
+   *       offset_numerator: '0',
+   *       offset_denominator: '1',
+   *       is_base_unit: false,
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  bulkUpsert(body: ActionBulkUpsertParams, options?: RequestOptions): APIPromise<JobsAPI.Job> {
+    return this._client.post('/v1/catalog/units/actions/bulk-upsert', { body, ...options });
+  }
+}
+
+/**
+ * BulkUpsertUnitsRequest is the request to bulk upsert units.
+ */
+export interface BulkUpsertUnitsRequest {
+  /**
+   * Units to create or update, matched by name or abbreviation within the account.
+   */
+  units: Array<UpsertUnitInput>;
+}
+
+/**
+ * UpsertUnitInput is the input for a single unit in a bulk upsert operation.
+ */
+export interface UpsertUnitInput {
+  /**
+   * Short abbreviation for the unit (e.g. "g"). Also used for matching — see `name`.
+   */
+  abbreviation: string;
+
+  /**
+   * Whether the unit is its dimension's base unit. Bulk upsert never creates a base
+   * unit and rejects a change to an existing one.
+   */
+  is_base_unit: boolean;
+
+  /**
+   * Display name of the unit (e.g. "Gram"). A row matching a system unit fails —
+   * system units cannot be modified.
+   */
+  name: string;
+
+  /**
+   * Conversion offset denominator, as a decimal string.
+   */
+  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.
+   */
+  ratio_denominator: string;
+
+  /**
+   * Conversion ratio numerator relative to the base unit, as a decimal string.
+   */
+  ratio_numerator: string;
+
+  /**
+   * Unit dimension code. Create-only — a row that changes an existing unit's
+   * dimension fails.
+   */
+  type: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
+}
+
+export interface ActionBulkUpsertParams {
+  /**
+   * Units to create or update, matched by name or abbreviation within the account.
+   */
+  units: Array<UpsertUnitInput>;
+}
+
+export declare namespace Actions {
+  export {
+    type BulkUpsertUnitsRequest as BulkUpsertUnitsRequest,
+    type UpsertUnitInput as UpsertUnitInput,
+    type ActionBulkUpsertParams as ActionBulkUpsertParams,
+  };
+}

package/src/resources/catalog/units/index.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type BulkUpsertUnitsRequest,
+  type UpsertUnitInput,
+  type ActionBulkUpsertParams,
+} from './actions';
+export {
+  Units,
+  type CreateUnitRequest,
+  type ListUnit,
+  type Unit,
+  type UpdateUnitRequest,
+  type UnitDeleteResponse,
+  type UnitListParams,
+  type UnitRetrieveParams,
+  type UnitCreateParams,
+  type UnitUpdateParams,
+} from './units';