@augno/sdk 0.17.0 → 0.18.0

package/src/resources/sales/priorities.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as AccountPricesAPI from './account-prices/account-prices';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -50,7 +51,7 @@ export class Priorities extends APIResource {
     id: string,
     query: PriorityRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Priority> {
+  ): APIPromise<AccountPricesAPI.Priority> {
     return this._client.get(path`/v1/sales/priorities/${id}`, { query, ...options });
   }
 }
@@ -63,7 +64,7 @@ export interface ListPriority {
   /**
    * Resources in this page.
    */
-  data: Array<Priority>;
+  data: Array<AccountPricesAPI.Priority>;
 
   /**
    * Resource type identifier.
@@ -82,54 +83,6 @@ export interface ListPriority {
   page_info: APIKeysAPI.PageInfo;
 }
 
-/**
- * Priority level used to order work on sales orders, purchase orders, and picks.
- *
- * The levels are platform-provided and the same for every account, so they cannot
- * be created, renamed, or removed. A customer can carry a default priority that
- * pre-fills new orders for them.
- */
-export interface Priority {
-  /**
-   * Priority ID.
-   */
-  id: string;
-
-  /**
-   * Machine-readable code identifying the priority level.
-   *
-   * Other resources refer to a priority by this code rather than by its ID, such as
-   * a sales order's `priority`, and it can be used in place of the ID when
-   * retrieving a priority.
-   */
-  code: 'low' | 'normal' | 'high';
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Display name of the priority level.
-   */
-  name: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'priority';
-
-  /**
-   * Owner describes the provenance of a resource.
-   */
-  owner: APIKeysAPI.Owner | null;
-
-  /**
-   * Last updated timestamp.
-   */
-  updated_at: string;
-}
-
 export interface PriorityListParams {
   /**
    * Opaque cursor token identifying where the page of results starts.
@@ -170,7 +123,6 @@ export interface PriorityRetrieveParams {
 export declare namespace Priorities {
   export {
     type ListPriority as ListPriority,
-    type Priority as Priority,
     type PriorityListParams as PriorityListParams,
     type PriorityRetrieveParams as PriorityRetrieveParams,
   };

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

@@ -35,7 +35,6 @@ export {
   type ListSalesOrderLine,
   type ListSalesOrderStatus,
   type OrderContact,
-  type OrderDiscount,
   type QuoteSalesOrderLineInput,
   type QuoteSalesOrderPricesRequest,
   type QuoteSalesOrderPricesResponse,

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

@@ -169,7 +169,7 @@ export interface UpdateSalesOrderLineRequest {
   /**
    * Description recorded on the line.
    */
-  product_description?: string;
+  product_description?: string | null;
 
   /**
    * SKU recorded on the line.
@@ -260,7 +260,7 @@ export interface LineUpdateParams {
   /**
    * Body param: Description recorded on the line.
    */
-  product_description?: string;
+  product_description?: string | null;
 
   /**
    * Body param: SKU recorded on the line.

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

@@ -8,7 +8,8 @@ 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 AccountPricesAPI from '../account-prices/account-prices';
+import * as OrderDiscountsAPI from '../order-discounts/order-discounts';
 import * as ActionsAPI from './actions';
 import {
   ActionBulkDeleteParams,
@@ -564,7 +565,7 @@ export interface Freight {
    * through Shippo for live rating and label purchase; other carriers represent
    * self-managed shipping methods such as will call or local delivery.
    */
-  carrier: CustomersAPI.Carrier | null;
+  carrier: AccountPricesAPI.Carrier | null;
 
   /**
    * Resource type identifier.
@@ -590,7 +591,7 @@ export interface Freight {
    * Carriers connected through Shippo have their service levels synced from the
    * carrier itself; any carrier can also have service levels you create by hand.
    */
-  service_level: CustomersAPI.ServiceLevel | null;
+  service_level: AccountPricesAPI.ServiceLevel | null;
 }
 
 /**
@@ -748,76 +749,6 @@ export interface OrderContact {
   object: 'order_contact';
 }
 
-/**
- * A discount code that can be applied to a sales order.
- *
- * An order discount reduces the order total by either a percentage or a fixed
- * amount, depending on `discount_type`. The reduction is capped at the order total
- * and rounded to the nearest cent.
- */
-export interface OrderDiscount {
-  /**
-   * Order discount ID.
-   */
-  id: string;
-
-  /**
-   * The flat amount taken off the order total, as a decimal string.
-   *
-   * Only read when `discount_type` is `amount`.
-   */
-  amount: string;
-
-  /**
-   * The code a buyer enters to apply this discount to an order.
-   *
-   * Codes are unique within your account and are matched without regard to letter
-   * case.
-   */
-  code: string;
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * How the discount is calculated.
-   *
-   * - `percentage`: the order total is reduced by the fraction in `percentage`.
-   * - `amount`: the order total is reduced by the flat amount in `amount`.
-   */
-  discount_type: 'percentage' | 'amount';
-
-  /**
-   * Display name of the discount.
-   */
-  name: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'order_discount';
-
-  /**
-   * How many sales orders this discount has been applied to, across all buyers.
-   */
-  order_count: number;
-
-  /**
-   * The fraction of the order total taken off, as a decimal string.
-   *
-   * This is a multiplier, not a whole percent: `0.1` takes 10% off. Only read when
-   * `discount_type` is `percentage`.
-   */
-  percentage: string;
-
-  /**
-   * Last updated timestamp.
-   */
-  updated_at: string;
-}
-
 /**
  * A line to price in a quote request.
  */
@@ -1015,7 +946,7 @@ export interface SalesOrder {
    * A business you sell to, with its contact details, default fulfillment settings,
    * and order policies.
    */
-  customer: CustomersAPI.Customer | null;
+  customer: AccountPricesAPI.Customer | null;
 
   /**
    * The customer's own purchase order number, for cross-referencing.
@@ -1092,7 +1023,7 @@ export interface SalesOrder {
    * amount, depending on `discount_type`. The reduction is capped at the order total
    * and rounded to the nearest cent.
    */
-  order_discount: OrderDiscount | null;
+  order_discount: OrderDiscountsAPI.OrderDiscount | null;
 
   /**
    * Stripe payment intent IDs recorded against this order.
@@ -1109,7 +1040,7 @@ export interface SalesOrder {
    * A payment term describing when payment is due (e.g. `Net 30`), assignable to
    * customers, sales orders, purchase orders, and invoices.
    */
-  payment_term: CustomersAPI.PaymentTerm | null;
+  payment_term: AccountPricesAPI.PaymentTerm | null;
 
   /**
    * Fulfillment priority, used to rank orders on the shop floor.
@@ -1163,7 +1094,7 @@ export interface SalesOrder {
    * of its price groups are checked first and zero the freight charge before the
    * shipping term is considered.
    */
-  shipping_term: CustomersAPI.ShippingTerm | null;
+  shipping_term: AccountPricesAPI.ShippingTerm | null;
 
   /**
    * Order lifecycle status.
@@ -1450,7 +1381,7 @@ export interface SalesOrderTotals {
   object: 'sales_order_totals';
 
   /**
-   * Total ordered amount as a decimal string (unit price times quantity ordered).
+   * Total ordered amount as a decimal string (unit price x quantity ordered).
    *
    * This is the baseline the stage completions are measured against.
    */
@@ -2151,7 +2082,6 @@ export declare namespace SalesOrders {
     type ListSalesOrderLine as ListSalesOrderLine,
     type ListSalesOrderStatus as ListSalesOrderStatus,
     type OrderContact as OrderContact,
-    type OrderDiscount as OrderDiscount,
     type QuoteSalesOrderLineInput as QuoteSalesOrderLineInput,
     type QuoteSalesOrderPricesRequest as QuoteSalesOrderPricesRequest,
     type QuoteSalesOrderPricesResponse as QuoteSalesOrderPricesResponse,

package/src/resources/sales/sales.ts

@@ -33,34 +33,76 @@ import {
   UpdateAddressRequest,
 } from './addresses';
 import * as PrioritiesAPI from './priorities';
-import { ListPriority, Priorities, Priority, PriorityListParams, PriorityRetrieveParams } from './priorities';
+import { ListPriority, Priorities, PriorityListParams, PriorityRetrieveParams } from './priorities';
+import * as VolumeDiscountsAPI from './volume-discounts';
+import {
+  CreateVolumeDiscountRequest,
+  CreateVolumeDiscountTierInput,
+  ListVolumeDiscount,
+  ListVolumeDiscountTier,
+  UpdateVolumeDiscountRequest,
+  UpdateVolumeDiscountTierInput,
+  VolumeDiscount,
+  VolumeDiscountCreateParams,
+  VolumeDiscountDeleteResponse,
+  VolumeDiscountListParams,
+  VolumeDiscountRetrieveParams,
+  VolumeDiscountTier,
+  VolumeDiscountUpdateParams,
+  VolumeDiscounts,
+} from './volume-discounts';
+import * as AccountPricesAPI from './account-prices/account-prices';
+import {
+  AccountPrice,
+  AccountPriceCreateParams,
+  AccountPriceDeleteResponse,
+  AccountPriceListParams,
+  AccountPriceRetrieveParams,
+  AccountPriceUpdateParams,
+  AccountPrices,
+  Carrier,
+  CreateAccountPriceRequest,
+  Customer,
+  CustomerContactInfo,
+  CustomerDefaults,
+  CustomerFreightPreferences,
+  CustomerNotificationPreferences,
+  ListAccountPrice,
+  ListCustomer,
+  ListServiceLevel,
+  PaymentTerm,
+  Priority,
+  ServiceLevel,
+  ShippingTerm,
+  UpdateAccountPriceRequest,
+} from './account-prices/account-prices';
 import * as AccountUsersAPI from './account-users/account-users';
 import { AccountUsers } from './account-users/account-users';
 import * as ContactsAPI from './contacts/contacts';
 import { Contacts } from './contacts/contacts';
 import * as CustomersAPI from './customers/customers';
 import {
-  Carrier,
   CreateCustomerRequest,
-  Customer,
-  CustomerContactInfo,
   CustomerCreateParams,
-  CustomerDefaults,
   CustomerDeleteResponse,
-  CustomerFreightPreferences,
   CustomerLeadTime,
   CustomerListParams,
-  CustomerNotificationPreferences,
   CustomerRetrieveParams,
   CustomerUpdateParams,
   Customers,
-  ListCustomer,
-  ListServiceLevel,
-  PaymentTerm,
-  ServiceLevel,
-  ShippingTerm,
   UpdateCustomerRequest,
 } from './customers/customers';
+import * as OrderDiscountsAPI from './order-discounts/order-discounts';
+import {
+  CreateOrderDiscountRequest,
+  ListOrderDiscount,
+  OrderDiscount,
+  OrderDiscountCreateParams,
+  OrderDiscountListParams,
+  OrderDiscountUpdateParams,
+  OrderDiscounts,
+  UpdateOrderDiscountRequest,
+} from './order-discounts/order-discounts';
 import * as SalesOrdersAPI from './sales-orders/sales-orders';
 import {
   CheckoutSalesOrderRequest,
@@ -76,7 +118,6 @@ import {
   ListSalesOrderLine,
   ListSalesOrderStatus,
   OrderContact,
-  OrderDiscount,
   QuoteSalesOrderLineInput,
   QuoteSalesOrderPricesRequest,
   QuoteSalesOrderPricesResponse,
@@ -103,23 +144,29 @@ import {
 
 export class Sales extends APIResource {
   accountGroups: AccountGroupsAPI.AccountGroups = new AccountGroupsAPI.AccountGroups(this._client);
+  accountPrices: AccountPricesAPI.AccountPrices = new AccountPricesAPI.AccountPrices(this._client);
   addresses: AddressesAPI.Addresses = new AddressesAPI.Addresses(this._client);
   accountStatuses: AccountStatusesAPI.AccountStatuses = new AccountStatusesAPI.AccountStatuses(this._client);
   accountUsers: AccountUsersAPI.AccountUsers = new AccountUsersAPI.AccountUsers(this._client);
   priorities: PrioritiesAPI.Priorities = new PrioritiesAPI.Priorities(this._client);
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   contacts: ContactsAPI.Contacts = new ContactsAPI.Contacts(this._client);
+  orderDiscounts: OrderDiscountsAPI.OrderDiscounts = new OrderDiscountsAPI.OrderDiscounts(this._client);
   salesOrders: SalesOrdersAPI.SalesOrders = new SalesOrdersAPI.SalesOrders(this._client);
+  volumeDiscounts: VolumeDiscountsAPI.VolumeDiscounts = new VolumeDiscountsAPI.VolumeDiscounts(this._client);
 }
 
 Sales.AccountGroups = AccountGroups;
+Sales.AccountPrices = AccountPrices;
 Sales.Addresses = Addresses;
 Sales.AccountStatuses = AccountStatuses;
 Sales.AccountUsers = AccountUsers;
 Sales.Priorities = Priorities;
 Sales.Customers = Customers;
 Sales.Contacts = Contacts;
+Sales.OrderDiscounts = OrderDiscounts;
 Sales.SalesOrders = SalesOrders;
+Sales.VolumeDiscounts = VolumeDiscounts;
 
 export declare namespace Sales {
   export {
@@ -134,6 +181,31 @@ export declare namespace Sales {
     type AccountGroupUpdateParams as AccountGroupUpdateParams,
   };
 
+  export {
+    AccountPrices as AccountPrices,
+    type AccountPrice as AccountPrice,
+    type Carrier as Carrier,
+    type CreateAccountPriceRequest as CreateAccountPriceRequest,
+    type Customer as Customer,
+    type CustomerContactInfo as CustomerContactInfo,
+    type CustomerDefaults as CustomerDefaults,
+    type CustomerFreightPreferences as CustomerFreightPreferences,
+    type CustomerNotificationPreferences as CustomerNotificationPreferences,
+    type ListAccountPrice as ListAccountPrice,
+    type ListCustomer as ListCustomer,
+    type ListServiceLevel as ListServiceLevel,
+    type PaymentTerm as PaymentTerm,
+    type Priority as Priority,
+    type ServiceLevel as ServiceLevel,
+    type ShippingTerm as ShippingTerm,
+    type UpdateAccountPriceRequest as UpdateAccountPriceRequest,
+    type AccountPriceDeleteResponse as AccountPriceDeleteResponse,
+    type AccountPriceListParams as AccountPriceListParams,
+    type AccountPriceRetrieveParams as AccountPriceRetrieveParams,
+    type AccountPriceCreateParams as AccountPriceCreateParams,
+    type AccountPriceUpdateParams as AccountPriceUpdateParams,
+  };
+
   export {
     Addresses as Addresses,
     type AddressInput as AddressInput,
@@ -158,26 +230,14 @@ export declare namespace Sales {
   export {
     Priorities as Priorities,
     type ListPriority as ListPriority,
-    type Priority as Priority,
     type PriorityListParams as PriorityListParams,
     type PriorityRetrieveParams as PriorityRetrieveParams,
   };
 
   export {
     Customers as Customers,
-    type Carrier as Carrier,
     type CreateCustomerRequest as CreateCustomerRequest,
-    type Customer as Customer,
-    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,
-    type PaymentTerm as PaymentTerm,
-    type ServiceLevel as ServiceLevel,
-    type ShippingTerm as ShippingTerm,
     type UpdateCustomerRequest as UpdateCustomerRequest,
     type CustomerDeleteResponse as CustomerDeleteResponse,
     type CustomerListParams as CustomerListParams,
@@ -188,6 +248,17 @@ export declare namespace Sales {
 
   export { Contacts as Contacts };
 
+  export {
+    OrderDiscounts as OrderDiscounts,
+    type CreateOrderDiscountRequest as CreateOrderDiscountRequest,
+    type ListOrderDiscount as ListOrderDiscount,
+    type OrderDiscount as OrderDiscount,
+    type UpdateOrderDiscountRequest as UpdateOrderDiscountRequest,
+    type OrderDiscountListParams as OrderDiscountListParams,
+    type OrderDiscountCreateParams as OrderDiscountCreateParams,
+    type OrderDiscountUpdateParams as OrderDiscountUpdateParams,
+  };
+
   export {
     SalesOrders as SalesOrders,
     type CheckoutSalesOrderRequest as CheckoutSalesOrderRequest,
@@ -203,7 +274,6 @@ export declare namespace Sales {
     type ListSalesOrderLine as ListSalesOrderLine,
     type ListSalesOrderStatus as ListSalesOrderStatus,
     type OrderContact as OrderContact,
-    type OrderDiscount as OrderDiscount,
     type QuoteSalesOrderLineInput as QuoteSalesOrderLineInput,
     type QuoteSalesOrderPricesRequest as QuoteSalesOrderPricesRequest,
     type QuoteSalesOrderPricesResponse as QuoteSalesOrderPricesResponse,
@@ -226,4 +296,21 @@ export declare namespace Sales {
     type SalesOrderCheckoutParams as SalesOrderCheckoutParams,
     type SalesOrderPriceQuoteParams as SalesOrderPriceQuoteParams,
   };
+
+  export {
+    VolumeDiscounts as VolumeDiscounts,
+    type CreateVolumeDiscountRequest as CreateVolumeDiscountRequest,
+    type CreateVolumeDiscountTierInput as CreateVolumeDiscountTierInput,
+    type ListVolumeDiscount as ListVolumeDiscount,
+    type ListVolumeDiscountTier as ListVolumeDiscountTier,
+    type UpdateVolumeDiscountRequest as UpdateVolumeDiscountRequest,
+    type UpdateVolumeDiscountTierInput as UpdateVolumeDiscountTierInput,
+    type VolumeDiscount as VolumeDiscount,
+    type VolumeDiscountTier as VolumeDiscountTier,
+    type VolumeDiscountDeleteResponse as VolumeDiscountDeleteResponse,
+    type VolumeDiscountListParams as VolumeDiscountListParams,
+    type VolumeDiscountRetrieveParams as VolumeDiscountRetrieveParams,
+    type VolumeDiscountCreateParams as VolumeDiscountCreateParams,
+    type VolumeDiscountUpdateParams as VolumeDiscountUpdateParams,
+  };
 }