@augno/sdk 0.16.1 → 0.18.0

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

@@ -3,19 +3,8 @@
 export { Actions, type MergeCustomersRequest, type ActionMergeParams } from './actions';
 export {
   Customers,
-  type Carrier,
   type CreateCustomerRequest,
-  type Customer,
-  type CustomerContactInfo,
-  type CustomerDefaults,
-  type CustomerFreightPreferences,
   type CustomerLeadTime,
-  type CustomerNotificationPreferences,
-  type ListCustomer,
-  type ListServiceLevel,
-  type PaymentTerm,
-  type ServiceLevel,
-  type ShippingTerm,
   type UpdateCustomerRequest,
   type CustomerDeleteResponse,
   type CustomerListParams,

package/src/resources/sales/index.ts

@@ -11,6 +11,30 @@ export {
   type AccountGroupCreateParams,
   type AccountGroupUpdateParams,
 } from './account-groups';
+export {
+  AccountPrices,
+  type AccountPrice,
+  type Carrier,
+  type CreateAccountPriceRequest,
+  type Customer,
+  type CustomerContactInfo,
+  type CustomerDefaults,
+  type CustomerFreightPreferences,
+  type CustomerNotificationPreferences,
+  type ListAccountPrice,
+  type ListCustomer,
+  type ListServiceLevel,
+  type PaymentTerm,
+  type Priority,
+  type ServiceLevel,
+  type ShippingTerm,
+  type UpdateAccountPriceRequest,
+  type AccountPriceDeleteResponse,
+  type AccountPriceListParams,
+  type AccountPriceRetrieveParams,
+  type AccountPriceCreateParams,
+  type AccountPriceUpdateParams,
+} from './account-prices/index';
 export {
   AccountStatuses,
   type AccountStatus,
@@ -32,19 +56,8 @@ export {
 export { Contacts } from './contacts/index';
 export {
   Customers,
-  type Carrier,
   type CreateCustomerRequest,
-  type Customer,
-  type CustomerContactInfo,
-  type CustomerDefaults,
-  type CustomerFreightPreferences,
   type CustomerLeadTime,
-  type CustomerNotificationPreferences,
-  type ListCustomer,
-  type ListServiceLevel,
-  type PaymentTerm,
-  type ServiceLevel,
-  type ShippingTerm,
   type UpdateCustomerRequest,
   type CustomerDeleteResponse,
   type CustomerListParams,
@@ -52,10 +65,19 @@ export {
   type CustomerCreateParams,
   type CustomerUpdateParams,
 } from './customers/index';
+export {
+  OrderDiscounts,
+  type CreateOrderDiscountRequest,
+  type ListOrderDiscount,
+  type OrderDiscount,
+  type UpdateOrderDiscountRequest,
+  type OrderDiscountListParams,
+  type OrderDiscountCreateParams,
+  type OrderDiscountUpdateParams,
+} from './order-discounts/index';
 export {
   Priorities,
   type ListPriority,
-  type Priority,
   type PriorityListParams,
   type PriorityRetrieveParams,
 } from './priorities';
@@ -75,7 +97,6 @@ export {
   type ListSalesOrderLine,
   type ListSalesOrderStatus,
   type OrderContact,
-  type OrderDiscount,
   type QuoteSalesOrderLineInput,
   type QuoteSalesOrderPricesRequest,
   type QuoteSalesOrderPricesResponse,
@@ -98,3 +119,19 @@ export {
   type SalesOrderCheckoutParams,
   type SalesOrderPriceQuoteParams,
 } from './sales-orders/index';
+export {
+  VolumeDiscounts,
+  type CreateVolumeDiscountRequest,
+  type CreateVolumeDiscountTierInput,
+  type ListVolumeDiscount,
+  type ListVolumeDiscountTier,
+  type UpdateVolumeDiscountRequest,
+  type UpdateVolumeDiscountTierInput,
+  type VolumeDiscount,
+  type VolumeDiscountTier,
+  type VolumeDiscountDeleteResponse,
+  type VolumeDiscountListParams,
+  type VolumeDiscountRetrieveParams,
+  type VolumeDiscountCreateParams,
+  type VolumeDiscountUpdateParams,
+} from './volume-discounts';

package/src/resources/sales/order-discounts/actions.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as OrderDiscountsAPI from './order-discounts';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * List and manage order discounts.
+ */
+export class Actions extends APIResource {
+  /**
+   * Validates a discount code and returns the matching order discount, so a code a
+   * buyer typed can be attached to an order.
+   *
+   * When `buyer_account_id` is provided, or the caller is a customer user, the
+   * lookup also verifies that the buyer has not already redeemed the discount on
+   * another order, and reports an already-redeemed code as not found. Pass
+   * `sales_order_id` to exclude an order the buyer is currently editing from that
+   * check.
+   *
+   * This endpoint requires the permission: `discounts:read`.
+   *
+   * @example
+   * ```ts
+   * const orderDiscount =
+   *   await client.sales.orderDiscounts.actions.findByCode({
+   *     code: 'SAVE10',
+   *   });
+   * ```
+   */
+  findByCode(
+    body: ActionFindByCodeParams,
+    options?: RequestOptions,
+  ): APIPromise<OrderDiscountsAPI.OrderDiscount> {
+    return this._client.post('/v1/sales/order-discounts/actions/find-by-code', { body, ...options });
+  }
+}
+
+/**
+ * Request to find an order discount by code.
+ */
+export interface FindOrderDiscountByCodeRequest {
+  /**
+   * The discount code to look up, as the buyer typed it.
+   *
+   * Matching ignores letter case, so `save10` finds a discount stored as `SAVE10`.
+   */
+  code: string;
+
+  /**
+   * The buyer account to check for prior use of this code.
+   *
+   * When set, the lookup returns a not-found error if that buyer has already
+   * redeemed the discount on another order, so a one-use-per-customer code can be
+   * rejected before it is attached to a new one. Customer callers cannot set this —
+   * their own account is always used.
+   */
+  buyer_account_id?: string;
+
+  /**
+   * Sales order ID to exclude from the prior-usage check.
+   *
+   * Set this when re-validating a code on an existing order so the order's own usage
+   * does not count against the buyer.
+   */
+  sales_order_id?: string;
+}
+
+export interface ActionFindByCodeParams {
+  /**
+   * The discount code to look up, as the buyer typed it.
+   *
+   * Matching ignores letter case, so `save10` finds a discount stored as `SAVE10`.
+   */
+  code: string;
+
+  /**
+   * The buyer account to check for prior use of this code.
+   *
+   * When set, the lookup returns a not-found error if that buyer has already
+   * redeemed the discount on another order, so a one-use-per-customer code can be
+   * rejected before it is attached to a new one. Customer callers cannot set this —
+   * their own account is always used.
+   */
+  buyer_account_id?: string;
+
+  /**
+   * Sales order ID to exclude from the prior-usage check.
+   *
+   * Set this when re-validating a code on an existing order so the order's own usage
+   * does not count against the buyer.
+   */
+  sales_order_id?: string;
+}
+
+export declare namespace Actions {
+  export {
+    type FindOrderDiscountByCodeRequest as FindOrderDiscountByCodeRequest,
+    type ActionFindByCodeParams as ActionFindByCodeParams,
+  };
+}

package/src/resources/sales/order-discounts/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type FindOrderDiscountByCodeRequest, type ActionFindByCodeParams } from './actions';
+export {
+  OrderDiscounts,
+  type CreateOrderDiscountRequest,
+  type ListOrderDiscount,
+  type OrderDiscount,
+  type UpdateOrderDiscountRequest,
+  type OrderDiscountListParams,
+  type OrderDiscountCreateParams,
+  type OrderDiscountUpdateParams,
+} from './order-discounts';

package/src/resources/sales/order-discounts/order-discounts.ts

@@ -0,0 +1,442 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ActionsAPI from './actions';
+import { ActionFindByCodeParams, Actions, FindOrderDiscountByCodeRequest } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage order discounts.
+ */
+export class OrderDiscounts extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Returns a paginated list of the order discounts defined for the current account,
+   * newest first.
+   *
+   * Pass `q` to narrow the list to discounts whose name or code contains the search
+   * text.
+   *
+   * This endpoint requires the permissions: `discounts:read`, `customers:read`,
+   * `suppliers:read`.
+   *
+   * @example
+   * ```ts
+   * const listOrderDiscount =
+   *   await client.sales.orderDiscounts.list();
+   * ```
+   */
+  list(
+    query: OrderDiscountListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListOrderDiscount> {
+    return this._client.get('/v1/sales/order-discounts', { query, ...options });
+  }
+
+  /**
+   * Returns an order discount by ID.
+   *
+   * This endpoint requires the permission: `discounts:read`.
+   *
+   * @example
+   * ```ts
+   * const orderDiscount =
+   *   await client.sales.orderDiscounts.retrieve(
+   *     'ords_qnbrjvq5ih2q',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<OrderDiscount> {
+    return this._client.get(path`/v1/sales/order-discounts/${id}`, options);
+  }
+
+  /**
+   * Creates an order discount that buyers can then redeem on a sales order by its
+   * code.
+   *
+   * The code must be unique within your account; reusing a code that another
+   * discount already holds returns a conflict error. Creating the discount does not
+   * apply it to anything — a discount only affects an order once that order
+   * references it.
+   *
+   * This endpoint requires the permission: `discounts:create`.
+   *
+   * @example
+   * ```ts
+   * const orderDiscount =
+   *   await client.sales.orderDiscounts.create({
+   *     code: 'SAVE10',
+   *     discount_type: 'percentage',
+   *     name: '10% Off',
+   *     percentage: '0.1',
+   *   });
+   * ```
+   */
+  create(body: OrderDiscountCreateParams, options?: RequestOptions): APIPromise<OrderDiscount> {
+    return this._client.post('/v1/sales/order-discounts', { body, ...options });
+  }
+
+  /**
+   * Partially updates an order discount.
+   *
+   * Only the fields you send are changed; the rest keep their current values.
+   * Changing `code` to one another discount already holds returns a conflict error.
+   * Edits apply to future orders only — orders that already used this discount keep
+   * the reduction they were given.
+   *
+   * This endpoint requires the permission: `discounts:update`.
+   *
+   * @example
+   * ```ts
+   * const orderDiscount =
+   *   await client.sales.orderDiscounts.update(
+   *     'ords_qnbrjvq5ih2q',
+   *     { code: 'SAVE15', name: '15% Off' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    body: OrderDiscountUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<OrderDiscount> {
+    return this._client.patch(path`/v1/sales/order-discounts/${id}`, { body, ...options });
+  }
+
+  /**
+   * Deletes an order discount and returns it as it was just before deletion.
+   *
+   * Deletion is permanent; further requests against the deleted ID return an error.
+   *
+   * The code can no longer be redeemed, but sales orders that already used the
+   * discount keep the reduction that was applied to them; their totals are not
+   * recalculated.
+   *
+   * This endpoint requires the permission: `discounts:delete`.
+   *
+   * @example
+   * ```ts
+   * const orderDiscount =
+   *   await client.sales.orderDiscounts.delete(
+   *     'ords_qnbrjvq5ih2q',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<OrderDiscount> {
+    return this._client.delete(path`/v1/sales/order-discounts/${id}`, options);
+  }
+}
+
+/**
+ * Request to create an order discount.
+ */
+export interface CreateOrderDiscountRequest {
+  /**
+   * The code a buyer enters to apply this discount to an order.
+   *
+   * Codes are unique within your account and are compared without regard to letter
+   * case, so `SAVE10` collides with `save10`.
+   */
+  code: 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;
+
+  /**
+   * The flat amount to take off the order total, as a decimal string.
+   *
+   * Only read when `discount_type` is `amount`. Leaving it out stores `0`, which
+   * produces a discount that takes nothing off.
+   */
+  amount?: string;
+
+  /**
+   * The fraction of the order total to take off, as a decimal string.
+   *
+   * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+   * when `discount_type` is `percentage`. Leaving it out stores `0`, which produces
+   * a discount that takes nothing off.
+   */
+  percentage?: string;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListOrderDiscount {
+  /**
+   * Resources in this page.
+   */
+  data: Array<OrderDiscount>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * Request to partially update an order discount.
+ */
+export interface UpdateOrderDiscountRequest {
+  /**
+   * The flat amount to take 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 compared without regard to letter
+   * case.
+   */
+  code?: 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`.
+   *
+   * Switching the type does not move the stored figure across, so send the matching
+   * `percentage` or `amount` in the same request or the discount will take nothing
+   * off.
+   */
+  discount_type?: 'percentage' | 'amount';
+
+  /**
+   * Display name of the discount.
+   */
+  name?: string;
+
+  /**
+   * The fraction of the order total to take off, as a decimal string.
+   *
+   * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+   * when `discount_type` is `percentage`.
+   */
+  percentage?: string;
+}
+
+export interface OrderDiscountListParams {
+  /**
+   * Opaque cursor token identifying where the page of results starts.
+   *
+   * Use the `cursor` value embedded in a previous response's `next_page_url` or
+   * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+   * page.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum number of results to return in a single page.
+   */
+  limit?: number;
+
+  /**
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
+   */
+  q?: string;
+}
+
+export interface OrderDiscountCreateParams {
+  /**
+   * The code a buyer enters to apply this discount to an order.
+   *
+   * Codes are unique within your account and are compared without regard to letter
+   * case, so `SAVE10` collides with `save10`.
+   */
+  code: 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;
+
+  /**
+   * The flat amount to take off the order total, as a decimal string.
+   *
+   * Only read when `discount_type` is `amount`. Leaving it out stores `0`, which
+   * produces a discount that takes nothing off.
+   */
+  amount?: string;
+
+  /**
+   * The fraction of the order total to take off, as a decimal string.
+   *
+   * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+   * when `discount_type` is `percentage`. Leaving it out stores `0`, which produces
+   * a discount that takes nothing off.
+   */
+  percentage?: string;
+}
+
+export interface OrderDiscountUpdateParams {
+  /**
+   * The flat amount to take 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 compared without regard to letter
+   * case.
+   */
+  code?: 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`.
+   *
+   * Switching the type does not move the stored figure across, so send the matching
+   * `percentage` or `amount` in the same request or the discount will take nothing
+   * off.
+   */
+  discount_type?: 'percentage' | 'amount';
+
+  /**
+   * Display name of the discount.
+   */
+  name?: string;
+
+  /**
+   * The fraction of the order total to take off, as a decimal string.
+   *
+   * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+   * when `discount_type` is `percentage`.
+   */
+  percentage?: string;
+}
+
+OrderDiscounts.Actions = Actions;
+
+export declare namespace OrderDiscounts {
+  export {
+    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 {
+    Actions as Actions,
+    type FindOrderDiscountByCodeRequest as FindOrderDiscountByCodeRequest,
+    type ActionFindByCodeParams as ActionFindByCodeParams,
+  };
+}

package/src/resources/sales/order-discounts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './order-discounts/index';