@augno/sdk 0.13.4 → 0.14.0

package/resources/catalog/products/products.js

@@ -0,0 +1,185 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Products = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ActionsAPI = tslib_1.__importStar(require("./actions.js"));
+const actions_1 = require("./actions.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * List and manage products.
+ */
+class Products extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * Returns a paginated list of products for the target account, newest first.
+     *
+     * Only products of type `sale` are listed — service, shipping, credit, return, and
+     * tax products are excluded and must be retrieved by ID. A request made by a
+     * customer-portal buyer always returns portal-visible products only, and its
+     * `customer_ids` filter is replaced with the buyer's own account, so the results
+     * reflect what that account is entitled to buy.
+     *
+     * The `q` search term is matched against the SKU and description of each product's
+     * item; when it is supplied, products whose SKU matches are returned ahead of the
+     * rest.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listProduct = await client.catalog.products.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/products', { query, ...options });
+    }
+    /**
+     * Returns a product by ID.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.retrieve(
+     *   'pd_07oe0r7adh2w',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/catalog/products/${id}`, { query, ...options });
+    }
+    /**
+     * Creates a product and its backing inventory item.
+     *
+     * The new item starts with zero on-hand inventory, and its pricing defaults to
+     * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
+     * provided.
+     *
+     * Only products of type `sale` appear in the product list and export; products
+     * created with any other type are still usable on orders and invoices but must be
+     * retrieved by ID.
+     *
+     * This endpoint requires the permission: `items:create`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.create({
+     *   category_id: 'ic_d06g9c6yc9ck',
+     *   sku: 'ALM-2024-1001',
+     *   type: 'sale',
+     *   attribute_ids: ['at_rf1w295jt5ia'],
+     *   description:
+     *     'Wireless barcode scanner with charging cradle',
+     *   notes:
+     *     'Ships with a 2-year warranty; register for extended coverage.',
+     *   portal_visibility: 'visible',
+     *   product_line_id: 'pdln_k9bnlgvxhxjh',
+     *   unit_cost: {
+     *     value: '112.00',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_price: {
+     *     value: '199.00',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
+    }
+    /**
+     * Partially updates a product.
+     *
+     * `sku`, `description`, `notes`, and `unit_price` all live on the product's
+     * backing item and are written there, so the change is visible on the item as
+     * well. The product line is reassigned through its own endpoint, and the product
+     * type cannot be changed after creation.
+     *
+     * This endpoint requires the permission: `items:update`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.update(
+     *   'pd_07oe0r7adh2w',
+     *   {
+     *     description:
+     *       'Wireless barcode scanner with charging cradle (v2)',
+     *     notes:
+     *       'Firmware 2.1 improves Bluetooth pairing reliability.',
+     *     portal_visibility: 'visible',
+     *     sku: 'SKU-002',
+     *     unit_price: {
+     *       value: '219.00',
+     *       numerator_unit_id: 'un_82bd37dae5po',
+     *       denominator_unit_id: 'un_82bd37dae5po',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
+    }
+    /**
+     * Soft-deletes a product and returns it as it stood at deletion.
+     *
+     * Deletion marks the product's backing item as deleted, so the item and its
+     * inventory drop out of catalog and inventory listings too. Deleting the same
+     * product again returns an error saying it has already been deleted.
+     *
+     * This endpoint requires the permission: `items:delete`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.delete(
+     *   'pd_07oe0r7adh2w',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.delete((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, ...options });
+    }
+    /**
+     * Moves a product to a different product line.
+     *
+     * The target product line must be one your account owns or a shared system line;
+     * anything else fails as not found. Because customer accounts are granted access
+     * to whole product lines, moving a product changes which buyers can see and order
+     * it in the customer portal, and which default commission and freight policies
+     * apply to it.
+     *
+     * This endpoint requires the permission: `items:update`.
+     *
+     * @example
+     * ```ts
+     * const product =
+     *   await client.catalog.products.changeProductLine(
+     *     'pdln_k9bnlgvxhxjh',
+     *     { id: 'pd_07oe0r7adh2w' },
+     *   );
+     * ```
+     */
+    changeProductLine(productLineID, params, options) {
+        const { id, include } = params;
+        return this._client.put((0, path_1.path) `/v1/catalog/products/${id}/product-line/${productLineID}`, {
+            query: { include },
+            ...options,
+        });
+    }
+}
+exports.Products = Products;
+Products.Actions = actions_1.Actions;
+//# sourceMappingURL=products.js.map

package/resources/catalog/products/products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../../src/resources/catalog/products/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAKrD,iEAAwC;AACxC,0CAMmB;AAGnB,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2LrE,CAAC;IAzLC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA5LD,4BA4LC;AAskBD,QAAQ,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/catalog/products/products.mjs

