@augno/sdk 0.1.6

package/src/resources/catalog/item-categories/item-categories.ts

@@ -0,0 +1,344 @@
+// 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 * as PropertiesAPI from './properties';
+import {
+  Properties,
+  PropertyDeleteParams,
+  PropertyDeleteResponse,
+  PropertyUpdateParams,
+  PropertyUpdateResponse,
+} from './properties';
+import * as ItemsAPI from '../items/items';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage item categories.
+ */
+export class ItemCategories extends APIResource {
+  properties: PropertiesAPI.Properties = new PropertiesAPI.Properties(this._client);
+
+  /**
+   * Creates an account-owned item category.
+   *
+   * @example
+   * ```ts
+   * const itemCategory =
+   *   await client.catalog.itemCategories.create({
+   *     name: 'Electronics',
+   *     type: 'material_category',
+   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *   });
+   * ```
+   */
+  create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/item-categories', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns an item category by ID. Includes account-specific and global system
+   * categories.
+   *
+   * @example
+   * ```ts
+   * const itemCategory =
+   *   await client.catalog.itemCategories.retrieve(
+   *     'ic_01ae7bd7bfd21ca0ab81e1357e',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: ItemCategoryRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemsAPI.ItemCategory> {
+    return this._client.get(path`/v1/catalog/item-categories/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates an account-owned item category. Default system categories
+   * cannot be updated.
+   *
+   * @example
+   * ```ts
+   * const itemCategory =
+   *   await client.catalog.itemCategories.update(
+   *     'ic_01ae7bd7bfd21ca0ab81e1357e',
+   *     { name: 'Electronic Components' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: ItemCategoryUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemsAPI.ItemCategory> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/catalog/item-categories/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of item categories for the current account, including
+   * account-specific and global system categories.
+   *
+   * @example
+   * ```ts
+   * const listItemCategory =
+   *   await client.catalog.itemCategories.list();
+   * ```
+   */
+  list(
+    query: ItemCategoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListItemCategory> {
+    return this._client.get('/v1/catalog/item-categories', { query, ...options });
+  }
+
+  /**
+   * Deletes an account-owned item category. Default system categories cannot be
+   * deleted.
+   *
+   * @example
+   * ```ts
+   * const itemCategory =
+   *   await client.catalog.itemCategories.delete(
+   *     'ic_01ae7bd7bfd21ca0ab81e1357e',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<ItemCategoryDeleteResponse> {
+    return this._client.delete(path`/v1/catalog/item-categories/${id}`, options);
+  }
+
+  /**
+   * Changes the unit group associated with an item category. All items in the
+   * category are updated to use the new base unit asynchronously.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.catalog.itemCategories.changeUnitGroup(
+   *     'ug_01aad07abb8e41fd392d2d7013',
+   *     { id: 'ic_01ae7bd7bfd21ca0ab81e1357e' },
+   *   );
+   * ```
+   */
+  changeUnitGroup(
+    unitGroupID: string,
+    params: ItemCategoryChangeUnitGroupParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemCategoryChangeUnitGroupResponse> {
+    const { id } = params;
+    return this._client.put(path`/v1/catalog/item-categories/${id}/unit-groups/${unitGroupID}`, options);
+  }
+}
+
+/**
+ * Request to create an item category.
+ */
+export interface CreateItemCategoryRequest {
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Item category type. Material categories are used to group materials, while
+   * product categories are used to group products and parts.
+   */
+  type: 'material_category' | 'product_category';
+
+  /**
+   * Unit group ID.
+   */
+  unit_group_id: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListItemCategory {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ItemsAPI.ItemCategory>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Request to partially update an item category.
+ */
+export interface UpdateItemCategoryRequest {
+  /**
+   * Display name.
+   */
+  name?: string;
+
+  /**
+   * Notes.
+   */
+  notes?: string;
+}
+
+export interface ItemCategoryDeleteResponse {}
+
+export interface ItemCategoryChangeUnitGroupResponse {}
+
+export interface ItemCategoryCreateParams {
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Body param: Item category type. Material categories are used to group materials,
+   * while product categories are used to group products and parts.
+   */
+  type: 'material_category' | 'product_category';
+
+  /**
+   * Body 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<
+    | 'owner'
+    | 'owner.account'
+    | 'properties'
+    | 'unit_group'
+    | 'unit_group.base_unit'
+    | 'unit_group.associated_units'
+    | 'unit_group.associated_units.unit'
+  >;
+}
+
+export interface ItemCategoryRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'owner'
+    | 'owner.account'
+    | 'properties'
+    | 'unit_group'
+    | 'unit_group.base_unit'
+    | 'unit_group.associated_units'
+    | 'unit_group.associated_units.unit'
+  >;
+}
+
+export interface ItemCategoryUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'owner'
+    | 'owner.account'
+    | 'properties'
+    | 'unit_group'
+    | 'unit_group.base_unit'
+    | 'unit_group.associated_units'
+    | 'unit_group.associated_units.unit'
+  >;
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Notes.
+   */
+  notes?: string;
+}
+
+export interface ItemCategoryListParams {
+  /**
+   * 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'
+    | 'properties'
+    | 'unit_group'
+    | 'unit_group.base_unit'
+    | 'unit_group.associated_units'
+    | 'unit_group.associated_units.unit'
+  >;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Filter by item category type.
+   */
+  type?: 'material_category' | 'product_category';
+}
+
+export interface ItemCategoryChangeUnitGroupParams {
+  /**
+   * Item category ID.
+   */
+  id: string;
+}
+
+ItemCategories.Properties = Properties;
+
+export declare namespace ItemCategories {
+  export {
+    type CreateItemCategoryRequest as CreateItemCategoryRequest,
+    type ListItemCategory as ListItemCategory,
+    type UpdateItemCategoryRequest as UpdateItemCategoryRequest,
+    type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse,
+    type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse,
+    type ItemCategoryCreateParams as ItemCategoryCreateParams,
+    type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams,
+    type ItemCategoryUpdateParams as ItemCategoryUpdateParams,
+    type ItemCategoryListParams as ItemCategoryListParams,
+    type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams,
+  };
+
+  export {
+    Properties as Properties,
+    type PropertyUpdateResponse as PropertyUpdateResponse,
+    type PropertyDeleteResponse as PropertyDeleteResponse,
+    type PropertyUpdateParams as PropertyUpdateParams,
+    type PropertyDeleteParams as PropertyDeleteParams,
+  };
+}

package/src/resources/catalog/item-categories/properties.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage item categories.
+ */
+export class Properties extends APIResource {
+  /**
+   * Adds a property to an item category. Default system categories cannot be
+   * modified.
+   *
+   * @example
+   * ```ts
+   * const property =
+   *   await client.catalog.itemCategories.properties.update(
+   *     'pp_01e21344878064372f69e67093',
+   *     { id: 'ic_01ae7bd7bfd21ca0ab81e1357e' },
+   *   );
+   * ```
+   */
+  update(
+    propertyID: string,
+    params: PropertyUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PropertyUpdateResponse> {
+    const { id } = params;
+    return this._client.put(path`/v1/catalog/item-categories/${id}/properties/${propertyID}`, options);
+  }
+
+  /**
+   * Removes a property from an item category. Default system categories cannot be
+   * modified.
+   *
+   * @example
+   * ```ts
+   * const property =
+   *   await client.catalog.itemCategories.properties.delete(
+   *     'pp_01e21344878064372f69e67093',
+   *     { id: 'ic_01ae7bd7bfd21ca0ab81e1357e' },
+   *   );
+   * ```
+   */
+  delete(
+    propertyID: string,
+    params: PropertyDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<PropertyDeleteResponse> {
+    const { id } = params;
+    return this._client.delete(path`/v1/catalog/item-categories/${id}/properties/${propertyID}`, options);
+  }
+}
+
+export interface PropertyUpdateResponse {}
+
+export interface PropertyDeleteResponse {}
+
+export interface PropertyUpdateParams {
+  /**
+   * Item category ID.
+   */
+  id: string;
+}
+
+export interface PropertyDeleteParams {
+  /**
+   * Item category ID.
+   */
+  id: string;
+}
+
+export declare namespace Properties {
+  export {
+    type PropertyUpdateResponse as PropertyUpdateResponse,
+    type PropertyDeleteResponse as PropertyDeleteResponse,
+    type PropertyUpdateParams as PropertyUpdateParams,
+    type PropertyDeleteParams as PropertyDeleteParams,
+  };
+}

package/src/resources/catalog/item-categories.ts

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

package/src/resources/catalog/items/attributes.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ItemsAPI from './items';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage inventory items.
+ */
+export class Attributes extends APIResource {
+  /**
+   * Adds an attribute to an item. If the attribute is already associated with the
+   * item, this is a no-op.
+   *
+   * @example
+   * ```ts
+   * const item = await client.catalog.items.attributes.update(
+   *   'at_01c9493ec0c46bb0ed12708ae4',
+   *   { id: 'it_0131e386ac683e8c29a71f6f1f' },
+   * );
+   * ```
+   */
+  update(
+    attributeID: string,
+    params: AttributeUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemsAPI.Item> {
+    const { id, include } = params;
+    return this._client.put(path`/v1/catalog/items/${id}/attributes/${attributeID}`, {
+      query: { include },
+      ...options,
+    });
+  }
+
+  /**
+   * Removes an attribute from an item.
+   *
+   * @example
+   * ```ts
+   * const item = await client.catalog.items.attributes.delete(
+   *   'at_01c9493ec0c46bb0ed12708ae4',
+   *   { id: 'it_0131e386ac683e8c29a71f6f1f' },
+   * );
+   * ```
+   */
+  delete(
+    attributeID: string,
+    params: AttributeDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemsAPI.Item> {
+    const { id, include } = params;
+    return this._client.delete(path`/v1/catalog/items/${id}/attributes/${attributeID}`, {
+      query: { include },
+      ...options,
+    });
+  }
+}
+
+export interface AttributeUpdateParams {
+  /**
+   * Path param: Item ID.
+   */
+  id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'category'
+    | 'unit_value'
+    | 'unit_cost'
+    | 'burn_rate'
+    | 'attributes'
+    | 'category.unit_group'
+    | 'category.properties'
+    | 'category.unit_group.base_unit'
+    | 'category.unit_group.associated_units'
+    | 'category.unit_group.associated_units.unit'
+  >;
+}
+
+export interface AttributeDeleteParams {
+  /**
+   * Path param: Item ID.
+   */
+  id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'category'
+    | 'unit_value'
+    | 'unit_cost'
+    | 'burn_rate'
+    | 'attributes'
+    | 'category.unit_group'
+    | 'category.properties'
+    | 'category.unit_group.base_unit'
+    | 'category.unit_group.associated_units'
+    | 'category.unit_group.associated_units.unit'
+  >;
+}
+
+export declare namespace Attributes {
+  export {
+    type AttributeUpdateParams as AttributeUpdateParams,
+    type AttributeDeleteParams as AttributeDeleteParams,
+  };
+}

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

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Attributes, type AttributeUpdateParams, type AttributeDeleteParams } from './attributes';
+export {
+  Items,
+  type Item,
+  type ItemCategory,
+  type ItemInventory,
+  type ListItem,
+  type Quantity,
+  type Rate,
+  type ItemRetrieveParams,
+  type ItemListParams,
+  type ItemChangeCategoryParams,
+  type ItemRetrieveInventoryParams,
+} from './items';