@augno/sdk 0.1.6 → 0.1.9
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 +8 -2
- package/package.json +11 -16
- package/resources/catalog/item-categories/item-categories.d.mts +0 -1
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +0 -1
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +0 -1
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +0 -1
- package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
- package/resources/catalog/materials.d.mts +23 -23
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +23 -23
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +0 -1
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +0 -1
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +12 -15
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +12 -15
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +0 -1
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +0 -1
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +0 -1
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +0 -1
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +0 -1
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +0 -1
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +24 -29
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +24 -29
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +0 -2
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +0 -2
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +12 -15
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +12 -15
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +2 -5
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +2 -5
- package/resources/catalog/properties/attributes.mjs.map +1 -1
- package/resources/catalog/properties/properties.d.mts +0 -1
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +0 -1
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +0 -1
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +0 -1
- package/resources/catalog/properties/properties.mjs.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.mts +1 -10
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +1 -10
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +1 -10
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +1 -10
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +2 -10
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +2 -10
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +2 -10
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +2 -10
- package/resources/catalog/unit-groups/units.mjs.map +1 -1
- package/resources/catalog/units.d.mts +0 -1
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +0 -1
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +0 -1
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +0 -1
- package/resources/catalog/units.mjs.map +1 -1
- 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/request-logs.d.mts +22 -7
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +22 -7
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/core/sandboxes.d.mts +2 -2
- package/resources/core/sandboxes.d.mts.map +1 -1
- package/resources/core/sandboxes.d.ts +2 -2
- package/resources/core/sandboxes.d.ts.map +1 -1
- package/resources/finance/payment-terms.d.mts +0 -1
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +0 -1
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js +0 -1
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs +0 -1
- package/resources/finance/payment-terms.mjs.map +1 -1
- package/resources/identity/account-users/account-users.d.mts +31 -36
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +31 -36
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +2 -7
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +2 -7
- package/resources/identity/account-users/account-users.mjs.map +1 -1
- package/resources/identity/roles.d.mts +0 -4
- package/resources/identity/roles.d.mts.map +1 -1
- package/resources/identity/roles.d.ts +0 -4
- package/resources/identity/roles.d.ts.map +1 -1
- package/resources/identity/roles.js +0 -4
- package/resources/identity/roles.js.map +1 -1
- package/resources/identity/roles.mjs +0 -4
- package/resources/identity/roles.mjs.map +1 -1
- package/resources/operations/carriers/carriers.d.mts +34 -26
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +34 -26
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +0 -4
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +0 -4
- package/resources/operations/carriers/carriers.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +1 -4
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +1 -4
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +1 -4
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +1 -4
- package/resources/operations/carriers/service-levels.mjs.map +1 -1
- package/resources/operations/locations.d.mts +4 -5
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +4 -5
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +0 -1
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +0 -1
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +0 -3
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +0 -3
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +0 -3
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +0 -3
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +4 -5
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +4 -5
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +0 -1
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +0 -1
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +62 -10
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +62 -10
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +0 -1
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +0 -1
- package/resources/sales/account-groups.mjs.map +1 -1
- package/resources/sales/addresses.d.mts +14 -15
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +14 -15
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +0 -1
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +0 -1
- package/resources/sales/addresses.mjs.map +1 -1
- package/resources/sales/customers/customers.d.mts +4 -6
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +4 -6
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +0 -6
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +0 -6
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/src/resources/catalog/item-categories/item-categories.ts +0 -1
- package/src/resources/catalog/materials.ts +23 -23
- package/src/resources/catalog/parts.ts +12 -15
- package/src/resources/catalog/product-lines.ts +0 -1
- package/src/resources/catalog/products.ts +26 -31
- package/src/resources/catalog/properties/attributes.ts +14 -39
- package/src/resources/catalog/properties/properties.ts +0 -1
- package/src/resources/catalog/unit-groups/unit-groups.ts +1 -10
- package/src/resources/catalog/unit-groups/units.ts +2 -10
- package/src/resources/catalog/units.ts +0 -1
- package/src/resources/core/audit-events.ts +13 -1
- package/src/resources/core/request-logs.ts +23 -7
- package/src/resources/core/sandboxes.ts +2 -2
- package/src/resources/finance/payment-terms.ts +0 -1
- package/src/resources/identity/account-users/account-users.ts +38 -40
- package/src/resources/identity/roles.ts +0 -4
- package/src/resources/operations/carriers/carriers.ts +35 -27
- package/src/resources/operations/carriers/service-levels.ts +1 -4
- package/src/resources/operations/locations.ts +4 -5
- package/src/resources/operations/scanning-stations.ts +0 -3
- package/src/resources/operations/shipping-terms.ts +4 -5
- package/src/resources/sales/account-groups.ts +62 -10
- package/src/resources/sales/addresses.ts +14 -15
- package/src/resources/sales/customers/customers.ts +5 -6
- 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
|
@@ -52,7 +52,6 @@ export class Materials extends APIResource {
|
|
|
52
52
|
* ```ts
|
|
53
53
|
* const material = await client.catalog.materials.update(
|
|
54
54
|
* 'ml_014613b8f7959a091d8cc0cef4',
|
|
55
|
-
* { sku: 'MAT-001-UPDATED' },
|
|
56
55
|
* );
|
|
57
56
|
* ```
|
|
58
57
|
*/
|
|
@@ -117,33 +116,32 @@ export interface CreateMaterialRequest {
|
|
|
117
116
|
/**
|
|
118
117
|
* Description.
|
|
119
118
|
*/
|
|
120
|
-
description?: string
|
|
119
|
+
description?: string;
|
|
121
120
|
|
|
122
121
|
/**
|
|
123
122
|
* QuantityInputRequest is a quantity value and unit.
|
|
124
123
|
*/
|
|
125
|
-
lead_time?: QuantityInputRequest
|
|
124
|
+
lead_time?: QuantityInputRequest;
|
|
126
125
|
|
|
127
126
|
/**
|
|
128
127
|
* Notes.
|
|
129
128
|
*/
|
|
130
|
-
notes?: string
|
|
129
|
+
notes?: string;
|
|
131
130
|
|
|
132
131
|
/**
|
|
133
132
|
* QuantityInputRequest is a quantity value and unit.
|
|
134
133
|
*/
|
|
135
|
-
order_point?: QuantityInputRequest
|
|
134
|
+
order_point?: QuantityInputRequest;
|
|
136
135
|
|
|
137
136
|
/**
|
|
138
|
-
*
|
|
137
|
+
* RateInput represents the input for creating or updating a rate.
|
|
139
138
|
*/
|
|
140
|
-
unit_cost?: RateInput
|
|
139
|
+
unit_cost?: RateInput;
|
|
141
140
|
|
|
142
141
|
/**
|
|
143
|
-
*
|
|
144
|
-
* must not be.
|
|
142
|
+
* RateInput represents the input for creating or updating a rate.
|
|
145
143
|
*/
|
|
146
|
-
unit_price?: RateInput
|
|
144
|
+
unit_price?: RateInput;
|
|
147
145
|
}
|
|
148
146
|
|
|
149
147
|
/**
|
|
@@ -221,6 +219,9 @@ export interface QuantityInputRequest {
|
|
|
221
219
|
value: string;
|
|
222
220
|
}
|
|
223
221
|
|
|
222
|
+
/**
|
|
223
|
+
* RateInput represents the input for creating or updating a rate.
|
|
224
|
+
*/
|
|
224
225
|
export interface RateInput {
|
|
225
226
|
/**
|
|
226
227
|
* Denominator unit ID.
|
|
@@ -268,9 +269,9 @@ export interface UpdateMaterialRequest {
|
|
|
268
269
|
sku?: string;
|
|
269
270
|
|
|
270
271
|
/**
|
|
271
|
-
*
|
|
272
|
+
* RateInput represents the input for creating or updating a rate.
|
|
272
273
|
*/
|
|
273
|
-
unit_cost?: RateInput
|
|
274
|
+
unit_cost?: RateInput;
|
|
274
275
|
}
|
|
275
276
|
|
|
276
277
|
export interface MaterialCreateParams {
|
|
@@ -307,33 +308,32 @@ export interface MaterialCreateParams {
|
|
|
307
308
|
/**
|
|
308
309
|
* Body param: Description.
|
|
309
310
|
*/
|
|
310
|
-
description?: string
|
|
311
|
+
description?: string;
|
|
311
312
|
|
|
312
313
|
/**
|
|
313
314
|
* Body param: QuantityInputRequest is a quantity value and unit.
|
|
314
315
|
*/
|
|
315
|
-
lead_time?: QuantityInputRequest
|
|
316
|
+
lead_time?: QuantityInputRequest;
|
|
316
317
|
|
|
317
318
|
/**
|
|
318
319
|
* Body param: Notes.
|
|
319
320
|
*/
|
|
320
|
-
notes?: string
|
|
321
|
+
notes?: string;
|
|
321
322
|
|
|
322
323
|
/**
|
|
323
324
|
* Body param: QuantityInputRequest is a quantity value and unit.
|
|
324
325
|
*/
|
|
325
|
-
order_point?: QuantityInputRequest
|
|
326
|
+
order_point?: QuantityInputRequest;
|
|
326
327
|
|
|
327
328
|
/**
|
|
328
|
-
* Body param:
|
|
329
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
329
330
|
*/
|
|
330
|
-
unit_cost?: RateInput
|
|
331
|
+
unit_cost?: RateInput;
|
|
331
332
|
|
|
332
333
|
/**
|
|
333
|
-
* Body param:
|
|
334
|
-
* denominator must not be.
|
|
334
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
335
335
|
*/
|
|
336
|
-
unit_price?: RateInput
|
|
336
|
+
unit_price?: RateInput;
|
|
337
337
|
}
|
|
338
338
|
|
|
339
339
|
export interface MaterialRetrieveParams {
|
|
@@ -395,9 +395,9 @@ export interface MaterialUpdateParams {
|
|
|
395
395
|
sku?: string;
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
|
-
* Body param:
|
|
398
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
399
399
|
*/
|
|
400
|
-
unit_cost?: RateInput
|
|
400
|
+
unit_cost?: RateInput;
|
|
401
401
|
}
|
|
402
402
|
|
|
403
403
|
export interface MaterialListParams {
|
|
@@ -53,7 +53,6 @@ export class Parts extends APIResource {
|
|
|
53
53
|
* ```ts
|
|
54
54
|
* const part = await client.catalog.parts.update(
|
|
55
55
|
* 'pt_018d7bab53e864351f4c693a21',
|
|
56
|
-
* { sku: 'BRG-6204-2RS' },
|
|
57
56
|
* );
|
|
58
57
|
* ```
|
|
59
58
|
*/
|
|
@@ -115,23 +114,22 @@ export interface CreatePartRequest {
|
|
|
115
114
|
/**
|
|
116
115
|
* Description.
|
|
117
116
|
*/
|
|
118
|
-
description?: string
|
|
117
|
+
description?: string;
|
|
119
118
|
|
|
120
119
|
/**
|
|
121
120
|
* Notes.
|
|
122
121
|
*/
|
|
123
|
-
notes?: string
|
|
122
|
+
notes?: string;
|
|
124
123
|
|
|
125
124
|
/**
|
|
126
|
-
*
|
|
125
|
+
* RateInput represents the input for creating or updating a rate.
|
|
127
126
|
*/
|
|
128
|
-
unit_cost?: MaterialsAPI.RateInput
|
|
127
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
129
128
|
|
|
130
129
|
/**
|
|
131
|
-
*
|
|
132
|
-
* must not be.
|
|
130
|
+
* RateInput represents the input for creating or updating a rate.
|
|
133
131
|
*/
|
|
134
|
-
unit_price?: MaterialsAPI.RateInput
|
|
132
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
135
133
|
}
|
|
136
134
|
|
|
137
135
|
/**
|
|
@@ -231,23 +229,22 @@ export interface PartCreateParams {
|
|
|
231
229
|
/**
|
|
232
230
|
* Body param: Description.
|
|
233
231
|
*/
|
|
234
|
-
description?: string
|
|
232
|
+
description?: string;
|
|
235
233
|
|
|
236
234
|
/**
|
|
237
235
|
* Body param: Notes.
|
|
238
236
|
*/
|
|
239
|
-
notes?: string
|
|
237
|
+
notes?: string;
|
|
240
238
|
|
|
241
239
|
/**
|
|
242
|
-
* Body param:
|
|
240
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
243
241
|
*/
|
|
244
|
-
unit_cost?: MaterialsAPI.RateInput
|
|
242
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
245
243
|
|
|
246
244
|
/**
|
|
247
|
-
* Body param:
|
|
248
|
-
* denominator must not be.
|
|
245
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
249
246
|
*/
|
|
250
|
-
unit_price?: MaterialsAPI.RateInput
|
|
247
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
251
248
|
}
|
|
252
249
|
|
|
253
250
|
export interface PartRetrieveParams {
|
|
@@ -20,7 +20,6 @@ export class Products extends APIResource {
|
|
|
20
20
|
* ```ts
|
|
21
21
|
* const product = await client.catalog.products.create({
|
|
22
22
|
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
23
|
-
* product_line_id: 'product_line_id',
|
|
24
23
|
* sku: 'ALM-2024-1001',
|
|
25
24
|
* type: 'sale',
|
|
26
25
|
* });
|
|
@@ -56,7 +55,6 @@ export class Products extends APIResource {
|
|
|
56
55
|
* ```ts
|
|
57
56
|
* const product = await client.catalog.products.update(
|
|
58
57
|
* 'pd_013c29ab3f1518d0004094c316',
|
|
59
|
-
* { sku: 'SKU-002' },
|
|
60
58
|
* );
|
|
61
59
|
* ```
|
|
62
60
|
*/
|
|
@@ -134,11 +132,6 @@ export interface CreateProductRequest {
|
|
|
134
132
|
*/
|
|
135
133
|
category_id: string;
|
|
136
134
|
|
|
137
|
-
/**
|
|
138
|
-
* Product line ID.
|
|
139
|
-
*/
|
|
140
|
-
product_line_id: string | null;
|
|
141
|
-
|
|
142
135
|
/**
|
|
143
136
|
* SKU.
|
|
144
137
|
*/
|
|
@@ -157,12 +150,12 @@ export interface CreateProductRequest {
|
|
|
157
150
|
/**
|
|
158
151
|
* Description.
|
|
159
152
|
*/
|
|
160
|
-
description?: string
|
|
153
|
+
description?: string;
|
|
161
154
|
|
|
162
155
|
/**
|
|
163
156
|
* Notes.
|
|
164
157
|
*/
|
|
165
|
-
notes?: string
|
|
158
|
+
notes?: string;
|
|
166
159
|
|
|
167
160
|
/**
|
|
168
161
|
* Whether visible in the customer portal.
|
|
@@ -170,15 +163,19 @@ export interface CreateProductRequest {
|
|
|
170
163
|
portal_visibility?: 'visible' | 'hidden';
|
|
171
164
|
|
|
172
165
|
/**
|
|
173
|
-
*
|
|
166
|
+
* Product line ID.
|
|
167
|
+
*/
|
|
168
|
+
product_line_id?: string;
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* RateInput represents the input for creating or updating a rate.
|
|
174
172
|
*/
|
|
175
|
-
unit_cost?: MaterialsAPI.RateInput
|
|
173
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
176
174
|
|
|
177
175
|
/**
|
|
178
|
-
*
|
|
179
|
-
* must not be.
|
|
176
|
+
* RateInput represents the input for creating or updating a rate.
|
|
180
177
|
*/
|
|
181
|
-
unit_price?: MaterialsAPI.RateInput
|
|
178
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
182
179
|
}
|
|
183
180
|
|
|
184
181
|
/**
|
|
@@ -271,9 +268,9 @@ export interface UpdateProductRequest {
|
|
|
271
268
|
sku?: string;
|
|
272
269
|
|
|
273
270
|
/**
|
|
274
|
-
*
|
|
271
|
+
* RateInput represents the input for creating or updating a rate.
|
|
275
272
|
*/
|
|
276
|
-
unit_price?: MaterialsAPI.RateInput
|
|
273
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
277
274
|
}
|
|
278
275
|
|
|
279
276
|
export interface ProductCreateParams {
|
|
@@ -282,11 +279,6 @@ export interface ProductCreateParams {
|
|
|
282
279
|
*/
|
|
283
280
|
category_id: string;
|
|
284
281
|
|
|
285
|
-
/**
|
|
286
|
-
* Body param: Product line ID.
|
|
287
|
-
*/
|
|
288
|
-
product_line_id: string | null;
|
|
289
|
-
|
|
290
282
|
/**
|
|
291
283
|
* Body param: SKU.
|
|
292
284
|
*/
|
|
@@ -328,12 +320,12 @@ export interface ProductCreateParams {
|
|
|
328
320
|
/**
|
|
329
321
|
* Body param: Description.
|
|
330
322
|
*/
|
|
331
|
-
description?: string
|
|
323
|
+
description?: string;
|
|
332
324
|
|
|
333
325
|
/**
|
|
334
326
|
* Body param: Notes.
|
|
335
327
|
*/
|
|
336
|
-
notes?: string
|
|
328
|
+
notes?: string;
|
|
337
329
|
|
|
338
330
|
/**
|
|
339
331
|
* Body param: Whether visible in the customer portal.
|
|
@@ -341,15 +333,19 @@ export interface ProductCreateParams {
|
|
|
341
333
|
portal_visibility?: 'visible' | 'hidden';
|
|
342
334
|
|
|
343
335
|
/**
|
|
344
|
-
* Body param:
|
|
336
|
+
* Body param: Product line ID.
|
|
337
|
+
*/
|
|
338
|
+
product_line_id?: string;
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
345
342
|
*/
|
|
346
|
-
unit_cost?: MaterialsAPI.RateInput
|
|
343
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
347
344
|
|
|
348
345
|
/**
|
|
349
|
-
* Body param:
|
|
350
|
-
* denominator must not be.
|
|
346
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
351
347
|
*/
|
|
352
|
-
unit_price?: MaterialsAPI.RateInput
|
|
348
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
353
349
|
}
|
|
354
350
|
|
|
355
351
|
export interface ProductRetrieveParams {
|
|
@@ -422,10 +418,9 @@ export interface ProductUpdateParams {
|
|
|
422
418
|
sku?: string;
|
|
423
419
|
|
|
424
420
|
/**
|
|
425
|
-
* Body param:
|
|
426
|
-
* must not be.
|
|
421
|
+
* Body param: RateInput represents the input for creating or updating a rate.
|
|
427
422
|
*/
|
|
428
|
-
unit_price?: MaterialsAPI.RateInput
|
|
423
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
429
424
|
}
|
|
430
425
|
|
|
431
426
|
export interface ProductListParams {
|
|
@@ -18,7 +18,7 @@ export class Attributes extends APIResource {
|
|
|
18
18
|
* const attribute =
|
|
19
19
|
* await client.catalog.properties.attributes.create(
|
|
20
20
|
* 'pp_01e21344878064372f69e67093',
|
|
21
|
-
* {
|
|
21
|
+
* { value: 'Red' },
|
|
22
22
|
* );
|
|
23
23
|
* ```
|
|
24
24
|
*/
|
|
@@ -59,10 +59,7 @@ export class Attributes extends APIResource {
|
|
|
59
59
|
* const attribute =
|
|
60
60
|
* await client.catalog.properties.attributes.update(
|
|
61
61
|
* 'at_01c9493ec0c46bb0ed12708ae4',
|
|
62
|
-
* {
|
|
63
|
-
* property_id: 'pp_01e21344878064372f69e67093',
|
|
64
|
-
* value: 'Blue',
|
|
65
|
-
* },
|
|
62
|
+
* { property_id: 'pp_01e21344878064372f69e67093' },
|
|
66
63
|
* );
|
|
67
64
|
* ```
|
|
68
65
|
*/
|
|
@@ -123,11 +120,6 @@ export class Attributes extends APIResource {
|
|
|
123
120
|
* Request to create an attribute.
|
|
124
121
|
*/
|
|
125
122
|
export interface CreateAttributeRequest {
|
|
126
|
-
/**
|
|
127
|
-
* Display order. Defaults to last position if not provided.
|
|
128
|
-
*/
|
|
129
|
-
sort_order: number | null;
|
|
130
|
-
|
|
131
123
|
/**
|
|
132
124
|
* Attribute value.
|
|
133
125
|
*/
|
|
@@ -136,18 +128,12 @@ export interface CreateAttributeRequest {
|
|
|
136
128
|
/**
|
|
137
129
|
* Color code. Randomly assigned if not provided.
|
|
138
130
|
*/
|
|
139
|
-
color?:
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
| 'orange'
|
|
146
|
-
| 'pink'
|
|
147
|
-
| 'purple'
|
|
148
|
-
| 'red'
|
|
149
|
-
| 'yellow'
|
|
150
|
-
| null;
|
|
131
|
+
color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Display order. Defaults to last position if not provided.
|
|
135
|
+
*/
|
|
136
|
+
sort_order?: number;
|
|
151
137
|
}
|
|
152
138
|
|
|
153
139
|
/**
|
|
@@ -173,11 +159,6 @@ export interface UpdateAttributeRequest {
|
|
|
173
159
|
export interface AttributeDeleteResponse {}
|
|
174
160
|
|
|
175
161
|
export interface AttributeCreateParams {
|
|
176
|
-
/**
|
|
177
|
-
* Display order. Defaults to last position if not provided.
|
|
178
|
-
*/
|
|
179
|
-
sort_order: number | null;
|
|
180
|
-
|
|
181
162
|
/**
|
|
182
163
|
* Attribute value.
|
|
183
164
|
*/
|
|
@@ -186,18 +167,12 @@ export interface AttributeCreateParams {
|
|
|
186
167
|
/**
|
|
187
168
|
* Color code. Randomly assigned if not provided.
|
|
188
169
|
*/
|
|
189
|
-
color?:
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
| 'orange'
|
|
196
|
-
| 'pink'
|
|
197
|
-
| 'purple'
|
|
198
|
-
| 'red'
|
|
199
|
-
| 'yellow'
|
|
200
|
-
| null;
|
|
170
|
+
color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Display order. Defaults to last position if not provided.
|
|
174
|
+
*/
|
|
175
|
+
sort_order?: number;
|
|
201
176
|
}
|
|
202
177
|
|
|
203
178
|
export interface AttributeRetrieveParams {
|
|
@@ -35,12 +35,7 @@ export class UnitGroups extends APIResource {
|
|
|
35
35
|
* name: 'Weight Units',
|
|
36
36
|
* type: 'mass',
|
|
37
37
|
* associated_units: [
|
|
38
|
-
* {
|
|
39
|
-
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
40
|
-
* discount_percentage: 1,
|
|
41
|
-
* discount_fixed: 0,
|
|
42
|
-
* customer_portal_visibility: 'visible',
|
|
43
|
-
* },
|
|
38
|
+
* { unit_id: 'un_01966263f74a5a0cae356000a1' },
|
|
44
39
|
* ],
|
|
45
40
|
* });
|
|
46
41
|
* ```
|
|
@@ -75,10 +70,6 @@ export class UnitGroups extends APIResource {
|
|
|
75
70
|
* ```ts
|
|
76
71
|
* const unitGroup = await client.catalog.unitGroups.update(
|
|
77
72
|
* 'ug_01aad07abb8e41fd392d2d7013',
|
|
78
|
-
* {
|
|
79
|
-
* base_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
80
|
-
* name: 'Weight Units (Updated)',
|
|
81
|
-
* },
|
|
82
73
|
* );
|
|
83
74
|
* ```
|
|
84
75
|
*/
|
|
@@ -18,11 +18,7 @@ export class Units extends APIResource {
|
|
|
18
18
|
* const unitGroupUnit =
|
|
19
19
|
* await client.catalog.unitGroups.units.create(
|
|
20
20
|
* 'ug_01aad07abb8e41fd392d2d7013',
|
|
21
|
-
* {
|
|
22
|
-
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
23
|
-
* customer_portal_visibility: 'visible',
|
|
24
|
-
* discount_percentage: 1,
|
|
25
|
-
* },
|
|
21
|
+
* { unit_id: 'un_01966263f74a5a0cae356000a1' },
|
|
26
22
|
* );
|
|
27
23
|
* ```
|
|
28
24
|
*/
|
|
@@ -71,11 +67,7 @@ export class Units extends APIResource {
|
|
|
71
67
|
* const unitGroupUnit =
|
|
72
68
|
* await client.catalog.unitGroups.units.update(
|
|
73
69
|
* 'un_01966263f74a5a0cae356000a1',
|
|
74
|
-
* {
|
|
75
|
-
* unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
|
|
76
|
-
* discount_percentage: 0.9,
|
|
77
|
-
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
78
|
-
* },
|
|
70
|
+
* { unit_group_id: 'ug_01aad07abb8e41fd392d2d7013' },
|
|
79
71
|
* );
|
|
80
72
|
* ```
|
|
81
73
|
*/
|
|
@@ -127,6 +127,10 @@ export interface AuditEvent {
|
|
|
127
127
|
| 'account'
|
|
128
128
|
| 'actor'
|
|
129
129
|
| 'entity'
|
|
130
|
+
| 'record'
|
|
131
|
+
| 'freight'
|
|
132
|
+
| 'sales_order_totals'
|
|
133
|
+
| 'sales_order_related'
|
|
130
134
|
| 'user'
|
|
131
135
|
| 'address'
|
|
132
136
|
| 'api_key'
|
|
@@ -398,6 +402,10 @@ export interface ListObjectType {
|
|
|
398
402
|
| 'account'
|
|
399
403
|
| 'actor'
|
|
400
404
|
| 'entity'
|
|
405
|
+
| 'record'
|
|
406
|
+
| 'freight'
|
|
407
|
+
| 'sales_order_totals'
|
|
408
|
+
| 'sales_order_related'
|
|
401
409
|
| 'user'
|
|
402
410
|
| 'address'
|
|
403
411
|
| 'api_key'
|
|
@@ -613,7 +621,7 @@ export interface AuditEventListParams {
|
|
|
613
621
|
/**
|
|
614
622
|
* Filter by the actor identifier.
|
|
615
623
|
*
|
|
616
|
-
* Will be `
|
|
624
|
+
* Will be `user.id` when `identity_type`=`user` or an `api_key.id` when
|
|
617
625
|
* `identity_type`=`api_key`.
|
|
618
626
|
*/
|
|
619
627
|
actor_ids?: Array<string>;
|
|
@@ -656,6 +664,10 @@ export interface AuditEventListParams {
|
|
|
656
664
|
| 'account'
|
|
657
665
|
| 'actor'
|
|
658
666
|
| 'entity'
|
|
667
|
+
| 'record'
|
|
668
|
+
| 'freight'
|
|
669
|
+
| 'sales_order_totals'
|
|
670
|
+
| 'sales_order_related'
|
|
659
671
|
| 'user'
|
|
660
672
|
| 'address'
|
|
661
673
|
| 'api_key'
|
|
@@ -237,14 +237,22 @@ export interface RequestLogRetrieveParams {
|
|
|
237
237
|
|
|
238
238
|
export interface RequestLogListParams {
|
|
239
239
|
/**
|
|
240
|
-
* Filter by the account
|
|
241
|
-
*
|
|
240
|
+
* Filter by the _acting_ account: the account the actor belongs to, not the
|
|
241
|
+
* account targeted by the request.
|
|
242
|
+
*
|
|
243
|
+
* This is usually your own account, but differs when another account acts on yours
|
|
244
|
+
* — for example a customer using a customer-portal API key, whose acting account
|
|
245
|
+
* is the customer's account. The request's target account is always your own
|
|
246
|
+
* account (the only account you are authorized to view request logs for), so this
|
|
247
|
+
* filter narrows by _who acted_, not by which account was acted upon.
|
|
242
248
|
*/
|
|
243
249
|
account_ids?: Array<string>;
|
|
244
250
|
|
|
245
251
|
/**
|
|
246
|
-
* Filter by the actor identifier.
|
|
247
|
-
*
|
|
252
|
+
* Filter by the actor identifier.
|
|
253
|
+
*
|
|
254
|
+
* This is the `user.id` when `identity_type`=`user` and an `api_key.id` when
|
|
255
|
+
* `identity_type`=`api_key`.
|
|
248
256
|
*/
|
|
249
257
|
actor_ids?: Array<string>;
|
|
250
258
|
|
|
@@ -333,9 +341,10 @@ export interface RequestLogListParams {
|
|
|
333
341
|
min_latency_us?: number;
|
|
334
342
|
|
|
335
343
|
/**
|
|
336
|
-
* Filter by the _normalized_ route template.
|
|
337
|
-
*
|
|
338
|
-
* `
|
|
344
|
+
* Filter by the _normalized_ route template.
|
|
345
|
+
*
|
|
346
|
+
* For example `PATCH /v1/sales/customers/{id}` is the normalized route for a
|
|
347
|
+
* request route `PUT /v1/sales/customers/ac_...`.
|
|
339
348
|
*/
|
|
340
349
|
normalized_routes?: Array<string>;
|
|
341
350
|
|
|
@@ -349,6 +358,13 @@ export interface RequestLogListParams {
|
|
|
349
358
|
*/
|
|
350
359
|
start_date?: string;
|
|
351
360
|
|
|
361
|
+
/**
|
|
362
|
+
* Filter by the HTTP status class: 1–5 for 1xx–5xx. Combined with `status_codes`
|
|
363
|
+
* using OR — e.g. status_codes=401 and status_code_classes=5 matches 401 and any
|
|
364
|
+
* 5xx.
|
|
365
|
+
*/
|
|
366
|
+
status_code_classes?: Array<number>;
|
|
367
|
+
|
|
352
368
|
/**
|
|
353
369
|
* Filter by the HTTP status code.
|
|
354
370
|
*/
|
|
@@ -83,7 +83,7 @@ export interface CreateSandboxRequest {
|
|
|
83
83
|
/**
|
|
84
84
|
* Controls whether the sandbox is blank or seeded with sample data.
|
|
85
85
|
*/
|
|
86
|
-
mode?: 'blank' | 'seeded'
|
|
86
|
+
mode?: 'blank' | 'seeded';
|
|
87
87
|
}
|
|
88
88
|
|
|
89
89
|
/**
|
|
@@ -158,7 +158,7 @@ export interface SandboxCreateParams {
|
|
|
158
158
|
/**
|
|
159
159
|
* Body param: Controls whether the sandbox is blank or seeded with sample data.
|
|
160
160
|
*/
|
|
161
|
-
mode?: 'blank' | 'seeded'
|
|
161
|
+
mode?: 'blank' | 'seeded';
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
export interface SandboxRetrieveParams {
|