@augno/sdk 0.13.4 → 0.15.0

package/src/resources/sales/account-groups.ts

@@ -162,6 +162,12 @@ export interface AccountGroup {
    */
   created_at: string;
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days: number | null;
+
   /**
    * Free-form description of the account group.
    */
@@ -242,6 +248,12 @@ export interface CreateAccountGroupRequest {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days?: number;
+
   /**
    * Free-form description of the account group.
    */
@@ -298,6 +310,13 @@ export interface UpdateAccountGroupRequest {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own. Clearing it returns
+   * the group's customers to the account default.
+   */
+  default_lead_time_days?: number | null;
+
   /**
    * Free-form description of the account group.
    */
@@ -383,6 +402,12 @@ export interface AccountGroupCreateParams {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days?: number;
+
   /**
    * Free-form description of the account group.
    */
@@ -409,6 +434,13 @@ export interface AccountGroupUpdateParams {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own. Clearing it returns
+   * the group's customers to the account default.
+   */
+  default_lead_time_days?: number | null;
+
   /**
    * Free-form description of the account group.
    */

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

@@ -1,13 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as ProductLinesAPI from '../../catalog/product-lines';
+import * as CoreAPI from '../../core/core';
 import * as BlocksAPI from '../../messaging/blocks';
 import * as AccountGroupsAPI from '../account-groups';
 import * as AddressesAPI from '../addresses';
 import * as PrioritiesAPI from '../priorities';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
 import * as ItemsAPI from '../../catalog/items/items';
+import * as ProductLinesAPI from '../../catalog/product-lines/product-lines';
 import * as ActionsAPI from './actions';
 import { ActionMergeParams, Actions, MergeCustomersRequest } from './actions';
 import { APIPromise } from '../../../core/api-promise';
@@ -178,6 +179,34 @@ export class Customers extends APIResource {
   delete(id: string, options?: RequestOptions): APIPromise<CustomerDeleteResponse> {
     return this._client.delete(path`/v1/sales/customers/${id}`, options);
   }
+
+  /**
+   * Returns the ship-by lead time a new order for this customer would be committed
+   * 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.
+   *
+   * 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
+   * time here moves what future orders will promise and leaves promises already made
+   * alone.
+   *
+   * This endpoint requires the permission: `customers:read`.
+   *
+   * @example
+   * ```ts
+   * const customerLeadTime =
+   *   await client.sales.customers.retrieveLeadTime(
+   *     'ac_opnlh43ymyee',
+   *   );
+   * ```
+   */
+  retrieveLeadTime(id: string, options?: RequestOptions): APIPromise<CustomerLeadTime> {
+    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, options);
+  }
 }
 
 /**
@@ -387,6 +416,14 @@ export interface CreateCustomerRequest {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number;
+
   /**
    * Free-form note about the customer.
    */
@@ -611,6 +648,14 @@ export interface CustomerContactInfo {
  * not supply its own.
  */
 export interface CustomerDefaults {
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * Sets each order's `ship_by_date` when it is issued. With none set here the
+   * customer inherits its account group's lead time, then the account default.
+   */
+  lead_time_days: number | null;
+
   /**
    * Resource type identifier.
    */
@@ -704,6 +749,46 @@ export interface CustomerFreightPreferences {
   status: 'free_freight' | 'billed_freight';
 }
 
+/**
+ * The ship-by lead time a new order for this customer would be committed to.
+ */
+export interface CustomerLeadTime {
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  account_group: CoreAPI.Entity | null;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  customer: CoreAPI.Entity | null;
+
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * `0` means same-day: an order issued today would be due to ship today.
+   */
+  days: number;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'customer_lead_time';
+
+  /**
+   * Which rule in the chain produced this lead time.
+   *
+   * - `customer`: a lead time set on the customer itself.
+   * - `account_group`: inherited from the customer's account group.
+   * - `account`: the account-wide fallback.
+   *
+   * The shared `manual` value cannot appear here: it means a promised date was set
+   * on one specific order, which is a fact about that order rather than about the
+   * customer.
+   */
+  source: 'customer' | 'account_group' | 'account' | 'manual';
+}
+
 /**
  * Customer notification settings.
  */
@@ -1078,6 +1163,14 @@ export interface UpdateCustomerRequest {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number | null;
+
   /**
    * The customer's business name, as shown throughout the app and on documents.
    */
@@ -1450,6 +1543,15 @@ export interface CustomerCreateParams {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number;
+
   /**
    * Body param: Free-form note about the customer.
    */
@@ -1625,6 +1727,15 @@ export interface CustomerUpdateParams {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number | null;
+
   /**
    * Body param: The customer's business name, as shown throughout the app and on
    * documents.
@@ -1683,6 +1794,7 @@ export declare namespace Customers {
     type CustomerContactInfo as CustomerContactInfo,
     type CustomerDefaults as CustomerDefaults,
     type CustomerFreightPreferences as CustomerFreightPreferences,
+    type CustomerLeadTime as CustomerLeadTime,
     type CustomerNotificationPreferences as CustomerNotificationPreferences,
     type ListCustomer as ListCustomer,
     type ListServiceLevel as ListServiceLevel,

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

@@ -9,6 +9,7 @@ export {
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
+  type CustomerLeadTime,
   type CustomerNotificationPreferences,
   type ListCustomer,
   type ListServiceLevel,

package/src/resources/sales/index.ts

@@ -38,6 +38,7 @@ export {
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
+  type CustomerLeadTime,
   type CustomerNotificationPreferences,
   type ListCustomer,
   type ListServiceLevel,

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 MaterialsAPI from '../../../catalog/materials';
-import * as ProductLinesAPI from '../../../catalog/product-lines';
+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 {

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

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as MaterialsAPI from '../../catalog/materials';
-import * as ProductLinesAPI from '../../catalog/product-lines';
-import * as ProductsAPI from '../../catalog/products';
-import * as UnitsAPI from '../../catalog/units';
 import * as RequestLogsAPI from '../../core/request-logs';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
 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 CustomersAPI from '../customers/customers';
 import * as ActionsAPI from './actions';
 import {
@@ -1008,6 +1008,16 @@ export interface SalesOrder {
    */
   issued_at: string | null;
 
+  /**
+   * Calendar days between issue and the ship-by date.
+   */
+  lead_time_days: number | null;
+
+  /**
+   * Which rule produced the ship-by date.
+   */
+  lead_time_source: 'customer' | 'account_group' | 'account' | 'manual' | null;
+
   /**
    * Number of lines on this order.
    */
@@ -1086,6 +1096,16 @@ export interface SalesOrder {
    */
   sales_rep: RequestLogsAPI.Actor | null;
 
+  /**
+   * Date this order is contractually due to ship.
+   *
+   * Stamped when the order is issued, from the promised date if one was set,
+   * otherwise from the lead time on the customer, its account group, or the account.
+   * It is not recomputed afterwards, so renegotiating a customer's lead time leaves
+   * commitments already made where they are. Cleared if the order is unissued.
+   */
+  ship_by_date: string | null;
+
   /**
    * A saved address that can be used for billing and shipping on sales orders,
    * invoices, and shipments.
@@ -1655,6 +1675,15 @@ export interface SalesOrderListParams {
    */
   limit?: number;
 
+  /**
+   * Restricts results to orders that are, or are not, past their ship-by date.
+   *
+   * An order is past due when it is still `issued` and its ship-by date has passed.
+   * A fulfilled order that shipped late is not past due — it is delivered, and how
+   * late it was is a delivery-performance question rather than a backlog one.
+   */
+  past_due?: boolean;
+
   /**
    * Restricts results to orders that have at least one line whose product belongs to
    * any of these product lines.
@@ -1675,6 +1704,18 @@ export interface SalesOrderListParams {
    */
   sales_rep_ids?: Array<string>;
 
+  /**
+   * Earliest ship-by date to include, in `YYYY-MM-DD` format. Inclusive of the date
+   * itself.
+   */
+  ship_by_after?: string;
+
+  /**
+   * Latest ship-by date to include, in `YYYY-MM-DD` format. Inclusive of the date
+   * itself.
+   */
+  ship_by_before?: string;
+
   /**
    * Earliest order creation date to include, in `YYYY-MM-DD` format.
    */

package/src/resources/sales/sales.ts

@@ -48,6 +48,7 @@ import {
   CustomerDefaults,
   CustomerDeleteResponse,
   CustomerFreightPreferences,
+  CustomerLeadTime,
   CustomerListParams,
   CustomerNotificationPreferences,
   CustomerRetrieveParams,
@@ -170,6 +171,7 @@ export declare namespace Sales {
     type CustomerContactInfo as CustomerContactInfo,
     type CustomerDefaults as CustomerDefaults,
     type CustomerFreightPreferences as CustomerFreightPreferences,
+    type CustomerLeadTime as CustomerLeadTime,
     type CustomerNotificationPreferences as CustomerNotificationPreferences,
     type ListCustomer as ListCustomer,
     type ListServiceLevel as ListServiceLevel,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.13.4'; // x-release-please-version
+export const VERSION = '0.15.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.13.4";
+export declare const VERSION = "0.15.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.13.4'; // x-release-please-version
+exports.VERSION = '0.15.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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