@augno/sdk 0.1.6

package/src/resources/catalog/parts.ts

@@ -0,0 +1,358 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MaterialsAPI from './materials';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
+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 parts.
+ */
+export class Parts extends APIResource {
+  /**
+   * Creates a part with the specified SKU and category.
+   *
+   * @example
+   * ```ts
+   * const part = await client.catalog.parts.create({
+   *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+   *   sku: 'BRG-6204-2RS',
+   * });
+   * ```
+   */
+  create(params: PartCreateParams, options?: RequestOptions): APIPromise<Part> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/parts', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a part by ID.
+   *
+   * @example
+   * ```ts
+   * const part = await client.catalog.parts.retrieve(
+   *   'pt_018d7bab53e864351f4c693a21',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: PartRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Part> {
+    return this._client.get(path`/v1/catalog/parts/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a part. Fields not provided retain their current values.
+   *
+   * @example
+   * ```ts
+   * const part = await client.catalog.parts.update(
+   *   'pt_018d7bab53e864351f4c693a21',
+   *   { sku: 'BRG-6204-2RS' },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: PartUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Part> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/catalog/parts/${id}`, { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of parts for the current account.
+   *
+   * @example
+   * ```ts
+   * const listPart = await client.catalog.parts.list();
+   * ```
+   */
+  list(query: PartListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListPart> {
+    return this._client.get('/v1/catalog/parts', { query, ...options });
+  }
+
+  /**
+   * Deletes a part. Sets the deleted_at timestamp rather than removing the record.
+   *
+   * @example
+   * ```ts
+   * const part = await client.catalog.parts.delete(
+   *   'pt_018d7bab53e864351f4c693a21',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<Part> {
+    return this._client.delete(path`/v1/catalog/parts/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a part.
+ */
+export interface CreatePartRequest {
+  /**
+   * Category ID.
+   */
+  category_id: string;
+
+  /**
+   * SKU.
+   */
+  sku: string;
+
+  /**
+   * Attribute IDs to connect to the part at creation time.
+   */
+  attribute_ids?: Array<string>;
+
+  /**
+   * Description.
+   */
+  description?: string | null;
+
+  /**
+   * Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * Initial unit cost. Same currency rule as unit_price.
+   */
+  unit_cost?: MaterialsAPI.RateInput | null;
+
+  /**
+   * Initial unit price. When set, numerator must be a currency unit and denominator
+   * must not be.
+   */
+  unit_price?: MaterialsAPI.RateInput | null;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListPart {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Part>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Part resource.
+ */
+export interface Part {
+  /**
+   * Part ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Item is an inventory item (product, material, or part).
+   */
+  item: ItemsAPI.Item | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'part';
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to partially update a part.
+ */
+export interface UpdatePartRequest {
+  /**
+   * Description.
+   */
+  description?: string | null;
+
+  /**
+   * Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * SKU.
+   */
+  sku?: string;
+}
+
+export interface PartCreateParams {
+  /**
+   * Body param: Category ID.
+   */
+  category_id: string;
+
+  /**
+   * Body param: SKU.
+   */
+  sku: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'
+  >;
+
+  /**
+   * Body param: Attribute IDs to connect to the part at creation time.
+   */
+  attribute_ids?: Array<string>;
+
+  /**
+   * Body param: Description.
+   */
+  description?: string | null;
+
+  /**
+   * Body param: Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * Body param: Initial unit cost. Same currency rule as unit_price.
+   */
+  unit_cost?: MaterialsAPI.RateInput | null;
+
+  /**
+   * Body param: Initial unit price. When set, numerator must be a currency unit and
+   * denominator must not be.
+   */
+  unit_price?: MaterialsAPI.RateInput | null;
+}
+
+export interface PartRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'item'
+    | 'item.category'
+    | 'item.category.properties'
+    | 'item.category.unit_group'
+    | 'item.unit_value'
+    | 'item.unit_cost'
+    | 'item.burn_rate'
+    | 'item.attributes'
+  >;
+}
+
+export interface PartUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'
+  >;
+
+  /**
+   * Body param: Description.
+   */
+  description?: string | null;
+
+  /**
+   * Body param: Notes.
+   */
+  notes?: string | null;
+
+  /**
+   * Body param: SKU.
+   */
+  sku?: string;
+}
+
+export interface PartListParams {
+  /**
+   * Filter by attribute IDs.
+   */
+  attribute_ids?: Array<string>;
+
+  /**
+   * Filter by category IDs.
+   */
+  category_ids?: Array<string>;
+
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Filter parts created on or before this date.
+   */
+  end_date?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'item'
+    | 'item.category'
+    | 'item.category.properties'
+    | 'item.category.unit_group'
+    | 'item.unit_value'
+    | 'item.unit_cost'
+    | 'item.burn_rate'
+    | 'item.attributes'
+  >;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Filter parts created on or after this date.
+   */
+  start_date?: string;
+}
+
+export declare namespace Parts {
+  export {
+    type CreatePartRequest as CreatePartRequest,
+    type ListPart as ListPart,
+    type Part as Part,
+    type UpdatePartRequest as UpdatePartRequest,
+    type PartCreateParams as PartCreateParams,
+    type PartRetrieveParams as PartRetrieveParams,
+    type PartUpdateParams as PartUpdateParams,
+    type PartListParams as PartListParams,
+  };
+}

package/src/resources/catalog/product-lines.ts

@@ -0,0 +1,348 @@
+// 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 UnitGroupsAPI from './unit-groups/unit-groups';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and manage product lines.
+ */
+export class ProductLines extends APIResource {
+  /**
+   * Creates an account-owned product line.
+   *
+   * @example
+   * ```ts
+   * const productLine =
+   *   await client.catalog.productLines.create({
+   *     commission_policy: 'commission_exempt',
+   *     freight_policy: 'billed_freight',
+   *     name: 'Industrial Fasteners',
+   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *   });
+   * ```
+   */
+  create(params: ProductLineCreateParams, options?: RequestOptions): APIPromise<ProductLine> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/product-lines', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a product line by ID, including system-owned product lines accessible to
+   * the account.
+   *
+   * @example
+   * ```ts
+   * const productLine =
+   *   await client.catalog.productLines.retrieve(
+   *     'pl_01996357326a0d3f7b129542ea',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: ProductLineRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductLine> {
+    return this._client.get(path`/v1/catalog/product-lines/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates an account-owned product line. Default system product lines
+   * cannot be updated.
+   *
+   * @example
+   * ```ts
+   * const productLine =
+   *   await client.catalog.productLines.update(
+   *     'pl_01996357326a0d3f7b129542ea',
+   *     { name: 'Updated Product Line' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: ProductLineUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductLine> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/catalog/product-lines/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of product lines, including account-owned and system
+   * product lines.
+   *
+   * @example
+   * ```ts
+   * const listProductLine =
+   *   await client.catalog.productLines.list();
+   * ```
+   */
+  list(
+    query: ProductLineListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListProductLine> {
+    return this._client.get('/v1/catalog/product-lines', { query, ...options });
+  }
+
+  /**
+   * Deletes an account-owned product line. Default system product lines cannot be
+   * deleted.
+   *
+   * @example
+   * ```ts
+   * const productLine =
+   *   await client.catalog.productLines.delete(
+   *     'pl_01996357326a0d3f7b129542ea',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<ProductLineDeleteResponse> {
+    return this._client.delete(path`/v1/catalog/product-lines/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a product line.
+ */
+export interface CreateProductLineRequest {
+  /**
+   * Commission policy of products in this product line.
+   */
+  commission_policy: 'commission_applied' | 'commission_exempt';
+
+  /**
+   * Freight policy for all items in this product line.
+   */
+  freight_policy: 'free_freight' | 'billed_freight';
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Unit group ID associated with this product line. This unit group dictates the
+   * units that products in this product line may be purchased in.
+   */
+  unit_group_id: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListProductLine {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ProductLine>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Product line resource.
+ */
+export interface ProductLine {
+  /**
+   * Product line ID.
+   */
+  id: string;
+
+  /**
+   * Commission policy of products in this product line.
+   */
+  commission_policy: 'commission_applied' | 'commission_exempt';
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Description.
+   */
+  description: string | null;
+
+  /**
+   * Freight policy for all items in this product line.
+   */
+  freight_policy: 'free_freight' | 'billed_freight';
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Notes.
+   */
+  notes: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'product_line';
+
+  /**
+   * Owner describes the provenance of a resource.
+   */
+  owner: APIKeysAPI.Owner | null;
+
+  /**
+   * UnitGroup is a unit group resource.
+   */
+  unit_group: UnitGroupsAPI.UnitGroup | null;
+
+  /**
+   * Last-updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to partially update a product line.
+ */
+export interface UpdateProductLineRequest {
+  /**
+   * Commission policy of products in this product line.
+   */
+  commission_policy?: 'commission_applied' | 'commission_exempt';
+
+  /**
+   * Freight policy for all items in this product line.
+   */
+  freight_policy?: 'free_freight' | 'billed_freight';
+
+  /**
+   * Display name.
+   */
+  name?: string;
+
+  /**
+   * Unit group ID associated with this product line. This unit group dictates the
+   * units that products in this product line may be purchased in.
+   */
+  unit_group_id?: string;
+}
+
+export interface ProductLineDeleteResponse {}
+
+export interface ProductLineCreateParams {
+  /**
+   * Body param: Commission policy of products in this product line.
+   */
+  commission_policy: 'commission_applied' | 'commission_exempt';
+
+  /**
+   * Body param: Freight policy for all items in this product line.
+   */
+  freight_policy: 'free_freight' | 'billed_freight';
+
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Body param: Unit group ID associated with this product line. This unit group
+   * dictates the units that products in this product line may be purchased in.
+   */
+  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' | 'unit_group'>;
+}
+
+export interface ProductLineRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+}
+
+export interface ProductLineUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+
+  /**
+   * Body param: Commission policy of products in this product line.
+   */
+  commission_policy?: 'commission_applied' | 'commission_exempt';
+
+  /**
+   * Body param: Freight policy for all items in this product line.
+   */
+  freight_policy?: 'free_freight' | 'billed_freight';
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Unit group ID associated with this product line. This unit group
+   * dictates the units that products in this product line may be purchased in.
+   */
+  unit_group_id?: string;
+}
+
+export interface ProductLineListParams {
+  /**
+   * 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' | 'unit_group'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+export declare namespace ProductLines {
+  export {
+    type CreateProductLineRequest as CreateProductLineRequest,
+    type ListProductLine as ListProductLine,
+    type ProductLine as ProductLine,
+    type UpdateProductLineRequest as UpdateProductLineRequest,
+    type ProductLineDeleteResponse as ProductLineDeleteResponse,
+    type ProductLineCreateParams as ProductLineCreateParams,
+    type ProductLineRetrieveParams as ProductLineRetrieveParams,
+    type ProductLineUpdateParams as ProductLineUpdateParams,
+    type ProductLineListParams as ProductLineListParams,
+  };
+}