@augno/sdk 0.18.1 → 0.19.0

package/src/resources/sales/customers/customers.ts

@@ -2,8 +2,9 @@
 
 import { APIResource } from '../../../core/resource';
 import * as CoreAPI from '../../core/core';
+import * as AccountGroupsAPI from '../account-groups';
 import * as AddressesAPI from '../addresses';
-import * as ProductLinesAPI from '../../catalog/product-lines/product-lines';
+import * as InventoryAPI from '../../catalog/items/inventory';
 import * as AccountPricesAPI from '../account-prices/account-prices';
 import * as ActionsAPI from './actions';
 import { ActionMergeParams, Actions, MergeCustomersRequest } from './actions';
@@ -181,9 +182,14 @@ export class Customers extends APIResource {
    * to.
    *
    * Resolved through the same chain the issue path stamps onto an order, most
-   * specific first: a lead time set on the customer, then on the customer's account
-   * group, then the account-wide default. `source` names which rule applied, so a
-   * form can show where the number came from rather than leaving a rep to guess.
+   * specific first: a lead time set on the customer, then on its parent account,
+   * then on the customer's account group, then the account-wide default. `source`
+   * names which rule applied, so a form can show where the number came from rather
+   * than leaving a rep to guess.
+   *
+   * A lead time set on a parent account therefore governs every child account under
+   * it that has not set its own, which is how a head office's terms are given to its
+   * locations without repeating them on each one.
    *
    * This is a preview of a commitment, not the commitment itself. An order takes its
    * own `ship_by_date` when it is issued and keeps it afterwards, so changing a lead
@@ -200,8 +206,12 @@ export class Customers extends APIResource {
    *   );
    * ```
    */
-  retrieveLeadTime(id: string, options?: RequestOptions): APIPromise<CustomerLeadTime> {
-    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, options);
+  retrieveLeadTime(
+    id: string,
+    query: CustomerRetrieveLeadTimeParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerLeadTime> {
+    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, { query, ...options });
   }
 }
 
@@ -285,7 +295,7 @@ export interface CreateCustomerRequest {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  credit_limit?: ProductLinesAPI.QuantityInput;
+  credit_limit?: InventoryAPI.QuantityInput;
 
   /**
    * IDs of the account groups of type `pricing_group` to assign to this customer,
@@ -337,7 +347,8 @@ export interface CreateCustomerRequest {
    * Calendar days between an order being issued and it being due to ship.
    *
    * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number;
 
@@ -391,9 +402,15 @@ export interface CreateCustomerRequest {
  */
 export interface CustomerLeadTime {
   /**
-   * Entity is a polymorphic reference to any resource in the system.
+   * A named grouping of customer accounts, used for pricing rules or to categorize
+   * accounts.
+   *
+   * A customer carries at most one group of type `type_group` as its customer type,
+   * plus any number of groups of type `pricing_group`. Membership of either kind can
+   * scope a volume discount to the customer and open up product lines for it to
+   * order from.
    */
-  account_group: CoreAPI.Entity | null;
+  account_group: AccountGroupsAPI.AccountGroup | null;
 
   /**
    * Entity is a polymorphic reference to any resource in the system.
@@ -412,10 +429,17 @@ export interface CustomerLeadTime {
    */
   object: 'customer_lead_time';
 
+  /**
+   * A business you sell to, with its contact details, default fulfillment settings,
+   * and order policies.
+   */
+  parent_customer: AccountPricesAPI.Customer | null;
+
   /**
    * Which rule in the chain produced this lead time.
    *
    * - `customer`: a lead time set on the customer itself.
+   * - `parent_customer`: inherited from the customer's parent account.
    * - `account_group`: inherited from the customer's account group.
    * - `account`: the account-wide fallback.
    *
@@ -423,7 +447,14 @@ export interface CustomerLeadTime {
    * on one specific order, which is a fact about that order rather than about the
    * customer.
    */
-  source: 'customer' | 'account_group' | 'account' | 'manual' | 'order_lead_time' | 'order_ship_by';
+  source:
+    | 'customer'
+    | 'parent_customer'
+    | 'account_group'
+    | 'account'
+    | 'manual'
+    | 'order_lead_time'
+    | 'order_ship_by';
 }
 
 /**
@@ -466,7 +497,7 @@ export interface UpdateCustomerRequest {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  credit_limit?: ProductLinesAPI.QuantityInput | null;
+  credit_limit?: InventoryAPI.QuantityInput | null;
 
   /**
    * IDs of the account groups of type `pricing_group` to assign to this customer,
@@ -543,8 +574,9 @@ export interface UpdateCustomerRequest {
   /**
    * Calendar days between an order being issued and it being due to ship.
    *
-   * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * Sets each order's `ship_by_date` when it is issued. Clear it to inherit the
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number | null;
 
@@ -878,7 +910,7 @@ export interface CustomerCreateParams {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  credit_limit?: ProductLinesAPI.QuantityInput;
+  credit_limit?: InventoryAPI.QuantityInput;
 
   /**
    * Body param: IDs of the account groups of type `pricing_group` to assign to this
@@ -932,7 +964,8 @@ export interface CustomerCreateParams {
    * ship.
    *
    * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number;
 
@@ -1046,7 +1079,7 @@ export interface CustomerUpdateParams {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  credit_limit?: ProductLinesAPI.QuantityInput | null;
+  credit_limit?: InventoryAPI.QuantityInput | null;
 
   /**
    * Body param: IDs of the account groups of type `pricing_group` to assign to this
@@ -1125,8 +1158,9 @@ export interface CustomerUpdateParams {
    * Body param: Calendar days between an order being issued and it being due to
    * ship.
    *
-   * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * Sets each order's `ship_by_date` when it is issued. Clear it to inherit the
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number | null;
 
@@ -1185,6 +1219,14 @@ export interface CustomerUpdateParams {
   url?: string | null;
 }
 
+export interface CustomerRetrieveLeadTimeParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'account_group' | 'parent_customer'>;
+}
+
 Customers.Actions = Actions;
 
 export declare namespace Customers {
@@ -1197,6 +1239,7 @@ export declare namespace Customers {
     type CustomerRetrieveParams as CustomerRetrieveParams,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerRetrieveLeadTimeParams as CustomerRetrieveLeadTimeParams,
   };
 
   export {

package/src/resources/sales/customers/index.ts

@@ -11,4 +11,5 @@ export {
   type CustomerRetrieveParams,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerRetrieveLeadTimeParams,
 } from './customers';

package/src/resources/sales/index.ts

@@ -64,6 +64,7 @@ export {
   type CustomerRetrieveParams,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerRetrieveLeadTimeParams,
 } from './customers/index';
 export {
   OrderDiscounts,

package/src/resources/sales/sales-orders/actions.ts

@@ -414,6 +414,18 @@ export interface QuoteSalesOrderCommitmentResponse {
    */
   calendar_adjustment_days: number;
 
+  /**
+   * When freight leaving on the ship-by date would reach the customer: transit
+   * walked forward from it and landed on a day their dock receives. Null whenever
+   * `transit_days` is, since an arrival with no journey behind it would just be the
+   * ship date wearing a different name.
+   *
+   * Reported for every basis, including the ones that do not use transit to decide
+   * the ship-by date. An order committed on a lead time has the same journey ahead
+   * of it; it simply was not worked backwards from.
+   */
+  estimated_delivery_date: string | null;
+
   /**
    * Calendar days between issue and the ship-by date.
    */
@@ -424,6 +436,7 @@ export interface QuoteSalesOrderCommitmentResponse {
    */
   lead_time_source:
     | 'customer'
+    | 'parent_customer'
     | 'account_group'
     | 'account'
     | 'manual'
@@ -454,7 +467,8 @@ export interface QuoteSalesOrderCommitmentResponse {
 
   /**
    * Days the carrier needs to cover the lane. Null when the lane has never been
-   * quoted and the service level carries no default.
+   * quoted and the service level carries no default, or when no service level was
+   * supplied to quote one on.
    */
   transit_days: number | null;
 

package/src/resources/sales/sales-orders/lines/lines.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../../core/resource';
+import * as InventoryAPI from '../../../catalog/items/inventory';
 import * as MaterialsAPI from '../../../catalog/materials/materials';
-import * as ProductLinesAPI from '../../../catalog/product-lines/product-lines';
 import * as SalesOrdersAPI from '../sales-orders';
 import * as ActionsAPI from './actions';
 import {
@@ -145,7 +145,7 @@ export interface CreateSalesOrderLineRequest {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity: ProductLinesAPI.QuantityInput;
+  quantity: InventoryAPI.QuantityInput;
 
   /**
    * The product description recorded on the line.
@@ -182,7 +182,7 @@ export interface UpdateSalesOrderLineRequest {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity?: ProductLinesAPI.QuantityInput;
+  quantity?: InventoryAPI.QuantityInput;
 
   /**
    * A value expressed as a ratio of two units, supplied on create and update
@@ -222,7 +222,7 @@ export interface LineCreateParams {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity: ProductLinesAPI.QuantityInput;
+  quantity: InventoryAPI.QuantityInput;
 
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
@@ -273,7 +273,7 @@ export interface LineUpdateParams {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity?: ProductLinesAPI.QuantityInput;
+  quantity?: InventoryAPI.QuantityInput;
 
   /**
    * Body param: A value expressed as a ratio of two units, supplied on create and

package/src/resources/sales/sales-orders/sales-orders.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../../core/resource';
 import * as RequestLogsAPI from '../../core/request-logs';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as InventoryAPI from '../../catalog/items/inventory';
 import * as ItemsAPI from '../../catalog/items/items';
 import * as MaterialsAPI from '../../catalog/materials/materials';
-import * as ProductLinesAPI from '../../catalog/product-lines/product-lines';
 import * as ProductsAPI from '../../catalog/products/products';
 import * as UnitsAPI from '../../catalog/units/units';
 import * as AccountPricesAPI from '../account-prices/account-prices';
@@ -354,7 +354,7 @@ export interface CreateSalesOrderLineInput {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity: ProductLinesAPI.QuantityInput;
+  quantity: InventoryAPI.QuantityInput;
 
   /**
    * Description recorded on the line.
@@ -792,7 +792,7 @@ export interface QuoteSalesOrderLineInput {
    * The unit may be a currency, so money amounts such as a credit limit are written
    * the same way as physical amounts like weights or counts.
    */
-  quantity: ProductLinesAPI.QuantityInput;
+  quantity: InventoryAPI.QuantityInput;
 }
 
 /**
@@ -1031,6 +1031,7 @@ export interface SalesOrder {
    */
   lead_time_source:
     | 'customer'
+    | 'parent_customer'
     | 'account_group'
     | 'account'
     | 'manual'
@@ -1131,7 +1132,7 @@ export interface SalesOrder {
    * date less the carrier's transit for the order's lane and less any day the
    * customer cannot receive on — the day the order has to leave to arrive when
    * promised. Otherwise it comes from a lead time, whether this order's own or the
-   * one on the customer, its account group, or the account.
+   * one on the customer, its parent account, its account group, or the account.
    *
    * Always a day the plant actually ships on, whichever rule produced it.
    *
@@ -1229,6 +1230,11 @@ export interface SalesOrderLine {
    */
   created_at: string;
 
+  /**
+   * An entry in your catalog: something you sell, consume, or build with.
+   */
+  item: ItemsAPI.Item | null;
+
   /**
    * Position of the line on the order.
    *
@@ -1275,7 +1281,7 @@ export interface SalesOrderLine {
    * resources point at them to report stock levels, ordered and packed amounts,
    * money, weights, and durations.
    */
-  quantity_ordered: ItemsAPI.Quantity | null;
+  quantity_ordered: MaterialsAPI.Quantity | null;
 
   /**
    * Derived monetary totals for a sales order or one of its lines.

package/src/resources/sales/sales.ts

@@ -87,6 +87,7 @@ import {
   CustomerDeleteResponse,
   CustomerLeadTime,
   CustomerListParams,
+  CustomerRetrieveLeadTimeParams,
   CustomerRetrieveParams,
   CustomerUpdateParams,
   Customers,
@@ -244,6 +245,7 @@ export declare namespace Sales {
     type CustomerRetrieveParams as CustomerRetrieveParams,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerRetrieveLeadTimeParams as CustomerRetrieveLeadTimeParams,
   };
 
   export { Contacts as Contacts };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.18.1'; // x-release-please-version
+export const VERSION = '0.19.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.1";
+export declare const VERSION = "0.19.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.1";
+export declare const VERSION = "0.19.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.18.1'; // x-release-please-version
+exports.VERSION = '0.19.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.18.1'; // x-release-please-version
+export const VERSION = '0.19.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map