@augno/sdk 0.17.0 → 0.18.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -4
- package/package.json +1 -1
- package/resources/ai/memories.d.mts +6 -6
- package/resources/ai/memories.d.mts.map +1 -1
- package/resources/ai/memories.d.ts +6 -6
- package/resources/ai/memories.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +8 -0
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +8 -0
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/catalog/items/attributes.d.mts +3 -0
- package/resources/catalog/items/attributes.d.mts.map +1 -1
- package/resources/catalog/items/attributes.d.ts +3 -0
- package/resources/catalog/items/attributes.d.ts.map +1 -1
- package/resources/catalog/items/attributes.js +3 -0
- package/resources/catalog/items/attributes.js.map +1 -1
- package/resources/catalog/items/attributes.mjs +3 -0
- package/resources/catalog/items/attributes.mjs.map +1 -1
- package/resources/catalog/materials/materials.d.mts +6 -0
- package/resources/catalog/materials/materials.d.mts.map +1 -1
- package/resources/catalog/materials/materials.d.ts +6 -0
- package/resources/catalog/materials/materials.d.ts.map +1 -1
- package/resources/catalog/materials/materials.js.map +1 -1
- package/resources/catalog/materials/materials.mjs.map +1 -1
- package/resources/catalog/parts/parts.d.mts +6 -0
- package/resources/catalog/parts/parts.d.mts.map +1 -1
- package/resources/catalog/parts/parts.d.ts +6 -0
- package/resources/catalog/parts/parts.d.ts.map +1 -1
- package/resources/catalog/parts/parts.js.map +1 -1
- package/resources/catalog/parts/parts.mjs.map +1 -1
- package/resources/catalog/products/products.d.mts +6 -4
- package/resources/catalog/products/products.d.mts.map +1 -1
- package/resources/catalog/products/products.d.ts +6 -4
- package/resources/catalog/products/products.d.ts.map +1 -1
- package/resources/catalog/products/products.js.map +1 -1
- package/resources/catalog/products/products.mjs.map +1 -1
- package/resources/core/actions.d.mts +73 -0
- package/resources/core/actions.d.mts.map +1 -0
- package/resources/core/actions.d.ts +73 -0
- package/resources/core/actions.d.ts.map +1 -0
- package/resources/core/actions.js +36 -0
- package/resources/core/actions.js.map +1 -0
- package/resources/core/actions.mjs +32 -0
- package/resources/core/actions.mjs.map +1 -0
- package/resources/core/audit-events.d.mts +4 -4
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +4 -4
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/core.d.mts +6 -2
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +6 -2
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js +4 -0
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs +4 -0
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/index.d.mts +1 -0
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +1 -0
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.js +3 -1
- package/resources/core/index.js.map +1 -1
- package/resources/core/index.mjs +1 -0
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/jobs.d.mts +1 -1
- package/resources/core/jobs.d.mts.map +1 -1
- package/resources/core/jobs.d.ts +1 -1
- package/resources/core/jobs.d.ts.map +1 -1
- package/resources/finance/payment-terms.d.mts +5 -5
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +5 -5
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs.map +1 -1
- package/resources/messaging/conversations/conversations.d.mts +3 -3
- package/resources/messaging/conversations/conversations.d.mts.map +1 -1
- package/resources/messaging/conversations/conversations.d.ts +3 -3
- package/resources/messaging/conversations/conversations.d.ts.map +1 -1
- package/resources/messaging/conversations/conversations.js.map +1 -1
- package/resources/messaging/conversations/conversations.mjs.map +1 -1
- package/resources/messaging/conversations/links.d.mts +2 -2
- package/resources/messaging/conversations/links.d.mts.map +1 -1
- package/resources/messaging/conversations/links.d.ts +2 -2
- package/resources/messaging/conversations/links.d.ts.map +1 -1
- package/resources/messaging/conversations/messages.d.mts +2 -2
- package/resources/messaging/conversations/messages.d.mts.map +1 -1
- package/resources/messaging/conversations/messages.d.ts +2 -2
- package/resources/messaging/conversations/messages.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.d.mts +2 -2
- package/resources/messaging/notifications/notifications.d.mts.map +1 -1
- package/resources/messaging/notifications/notifications.d.ts +2 -2
- package/resources/messaging/notifications/notifications.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.js.map +1 -1
- package/resources/messaging/notifications/notifications.mjs.map +1 -1
- package/resources/operations/carriers/carriers.d.mts +5 -5
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +5 -5
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +5 -5
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +5 -5
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/index.d.mts +1 -0
- package/resources/operations/index.d.mts.map +1 -1
- package/resources/operations/index.d.ts +1 -0
- package/resources/operations/index.d.ts.map +1 -1
- package/resources/operations/index.js +9 -7
- package/resources/operations/index.js.map +1 -1
- package/resources/operations/index.mjs +1 -0
- package/resources/operations/index.mjs.map +1 -1
- package/resources/operations/operating-calendars/closures.d.mts +173 -0
- package/resources/operations/operating-calendars/closures.d.mts.map +1 -0
- package/resources/operations/operating-calendars/closures.d.ts +173 -0
- package/resources/operations/operating-calendars/closures.d.ts.map +1 -0
- package/resources/operations/operating-calendars/closures.js +81 -0
- package/resources/operations/operating-calendars/closures.js.map +1 -0
- package/resources/operations/operating-calendars/closures.mjs +77 -0
- package/resources/operations/operating-calendars/closures.mjs.map +1 -0
- package/resources/operations/operating-calendars/index.d.mts +3 -0
- package/resources/operations/operating-calendars/index.d.mts.map +1 -0
- package/resources/operations/operating-calendars/index.d.ts +3 -0
- package/resources/operations/operating-calendars/index.d.ts.map +1 -0
- package/resources/operations/operating-calendars/index.js +9 -0
- package/resources/operations/operating-calendars/index.js.map +1 -0
- package/resources/operations/operating-calendars/index.mjs +4 -0
- package/resources/operations/operating-calendars/index.mjs.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.d.mts +332 -0
- package/resources/operations/operating-calendars/operating-calendars.d.mts.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.d.ts +332 -0
- package/resources/operations/operating-calendars/operating-calendars.d.ts.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.js +129 -0
- package/resources/operations/operating-calendars/operating-calendars.js.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.mjs +124 -0
- package/resources/operations/operating-calendars/operating-calendars.mjs.map +1 -0
- package/resources/operations/operating-calendars.d.mts +2 -0
- package/resources/operations/operating-calendars.d.mts.map +1 -0
- package/resources/operations/operating-calendars.d.ts +2 -0
- package/resources/operations/operating-calendars.d.ts.map +1 -0
- package/resources/operations/operating-calendars.js +6 -0
- package/resources/operations/operating-calendars.js.map +1 -0
- package/resources/operations/operating-calendars.mjs +3 -0
- package/resources/operations/operating-calendars.mjs.map +1 -0
- package/resources/operations/operations.d.mts +4 -0
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +4 -0
- package/resources/operations/operations.d.ts.map +1 -1
- package/resources/operations/operations.js +4 -0
- package/resources/operations/operations.js.map +1 -1
- package/resources/operations/operations.mjs +4 -0
- package/resources/operations/operations.mjs.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts +30 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts +30 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.js.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.mjs.map +1 -1
- package/resources/operations/production-schedules/lines.d.mts +10 -6
- package/resources/operations/production-schedules/lines.d.mts.map +1 -1
- package/resources/operations/production-schedules/lines.d.ts +10 -6
- package/resources/operations/production-schedules/lines.d.ts.map +1 -1
- package/resources/operations/shipments/actions.d.mts +3 -3
- package/resources/operations/shipments/actions.d.mts.map +1 -1
- package/resources/operations/shipments/actions.d.ts +3 -3
- package/resources/operations/shipments/actions.d.ts.map +1 -1
- package/resources/operations/shipping-terms.d.mts +5 -5
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +5 -5
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/sales/account-prices/account-prices.d.mts +1007 -0
- package/resources/sales/account-prices/account-prices.d.mts.map +1 -0
- package/resources/sales/account-prices/account-prices.d.ts +1007 -0
- package/resources/sales/account-prices/account-prices.d.ts.map +1 -0
- package/resources/sales/account-prices/account-prices.js +143 -0
- package/resources/sales/account-prices/account-prices.js.map +1 -0
- package/resources/sales/account-prices/account-prices.mjs +138 -0
- package/resources/sales/account-prices/account-prices.mjs.map +1 -0
- package/resources/sales/account-prices/actions.d.mts +58 -0
- package/resources/sales/account-prices/actions.d.mts.map +1 -0
- package/resources/sales/account-prices/actions.d.ts +58 -0
- package/resources/sales/account-prices/actions.d.ts.map +1 -0
- package/resources/sales/account-prices/actions.js +44 -0
- package/resources/sales/account-prices/actions.js.map +1 -0
- package/resources/sales/account-prices/actions.mjs +40 -0
- package/resources/sales/account-prices/actions.mjs.map +1 -0
- package/resources/sales/account-prices/index.d.mts +3 -0
- package/resources/sales/account-prices/index.d.mts.map +1 -0
- package/resources/sales/account-prices/index.d.ts +3 -0
- package/resources/sales/account-prices/index.d.ts.map +1 -0
- package/resources/sales/account-prices/index.js +9 -0
- package/resources/sales/account-prices/index.js.map +1 -0
- package/resources/sales/account-prices/index.mjs +4 -0
- package/resources/sales/account-prices/index.mjs.map +1 -0
- package/resources/sales/account-prices.d.mts +2 -0
- package/resources/sales/account-prices.d.mts.map +1 -0
- package/resources/sales/account-prices.d.ts +2 -0
- package/resources/sales/account-prices.d.ts.map +1 -0
- package/resources/sales/account-prices.js +6 -0
- package/resources/sales/account-prices.js.map +1 -0
- package/resources/sales/account-prices.mjs +3 -0
- package/resources/sales/account-prices.mjs.map +1 -0
- package/resources/sales/addresses.d.mts +20 -0
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +20 -0
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/customers/actions.d.mts +2 -2
- package/resources/sales/customers/actions.d.mts.map +1 -1
- package/resources/sales/customers/actions.d.ts +2 -2
- package/resources/sales/customers/actions.d.ts.map +1 -1
- package/resources/sales/customers/actions.js.map +1 -1
- package/resources/sales/customers/actions.mjs.map +1 -1
- package/resources/sales/customers/customers.d.mts +35 -564
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +35 -564
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/resources/sales/customers/index.d.mts +1 -1
- package/resources/sales/customers/index.d.mts.map +1 -1
- package/resources/sales/customers/index.d.ts +1 -1
- package/resources/sales/customers/index.d.ts.map +1 -1
- package/resources/sales/customers/index.js.map +1 -1
- package/resources/sales/customers/index.mjs.map +1 -1
- package/resources/sales/index.d.mts +6 -3
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +6 -3
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js +15 -9
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs +3 -0
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/order-discounts/actions.d.mts +85 -0
- package/resources/sales/order-discounts/actions.d.mts.map +1 -0
- package/resources/sales/order-discounts/actions.d.ts +85 -0
- package/resources/sales/order-discounts/actions.d.ts.map +1 -0
- package/resources/sales/order-discounts/actions.js +35 -0
- package/resources/sales/order-discounts/actions.js.map +1 -0
- package/resources/sales/order-discounts/actions.mjs +31 -0
- package/resources/sales/order-discounts/actions.mjs.map +1 -0
- package/resources/sales/order-discounts/index.d.mts +3 -0
- package/resources/sales/order-discounts/index.d.mts.map +1 -0
- package/resources/sales/order-discounts/index.d.ts +3 -0
- package/resources/sales/order-discounts/index.d.ts.map +1 -0
- package/resources/sales/order-discounts/index.js +9 -0
- package/resources/sales/order-discounts/index.js.map +1 -0
- package/resources/sales/order-discounts/index.mjs +4 -0
- package/resources/sales/order-discounts/index.mjs.map +1 -0
- package/resources/sales/order-discounts/order-discounts.d.mts +365 -0
- package/resources/sales/order-discounts/order-discounts.d.mts.map +1 -0
- package/resources/sales/order-discounts/order-discounts.d.ts +365 -0
- package/resources/sales/order-discounts/order-discounts.d.ts.map +1 -0
- package/resources/sales/order-discounts/order-discounts.js +125 -0
- package/resources/sales/order-discounts/order-discounts.js.map +1 -0
- package/resources/sales/order-discounts/order-discounts.mjs +120 -0
- package/resources/sales/order-discounts/order-discounts.mjs.map +1 -0
- package/resources/sales/order-discounts.d.mts +2 -0
- package/resources/sales/order-discounts.d.mts.map +1 -0
- package/resources/sales/order-discounts.d.ts +2 -0
- package/resources/sales/order-discounts.d.ts.map +1 -0
- package/resources/sales/order-discounts.js +6 -0
- package/resources/sales/order-discounts.js.map +1 -0
- package/resources/sales/order-discounts.mjs +3 -0
- package/resources/sales/order-discounts.mjs.map +1 -0
- package/resources/sales/priorities.d.mts +4 -44
- package/resources/sales/priorities.d.mts.map +1 -1
- package/resources/sales/priorities.d.ts +4 -44
- package/resources/sales/priorities.d.ts.map +1 -1
- package/resources/sales/priorities.js.map +1 -1
- package/resources/sales/priorities.mjs.map +1 -1
- package/resources/sales/sales-orders/actions.d.mts +205 -1
- package/resources/sales/sales-orders/actions.d.mts.map +1 -1
- package/resources/sales/sales-orders/actions.d.ts +205 -1
- package/resources/sales/sales-orders/actions.d.ts.map +1 -1
- package/resources/sales/sales-orders/actions.js +36 -0
- package/resources/sales/sales-orders/actions.js.map +1 -1
- package/resources/sales/sales-orders/actions.mjs +36 -0
- package/resources/sales/sales-orders/actions.mjs.map +1 -1
- package/resources/sales/sales-orders/index.d.mts +2 -2
- package/resources/sales/sales-orders/index.d.mts.map +1 -1
- package/resources/sales/sales-orders/index.d.ts +2 -2
- package/resources/sales/sales-orders/index.d.ts.map +1 -1
- package/resources/sales/sales-orders/index.js.map +1 -1
- package/resources/sales/sales-orders/index.mjs.map +1 -1
- package/resources/sales/sales-orders/lines/lines.d.mts +2 -2
- package/resources/sales/sales-orders/lines/lines.d.mts.map +1 -1
- package/resources/sales/sales-orders/lines/lines.d.ts +2 -2
- package/resources/sales/sales-orders/lines/lines.d.ts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.mts +115 -78
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.ts +115 -78
- package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +18 -6
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +18 -6
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js +12 -0
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs +12 -0
- package/resources/sales/sales.mjs.map +1 -1
- package/resources/sales/volume-discounts.d.mts +684 -0
- package/resources/sales/volume-discounts.d.mts.map +1 -0
- package/resources/sales/volume-discounts.d.ts +684 -0
- package/resources/sales/volume-discounts.d.ts.map +1 -0
- package/resources/sales/volume-discounts.js +152 -0
- package/resources/sales/volume-discounts.js.map +1 -0
- package/resources/sales/volume-discounts.mjs +148 -0
- package/resources/sales/volume-discounts.mjs.map +1 -0
- package/src/resources/ai/memories.ts +6 -6
- package/src/resources/auth/api-keys/api-keys.ts +9 -0
- package/src/resources/catalog/items/attributes.ts +3 -0
- package/src/resources/catalog/materials/materials.ts +6 -0
- package/src/resources/catalog/parts/parts.ts +6 -0
- package/src/resources/catalog/products/products.ts +6 -4
- package/src/resources/core/actions.ts +89 -0
- package/src/resources/core/audit-events.ts +12 -0
- package/src/resources/core/core.ts +17 -0
- package/src/resources/core/index.ts +6 -0
- package/src/resources/core/jobs.ts +3 -0
- package/src/resources/finance/payment-terms.ts +8 -5
- package/src/resources/messaging/conversations/conversations.ts +9 -0
- package/src/resources/messaging/conversations/links.ts +6 -0
- package/src/resources/messaging/conversations/messages.ts +6 -0
- package/src/resources/messaging/notifications/notifications.ts +6 -0
- package/src/resources/operations/carriers/carriers.ts +5 -5
- package/src/resources/operations/carriers/service-levels.ts +5 -5
- package/src/resources/operations/index.ts +11 -0
- package/src/resources/operations/operating-calendars/closures.ts +223 -0
- package/src/resources/operations/operating-calendars/index.ts +23 -0
- package/src/resources/operations/operating-calendars/operating-calendars.ts +427 -0
- package/src/resources/operations/operating-calendars.ts +3 -0
- package/src/resources/operations/operations.ts +28 -0
- package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts +36 -0
- package/src/resources/operations/production-schedules/lines.ts +10 -6
- package/src/resources/operations/shipments/actions.ts +3 -3
- package/src/resources/operations/shipping-terms.ts +8 -5
- package/src/resources/sales/account-prices/account-prices.ts +1200 -0
- package/src/resources/sales/account-prices/actions.ts +74 -0
- package/src/resources/sales/account-prices/index.ts +27 -0
- package/src/resources/sales/account-prices.ts +3 -0
- package/src/resources/sales/addresses.ts +24 -0
- package/src/resources/sales/customers/actions.ts +6 -2
- package/src/resources/sales/customers/customers.ts +37 -657
- package/src/resources/sales/customers/index.ts +0 -11
- package/src/resources/sales/index.ts +50 -13
- package/src/resources/sales/order-discounts/actions.ts +102 -0
- package/src/resources/sales/order-discounts/index.ts +13 -0
- package/src/resources/sales/order-discounts/order-discounts.ts +442 -0
- package/src/resources/sales/order-discounts.ts +3 -0
- package/src/resources/sales/priorities.ts +3 -51
- package/src/resources/sales/sales-orders/actions.ts +252 -0
- package/src/resources/sales/sales-orders/index.ts +4 -1
- package/src/resources/sales/sales-orders/lines/lines.ts +2 -2
- package/src/resources/sales/sales-orders/sales-orders.ts +139 -86
- package/src/resources/sales/sales.ts +113 -26
- package/src/resources/sales/volume-discounts.ts +813 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.VolumeDiscounts = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* List and manage volume discounts.
|
|
9
|
+
*/
|
|
10
|
+
class VolumeDiscounts extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Returns a paginated list of volume discounts, newest first.
|
|
13
|
+
*
|
|
14
|
+
* The search term matches the discount name, the name of a customer group it is
|
|
15
|
+
* scoped to, or the name of a product line it is scoped to. Customer portal users
|
|
16
|
+
* see only discounts with no customer-group restriction plus those scoped to a
|
|
17
|
+
* group their own account belongs to.
|
|
18
|
+
*
|
|
19
|
+
* This endpoint requires the permissions: `discounts:read`, `customers:read`,
|
|
20
|
+
* `suppliers:read`.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const listVolumeDiscount =
|
|
25
|
+
* await client.sales.volumeDiscounts.list();
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
list(query = {}, options) {
|
|
29
|
+
return this._client.get('/v1/sales/volume-discounts', { query, ...options });
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Returns a volume discount by ID.
|
|
33
|
+
*
|
|
34
|
+
* This endpoint requires the permissions: `discounts:read`, `customers:read`,
|
|
35
|
+
* `suppliers:read`.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const volumeDiscount =
|
|
40
|
+
* await client.sales.volumeDiscounts.retrieve(
|
|
41
|
+
* 'quds_bn7hto9s10pp',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieve(id, query = {}, options) {
|
|
46
|
+
return this._client.get((0, path_1.path) `/v1/sales/volume-discounts/${id}`, { query, ...options });
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Creates a volume discount with its tiers and scoping associations.
|
|
50
|
+
*
|
|
51
|
+
* The discount name must be unique within the account; creating a discount with an
|
|
52
|
+
* existing name returns a conflict error.
|
|
53
|
+
*
|
|
54
|
+
* Each scoping list narrows the order lines the discount applies to, and an empty
|
|
55
|
+
* list places no restriction on that dimension. Because tier thresholds are
|
|
56
|
+
* compared against quantities converted into `unit_ids`, a discount created
|
|
57
|
+
* without any units never reaches a threshold above zero.
|
|
58
|
+
*
|
|
59
|
+
* This endpoint requires the permission: `discounts:create`.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const volumeDiscount =
|
|
64
|
+
* await client.sales.volumeDiscounts.create({
|
|
65
|
+
* name: 'Bulk Order Discount',
|
|
66
|
+
* tiers: [
|
|
67
|
+
* {
|
|
68
|
+
* name: '100+ Units',
|
|
69
|
+
* discount_percentage:
|
|
70
|
+
* '5.000000000000000000000000000000',
|
|
71
|
+
* threshold: '100.000000000000000000000000000000',
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* });
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
create(params, options) {
|
|
78
|
+
const { include, ...body } = params;
|
|
79
|
+
return this._client.post('/v1/sales/volume-discounts', { query: { include }, body, ...options });
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Partially updates a volume discount.
|
|
83
|
+
*
|
|
84
|
+
* The tier and association lists are only applied when their corresponding `has_*`
|
|
85
|
+
* flag is `true`, in which case they replace the existing set entirely. Tiers use
|
|
86
|
+
* upsert semantics: tiers with an `id` are updated, tiers without one are created,
|
|
87
|
+
* and existing tiers omitted from the list are deleted.
|
|
88
|
+
*
|
|
89
|
+
* The name must remain unique within the account; reusing another discount's name
|
|
90
|
+
* returns a conflict error. Order lines that have already been priced keep the
|
|
91
|
+
* unit price they were given; the revised discount applies to lines priced after
|
|
92
|
+
* the change.
|
|
93
|
+
*
|
|
94
|
+
* This endpoint requires the permission: `discounts:update`.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```ts
|
|
98
|
+
* const volumeDiscount =
|
|
99
|
+
* await client.sales.volumeDiscounts.update(
|
|
100
|
+
* 'quds_bn7hto9s10pp',
|
|
101
|
+
* {
|
|
102
|
+
* has_attributes: true,
|
|
103
|
+
* has_categories: true,
|
|
104
|
+
* has_customer_groups: true,
|
|
105
|
+
* has_product_lines: true,
|
|
106
|
+
* has_tiers: true,
|
|
107
|
+
* has_units: true,
|
|
108
|
+
* name: 'Updated Bulk Discount',
|
|
109
|
+
* tiers: [
|
|
110
|
+
* {
|
|
111
|
+
* name: '50+ Units',
|
|
112
|
+
* discount_percentage:
|
|
113
|
+
* '10.000000000000000000000000000000',
|
|
114
|
+
* threshold: '50.000000000000000000000000000000',
|
|
115
|
+
* },
|
|
116
|
+
* ],
|
|
117
|
+
* },
|
|
118
|
+
* );
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
update(id, params, options) {
|
|
122
|
+
const { include, ...body } = params;
|
|
123
|
+
return this._client.patch((0, path_1.path) `/v1/sales/volume-discounts/${id}`, {
|
|
124
|
+
query: { include },
|
|
125
|
+
body,
|
|
126
|
+
...options,
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Deletes a volume discount along with its tiers and scoping associations.
|
|
131
|
+
*
|
|
132
|
+
* Deletion is permanent; further requests against the deleted ID return an error.
|
|
133
|
+
*
|
|
134
|
+
* Order lines that have already been priced keep the unit price they were given;
|
|
135
|
+
* only lines priced after the deletion lose the discount.
|
|
136
|
+
*
|
|
137
|
+
* This endpoint requires the permission: `discounts:delete`.
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* ```ts
|
|
141
|
+
* const volumeDiscount =
|
|
142
|
+
* await client.sales.volumeDiscounts.delete(
|
|
143
|
+
* 'quds_bn7hto9s10pp',
|
|
144
|
+
* );
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
delete(id, options) {
|
|
148
|
+
return this._client.delete((0, path_1.path) `/v1/sales/volume-discounts/${id}`, options);
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
exports.VolumeDiscounts = VolumeDiscounts;
|
|
152
|
+
//# sourceMappingURL=volume-discounts.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"volume-discounts.js","sourceRoot":"","sources":["../../src/resources/sales/volume-discounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AASlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAkC,EAAE,OAAwB;QACjE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,8BAA8B,EAAE,EAAE,EAAE;YAChE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AA3JD,0CA2JC"}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* List and manage volume discounts.
|
|
6
|
+
*/
|
|
7
|
+
export class VolumeDiscounts extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns a paginated list of volume discounts, newest first.
|
|
10
|
+
*
|
|
11
|
+
* The search term matches the discount name, the name of a customer group it is
|
|
12
|
+
* scoped to, or the name of a product line it is scoped to. Customer portal users
|
|
13
|
+
* see only discounts with no customer-group restriction plus those scoped to a
|
|
14
|
+
* group their own account belongs to.
|
|
15
|
+
*
|
|
16
|
+
* This endpoint requires the permissions: `discounts:read`, `customers:read`,
|
|
17
|
+
* `suppliers:read`.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const listVolumeDiscount =
|
|
22
|
+
* await client.sales.volumeDiscounts.list();
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
list(query = {}, options) {
|
|
26
|
+
return this._client.get('/v1/sales/volume-discounts', { query, ...options });
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Returns a volume discount by ID.
|
|
30
|
+
*
|
|
31
|
+
* This endpoint requires the permissions: `discounts:read`, `customers:read`,
|
|
32
|
+
* `suppliers:read`.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const volumeDiscount =
|
|
37
|
+
* await client.sales.volumeDiscounts.retrieve(
|
|
38
|
+
* 'quds_bn7hto9s10pp',
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
retrieve(id, query = {}, options) {
|
|
43
|
+
return this._client.get(path `/v1/sales/volume-discounts/${id}`, { query, ...options });
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Creates a volume discount with its tiers and scoping associations.
|
|
47
|
+
*
|
|
48
|
+
* The discount name must be unique within the account; creating a discount with an
|
|
49
|
+
* existing name returns a conflict error.
|
|
50
|
+
*
|
|
51
|
+
* Each scoping list narrows the order lines the discount applies to, and an empty
|
|
52
|
+
* list places no restriction on that dimension. Because tier thresholds are
|
|
53
|
+
* compared against quantities converted into `unit_ids`, a discount created
|
|
54
|
+
* without any units never reaches a threshold above zero.
|
|
55
|
+
*
|
|
56
|
+
* This endpoint requires the permission: `discounts:create`.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const volumeDiscount =
|
|
61
|
+
* await client.sales.volumeDiscounts.create({
|
|
62
|
+
* name: 'Bulk Order Discount',
|
|
63
|
+
* tiers: [
|
|
64
|
+
* {
|
|
65
|
+
* name: '100+ Units',
|
|
66
|
+
* discount_percentage:
|
|
67
|
+
* '5.000000000000000000000000000000',
|
|
68
|
+
* threshold: '100.000000000000000000000000000000',
|
|
69
|
+
* },
|
|
70
|
+
* ],
|
|
71
|
+
* });
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
create(params, options) {
|
|
75
|
+
const { include, ...body } = params;
|
|
76
|
+
return this._client.post('/v1/sales/volume-discounts', { query: { include }, body, ...options });
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Partially updates a volume discount.
|
|
80
|
+
*
|
|
81
|
+
* The tier and association lists are only applied when their corresponding `has_*`
|
|
82
|
+
* flag is `true`, in which case they replace the existing set entirely. Tiers use
|
|
83
|
+
* upsert semantics: tiers with an `id` are updated, tiers without one are created,
|
|
84
|
+
* and existing tiers omitted from the list are deleted.
|
|
85
|
+
*
|
|
86
|
+
* The name must remain unique within the account; reusing another discount's name
|
|
87
|
+
* returns a conflict error. Order lines that have already been priced keep the
|
|
88
|
+
* unit price they were given; the revised discount applies to lines priced after
|
|
89
|
+
* the change.
|
|
90
|
+
*
|
|
91
|
+
* This endpoint requires the permission: `discounts:update`.
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* const volumeDiscount =
|
|
96
|
+
* await client.sales.volumeDiscounts.update(
|
|
97
|
+
* 'quds_bn7hto9s10pp',
|
|
98
|
+
* {
|
|
99
|
+
* has_attributes: true,
|
|
100
|
+
* has_categories: true,
|
|
101
|
+
* has_customer_groups: true,
|
|
102
|
+
* has_product_lines: true,
|
|
103
|
+
* has_tiers: true,
|
|
104
|
+
* has_units: true,
|
|
105
|
+
* name: 'Updated Bulk Discount',
|
|
106
|
+
* tiers: [
|
|
107
|
+
* {
|
|
108
|
+
* name: '50+ Units',
|
|
109
|
+
* discount_percentage:
|
|
110
|
+
* '10.000000000000000000000000000000',
|
|
111
|
+
* threshold: '50.000000000000000000000000000000',
|
|
112
|
+
* },
|
|
113
|
+
* ],
|
|
114
|
+
* },
|
|
115
|
+
* );
|
|
116
|
+
* ```
|
|
117
|
+
*/
|
|
118
|
+
update(id, params, options) {
|
|
119
|
+
const { include, ...body } = params;
|
|
120
|
+
return this._client.patch(path `/v1/sales/volume-discounts/${id}`, {
|
|
121
|
+
query: { include },
|
|
122
|
+
body,
|
|
123
|
+
...options,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Deletes a volume discount along with its tiers and scoping associations.
|
|
128
|
+
*
|
|
129
|
+
* Deletion is permanent; further requests against the deleted ID return an error.
|
|
130
|
+
*
|
|
131
|
+
* Order lines that have already been priced keep the unit price they were given;
|
|
132
|
+
* only lines priced after the deletion lose the discount.
|
|
133
|
+
*
|
|
134
|
+
* This endpoint requires the permission: `discounts:delete`.
|
|
135
|
+
*
|
|
136
|
+
* @example
|
|
137
|
+
* ```ts
|
|
138
|
+
* const volumeDiscount =
|
|
139
|
+
* await client.sales.volumeDiscounts.delete(
|
|
140
|
+
* 'quds_bn7hto9s10pp',
|
|
141
|
+
* );
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
delete(id, options) {
|
|
145
|
+
return this._client.delete(path `/v1/sales/volume-discounts/${id}`, options);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=volume-discounts.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"volume-discounts.mjs","sourceRoot":"","sources":["../../src/resources/sales/volume-discounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OASf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAkC,EAAE,OAAwB;QACjE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,8BAA8B,EAAE,EAAE,EAAE;YAChE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8BAA8B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}
|
|
@@ -139,7 +139,7 @@ export interface AgentMemory {
|
|
|
139
139
|
* - `instruction`: standing guidance for agents to follow, such as always
|
|
140
140
|
* confirming freight before issuing an order.
|
|
141
141
|
*/
|
|
142
|
-
category:
|
|
142
|
+
category: 'preference' | 'fact' | 'instruction';
|
|
143
143
|
|
|
144
144
|
/**
|
|
145
145
|
* The information itself, written as plain text for an agent to read.
|
|
@@ -205,7 +205,7 @@ export interface CreateMemoryRequest {
|
|
|
205
205
|
* - `instruction`: standing guidance for agents to follow, such as always
|
|
206
206
|
* confirming freight before issuing an order.
|
|
207
207
|
*/
|
|
208
|
-
category:
|
|
208
|
+
category: 'preference' | 'fact' | 'instruction';
|
|
209
209
|
|
|
210
210
|
/**
|
|
211
211
|
* The information to remember, written as plain text for an agent to read.
|
|
@@ -295,7 +295,7 @@ export interface UpdateMemoryRequest {
|
|
|
295
295
|
* - `instruction`: standing guidance for agents to follow, such as always
|
|
296
296
|
* confirming freight before issuing an order.
|
|
297
297
|
*/
|
|
298
|
-
category?:
|
|
298
|
+
category?: 'preference' | 'fact' | 'instruction';
|
|
299
299
|
|
|
300
300
|
/**
|
|
301
301
|
* The information to remember, written as plain text for an agent to read.
|
|
@@ -352,7 +352,7 @@ export interface MemoryListParams {
|
|
|
352
352
|
/**
|
|
353
353
|
* Filter to memories with this exact category (e.g. `preference`, `fact`).
|
|
354
354
|
*/
|
|
355
|
-
category?:
|
|
355
|
+
category?: 'preference' | 'fact' | 'instruction';
|
|
356
356
|
|
|
357
357
|
/**
|
|
358
358
|
* Opaque cursor token identifying where the page of results starts.
|
|
@@ -392,7 +392,7 @@ export interface MemoryCreateParams {
|
|
|
392
392
|
* - `instruction`: standing guidance for agents to follow, such as always
|
|
393
393
|
* confirming freight before issuing an order.
|
|
394
394
|
*/
|
|
395
|
-
category:
|
|
395
|
+
category: 'preference' | 'fact' | 'instruction';
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
398
|
* The information to remember, written as plain text for an agent to read.
|
|
@@ -452,7 +452,7 @@ export interface MemoryUpdateParams {
|
|
|
452
452
|
* - `instruction`: standing guidance for agents to follow, such as always
|
|
453
453
|
* confirming freight before issuing an order.
|
|
454
454
|
*/
|
|
455
|
-
category?:
|
|
455
|
+
category?: 'preference' | 'fact' | 'instruction';
|
|
456
456
|
|
|
457
457
|
/**
|
|
458
458
|
* The information to remember, written as plain text for an agent to read.
|
|
@@ -314,6 +314,15 @@ export interface Address {
|
|
|
314
314
|
*/
|
|
315
315
|
phone: string | null;
|
|
316
316
|
|
|
317
|
+
/**
|
|
318
|
+
* The operating calendar naming the days this dock accepts freight.
|
|
319
|
+
*
|
|
320
|
+
* The most specific link in the receiving chain: set it when one of a customer's
|
|
321
|
+
* sites keeps different days from the rest. Null falls through to the customer,
|
|
322
|
+
* then their group, then the account default.
|
|
323
|
+
*/
|
|
324
|
+
receive_calendar_id: string | null;
|
|
325
|
+
|
|
317
326
|
/**
|
|
318
327
|
* How the address is used.
|
|
319
328
|
*
|
|
@@ -13,6 +13,9 @@ export class Attributes extends APIResource {
|
|
|
13
13
|
/**
|
|
14
14
|
* Assigns an attribute to an item and returns the updated item.
|
|
15
15
|
*
|
|
16
|
+
* The attribute's property must be one the item's category carries, so link the
|
|
17
|
+
* property to the category before assigning any of its attributes.
|
|
18
|
+
*
|
|
16
19
|
* Adding an attribute the item already carries succeeds and changes nothing, so
|
|
17
20
|
* the call is safe to repeat.
|
|
18
21
|
*
|
|
@@ -198,6 +198,9 @@ export interface CreateMaterialRequest {
|
|
|
198
198
|
|
|
199
199
|
/**
|
|
200
200
|
* IDs of existing attributes to link to the material at creation time.
|
|
201
|
+
*
|
|
202
|
+
* Each attribute's property must be one the material's category carries; an
|
|
203
|
+
* attribute from any other property fails the whole request.
|
|
201
204
|
*/
|
|
202
205
|
attribute_ids?: Array<string>;
|
|
203
206
|
|
|
@@ -511,6 +514,9 @@ export interface MaterialCreateParams {
|
|
|
511
514
|
|
|
512
515
|
/**
|
|
513
516
|
* Body param: IDs of existing attributes to link to the material at creation time.
|
|
517
|
+
*
|
|
518
|
+
* Each attribute's property must be one the material's category carries; an
|
|
519
|
+
* attribute from any other property fails the whole request.
|
|
514
520
|
*/
|
|
515
521
|
attribute_ids?: Array<string>;
|
|
516
522
|
|
|
@@ -175,6 +175,9 @@ export interface CreatePartRequest {
|
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
177
|
* IDs of existing attributes to link to the part at creation time.
|
|
178
|
+
*
|
|
179
|
+
* Each attribute's property must be one the part's category carries; an attribute
|
|
180
|
+
* from any other property fails the whole request.
|
|
178
181
|
*/
|
|
179
182
|
attribute_ids?: Array<string>;
|
|
180
183
|
|
|
@@ -392,6 +395,9 @@ export interface PartCreateParams {
|
|
|
392
395
|
|
|
393
396
|
/**
|
|
394
397
|
* Body param: IDs of existing attributes to link to the part at creation time.
|
|
398
|
+
*
|
|
399
|
+
* Each attribute's property must be one the part's category carries; an attribute
|
|
400
|
+
* from any other property fails the whole request.
|
|
395
401
|
*/
|
|
396
402
|
attribute_ids?: Array<string>;
|
|
397
403
|
|
|
@@ -246,8 +246,9 @@ export interface CreateProductRequest {
|
|
|
246
246
|
/**
|
|
247
247
|
* Attribute IDs to link to the product's item at creation time.
|
|
248
248
|
*
|
|
249
|
-
* Every ID must already exist in your account
|
|
250
|
-
*
|
|
249
|
+
* Every ID must already exist in your account, and each attribute's property must
|
|
250
|
+
* be one the item's category carries; an ID that fails either check fails the
|
|
251
|
+
* whole request rather than being skipped.
|
|
251
252
|
*/
|
|
252
253
|
attribute_ids?: Array<string>;
|
|
253
254
|
|
|
@@ -614,8 +615,9 @@ export interface ProductCreateParams {
|
|
|
614
615
|
/**
|
|
615
616
|
* Body param: Attribute IDs to link to the product's item at creation time.
|
|
616
617
|
*
|
|
617
|
-
* Every ID must already exist in your account
|
|
618
|
-
*
|
|
618
|
+
* Every ID must already exist in your account, and each attribute's property must
|
|
619
|
+
* be one the item's category carries; an ID that fails either check fails the
|
|
620
|
+
* whole request rather than being skipped.
|
|
619
621
|
*/
|
|
620
622
|
attribute_ids?: Array<string>;
|
|
621
623
|
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import { APIPromise } from '../../core/api-promise';
|
|
5
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Utility action endpoints for checking duplicates and emailing records.
|
|
9
|
+
*/
|
|
10
|
+
export class Actions extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Emails a record (invoice, sales order, or purchase order) to its configured
|
|
13
|
+
* recipients and marks the record as sent.
|
|
14
|
+
*
|
|
15
|
+
* Delivery is asynchronous: the endpoint returns `202 Accepted` once the email is
|
|
16
|
+
* queued, so a `202` means the send was accepted, not that it reached the
|
|
17
|
+
* recipients. If the record has no configured recipients the request still
|
|
18
|
+
* succeeds and nothing is sent; in that case a sales order or purchase order is
|
|
19
|
+
* also left unmarked, while an invoice is still marked as sent.
|
|
20
|
+
*
|
|
21
|
+
* This endpoint requires the permissions: `invoices:read`, `sales_orders:read`,
|
|
22
|
+
* `purchase_orders:read`.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const response = await client.core.actions.emailRecord({
|
|
27
|
+
* id: 'iv_m982ezb0fgp7',
|
|
28
|
+
* type: 'invoice',
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
emailRecord(
|
|
33
|
+
body: ActionEmailRecordParams,
|
|
34
|
+
options?: RequestOptions,
|
|
35
|
+
): APIPromise<ActionEmailRecordResponse> {
|
|
36
|
+
return this._client.post('/v1/core/actions/email-record', { body, ...options });
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Request to email a record to its configured recipients.
|
|
42
|
+
*/
|
|
43
|
+
export interface EmailRecordRequest {
|
|
44
|
+
/**
|
|
45
|
+
* ID of the record to email.
|
|
46
|
+
*/
|
|
47
|
+
id: string;
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* The type of record to email.
|
|
51
|
+
*
|
|
52
|
+
* - `invoice`: emails the invoice to the contacts on its sales order that are set
|
|
53
|
+
* to receive invoice emails.
|
|
54
|
+
* - `sales_order`: sends an order acknowledgement to the order's acknowledgement
|
|
55
|
+
* recipients.
|
|
56
|
+
* - `purchase_order`: sends the purchase order submission to the order's
|
|
57
|
+
* submission recipients.
|
|
58
|
+
*/
|
|
59
|
+
type: 'invoice' | 'sales_order' | 'purchase_order';
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface ActionEmailRecordResponse {}
|
|
63
|
+
|
|
64
|
+
export interface ActionEmailRecordParams {
|
|
65
|
+
/**
|
|
66
|
+
* ID of the record to email.
|
|
67
|
+
*/
|
|
68
|
+
id: string;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* The type of record to email.
|
|
72
|
+
*
|
|
73
|
+
* - `invoice`: emails the invoice to the contacts on its sales order that are set
|
|
74
|
+
* to receive invoice emails.
|
|
75
|
+
* - `sales_order`: sends an order acknowledgement to the order's acknowledgement
|
|
76
|
+
* recipients.
|
|
77
|
+
* - `purchase_order`: sends the purchase order submission to the order's
|
|
78
|
+
* submission recipients.
|
|
79
|
+
*/
|
|
80
|
+
type: 'invoice' | 'sales_order' | 'purchase_order';
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export declare namespace Actions {
|
|
84
|
+
export {
|
|
85
|
+
type EmailRecordRequest as EmailRecordRequest,
|
|
86
|
+
type ActionEmailRecordResponse as ActionEmailRecordResponse,
|
|
87
|
+
type ActionEmailRecordParams as ActionEmailRecordParams,
|
|
88
|
+
};
|
|
89
|
+
}
|
|
@@ -448,6 +448,9 @@ export interface AuditEvent {
|
|
|
448
448
|
| 'checkout_sales_order'
|
|
449
449
|
| 'sales_order_price_quote'
|
|
450
450
|
| 'sales_order_freight_quote'
|
|
451
|
+
| 'sales_order_commitment_quote'
|
|
452
|
+
| 'operating_calendar'
|
|
453
|
+
| 'operating_calendar_closure'
|
|
451
454
|
| 'sales_order_price_quote_line'
|
|
452
455
|
| 'hubspot_sync_job'
|
|
453
456
|
| 'hubspot_sync_report'
|
|
@@ -853,6 +856,9 @@ export interface ListObjectType {
|
|
|
853
856
|
| 'checkout_sales_order'
|
|
854
857
|
| 'sales_order_price_quote'
|
|
855
858
|
| 'sales_order_freight_quote'
|
|
859
|
+
| 'sales_order_commitment_quote'
|
|
860
|
+
| 'operating_calendar'
|
|
861
|
+
| 'operating_calendar_closure'
|
|
856
862
|
| 'sales_order_price_quote_line'
|
|
857
863
|
| 'hubspot_sync_job'
|
|
858
864
|
| 'hubspot_sync_report'
|
|
@@ -1246,6 +1252,9 @@ export interface AuditEventListParams {
|
|
|
1246
1252
|
| 'checkout_sales_order'
|
|
1247
1253
|
| 'sales_order_price_quote'
|
|
1248
1254
|
| 'sales_order_freight_quote'
|
|
1255
|
+
| 'sales_order_commitment_quote'
|
|
1256
|
+
| 'operating_calendar'
|
|
1257
|
+
| 'operating_calendar_closure'
|
|
1249
1258
|
| 'sales_order_price_quote_line'
|
|
1250
1259
|
| 'hubspot_sync_job'
|
|
1251
1260
|
| 'hubspot_sync_report'
|
|
@@ -1562,6 +1571,9 @@ export interface AuditEventListParams {
|
|
|
1562
1571
|
| 'checkout_sales_order'
|
|
1563
1572
|
| 'sales_order_price_quote'
|
|
1564
1573
|
| 'sales_order_freight_quote'
|
|
1574
|
+
| 'sales_order_commitment_quote'
|
|
1575
|
+
| 'operating_calendar'
|
|
1576
|
+
| 'operating_calendar_closure'
|
|
1565
1577
|
| 'sales_order_price_quote_line'
|
|
1566
1578
|
| 'hubspot_sync_job'
|
|
1567
1579
|
| 'hubspot_sync_report'
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as ActionsAPI from './actions';
|
|
5
|
+
import { ActionEmailRecordParams, ActionEmailRecordResponse, Actions, EmailRecordRequest } from './actions';
|
|
4
6
|
import * as AnalyticsAPI from './analytics';
|
|
5
7
|
import {
|
|
6
8
|
Analytics,
|
|
@@ -103,6 +105,7 @@ export class Core extends APIResource {
|
|
|
103
105
|
emailLogs: EmailLogsAPI.EmailLogs = new EmailLogsAPI.EmailLogs(this._client);
|
|
104
106
|
jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
|
|
105
107
|
analytics: AnalyticsAPI.Analytics = new AnalyticsAPI.Analytics(this._client);
|
|
108
|
+
actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
|
|
106
109
|
|
|
107
110
|
/**
|
|
108
111
|
* Searches across multiple resource types at once and returns lightweight `entity`
|
|
@@ -438,6 +441,9 @@ export interface Entity {
|
|
|
438
441
|
| 'checkout_sales_order'
|
|
439
442
|
| 'sales_order_price_quote'
|
|
440
443
|
| 'sales_order_freight_quote'
|
|
444
|
+
| 'sales_order_commitment_quote'
|
|
445
|
+
| 'operating_calendar'
|
|
446
|
+
| 'operating_calendar_closure'
|
|
441
447
|
| 'sales_order_price_quote_line'
|
|
442
448
|
| 'hubspot_sync_job'
|
|
443
449
|
| 'hubspot_sync_report'
|
|
@@ -809,6 +815,9 @@ export interface CoreRetrieveSearchParams {
|
|
|
809
815
|
| 'checkout_sales_order'
|
|
810
816
|
| 'sales_order_price_quote'
|
|
811
817
|
| 'sales_order_freight_quote'
|
|
818
|
+
| 'sales_order_commitment_quote'
|
|
819
|
+
| 'operating_calendar'
|
|
820
|
+
| 'operating_calendar_closure'
|
|
812
821
|
| 'sales_order_price_quote_line'
|
|
813
822
|
| 'hubspot_sync_job'
|
|
814
823
|
| 'hubspot_sync_report'
|
|
@@ -849,6 +858,7 @@ Core.Addresses = Addresses;
|
|
|
849
858
|
Core.EmailLogs = EmailLogs;
|
|
850
859
|
Core.Jobs = Jobs;
|
|
851
860
|
Core.Analytics = Analytics;
|
|
861
|
+
Core.Actions = Actions;
|
|
852
862
|
|
|
853
863
|
export declare namespace Core {
|
|
854
864
|
export {
|
|
@@ -949,4 +959,11 @@ export declare namespace Core {
|
|
|
949
959
|
type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams,
|
|
950
960
|
type AnalyticsUpdateDeliveryPerformanceParams as AnalyticsUpdateDeliveryPerformanceParams,
|
|
951
961
|
};
|
|
962
|
+
|
|
963
|
+
export {
|
|
964
|
+
Actions as Actions,
|
|
965
|
+
type EmailRecordRequest as EmailRecordRequest,
|
|
966
|
+
type ActionEmailRecordResponse as ActionEmailRecordResponse,
|
|
967
|
+
type ActionEmailRecordParams as ActionEmailRecordParams,
|
|
968
|
+
};
|
|
952
969
|
}
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
export {
|
|
4
|
+
Actions,
|
|
5
|
+
type EmailRecordRequest,
|
|
6
|
+
type ActionEmailRecordResponse,
|
|
7
|
+
type ActionEmailRecordParams,
|
|
8
|
+
} from './actions';
|
|
3
9
|
export {
|
|
4
10
|
Addresses,
|
|
5
11
|
type AddressSuggestion,
|
|
@@ -390,6 +390,9 @@ export interface Job {
|
|
|
390
390
|
| 'checkout_sales_order'
|
|
391
391
|
| 'sales_order_price_quote'
|
|
392
392
|
| 'sales_order_freight_quote'
|
|
393
|
+
| 'sales_order_commitment_quote'
|
|
394
|
+
| 'operating_calendar'
|
|
395
|
+
| 'operating_calendar_closure'
|
|
393
396
|
| 'sales_order_price_quote_line'
|
|
394
397
|
| 'hubspot_sync_job'
|
|
395
398
|
| 'hubspot_sync_report'
|