@@ -0,0 +1,180 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { Actions, } from "./actions.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * List and manage products.
+ */
+export class Products extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * Returns a paginated list of products for the target account, newest first.
+     *
+     * Only products of type `sale` are listed — service, shipping, credit, return, and
+     * tax products are excluded and must be retrieved by ID. A request made by a
+     * customer-portal buyer always returns portal-visible products only, and its
+     * `customer_ids` filter is replaced with the buyer's own account, so the results
+     * reflect what that account is entitled to buy.
+     *
+     * The `q` search term is matched against the SKU and description of each product's
+     * item; when it is supplied, products whose SKU matches are returned ahead of the
+     * rest.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listProduct = await client.catalog.products.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/products', { query, ...options });
+    }
+    /**
+     * Returns a product by ID.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.retrieve(
+     *   'pd_07oe0r7adh2w',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/v1/catalog/products/${id}`, { query, ...options });
+    }
+    /**
+     * Creates a product and its backing inventory item.
+     *
+     * The new item starts with zero on-hand inventory, and its pricing defaults to
+     * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
+     * provided.
+     *
+     * Only products of type `sale` appear in the product list and export; products
+     * created with any other type are still usable on orders and invoices but must be
+     * retrieved by ID.
+     *
+     * This endpoint requires the permission: `items:create`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.create({
+     *   category_id: 'ic_d06g9c6yc9ck',
+     *   sku: 'ALM-2024-1001',
+     *   type: 'sale',
+     *   attribute_ids: ['at_rf1w295jt5ia'],
+     *   description:
+     *     'Wireless barcode scanner with charging cradle',
+     *   notes:
+     *     'Ships with a 2-year warranty; register for extended coverage.',
+     *   portal_visibility: 'visible',
+     *   product_line_id: 'pdln_k9bnlgvxhxjh',
+     *   unit_cost: {
+     *     value: '112.00',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_price: {
+     *     value: '199.00',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
+    }
+    /**
+     * Partially updates a product.
+     *
+     * `sku`, `description`, `notes`, and `unit_price` all live on the product's
+     * backing item and are written there, so the change is visible on the item as
+     * well. The product line is reassigned through its own endpoint, and the product
+     * type cannot be changed after creation.
+     *
+     * This endpoint requires the permission: `items:update`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.update(
+     *   'pd_07oe0r7adh2w',
+     *   {
+     *     description:
+     *       'Wireless barcode scanner with charging cradle (v2)',
+     *     notes:
+     *       'Firmware 2.1 improves Bluetooth pairing reliability.',
+     *     portal_visibility: 'visible',
+     *     sku: 'SKU-002',
+     *     unit_price: {
+     *       value: '219.00',
+     *       numerator_unit_id: 'un_82bd37dae5po',
+     *       denominator_unit_id: 'un_82bd37dae5po',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
+    }
+    /**
+     * Soft-deletes a product and returns it as it stood at deletion.
+     *
+     * Deletion marks the product's backing item as deleted, so the item and its
+     * inventory drop out of catalog and inventory listings too. Deleting the same
+     * product again returns an error saying it has already been deleted.
+     *
+     * This endpoint requires the permission: `items:delete`.
+     *
+     * @example
+     * ```ts
+     * const product = await client.catalog.products.delete(
+     *   'pd_07oe0r7adh2w',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.delete(path `/v1/catalog/products/${id}`, { query: { include }, ...options });
+    }
+    /**
+     * Moves a product to a different product line.
+     *
+     * The target product line must be one your account owns or a shared system line;
+     * anything else fails as not found. Because customer accounts are granted access
+     * to whole product lines, moving a product changes which buyers can see and order
+     * it in the customer portal, and which default commission and freight policies
+     * apply to it.
+     *
+     * This endpoint requires the permission: `items:update`.
+     *
+     * @example
+     * ```ts
+     * const product =
+     *   await client.catalog.products.changeProductLine(
+     *     'pdln_k9bnlgvxhxjh',
+     *     { id: 'pd_07oe0r7adh2w' },
+     *   );
+     * ```
+     */
+    changeProductLine(productLineID, params, options) {
+        const { id, include } = params;
+        return this._client.put(path `/v1/catalog/products/${id}/product-line/${productLineID}`, {
+            query: { include },
+            ...options,
+        });
+    }
+}
+Products.Actions = Actions;
+//# sourceMappingURL=products.mjs.map

package/resources/catalog/products/products.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/products/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,KAAK,UAAU;OACf,EAEL,OAAO,GAIR;OAGM,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2LrE,CAAC;IAzLC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAskBD,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC"}