@augno/sdk 0.7.0 → 0.7.1

package/src/resources/catalog/materials.ts

@@ -14,6 +14,9 @@ export class Materials extends APIResource {
   /**
    * Returns a paginated list of materials.
    *
+   * This endpoint requires the permissions: `materials:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listMaterial = await client.catalog.materials.list();
@@ -29,6 +32,9 @@ export class Materials extends APIResource {
   /**
    * Returns a material by ID.
    *
+   * This endpoint requires the permissions: `materials:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.retrieve(
@@ -50,6 +56,9 @@ export class Materials extends APIResource {
    * Inventory tracking for the new material starts at a zero on-hand quantity in the
    * category's base unit.
    *
+   * This endpoint requires the permissions: `materials:create`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.create({
@@ -68,6 +77,9 @@ export class Materials extends APIResource {
    *
    * Fields not provided retain their current values.
    *
+   * This endpoint requires the permissions: `materials:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.update(
@@ -92,6 +104,9 @@ export class Materials extends APIResource {
    * other endpoints, but the record is retained. Deleting an already-deleted
    * material returns an error.
    *
+   * This endpoint requires the permissions: `materials:delete`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.delete(
@@ -135,7 +150,7 @@ export interface CreateMaterialRequest {
   description?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -145,7 +160,7 @@ export interface CreateMaterialRequest {
   notes?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -228,7 +243,7 @@ export interface Material {
 }
 
 /**
- * QuantityInputRequest is a quantity value and unit.
+ * A quantity, given as a decimal value and the unit it is measured in.
  */
 export interface QuantityInputRequest {
   /**
@@ -274,7 +289,7 @@ export interface UpdateMaterialRequest {
   description?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -284,7 +299,7 @@ export interface UpdateMaterialRequest {
   notes?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -421,7 +436,7 @@ export interface MaterialCreateParams {
   description?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -431,7 +446,7 @@ export interface MaterialCreateParams {
   notes?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -470,7 +485,7 @@ export interface MaterialUpdateParams {
   description?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -480,7 +495,7 @@ export interface MaterialUpdateParams {
   notes?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 

package/src/resources/catalog/parts.ts

@@ -15,6 +15,9 @@ export class Parts extends APIResource {
   /**
    * Returns a paginated list of parts for the current account.
    *
+   * This endpoint requires the permissions: `parts:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listPart = await client.catalog.parts.list();
@@ -27,6 +30,9 @@ export class Parts extends APIResource {
   /**
    * Returns a part by ID.
    *
+   * This endpoint requires the permissions: `parts:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.retrieve(
@@ -48,6 +54,9 @@ export class Parts extends APIResource {
    * Inventory tracking for the new part starts at a zero on-hand quantity in the
    * category's base unit.
    *
+   * This endpoint requires the permissions: `parts:create`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.create({
@@ -67,6 +76,9 @@ export class Parts extends APIResource {
    *
    * Fields not provided retain their current values.
    *
+   * This endpoint requires the permissions: `parts:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.update(
@@ -94,6 +106,9 @@ export class Parts extends APIResource {
    * other endpoints, but the record is retained. Deleting an already-deleted part
    * returns an error.
    *
+   * This endpoint requires the permissions: `parts:delete`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.delete(

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

@@ -15,6 +15,9 @@ export class ProductLines extends APIResource {
    * Returns a paginated list of product lines, including account-owned and system
    * product lines.
    *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listProductLine =
@@ -32,6 +35,9 @@ export class ProductLines extends APIResource {
    * Returns a product line by ID, including system-owned product lines accessible to
    * the account.
    *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -51,6 +57,8 @@ export class ProductLines extends APIResource {
   /**
    * Creates an account-owned product line.
    *
+   * This endpoint requires the permission: `product_lines:create`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -73,6 +81,8 @@ export class ProductLines extends APIResource {
    * Only the provided fields are changed. The reserved default product lines
    * (shipping, service, credit, tax) cannot be updated.
    *
+   * This endpoint requires the permission: `product_lines:update`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -101,6 +111,8 @@ export class ProductLines extends APIResource {
    * The reserved default product lines (shipping, service, credit, tax) cannot be
    * deleted.
    *
+   * This endpoint requires the permission: `product_lines:delete`.
+   *
    * @example
    * ```ts
    * const productLine =

package/src/resources/catalog/products.ts

@@ -16,6 +16,9 @@ export class Products extends APIResource {
   /**
    * Returns a paginated list of products for the target account.
    *
+   * This endpoint requires the permissions: `items:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listProduct = await client.catalog.products.list();
@@ -28,6 +31,9 @@ export class Products extends APIResource {
   /**
    * 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(
@@ -50,6 +56,8 @@ export class Products extends APIResource {
    * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
    * provided.
    *
+   * This endpoint requires the permission: `items:create`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.create({
@@ -67,6 +75,8 @@ export class Products extends APIResource {
   /**
    * Partially updates a product.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.update(
@@ -87,6 +97,8 @@ export class Products extends APIResource {
   /**
    * Soft-deletes a product and returns the deleted product.
    *
+   * This endpoint requires the permission: `items:delete`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.delete(
@@ -106,6 +118,8 @@ export class Products extends APIResource {
   /**
    * Changes the product line assignment for a product.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const product =
@@ -167,12 +181,12 @@ export interface CreateProductRequest {
   attribute_ids?: Array<string>;
 
   /**
-   * Description.
+   * Free-form description of the product.
    */
   description?: string;
 
   /**
-   * Notes.
+   * Free-form notes about the product.
    */
   notes?: string;
 
@@ -292,14 +306,14 @@ export interface Product {
  */
 export interface UpdateProductRequest {
   /**
-   * Description.
+   * Free-form description of the product.
    *
    * Send `null` to clear.
    */
   description?: string | null;
 
   /**
-   * Notes.
+   * Free-form notes about the product.
    *
    * Send `null` to clear.
    */
@@ -494,12 +508,12 @@ export interface ProductCreateParams {
   attribute_ids?: Array<string>;
 
   /**
-   * Body param: Description.
+   * Body param: Free-form description of the product.
    */
   description?: string;
 
   /**
-   * Body param: Notes.
+   * Body param: Free-form notes about the product.
    */
   notes?: string;
 
@@ -558,14 +572,14 @@ export interface ProductUpdateParams {
   >;
 
   /**
-   * Body param: Description.
+   * Body param: Free-form description of the product.
    *
    * Send `null` to clear.
    */
   description?: string | null;
 
   /**
-   * Body param: Notes.
+   * Body param: Free-form notes about the product.
    *
    * Send `null` to clear.
    */

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

@@ -13,6 +13,8 @@ export class Attributes extends APIResource {
   /**
    * Returns a paginated list of attributes for a property.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const listAttribute =
@@ -32,6 +34,8 @@ export class Attributes extends APIResource {
   /**
    * Returns an attribute by ID within a property.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -53,6 +57,8 @@ export class Attributes extends APIResource {
   /**
    * Creates an attribute under a property.
    *
+   * This endpoint requires the permission: `properties:create`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -77,6 +83,8 @@ export class Attributes extends APIResource {
   /**
    * Partially updates an attribute.
    *
+   * This endpoint requires the permission: `properties:update`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -107,6 +115,8 @@ export class Attributes extends APIResource {
    * Remaining attributes in the property are shifted so their sort orders stay
    * contiguous.
    *
+   * This endpoint requires the permission: `properties:delete`.
+   *
    * @example
    * ```ts
    * const attribute =

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

@@ -27,6 +27,8 @@ export class Properties extends APIResource {
   /**
    * Returns a paginated list of properties for the target account.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const listProperty = await client.catalog.properties.list();
@@ -42,6 +44,8 @@ export class Properties extends APIResource {
   /**
    * Returns a property by ID.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.retrieve(
@@ -60,6 +64,8 @@ export class Properties extends APIResource {
   /**
    * Creates a property.
    *
+   * This endpoint requires the permission: `properties:create`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.create({
@@ -75,6 +81,8 @@ export class Properties extends APIResource {
   /**
    * Partially updates a property.
    *
+   * This endpoint requires the permission: `properties:update`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.update(
@@ -95,6 +103,8 @@ export class Properties extends APIResource {
   /**
    * Deletes a property and all associated attributes.
    *
+   * This endpoint requires the permission: `properties:delete`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.delete(

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

@@ -28,6 +28,8 @@ export class UnitGroups extends APIResource {
   /**
    * Returns a paginated list of unit groups, including system unit groups.
    *
+   * This endpoint requires the permission: `unit_groups:read`.
+   *
    * @example
    * ```ts
    * const listUnitGroup =
@@ -44,6 +46,8 @@ export class UnitGroups extends APIResource {
   /**
    * Returns a unit group by ID.
    *
+   * This endpoint requires the permission: `unit_groups:read`.
+   *
    * @example
    * ```ts
    * const unitGroup = await client.catalog.unitGroups.retrieve(
@@ -62,6 +66,8 @@ export class UnitGroups extends APIResource {
   /**
    * Creates a unit group with optional associated units.
    *
+   * This endpoint requires the permission: `unit_groups:create`.
+   *
    * @example
    * ```ts
    * const unitGroup = await client.catalog.unitGroups.create({
@@ -87,6 +93,8 @@ export class UnitGroups extends APIResource {
   /**
    * Partially updates a unit group. System unit groups cannot be updated.
    *
+   * This endpoint requires the permission: `unit_groups:update`.
+   *
    * @example
    * ```ts
    * const unitGroup = await client.catalog.unitGroups.update(
@@ -108,8 +116,10 @@ export class UnitGroups extends APIResource {
   }
 
   /**
-   * Deletes a unit group and all associated unit conversions. System unit groups
-   * cannot be deleted.
+   * Deletes a unit group and all of its associated units. System unit groups cannot
+   * be deleted.
+   *
+   * This endpoint requires the permission: `unit_groups:delete`.
    *
    * @example
    * ```ts
@@ -140,7 +150,7 @@ export interface CreateUnitGroupRequest {
   name: string;
 
   /**
-   * Dimension shared by every unit in this group (e.g. `mass`, `volume`).
+   * Dimension shared by every unit in this group.
    *
    * All associated units must be of this dimension.
    */
@@ -252,7 +262,9 @@ export interface UnitGroup {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name of the unit group.
+   *
+   * Unique within the account.
    */
   name: string;
 
@@ -396,7 +408,7 @@ export interface UnitGroupListParams {
   q?: string;
 
   /**
-   * Filter by unit dimension (e.g. `mass`).
+   * Filter by unit dimension.
    */
   type?: 'currency' | 'quantity' | 'time' | 'mass' | 'volume' | 'length' | 'temperature' | 'area';
 }
@@ -423,8 +435,7 @@ export interface UnitGroupCreateParams {
   name: string;
 
   /**
-   * Body param: Dimension shared by every unit in this group (e.g. `mass`,
-   * `volume`).
+   * Body param: Dimension shared by every unit in this group.
    *
    * All associated units must be of this dimension.
    */

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

@@ -13,6 +13,8 @@ export class Units extends APIResource {
   /**
    * Returns a list of associated units within a unit group.
    *
+   * This endpoint requires the permission: `unit_groups:read`.
+   *
    * @example
    * ```ts
    * const listUnitGroupUnit =
@@ -32,6 +34,8 @@ export class Units extends APIResource {
   /**
    * Returns an associated unit within a unit group by ID.
    *
+   * This endpoint requires the permission: `unit_groups:read`.
+   *
    * @example
    * ```ts
    * const unitGroupUnit =
@@ -57,6 +61,8 @@ export class Units extends APIResource {
    * Adds a unit to a unit group. If the unit is already in the group, its existing
    * association is updated with the provided settings instead.
    *
+   * This endpoint requires the permission: `unit_groups:update`.
+   *
    * @example
    * ```ts
    * const unitGroupUnit =
@@ -86,6 +92,8 @@ export class Units extends APIResource {
   /**
    * Partially updates an associated unit within a unit group.
    *
+   * This endpoint requires the permission: `unit_groups:update`.
+   *
    * @example
    * ```ts
    * const unitGroupUnit =
@@ -115,6 +123,8 @@ export class Units extends APIResource {
   /**
    * Removes a unit from a unit group. The unit itself is not deleted.
    *
+   * This endpoint requires the permission: `unit_groups:delete`.
+   *
    * @example
    * ```ts
    * const unit = await client.catalog.unitGroups.units.delete(