@augno/sdk 0.12.4 → 0.12.5
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 +2 -2
- package/package.json +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +4 -0
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +4 -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/core/audit-events.d.mts +3 -3
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +3 -3
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/core.d.mts +2 -2
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +2 -2
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/request-logs.d.mts +11 -1
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +11 -1
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/identity/accounts.d.mts +34 -0
- package/resources/identity/accounts.d.mts.map +1 -0
- package/resources/identity/accounts.d.ts +34 -0
- package/resources/identity/accounts.d.ts.map +1 -0
- package/resources/identity/accounts.js +35 -0
- package/resources/identity/accounts.js.map +1 -0
- package/resources/identity/accounts.mjs +31 -0
- package/resources/identity/accounts.mjs.map +1 -0
- package/resources/identity/identity.d.mts +4 -0
- package/resources/identity/identity.d.mts.map +1 -1
- package/resources/identity/identity.d.ts +4 -0
- package/resources/identity/identity.d.ts.map +1 -1
- package/resources/identity/identity.js +4 -0
- package/resources/identity/identity.js.map +1 -1
- package/resources/identity/identity.mjs +4 -0
- package/resources/identity/identity.mjs.map +1 -1
- package/resources/identity/index.d.mts +1 -0
- package/resources/identity/index.d.mts.map +1 -1
- package/resources/identity/index.d.ts +1 -0
- package/resources/identity/index.d.ts.map +1 -1
- package/resources/identity/index.js +3 -1
- package/resources/identity/index.js.map +1 -1
- package/resources/identity/index.mjs +1 -0
- package/resources/identity/index.mjs.map +1 -1
- package/resources/messaging/announcements/announcements.d.mts +1 -1
- package/resources/messaging/announcements/announcements.d.mts.map +1 -1
- package/resources/messaging/announcements/announcements.d.ts +1 -1
- package/resources/messaging/announcements/announcements.d.ts.map +1 -1
- package/resources/messaging/announcements/announcements.js.map +1 -1
- package/resources/messaging/announcements/announcements.mjs.map +1 -1
- package/resources/messaging/conversations/conversations.d.mts +32 -19
- package/resources/messaging/conversations/conversations.d.mts.map +1 -1
- package/resources/messaging/conversations/conversations.d.ts +32 -19
- package/resources/messaging/conversations/conversations.d.ts.map +1 -1
- package/resources/messaging/conversations/conversations.js +2 -2
- package/resources/messaging/conversations/conversations.js.map +1 -1
- package/resources/messaging/conversations/conversations.mjs +2 -2
- 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 +6 -6
- package/resources/messaging/notifications/notifications.d.mts.map +1 -1
- package/resources/messaging/notifications/notifications.d.ts +6 -6
- 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/sales/index.d.mts +1 -1
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +1 -1
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js +2 -2
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs +1 -1
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/sales-orders/actions.d.mts +255 -0
- package/resources/sales/sales-orders/actions.d.mts.map +1 -0
- package/resources/sales/sales-orders/actions.d.ts +255 -0
- package/resources/sales/sales-orders/actions.d.ts.map +1 -0
- package/resources/sales/sales-orders/actions.js +156 -0
- package/resources/sales/sales-orders/actions.js.map +1 -0
- package/resources/sales/sales-orders/actions.mjs +152 -0
- package/resources/sales/sales-orders/actions.mjs.map +1 -0
- package/resources/sales/sales-orders/index.d.mts +4 -0
- package/resources/sales/sales-orders/index.d.mts.map +1 -0
- package/resources/sales/sales-orders/index.d.ts +4 -0
- package/resources/sales/sales-orders/index.d.ts.map +1 -0
- package/resources/sales/sales-orders/index.js +11 -0
- package/resources/sales/sales-orders/index.js.map +1 -0
- package/resources/sales/sales-orders/index.mjs +5 -0
- package/resources/sales/sales-orders/index.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/actions.d.mts +56 -0
- package/resources/sales/sales-orders/lines/actions.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/actions.d.ts +56 -0
- package/resources/sales/sales-orders/lines/actions.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/actions.js +38 -0
- package/resources/sales/sales-orders/lines/actions.js.map +1 -0
- package/resources/sales/sales-orders/lines/actions.mjs +34 -0
- package/resources/sales/sales-orders/lines/actions.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/index.d.mts +3 -0
- package/resources/sales/sales-orders/lines/index.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/index.d.ts +3 -0
- package/resources/sales/sales-orders/lines/index.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/index.js +9 -0
- package/resources/sales/sales-orders/lines/index.js.map +1 -0
- package/resources/sales/sales-orders/lines/index.mjs +4 -0
- package/resources/sales/sales-orders/lines/index.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/lines.d.mts +208 -0
- package/resources/sales/sales-orders/lines/lines.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/lines.d.ts +208 -0
- package/resources/sales/sales-orders/lines/lines.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/lines.js +100 -0
- package/resources/sales/sales-orders/lines/lines.js.map +1 -0
- package/resources/sales/sales-orders/lines/lines.mjs +95 -0
- package/resources/sales/sales-orders/lines/lines.mjs.map +1 -0
- package/resources/sales/sales-orders/lines.d.mts +2 -0
- package/resources/sales/sales-orders/lines.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines.d.ts +2 -0
- package/resources/sales/sales-orders/lines.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines.js +6 -0
- package/resources/sales/sales-orders/lines.js.map +1 -0
- package/resources/sales/sales-orders/lines.mjs +3 -0
- package/resources/sales/sales-orders/lines.mjs.map +1 -0
- package/resources/sales/sales-orders/sales-orders.d.mts +1466 -0
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -0
- package/resources/sales/sales-orders/sales-orders.d.ts +1466 -0
- package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -0
- package/resources/sales/sales-orders/sales-orders.js +199 -0
- package/resources/sales/sales-orders/sales-orders.js.map +1 -0
- package/resources/sales/sales-orders/sales-orders.mjs +194 -0
- package/resources/sales/sales-orders/sales-orders.mjs.map +1 -0
- package/resources/sales/sales-orders.d.mts +1 -980
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +1 -980
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +2 -76
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +1 -74
- package/resources/sales/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +3 -3
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +3 -3
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js +2 -2
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs +2 -2
- package/resources/sales/sales.mjs.map +1 -1
- package/src/resources/auth/api-keys/api-keys.ts +5 -0
- package/src/resources/core/audit-events.ts +40 -7
- package/src/resources/core/core.ts +27 -5
- package/src/resources/core/request-logs.ts +46 -0
- package/src/resources/identity/accounts.ts +40 -0
- package/src/resources/identity/identity.ts +6 -0
- package/src/resources/identity/index.ts +1 -0
- package/src/resources/messaging/announcements/announcements.ts +2 -1
- package/src/resources/messaging/conversations/conversations.ts +75 -27
- package/src/resources/messaging/conversations/links.ts +28 -6
- package/src/resources/messaging/conversations/messages.ts +28 -6
- package/src/resources/messaging/notifications/notifications.ts +36 -10
- package/src/resources/sales/index.ts +16 -1
- package/src/resources/sales/sales-orders/actions.ts +316 -0
- package/src/resources/sales/sales-orders/index.ts +60 -0
- package/src/resources/sales/sales-orders/lines/actions.ts +72 -0
- package/src/resources/sales/sales-orders/lines/index.ts +17 -0
- package/src/resources/sales/sales-orders/lines/lines.ts +284 -0
- package/src/resources/sales/sales-orders/lines.ts +3 -0
- package/src/resources/sales/sales-orders/sales-orders.ts +1934 -0
- package/src/resources/sales/sales-orders.ts +1 -1239
- package/src/resources/sales/sales.ts +54 -24
- 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,255 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as BlocksAPI from "../../messaging/blocks.js";
|
|
3
|
+
import * as SalesOrdersAPI from "./sales-orders.js";
|
|
4
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
6
|
+
/**
|
|
7
|
+
* List, view, create, update, and delete sales orders.
|
|
8
|
+
*/
|
|
9
|
+
export declare class Actions extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Deletes multiple sales orders in a single atomic operation.
|
|
12
|
+
*
|
|
13
|
+
* Fulfilled orders cannot be deleted; if any requested order fails this check, no
|
|
14
|
+
* orders are deleted.
|
|
15
|
+
*
|
|
16
|
+
* This endpoint requires the permission: `sales_orders:delete`.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const response =
|
|
21
|
+
* await client.sales.salesOrders.actions.bulkDelete({
|
|
22
|
+
* sales_order_ids: ['or_01d5034136c3ccc048abecc312'],
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
bulkDelete(body: ActionBulkDeleteParams, options?: RequestOptions): APIPromise<ActionBulkDeleteResponse>;
|
|
27
|
+
/**
|
|
28
|
+
* Issues a sales order, transitioning it from `estimate` to `issued`.
|
|
29
|
+
*
|
|
30
|
+
* Issuing commits the order for fulfillment: a pick is created for the order's
|
|
31
|
+
* sale lines and inventory is reserved for each line tied to an inventory item.
|
|
32
|
+
*
|
|
33
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const salesOrder =
|
|
38
|
+
* await client.sales.salesOrders.actions.issue(
|
|
39
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
40
|
+
* { notify_customer: true },
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
issue(id: string, body: ActionIssueParams, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder>;
|
|
45
|
+
/**
|
|
46
|
+
* Unissues a sales order, transitioning it from `issued` back to `estimate`.
|
|
47
|
+
*
|
|
48
|
+
* Deletes the order's pick and releases any inventory reserved when the order was
|
|
49
|
+
* issued.
|
|
50
|
+
*
|
|
51
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const salesOrder =
|
|
56
|
+
* await client.sales.salesOrders.actions.unissue(
|
|
57
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
unissue(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder>;
|
|
62
|
+
/**
|
|
63
|
+
* Closes a sales order, transitioning it from `issued` to `fulfilled`.
|
|
64
|
+
*
|
|
65
|
+
* Sets the order's completion timestamp and marks its pick as finished.
|
|
66
|
+
*
|
|
67
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* const salesOrder =
|
|
72
|
+
* await client.sales.salesOrders.actions.close(
|
|
73
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
close(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder>;
|
|
78
|
+
/**
|
|
79
|
+
* Reopens a sales order, transitioning it from `fulfilled` back to `issued`.
|
|
80
|
+
*
|
|
81
|
+
* Clears the order's completion timestamp and marks its pick as unfinished.
|
|
82
|
+
*
|
|
83
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const salesOrder =
|
|
88
|
+
* await client.sales.salesOrders.actions.open(
|
|
89
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
90
|
+
* );
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
open(id: string, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrder>;
|
|
94
|
+
/**
|
|
95
|
+
* Re-estimates the freight (shipping) charge for an order using the latest carrier
|
|
96
|
+
* rates.
|
|
97
|
+
*
|
|
98
|
+
* Computes what the order's freight charge would be from its current ship-to
|
|
99
|
+
* address, carrier, service level, and line items — applying the same
|
|
100
|
+
* freight-exemption, flat-rate, and live carrier-rate logic used when the order is
|
|
101
|
+
* created. The order is not modified: the returned amount is a quote to review,
|
|
102
|
+
* and callers apply it by updating the order's shipping line. Use this to refresh
|
|
103
|
+
* freight after changing the address or line items, or at any time to re-price
|
|
104
|
+
* against current rates.
|
|
105
|
+
*
|
|
106
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* ```ts
|
|
110
|
+
* const quoteSalesOrderFreightResponse =
|
|
111
|
+
* await client.sales.salesOrders.actions.quoteFreight(
|
|
112
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
113
|
+
* );
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
quoteFreight(id: string, options?: RequestOptions): APIPromise<QuoteSalesOrderFreightResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates a production run from a sales order.
|
|
119
|
+
*
|
|
120
|
+
* Creates a batch for each of the order's item-backed lines, reserves the material
|
|
121
|
+
* inventory required to produce them, and links the run to the order. An order can
|
|
122
|
+
* have at most one production run.
|
|
123
|
+
*
|
|
124
|
+
* This endpoint requires the permission: `production_runs:create`.
|
|
125
|
+
*
|
|
126
|
+
* @example
|
|
127
|
+
* ```ts
|
|
128
|
+
* const productionRun =
|
|
129
|
+
* await client.sales.salesOrders.actions.createProductionRun(
|
|
130
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
131
|
+
* );
|
|
132
|
+
* ```
|
|
133
|
+
*/
|
|
134
|
+
createProductionRun(id: string, params?: ActionCreateProductionRunParams | null | undefined, options?: RequestOptions): APIPromise<ProductionRun>;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Request to bulk delete sales orders.
|
|
138
|
+
*/
|
|
139
|
+
export interface BulkDeleteSalesOrdersRequest {
|
|
140
|
+
/**
|
|
141
|
+
* IDs of the sales orders to delete.
|
|
142
|
+
*/
|
|
143
|
+
sales_order_ids: Array<string>;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Request to issue a sales order.
|
|
147
|
+
*/
|
|
148
|
+
export interface IssueSalesOrderRequest {
|
|
149
|
+
/**
|
|
150
|
+
* Whether to notify the customer.
|
|
151
|
+
*
|
|
152
|
+
* When `true`, the order acknowledgement email is sent to the contacts configured
|
|
153
|
+
* on the order and the order's `acknowledgment_status` is set to `sent`.
|
|
154
|
+
*/
|
|
155
|
+
notify_customer: boolean;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Production run resource.
|
|
159
|
+
*/
|
|
160
|
+
export interface ProductionRun {
|
|
161
|
+
/**
|
|
162
|
+
* Production run ID.
|
|
163
|
+
*/
|
|
164
|
+
id: string;
|
|
165
|
+
/**
|
|
166
|
+
* Number of batches currently recorded against this run.
|
|
167
|
+
*/
|
|
168
|
+
batch_count: number;
|
|
169
|
+
/**
|
|
170
|
+
* Time the run was marked complete.
|
|
171
|
+
*
|
|
172
|
+
* Set automatically once every batch in the run has been scanned or deleted, and
|
|
173
|
+
* unset while the run is still in progress. Once set, the run can no longer be
|
|
174
|
+
* updated and new batches can no longer be added.
|
|
175
|
+
*/
|
|
176
|
+
completed_at: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* Creation timestamp.
|
|
179
|
+
*/
|
|
180
|
+
created_at: string;
|
|
181
|
+
/**
|
|
182
|
+
* Production run number, unique per account.
|
|
183
|
+
*
|
|
184
|
+
* Assigned automatically at creation as the next sequential number for the
|
|
185
|
+
* account; can be changed via update.
|
|
186
|
+
*/
|
|
187
|
+
number: string;
|
|
188
|
+
/**
|
|
189
|
+
* Resource type identifier.
|
|
190
|
+
*/
|
|
191
|
+
object: 'production_run';
|
|
192
|
+
/**
|
|
193
|
+
* A user's membership in an account, carrying the account-specific status, role,
|
|
194
|
+
* and department.
|
|
195
|
+
*
|
|
196
|
+
* Profile fields (name, email, username, image URL) live on the expandable `user`
|
|
197
|
+
* sub-resource, which is shared across every account the user belongs to.
|
|
198
|
+
*/
|
|
199
|
+
responsible_user: BlocksAPI.AccountUser | null;
|
|
200
|
+
/**
|
|
201
|
+
* Time the run started production.
|
|
202
|
+
*
|
|
203
|
+
* Set automatically when the first batch in the run is scanned, and unset until
|
|
204
|
+
* then.
|
|
205
|
+
*/
|
|
206
|
+
started_at: string | null;
|
|
207
|
+
/**
|
|
208
|
+
* Last-updated timestamp.
|
|
209
|
+
*/
|
|
210
|
+
updated_at: string;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* The freshly estimated freight charge for a sales order.
|
|
214
|
+
*/
|
|
215
|
+
export interface QuoteSalesOrderFreightResponse {
|
|
216
|
+
/**
|
|
217
|
+
* Resource type identifier.
|
|
218
|
+
*/
|
|
219
|
+
object: 'sales_order_freight_quote';
|
|
220
|
+
/**
|
|
221
|
+
* A per-unit rate on a sales-order quote.
|
|
222
|
+
*
|
|
223
|
+
* A lightweight, unpersisted variant of a rate: it carries no ID or timestamps
|
|
224
|
+
* because a quote is computed on demand and never stored.
|
|
225
|
+
*/
|
|
226
|
+
unit_price: SalesOrdersAPI.SalesOrderQuoteRate | null;
|
|
227
|
+
}
|
|
228
|
+
export interface ActionBulkDeleteResponse {
|
|
229
|
+
}
|
|
230
|
+
export interface ActionBulkDeleteParams {
|
|
231
|
+
/**
|
|
232
|
+
* IDs of the sales orders to delete.
|
|
233
|
+
*/
|
|
234
|
+
sales_order_ids: Array<string>;
|
|
235
|
+
}
|
|
236
|
+
export interface ActionIssueParams {
|
|
237
|
+
/**
|
|
238
|
+
* Whether to notify the customer.
|
|
239
|
+
*
|
|
240
|
+
* When `true`, the order acknowledgement email is sent to the contacts configured
|
|
241
|
+
* on the order and the order's `acknowledgment_status` is set to `sent`.
|
|
242
|
+
*/
|
|
243
|
+
notify_customer: boolean;
|
|
244
|
+
}
|
|
245
|
+
export interface ActionCreateProductionRunParams {
|
|
246
|
+
/**
|
|
247
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
248
|
+
* `null`.
|
|
249
|
+
*/
|
|
250
|
+
include?: Array<'responsible_user' | 'responsible_user.user'>;
|
|
251
|
+
}
|
|
252
|
+
export declare namespace Actions {
|
|
253
|
+
export { type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest as IssueSalesOrderRequest, type ProductionRun as ProductionRun, type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse as ActionBulkDeleteResponse, type ActionBulkDeleteParams as ActionBulkDeleteParams, type ActionIssueParams as ActionIssueParams, type ActionCreateProductionRunParams as ActionCreateProductionRunParams, };
|
|
254
|
+
}
|
|
255
|
+
//# sourceMappingURL=actions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIxC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIlF;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIjF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI9F;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAO7B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;;;;OAMG;IACH,gBAAgB,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE/C;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;;;;OAKG;IACH,UAAU,EAAE,cAAc,CAAC,mBAAmB,GAAG,IAAI,CAAC;CACvD;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAAC;CAC/D;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -0,0 +1,156 @@
|
|
|
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.Actions = void 0;
|
|
5
|
+
const resource_1 = require("../../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* List, view, create, update, and delete sales orders.
|
|
9
|
+
*/
|
|
10
|
+
class Actions extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Deletes multiple sales orders in a single atomic operation.
|
|
13
|
+
*
|
|
14
|
+
* Fulfilled orders cannot be deleted; if any requested order fails this check, no
|
|
15
|
+
* orders are deleted.
|
|
16
|
+
*
|
|
17
|
+
* This endpoint requires the permission: `sales_orders:delete`.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const response =
|
|
22
|
+
* await client.sales.salesOrders.actions.bulkDelete({
|
|
23
|
+
* sales_order_ids: ['or_01d5034136c3ccc048abecc312'],
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
bulkDelete(body, options) {
|
|
28
|
+
return this._client.post('/v1/sales/sales-orders/actions/bulk-delete', { body, ...options });
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Issues a sales order, transitioning it from `estimate` to `issued`.
|
|
32
|
+
*
|
|
33
|
+
* Issuing commits the order for fulfillment: a pick is created for the order's
|
|
34
|
+
* sale lines and inventory is reserved for each line tied to an inventory item.
|
|
35
|
+
*
|
|
36
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const salesOrder =
|
|
41
|
+
* await client.sales.salesOrders.actions.issue(
|
|
42
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
43
|
+
* { notify_customer: true },
|
|
44
|
+
* );
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
issue(id, body, options) {
|
|
48
|
+
return this._client.put((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/issue`, { body, ...options });
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Unissues a sales order, transitioning it from `issued` back to `estimate`.
|
|
52
|
+
*
|
|
53
|
+
* Deletes the order's pick and releases any inventory reserved when the order was
|
|
54
|
+
* issued.
|
|
55
|
+
*
|
|
56
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const salesOrder =
|
|
61
|
+
* await client.sales.salesOrders.actions.unissue(
|
|
62
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
63
|
+
* );
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
unissue(id, options) {
|
|
67
|
+
return this._client.put((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/unissue`, options);
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Closes a sales order, transitioning it from `issued` to `fulfilled`.
|
|
71
|
+
*
|
|
72
|
+
* Sets the order's completion timestamp and marks its pick as finished.
|
|
73
|
+
*
|
|
74
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const salesOrder =
|
|
79
|
+
* await client.sales.salesOrders.actions.close(
|
|
80
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
81
|
+
* );
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
close(id, options) {
|
|
85
|
+
return this._client.put((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/close`, options);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Reopens a sales order, transitioning it from `fulfilled` back to `issued`.
|
|
89
|
+
*
|
|
90
|
+
* Clears the order's completion timestamp and marks its pick as unfinished.
|
|
91
|
+
*
|
|
92
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const salesOrder =
|
|
97
|
+
* await client.sales.salesOrders.actions.open(
|
|
98
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
99
|
+
* );
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
open(id, options) {
|
|
103
|
+
return this._client.put((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/open`, options);
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Re-estimates the freight (shipping) charge for an order using the latest carrier
|
|
107
|
+
* rates.
|
|
108
|
+
*
|
|
109
|
+
* Computes what the order's freight charge would be from its current ship-to
|
|
110
|
+
* address, carrier, service level, and line items — applying the same
|
|
111
|
+
* freight-exemption, flat-rate, and live carrier-rate logic used when the order is
|
|
112
|
+
* created. The order is not modified: the returned amount is a quote to review,
|
|
113
|
+
* and callers apply it by updating the order's shipping line. Use this to refresh
|
|
114
|
+
* freight after changing the address or line items, or at any time to re-price
|
|
115
|
+
* against current rates.
|
|
116
|
+
*
|
|
117
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
118
|
+
*
|
|
119
|
+
* @example
|
|
120
|
+
* ```ts
|
|
121
|
+
* const quoteSalesOrderFreightResponse =
|
|
122
|
+
* await client.sales.salesOrders.actions.quoteFreight(
|
|
123
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
124
|
+
* );
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
quoteFreight(id, options) {
|
|
128
|
+
return this._client.post((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Creates a production run from a sales order.
|
|
132
|
+
*
|
|
133
|
+
* Creates a batch for each of the order's item-backed lines, reserves the material
|
|
134
|
+
* inventory required to produce them, and links the run to the order. An order can
|
|
135
|
+
* have at most one production run.
|
|
136
|
+
*
|
|
137
|
+
* This endpoint requires the permission: `production_runs:create`.
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* ```ts
|
|
141
|
+
* const productionRun =
|
|
142
|
+
* await client.sales.salesOrders.actions.createProductionRun(
|
|
143
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
144
|
+
* );
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
createProductionRun(id, params = {}, options) {
|
|
148
|
+
const { include } = params ?? {};
|
|
149
|
+
return this._client.post((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/create-production-run`, {
|
|
150
|
+
query: { include },
|
|
151
|
+
...options,
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
exports.Actions = Actions;
|
|
156
|
+
//# sourceMappingURL=actions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9JD,0BA8JC"}
|
|
@@ -0,0 +1,152 @@
|
|
|
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, view, create, update, and delete sales orders.
|
|
6
|
+
*/
|
|
7
|
+
export class Actions extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Deletes multiple sales orders in a single atomic operation.
|
|
10
|
+
*
|
|
11
|
+
* Fulfilled orders cannot be deleted; if any requested order fails this check, no
|
|
12
|
+
* orders are deleted.
|
|
13
|
+
*
|
|
14
|
+
* This endpoint requires the permission: `sales_orders:delete`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.sales.salesOrders.actions.bulkDelete({
|
|
20
|
+
* sales_order_ids: ['or_01d5034136c3ccc048abecc312'],
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
bulkDelete(body, options) {
|
|
25
|
+
return this._client.post('/v1/sales/sales-orders/actions/bulk-delete', { body, ...options });
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Issues a sales order, transitioning it from `estimate` to `issued`.
|
|
29
|
+
*
|
|
30
|
+
* Issuing commits the order for fulfillment: a pick is created for the order's
|
|
31
|
+
* sale lines and inventory is reserved for each line tied to an inventory item.
|
|
32
|
+
*
|
|
33
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const salesOrder =
|
|
38
|
+
* await client.sales.salesOrders.actions.issue(
|
|
39
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
40
|
+
* { notify_customer: true },
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
issue(id, body, options) {
|
|
45
|
+
return this._client.put(path `/v1/sales/sales-orders/${id}/actions/issue`, { body, ...options });
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Unissues a sales order, transitioning it from `issued` back to `estimate`.
|
|
49
|
+
*
|
|
50
|
+
* Deletes the order's pick and releases any inventory reserved when the order was
|
|
51
|
+
* issued.
|
|
52
|
+
*
|
|
53
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const salesOrder =
|
|
58
|
+
* await client.sales.salesOrders.actions.unissue(
|
|
59
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
60
|
+
* );
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
unissue(id, options) {
|
|
64
|
+
return this._client.put(path `/v1/sales/sales-orders/${id}/actions/unissue`, options);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Closes a sales order, transitioning it from `issued` to `fulfilled`.
|
|
68
|
+
*
|
|
69
|
+
* Sets the order's completion timestamp and marks its pick as finished.
|
|
70
|
+
*
|
|
71
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```ts
|
|
75
|
+
* const salesOrder =
|
|
76
|
+
* await client.sales.salesOrders.actions.close(
|
|
77
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
78
|
+
* );
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
close(id, options) {
|
|
82
|
+
return this._client.put(path `/v1/sales/sales-orders/${id}/actions/close`, options);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Reopens a sales order, transitioning it from `fulfilled` back to `issued`.
|
|
86
|
+
*
|
|
87
|
+
* Clears the order's completion timestamp and marks its pick as unfinished.
|
|
88
|
+
*
|
|
89
|
+
* This endpoint requires the permission: `sales_orders:update`.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* const salesOrder =
|
|
94
|
+
* await client.sales.salesOrders.actions.open(
|
|
95
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
96
|
+
* );
|
|
97
|
+
* ```
|
|
98
|
+
*/
|
|
99
|
+
open(id, options) {
|
|
100
|
+
return this._client.put(path `/v1/sales/sales-orders/${id}/actions/open`, options);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Re-estimates the freight (shipping) charge for an order using the latest carrier
|
|
104
|
+
* rates.
|
|
105
|
+
*
|
|
106
|
+
* Computes what the order's freight charge would be from its current ship-to
|
|
107
|
+
* address, carrier, service level, and line items — applying the same
|
|
108
|
+
* freight-exemption, flat-rate, and live carrier-rate logic used when the order is
|
|
109
|
+
* created. The order is not modified: the returned amount is a quote to review,
|
|
110
|
+
* and callers apply it by updating the order's shipping line. Use this to refresh
|
|
111
|
+
* freight after changing the address or line items, or at any time to re-price
|
|
112
|
+
* against current rates.
|
|
113
|
+
*
|
|
114
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```ts
|
|
118
|
+
* const quoteSalesOrderFreightResponse =
|
|
119
|
+
* await client.sales.salesOrders.actions.quoteFreight(
|
|
120
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
121
|
+
* );
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
quoteFreight(id, options) {
|
|
125
|
+
return this._client.post(path `/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Creates a production run from a sales order.
|
|
129
|
+
*
|
|
130
|
+
* Creates a batch for each of the order's item-backed lines, reserves the material
|
|
131
|
+
* inventory required to produce them, and links the run to the order. An order can
|
|
132
|
+
* have at most one production run.
|
|
133
|
+
*
|
|
134
|
+
* This endpoint requires the permission: `production_runs:create`.
|
|
135
|
+
*
|
|
136
|
+
* @example
|
|
137
|
+
* ```ts
|
|
138
|
+
* const productionRun =
|
|
139
|
+
* await client.sales.salesOrders.actions.createProductionRun(
|
|
140
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
141
|
+
* );
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
createProductionRun(id, params = {}, options) {
|
|
145
|
+
const { include } = params ?? {};
|
|
146
|
+
return this._client.post(path `/v1/sales/sales-orders/${id}/actions/create-production-run`, {
|
|
147
|
+
query: { include },
|
|
148
|
+
...options,
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
//# sourceMappingURL=actions.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { Actions, type BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionCreateProductionRunParams, } from "./actions.mjs";
|
|
2
|
+
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines/index.mjs";
|
|
3
|
+
export { SalesOrders, type CheckoutSalesOrderRequest, type CheckoutSalesOrderResponse, type CreateSalesOrderLineInput, type CreateSalesOrderRequest, type CreatedBy, type Freight, type ListQuotedSalesOrderLine, type ListRecord, type ListSalesOrder, type ListSalesOrderLine, type ListSalesOrderStatus, type OrderContact, type OrderDiscount, type QuoteSalesOrderLineInput, type QuoteSalesOrderPricesRequest, type QuoteSalesOrderPricesResponse, type QuotedSalesOrderLine, type Record, type SalesOrder, type SalesOrderEmailContactInput, type SalesOrderLine, type SalesOrderQuoteRate, type SalesOrderRelated, type SalesOrderStageTotal, type SalesOrderStatus, type SalesOrderTotals, type UpdateSalesOrderRequest, type SalesOrderDeleteResponse, type SalesOrderRetrieveStatusesParams, type SalesOrderListParams, type SalesOrderRetrieveParams, type SalesOrderCreateParams, type SalesOrderUpdateParams, type SalesOrderCheckoutParams, type SalesOrderPriceQuoteParams, } from "./sales-orders.mjs";
|
|
4
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { Actions, type BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionCreateProductionRunParams, } from "./actions.js";
|
|
2
|
+
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines/index.js";
|
|
3
|
+
export { SalesOrders, type CheckoutSalesOrderRequest, type CheckoutSalesOrderResponse, type CreateSalesOrderLineInput, type CreateSalesOrderRequest, type CreatedBy, type Freight, type ListQuotedSalesOrderLine, type ListRecord, type ListSalesOrder, type ListSalesOrderLine, type ListSalesOrderStatus, type OrderContact, type OrderDiscount, type QuoteSalesOrderLineInput, type QuoteSalesOrderPricesRequest, type QuoteSalesOrderPricesResponse, type QuotedSalesOrderLine, type Record, type SalesOrder, type SalesOrderEmailContactInput, type SalesOrderLine, type SalesOrderQuoteRate, type SalesOrderRelated, type SalesOrderStageTotal, type SalesOrderStatus, type SalesOrderTotals, type UpdateSalesOrderRequest, type SalesOrderDeleteResponse, type SalesOrderRetrieveStatusesParams, type SalesOrderListParams, type SalesOrderRetrieveParams, type SalesOrderCreateParams, type SalesOrderUpdateParams, type SalesOrderCheckoutParams, type SalesOrderPriceQuoteParams, } from "./sales-orders.js";
|
|
4
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
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.SalesOrders = exports.Lines = exports.Actions = void 0;
|
|
5
|
+
var actions_1 = require("./actions.js");
|
|
6
|
+
Object.defineProperty(exports, "Actions", { enumerable: true, get: function () { return actions_1.Actions; } });
|
|
7
|
+
var index_1 = require("./lines/index.js");
|
|
8
|
+
Object.defineProperty(exports, "Lines", { enumerable: true, get: function () { return index_1.Lines; } });
|
|
9
|
+
var sales_orders_1 = require("./sales-orders.js");
|
|
10
|
+
Object.defineProperty(exports, "SalesOrders", { enumerable: true, get: function () { return sales_orders_1.SalesOrders; } });
|
|
11
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAUmB;AATjB,kGAAA,OAAO,OAAA;AAUT,0CAQuB;AAPrB,8FAAA,KAAK,OAAA;AAQP,kDAqCwB;AApCtB,2GAAA,WAAW,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GASR;OACM,EACL,KAAK,GAON;OACM,EACL,WAAW,GAoCZ"}
|