@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,56 @@
|
|
|
1
|
+
import { APIResource } from "../../../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../../../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* List, view, create, update, and delete sales orders.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Actions extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Reorders the product lines on a sales order to match the supplied order. Credit
|
|
10
|
+
* and freight lines always stay at the bottom of the list regardless of the order
|
|
11
|
+
* given here.
|
|
12
|
+
*
|
|
13
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
14
|
+
* `sales_orders:update`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.sales.salesOrders.lines.actions.reorder(
|
|
20
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
21
|
+
* {
|
|
22
|
+
* line_ids: [
|
|
23
|
+
* 'orln_0142f9b74268973450b3a76ce3',
|
|
24
|
+
* 'orln_0142f9b74268973450b3a76ce4',
|
|
25
|
+
* ],
|
|
26
|
+
* },
|
|
27
|
+
* );
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
reorder(id: string, body: ActionReorderParams, options?: RequestOptions): APIPromise<ActionReorderResponse>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Request to reorder a sales order's lines.
|
|
34
|
+
*/
|
|
35
|
+
export interface ReorderSalesOrderLinesRequest {
|
|
36
|
+
/**
|
|
37
|
+
* The order's product-line IDs in the desired display order. Every product line on
|
|
38
|
+
* the order must be listed exactly once; credit and freight lines are kept at the
|
|
39
|
+
* bottom of the list and must not be included.
|
|
40
|
+
*/
|
|
41
|
+
line_ids: Array<string>;
|
|
42
|
+
}
|
|
43
|
+
export interface ActionReorderResponse {
|
|
44
|
+
}
|
|
45
|
+
export interface ActionReorderParams {
|
|
46
|
+
/**
|
|
47
|
+
* The order's product-line IDs in the desired display order. Every product line on
|
|
48
|
+
* the order must be listed exactly once; credit and freight lines are kept at the
|
|
49
|
+
* bottom of the list and must not be included.
|
|
50
|
+
*/
|
|
51
|
+
line_ids: Array<string>;
|
|
52
|
+
}
|
|
53
|
+
export declare namespace Actions {
|
|
54
|
+
export { type ReorderSalesOrderLinesRequest as ReorderSalesOrderLinesRequest, type ActionReorderResponse as ActionReorderResponse, type ActionReorderParams as ActionReorderParams, };
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=actions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { APIResource } from "../../../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../../../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* List, view, create, update, and delete sales orders.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Actions extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Reorders the product lines on a sales order to match the supplied order. Credit
|
|
10
|
+
* and freight lines always stay at the bottom of the list regardless of the order
|
|
11
|
+
* given here.
|
|
12
|
+
*
|
|
13
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
14
|
+
* `sales_orders:update`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.sales.salesOrders.lines.actions.reorder(
|
|
20
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
21
|
+
* {
|
|
22
|
+
* line_ids: [
|
|
23
|
+
* 'orln_0142f9b74268973450b3a76ce3',
|
|
24
|
+
* 'orln_0142f9b74268973450b3a76ce4',
|
|
25
|
+
* ],
|
|
26
|
+
* },
|
|
27
|
+
* );
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
reorder(id: string, body: ActionReorderParams, options?: RequestOptions): APIPromise<ActionReorderResponse>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Request to reorder a sales order's lines.
|
|
34
|
+
*/
|
|
35
|
+
export interface ReorderSalesOrderLinesRequest {
|
|
36
|
+
/**
|
|
37
|
+
* The order's product-line IDs in the desired display order. Every product line on
|
|
38
|
+
* the order must be listed exactly once; credit and freight lines are kept at the
|
|
39
|
+
* bottom of the list and must not be included.
|
|
40
|
+
*/
|
|
41
|
+
line_ids: Array<string>;
|
|
42
|
+
}
|
|
43
|
+
export interface ActionReorderResponse {
|
|
44
|
+
}
|
|
45
|
+
export interface ActionReorderParams {
|
|
46
|
+
/**
|
|
47
|
+
* The order's product-line IDs in the desired display order. Every product line on
|
|
48
|
+
* the order must be listed exactly once; credit and freight lines are kept at the
|
|
49
|
+
* bottom of the list and must not be included.
|
|
50
|
+
*/
|
|
51
|
+
line_ids: Array<string>;
|
|
52
|
+
}
|
|
53
|
+
export declare namespace Actions {
|
|
54
|
+
export { type ReorderSalesOrderLinesRequest as ReorderSalesOrderLinesRequest, type ActionReorderResponse as ActionReorderResponse, type ActionReorderParams as ActionReorderParams, };
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=actions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,38 @@
|
|
|
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
|
+
* Reorders the product lines on a sales order to match the supplied order. Credit
|
|
13
|
+
* and freight lines always stay at the bottom of the list regardless of the order
|
|
14
|
+
* given here.
|
|
15
|
+
*
|
|
16
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
17
|
+
* `sales_orders:update`.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const response =
|
|
22
|
+
* await client.sales.salesOrders.lines.actions.reorder(
|
|
23
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
24
|
+
* {
|
|
25
|
+
* line_ids: [
|
|
26
|
+
* 'orln_0142f9b74268973450b3a76ce3',
|
|
27
|
+
* 'orln_0142f9b74268973450b3a76ce4',
|
|
28
|
+
* ],
|
|
29
|
+
* },
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
reorder(id, body, options) {
|
|
34
|
+
return this._client.post((0, path_1.path) `/v1/sales/sales-orders/${id}/lines/actions/reorder`, { body, ...options });
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.Actions = Actions;
|
|
38
|
+
//# sourceMappingURL=actions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAAwD;AAGxD,6DAAuD;AAEvD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CACL,EAAU,EACV,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA9BD,0BA8BC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
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
|
+
* Reorders the product lines on a sales order to match the supplied order. Credit
|
|
10
|
+
* and freight lines always stay at the bottom of the list regardless of the order
|
|
11
|
+
* given here.
|
|
12
|
+
*
|
|
13
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
14
|
+
* `sales_orders:update`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.sales.salesOrders.lines.actions.reorder(
|
|
20
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
21
|
+
* {
|
|
22
|
+
* line_ids: [
|
|
23
|
+
* 'orln_0142f9b74268973450b3a76ce3',
|
|
24
|
+
* 'orln_0142f9b74268973450b3a76ce4',
|
|
25
|
+
* ],
|
|
26
|
+
* },
|
|
27
|
+
* );
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
reorder(id, body, options) {
|
|
31
|
+
return this._client.post(path `/v1/sales/sales-orders/${id}/lines/actions/reorder`, { body, ...options });
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=actions.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CACL,EAAU,EACV,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { Actions, type ReorderSalesOrderLinesRequest, type ActionReorderResponse, type ActionReorderParams, } from "./actions.mjs";
|
|
2
|
+
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines.mjs";
|
|
3
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GACzB;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { Actions, type ReorderSalesOrderLinesRequest, type ActionReorderResponse, type ActionReorderParams, } from "./actions.js";
|
|
2
|
+
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines.js";
|
|
3
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GACzB;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}
|
|
@@ -0,0 +1,9 @@
|
|
|
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.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 lines_1 = require("./lines.js");
|
|
8
|
+
Object.defineProperty(exports, "Lines", { enumerable: true, get: function () { return lines_1.Lines; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAKmB;AAJjB,kGAAA,OAAO,OAAA;AAKT,oCAQiB;AAPf,8FAAA,KAAK,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAIR;OACM,EACL,KAAK,GAON"}
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import { APIResource } from "../../../../core/resource.mjs";
|
|
2
|
+
import * as MaterialsAPI from "../../../catalog/materials.mjs";
|
|
3
|
+
import * as CustomersAPI from "../../customers/customers.mjs";
|
|
4
|
+
import * as SalesOrdersAPI from "../sales-orders.mjs";
|
|
5
|
+
import * as ActionsAPI from "./actions.mjs";
|
|
6
|
+
import { ActionReorderParams, ActionReorderResponse, Actions, ReorderSalesOrderLinesRequest } from "./actions.mjs";
|
|
7
|
+
import { APIPromise } from "../../../../core/api-promise.mjs";
|
|
8
|
+
import { RequestOptions } from "../../../../internal/request-options.mjs";
|
|
9
|
+
/**
|
|
10
|
+
* List, view, create, update, and delete sales orders.
|
|
11
|
+
*/
|
|
12
|
+
export declare class Lines extends APIResource {
|
|
13
|
+
actions: ActionsAPI.Actions;
|
|
14
|
+
/**
|
|
15
|
+
* Creates a line item on a sales order.
|
|
16
|
+
*
|
|
17
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
18
|
+
* `sales_orders:update`.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const salesOrderLine =
|
|
23
|
+
* await client.sales.salesOrders.lines.create(
|
|
24
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
25
|
+
* {
|
|
26
|
+
* product_id: 'pd_013c29ab3f1518d0004094c316',
|
|
27
|
+
* product_sku: 'WIDGET-001',
|
|
28
|
+
* quantity: {
|
|
29
|
+
* value: '10',
|
|
30
|
+
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
31
|
+
* },
|
|
32
|
+
* },
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
create(id: string, params: LineCreateParams, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrderLine>;
|
|
37
|
+
/**
|
|
38
|
+
* Partially updates a sales order line item.
|
|
39
|
+
*
|
|
40
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
41
|
+
* `sales_orders:update`.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const salesOrderLine =
|
|
46
|
+
* await client.sales.salesOrders.lines.update('example', {
|
|
47
|
+
* id: 'or_01d5034136c3ccc048abecc312',
|
|
48
|
+
* quantity: {
|
|
49
|
+
* value: '20',
|
|
50
|
+
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
51
|
+
* },
|
|
52
|
+
* unit_price: {
|
|
53
|
+
* value: '30.00',
|
|
54
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
55
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
56
|
+
* },
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
update(lineID: string, params: LineUpdateParams, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrderLine>;
|
|
61
|
+
/**
|
|
62
|
+
* Deletes a sales order line and related records.
|
|
63
|
+
*
|
|
64
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
65
|
+
* `sales_orders:update`.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const line = await client.sales.salesOrders.lines.delete(
|
|
70
|
+
* 'example',
|
|
71
|
+
* { id: 'or_01d5034136c3ccc048abecc312' },
|
|
72
|
+
* );
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
delete(lineID: string, params: LineDeleteParams, options?: RequestOptions): APIPromise<LineDeleteResponse>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Request to create a line on a sales order.
|
|
79
|
+
*
|
|
80
|
+
* This mirrors the create-order line shape (not the shared purchase-order
|
|
81
|
+
* OrderLineInput): the unit price is optional and, when omitted, the line is
|
|
82
|
+
* priced server-side from the product. The unit cost is always resolved
|
|
83
|
+
* server-side from the product.
|
|
84
|
+
*/
|
|
85
|
+
export interface CreateSalesOrderLineRequest {
|
|
86
|
+
/**
|
|
87
|
+
* ID of the product being ordered.
|
|
88
|
+
*/
|
|
89
|
+
product_id: string;
|
|
90
|
+
/**
|
|
91
|
+
* The product SKU recorded on the line.
|
|
92
|
+
*/
|
|
93
|
+
product_sku: string;
|
|
94
|
+
/**
|
|
95
|
+
* A value with an associated unit, used in create and update requests.
|
|
96
|
+
*/
|
|
97
|
+
quantity: CustomersAPI.QuantityInput;
|
|
98
|
+
/**
|
|
99
|
+
* The product description recorded on the line.
|
|
100
|
+
*/
|
|
101
|
+
product_description?: string;
|
|
102
|
+
/**
|
|
103
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
104
|
+
* requests.
|
|
105
|
+
*/
|
|
106
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Request to update a sales order line.
|
|
110
|
+
*/
|
|
111
|
+
export interface UpdateSalesOrderLineRequest {
|
|
112
|
+
/**
|
|
113
|
+
* Product description.
|
|
114
|
+
*/
|
|
115
|
+
product_description?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Product SKU.
|
|
118
|
+
*/
|
|
119
|
+
product_sku?: string;
|
|
120
|
+
/**
|
|
121
|
+
* A value with an associated unit, used in create and update requests.
|
|
122
|
+
*/
|
|
123
|
+
quantity?: CustomersAPI.QuantityInput;
|
|
124
|
+
/**
|
|
125
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
126
|
+
* requests.
|
|
127
|
+
*/
|
|
128
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
129
|
+
/**
|
|
130
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
131
|
+
* requests.
|
|
132
|
+
*/
|
|
133
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
134
|
+
}
|
|
135
|
+
export interface LineDeleteResponse {
|
|
136
|
+
}
|
|
137
|
+
export interface LineCreateParams {
|
|
138
|
+
/**
|
|
139
|
+
* Body param: ID of the product being ordered.
|
|
140
|
+
*/
|
|
141
|
+
product_id: string;
|
|
142
|
+
/**
|
|
143
|
+
* Body param: The product SKU recorded on the line.
|
|
144
|
+
*/
|
|
145
|
+
product_sku: string;
|
|
146
|
+
/**
|
|
147
|
+
* Body param: A value with an associated unit, used in create and update requests.
|
|
148
|
+
*/
|
|
149
|
+
quantity: CustomersAPI.QuantityInput;
|
|
150
|
+
/**
|
|
151
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
152
|
+
* are returned as `null`.
|
|
153
|
+
*/
|
|
154
|
+
include?: Array<'product' | 'quantity_ordered' | 'unit_price' | 'unit_cost' | 'totals'>;
|
|
155
|
+
/**
|
|
156
|
+
* Body param: The product description recorded on the line.
|
|
157
|
+
*/
|
|
158
|
+
product_description?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
161
|
+
* create and update requests.
|
|
162
|
+
*/
|
|
163
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
164
|
+
}
|
|
165
|
+
export interface LineUpdateParams {
|
|
166
|
+
/**
|
|
167
|
+
* Path param: Sales order ID.
|
|
168
|
+
*/
|
|
169
|
+
id: string;
|
|
170
|
+
/**
|
|
171
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
172
|
+
* are returned as `null`.
|
|
173
|
+
*/
|
|
174
|
+
include?: Array<'product' | 'quantity_ordered' | 'unit_price' | 'unit_cost' | 'totals'>;
|
|
175
|
+
/**
|
|
176
|
+
* Body param: Product description.
|
|
177
|
+
*/
|
|
178
|
+
product_description?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Body param: Product SKU.
|
|
181
|
+
*/
|
|
182
|
+
product_sku?: string;
|
|
183
|
+
/**
|
|
184
|
+
* Body param: A value with an associated unit, used in create and update requests.
|
|
185
|
+
*/
|
|
186
|
+
quantity?: CustomersAPI.QuantityInput;
|
|
187
|
+
/**
|
|
188
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
189
|
+
* create and update requests.
|
|
190
|
+
*/
|
|
191
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
192
|
+
/**
|
|
193
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
194
|
+
* create and update requests.
|
|
195
|
+
*/
|
|
196
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
197
|
+
}
|
|
198
|
+
export interface LineDeleteParams {
|
|
199
|
+
/**
|
|
200
|
+
* Sales order ID.
|
|
201
|
+
*/
|
|
202
|
+
id: string;
|
|
203
|
+
}
|
|
204
|
+
export declare namespace Lines {
|
|
205
|
+
export { type CreateSalesOrderLineRequest as CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest as UpdateSalesOrderLineRequest, type LineDeleteResponse as LineDeleteResponse, type LineCreateParams as LineCreateParams, type LineUpdateParams as LineUpdateParams, type LineDeleteParams as LineDeleteParams, };
|
|
206
|
+
export { Actions as Actions, type ReorderSalesOrderLinesRequest as ReorderSalesOrderLinesRequest, type ActionReorderResponse as ActionReorderResponse, type ActionReorderParams as ActionReorderParams, };
|
|
207
|
+
}
|
|
208
|
+
//# sourceMappingURL=lines.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lines.d.mts","sourceRoot":"","sources":["../../../../src/resources/sales/sales-orders/lines/lines.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,YAAY;OACjB,KAAK,cAAc;OACnB,KAAK,UAAU;OACf,EACL,mBAAmB,EACnB,qBAAqB,EACrB,OAAO,EACP,6BAA6B,EAC9B;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,cAAc,CAAC;IAS5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,cAAc,CAAC;IAS5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAI3G;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC,aAAa,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC,aAAa,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,kBAAkB,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC;IAExF;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,kBAAkB,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC;IAExF;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import { APIResource } from "../../../../core/resource.js";
|
|
2
|
+
import * as MaterialsAPI from "../../../catalog/materials.js";
|
|
3
|
+
import * as CustomersAPI from "../../customers/customers.js";
|
|
4
|
+
import * as SalesOrdersAPI from "../sales-orders.js";
|
|
5
|
+
import * as ActionsAPI from "./actions.js";
|
|
6
|
+
import { ActionReorderParams, ActionReorderResponse, Actions, ReorderSalesOrderLinesRequest } from "./actions.js";
|
|
7
|
+
import { APIPromise } from "../../../../core/api-promise.js";
|
|
8
|
+
import { RequestOptions } from "../../../../internal/request-options.js";
|
|
9
|
+
/**
|
|
10
|
+
* List, view, create, update, and delete sales orders.
|
|
11
|
+
*/
|
|
12
|
+
export declare class Lines extends APIResource {
|
|
13
|
+
actions: ActionsAPI.Actions;
|
|
14
|
+
/**
|
|
15
|
+
* Creates a line item on a sales order.
|
|
16
|
+
*
|
|
17
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
18
|
+
* `sales_orders:update`.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const salesOrderLine =
|
|
23
|
+
* await client.sales.salesOrders.lines.create(
|
|
24
|
+
* 'or_01d5034136c3ccc048abecc312',
|
|
25
|
+
* {
|
|
26
|
+
* product_id: 'pd_013c29ab3f1518d0004094c316',
|
|
27
|
+
* product_sku: 'WIDGET-001',
|
|
28
|
+
* quantity: {
|
|
29
|
+
* value: '10',
|
|
30
|
+
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
31
|
+
* },
|
|
32
|
+
* },
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
create(id: string, params: LineCreateParams, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrderLine>;
|
|
37
|
+
/**
|
|
38
|
+
* Partially updates a sales order line item.
|
|
39
|
+
*
|
|
40
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
41
|
+
* `sales_orders:update`.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const salesOrderLine =
|
|
46
|
+
* await client.sales.salesOrders.lines.update('example', {
|
|
47
|
+
* id: 'or_01d5034136c3ccc048abecc312',
|
|
48
|
+
* quantity: {
|
|
49
|
+
* value: '20',
|
|
50
|
+
* unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
51
|
+
* },
|
|
52
|
+
* unit_price: {
|
|
53
|
+
* value: '30.00',
|
|
54
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
55
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
56
|
+
* },
|
|
57
|
+
* });
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
update(lineID: string, params: LineUpdateParams, options?: RequestOptions): APIPromise<SalesOrdersAPI.SalesOrderLine>;
|
|
61
|
+
/**
|
|
62
|
+
* Deletes a sales order line and related records.
|
|
63
|
+
*
|
|
64
|
+
* This endpoint requires the permissions: `customers:update`, `suppliers:update`,
|
|
65
|
+
* `sales_orders:update`.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const line = await client.sales.salesOrders.lines.delete(
|
|
70
|
+
* 'example',
|
|
71
|
+
* { id: 'or_01d5034136c3ccc048abecc312' },
|
|
72
|
+
* );
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
delete(lineID: string, params: LineDeleteParams, options?: RequestOptions): APIPromise<LineDeleteResponse>;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Request to create a line on a sales order.
|
|
79
|
+
*
|
|
80
|
+
* This mirrors the create-order line shape (not the shared purchase-order
|
|
81
|
+
* OrderLineInput): the unit price is optional and, when omitted, the line is
|
|
82
|
+
* priced server-side from the product. The unit cost is always resolved
|
|
83
|
+
* server-side from the product.
|
|
84
|
+
*/
|
|
85
|
+
export interface CreateSalesOrderLineRequest {
|
|
86
|
+
/**
|
|
87
|
+
* ID of the product being ordered.
|
|
88
|
+
*/
|
|
89
|
+
product_id: string;
|
|
90
|
+
/**
|
|
91
|
+
* The product SKU recorded on the line.
|
|
92
|
+
*/
|
|
93
|
+
product_sku: string;
|
|
94
|
+
/**
|
|
95
|
+
* A value with an associated unit, used in create and update requests.
|
|
96
|
+
*/
|
|
97
|
+
quantity: CustomersAPI.QuantityInput;
|
|
98
|
+
/**
|
|
99
|
+
* The product description recorded on the line.
|
|
100
|
+
*/
|
|
101
|
+
product_description?: string;
|
|
102
|
+
/**
|
|
103
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
104
|
+
* requests.
|
|
105
|
+
*/
|
|
106
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Request to update a sales order line.
|
|
110
|
+
*/
|
|
111
|
+
export interface UpdateSalesOrderLineRequest {
|
|
112
|
+
/**
|
|
113
|
+
* Product description.
|
|
114
|
+
*/
|
|
115
|
+
product_description?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Product SKU.
|
|
118
|
+
*/
|
|
119
|
+
product_sku?: string;
|
|
120
|
+
/**
|
|
121
|
+
* A value with an associated unit, used in create and update requests.
|
|
122
|
+
*/
|
|
123
|
+
quantity?: CustomersAPI.QuantityInput;
|
|
124
|
+
/**
|
|
125
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
126
|
+
* requests.
|
|
127
|
+
*/
|
|
128
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
129
|
+
/**
|
|
130
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
131
|
+
* requests.
|
|
132
|
+
*/
|
|
133
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
134
|
+
}
|
|
135
|
+
export interface LineDeleteResponse {
|
|
136
|
+
}
|
|
137
|
+
export interface LineCreateParams {
|
|
138
|
+
/**
|
|
139
|
+
* Body param: ID of the product being ordered.
|
|
140
|
+
*/
|
|
141
|
+
product_id: string;
|
|
142
|
+
/**
|
|
143
|
+
* Body param: The product SKU recorded on the line.
|
|
144
|
+
*/
|
|
145
|
+
product_sku: string;
|
|
146
|
+
/**
|
|
147
|
+
* Body param: A value with an associated unit, used in create and update requests.
|
|
148
|
+
*/
|
|
149
|
+
quantity: CustomersAPI.QuantityInput;
|
|
150
|
+
/**
|
|
151
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
152
|
+
* are returned as `null`.
|
|
153
|
+
*/
|
|
154
|
+
include?: Array<'product' | 'quantity_ordered' | 'unit_price' | 'unit_cost' | 'totals'>;
|
|
155
|
+
/**
|
|
156
|
+
* Body param: The product description recorded on the line.
|
|
157
|
+
*/
|
|
158
|
+
product_description?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
161
|
+
* create and update requests.
|
|
162
|
+
*/
|
|
163
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
164
|
+
}
|
|
165
|
+
export interface LineUpdateParams {
|
|
166
|
+
/**
|
|
167
|
+
* Path param: Sales order ID.
|
|
168
|
+
*/
|
|
169
|
+
id: string;
|
|
170
|
+
/**
|
|
171
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
172
|
+
* are returned as `null`.
|
|
173
|
+
*/
|
|
174
|
+
include?: Array<'product' | 'quantity_ordered' | 'unit_price' | 'unit_cost' | 'totals'>;
|
|
175
|
+
/**
|
|
176
|
+
* Body param: Product description.
|
|
177
|
+
*/
|
|
178
|
+
product_description?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Body param: Product SKU.
|
|
181
|
+
*/
|
|
182
|
+
product_sku?: string;
|
|
183
|
+
/**
|
|
184
|
+
* Body param: A value with an associated unit, used in create and update requests.
|
|
185
|
+
*/
|
|
186
|
+
quantity?: CustomersAPI.QuantityInput;
|
|
187
|
+
/**
|
|
188
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
189
|
+
* create and update requests.
|
|
190
|
+
*/
|
|
191
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
192
|
+
/**
|
|
193
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
194
|
+
* create and update requests.
|
|
195
|
+
*/
|
|
196
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
197
|
+
}
|
|
198
|
+
export interface LineDeleteParams {
|
|
199
|
+
/**
|
|
200
|
+
* Sales order ID.
|
|
201
|
+
*/
|
|
202
|
+
id: string;
|
|
203
|
+
}
|
|
204
|
+
export declare namespace Lines {
|
|
205
|
+
export { type CreateSalesOrderLineRequest as CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest as UpdateSalesOrderLineRequest, type LineDeleteResponse as LineDeleteResponse, type LineCreateParams as LineCreateParams, type LineUpdateParams as LineUpdateParams, type LineDeleteParams as LineDeleteParams, };
|
|
206
|
+
export { Actions as Actions, type ReorderSalesOrderLinesRequest as ReorderSalesOrderLinesRequest, type ActionReorderResponse as ActionReorderResponse, type ActionReorderParams as ActionReorderParams, };
|
|
207
|
+
}
|
|
208
|
+
//# sourceMappingURL=lines.d.ts.map
|