@revenexx/sdk 0.0.12 → 0.0.13
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/dist/cjs/sdk.js +842 -32
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +842 -32
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +842 -32
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/models.ts +4 -0
- package/src/services/carts.ts +43 -1
- package/src/services/channels.ts +43 -1
- package/src/services/customers.ts +43 -1
- package/src/services/inventories.ts +172 -4
- package/src/services/markets.ts +127 -19
- package/src/services/orders.ts +43 -1
- package/src/services/pages.ts +243 -11
- package/src/services/payments.ts +129 -3
- package/src/services/prices.ts +71 -7
- package/src/services/shipping.ts +71 -7
- package/types/models.d.ts +4 -0
- package/types/services/carts.d.ts +18 -1
- package/types/services/channels.d.ts +18 -1
- package/types/services/customers.d.ts +18 -1
- package/types/services/inventories.d.ts +72 -4
- package/types/services/markets.d.ts +48 -4
- package/types/services/orders.d.ts +18 -1
- package/types/services/pages.d.ts +100 -6
- package/types/services/payments.d.ts +54 -3
- package/types/services/prices.d.ts +28 -2
- package/types/services/shipping.d.ts +28 -2
package/src/services/payments.ts
CHANGED
|
@@ -14,13 +14,55 @@ export class Payments {
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
18
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
19
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
17
20
|
* @throws {RevenexxException}
|
|
18
21
|
* @returns {Promise<{}>}
|
|
19
22
|
*/
|
|
20
|
-
paymentsList(): Promise<{}
|
|
23
|
+
paymentsList(params?: { limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
27
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
28
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
29
|
+
* @throws {RevenexxException}
|
|
30
|
+
* @returns {Promise<{}>}
|
|
31
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
32
|
+
*/
|
|
33
|
+
paymentsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
34
|
+
paymentsList(
|
|
35
|
+
paramsOrFirst?: { limit?: number, offset?: number, order?: string } | number,
|
|
36
|
+
...rest: [(number)?, (string)?]
|
|
37
|
+
): Promise<{}> {
|
|
38
|
+
let params: { limit?: number, offset?: number, order?: string };
|
|
39
|
+
|
|
40
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
41
|
+
params = (paramsOrFirst || {}) as { limit?: number, offset?: number, order?: string };
|
|
42
|
+
} else {
|
|
43
|
+
params = {
|
|
44
|
+
limit: paramsOrFirst as number,
|
|
45
|
+
offset: rest[0] as number,
|
|
46
|
+
order: rest[1] as string
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const limit = params.limit;
|
|
51
|
+
const offset = params.offset;
|
|
52
|
+
const order = params.order;
|
|
53
|
+
|
|
21
54
|
|
|
22
55
|
const apiPath = '/v1/payments';
|
|
23
56
|
const apiPayload: Payload = {};
|
|
57
|
+
if (typeof limit !== 'undefined') {
|
|
58
|
+
apiPayload['limit'] = limit;
|
|
59
|
+
}
|
|
60
|
+
if (typeof offset !== 'undefined') {
|
|
61
|
+
apiPayload['offset'] = offset;
|
|
62
|
+
}
|
|
63
|
+
if (typeof order !== 'undefined') {
|
|
64
|
+
apiPayload['order'] = order;
|
|
65
|
+
}
|
|
24
66
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
25
67
|
|
|
26
68
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -156,13 +198,55 @@ export class Payments {
|
|
|
156
198
|
|
|
157
199
|
/**
|
|
158
200
|
*
|
|
201
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
202
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
203
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
159
204
|
* @throws {RevenexxException}
|
|
160
205
|
* @returns {Promise<{}>}
|
|
161
206
|
*/
|
|
162
|
-
paymentsMethodsList(): Promise<{}
|
|
207
|
+
paymentsMethodsList(params?: { limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
211
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
212
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
213
|
+
* @throws {RevenexxException}
|
|
214
|
+
* @returns {Promise<{}>}
|
|
215
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
216
|
+
*/
|
|
217
|
+
paymentsMethodsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
218
|
+
paymentsMethodsList(
|
|
219
|
+
paramsOrFirst?: { limit?: number, offset?: number, order?: string } | number,
|
|
220
|
+
...rest: [(number)?, (string)?]
|
|
221
|
+
): Promise<{}> {
|
|
222
|
+
let params: { limit?: number, offset?: number, order?: string };
|
|
223
|
+
|
|
224
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
225
|
+
params = (paramsOrFirst || {}) as { limit?: number, offset?: number, order?: string };
|
|
226
|
+
} else {
|
|
227
|
+
params = {
|
|
228
|
+
limit: paramsOrFirst as number,
|
|
229
|
+
offset: rest[0] as number,
|
|
230
|
+
order: rest[1] as string
|
|
231
|
+
};
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
const limit = params.limit;
|
|
235
|
+
const offset = params.offset;
|
|
236
|
+
const order = params.order;
|
|
237
|
+
|
|
163
238
|
|
|
164
239
|
const apiPath = '/v1/payments/methods';
|
|
165
240
|
const apiPayload: Payload = {};
|
|
241
|
+
if (typeof limit !== 'undefined') {
|
|
242
|
+
apiPayload['limit'] = limit;
|
|
243
|
+
}
|
|
244
|
+
if (typeof offset !== 'undefined') {
|
|
245
|
+
apiPayload['offset'] = offset;
|
|
246
|
+
}
|
|
247
|
+
if (typeof order !== 'undefined') {
|
|
248
|
+
apiPayload['order'] = order;
|
|
249
|
+
}
|
|
166
250
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
167
251
|
|
|
168
252
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -688,13 +772,55 @@ export class Payments {
|
|
|
688
772
|
|
|
689
773
|
/**
|
|
690
774
|
*
|
|
775
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
776
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
777
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
691
778
|
* @throws {RevenexxException}
|
|
692
779
|
* @returns {Promise<{}>}
|
|
693
780
|
*/
|
|
694
|
-
paymentsProvidersList(): Promise<{}
|
|
781
|
+
paymentsProvidersList(params?: { limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
782
|
+
/**
|
|
783
|
+
*
|
|
784
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
785
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
786
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
787
|
+
* @throws {RevenexxException}
|
|
788
|
+
* @returns {Promise<{}>}
|
|
789
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
790
|
+
*/
|
|
791
|
+
paymentsProvidersList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
792
|
+
paymentsProvidersList(
|
|
793
|
+
paramsOrFirst?: { limit?: number, offset?: number, order?: string } | number,
|
|
794
|
+
...rest: [(number)?, (string)?]
|
|
795
|
+
): Promise<{}> {
|
|
796
|
+
let params: { limit?: number, offset?: number, order?: string };
|
|
797
|
+
|
|
798
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
799
|
+
params = (paramsOrFirst || {}) as { limit?: number, offset?: number, order?: string };
|
|
800
|
+
} else {
|
|
801
|
+
params = {
|
|
802
|
+
limit: paramsOrFirst as number,
|
|
803
|
+
offset: rest[0] as number,
|
|
804
|
+
order: rest[1] as string
|
|
805
|
+
};
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
const limit = params.limit;
|
|
809
|
+
const offset = params.offset;
|
|
810
|
+
const order = params.order;
|
|
811
|
+
|
|
695
812
|
|
|
696
813
|
const apiPath = '/v1/payments/providers';
|
|
697
814
|
const apiPayload: Payload = {};
|
|
815
|
+
if (typeof limit !== 'undefined') {
|
|
816
|
+
apiPayload['limit'] = limit;
|
|
817
|
+
}
|
|
818
|
+
if (typeof offset !== 'undefined') {
|
|
819
|
+
apiPayload['offset'] = offset;
|
|
820
|
+
}
|
|
821
|
+
if (typeof order !== 'undefined') {
|
|
822
|
+
apiPayload['order'] = order;
|
|
823
|
+
}
|
|
698
824
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
699
825
|
|
|
700
826
|
const apiHeaders: { [header: string]: string } = {
|
package/src/services/prices.ts
CHANGED
|
@@ -14,13 +14,55 @@ export class Prices {
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
18
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
19
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
17
20
|
* @throws {RevenexxException}
|
|
18
21
|
* @returns {Promise<{}>}
|
|
19
22
|
*/
|
|
20
|
-
pricesListsList(): Promise<{}
|
|
23
|
+
pricesListsList(params?: { limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
27
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
28
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
29
|
+
* @throws {RevenexxException}
|
|
30
|
+
* @returns {Promise<{}>}
|
|
31
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
32
|
+
*/
|
|
33
|
+
pricesListsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
34
|
+
pricesListsList(
|
|
35
|
+
paramsOrFirst?: { limit?: number, offset?: number, order?: string } | number,
|
|
36
|
+
...rest: [(number)?, (string)?]
|
|
37
|
+
): Promise<{}> {
|
|
38
|
+
let params: { limit?: number, offset?: number, order?: string };
|
|
39
|
+
|
|
40
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
41
|
+
params = (paramsOrFirst || {}) as { limit?: number, offset?: number, order?: string };
|
|
42
|
+
} else {
|
|
43
|
+
params = {
|
|
44
|
+
limit: paramsOrFirst as number,
|
|
45
|
+
offset: rest[0] as number,
|
|
46
|
+
order: rest[1] as string
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const limit = params.limit;
|
|
51
|
+
const offset = params.offset;
|
|
52
|
+
const order = params.order;
|
|
53
|
+
|
|
21
54
|
|
|
22
55
|
const apiPath = '/v1/prices/lists';
|
|
23
56
|
const apiPayload: Payload = {};
|
|
57
|
+
if (typeof limit !== 'undefined') {
|
|
58
|
+
apiPayload['limit'] = limit;
|
|
59
|
+
}
|
|
60
|
+
if (typeof offset !== 'undefined') {
|
|
61
|
+
apiPayload['offset'] = offset;
|
|
62
|
+
}
|
|
63
|
+
if (typeof order !== 'undefined') {
|
|
64
|
+
apiPayload['order'] = order;
|
|
65
|
+
}
|
|
24
66
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
25
67
|
|
|
26
68
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -482,32 +524,45 @@ export class Prices {
|
|
|
482
524
|
/**
|
|
483
525
|
*
|
|
484
526
|
* @param {string} params.listId -
|
|
527
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
528
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
529
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
485
530
|
* @throws {RevenexxException}
|
|
486
531
|
* @returns {Promise<{}>}
|
|
487
532
|
*/
|
|
488
|
-
pricesEntriesList(params: { listId: string }): Promise<{}>;
|
|
533
|
+
pricesEntriesList(params: { listId: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
489
534
|
/**
|
|
490
535
|
*
|
|
491
536
|
* @param {string} listId -
|
|
537
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
538
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
539
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
492
540
|
* @throws {RevenexxException}
|
|
493
541
|
* @returns {Promise<{}>}
|
|
494
542
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
495
543
|
*/
|
|
496
|
-
pricesEntriesList(listId: string): Promise<{}>;
|
|
544
|
+
pricesEntriesList(listId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
497
545
|
pricesEntriesList(
|
|
498
|
-
paramsOrFirst: { listId: string } | string
|
|
546
|
+
paramsOrFirst: { listId: string, limit?: number, offset?: number, order?: string } | string,
|
|
547
|
+
...rest: [(number)?, (number)?, (string)?]
|
|
499
548
|
): Promise<{}> {
|
|
500
|
-
let params: { listId: string };
|
|
549
|
+
let params: { listId: string, limit?: number, offset?: number, order?: string };
|
|
501
550
|
|
|
502
551
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
503
|
-
params = (paramsOrFirst || {}) as { listId: string };
|
|
552
|
+
params = (paramsOrFirst || {}) as { listId: string, limit?: number, offset?: number, order?: string };
|
|
504
553
|
} else {
|
|
505
554
|
params = {
|
|
506
|
-
listId: paramsOrFirst as string
|
|
555
|
+
listId: paramsOrFirst as string,
|
|
556
|
+
limit: rest[0] as number,
|
|
557
|
+
offset: rest[1] as number,
|
|
558
|
+
order: rest[2] as string
|
|
507
559
|
};
|
|
508
560
|
}
|
|
509
561
|
|
|
510
562
|
const listId = params.listId;
|
|
563
|
+
const limit = params.limit;
|
|
564
|
+
const offset = params.offset;
|
|
565
|
+
const order = params.order;
|
|
511
566
|
|
|
512
567
|
if (typeof listId === 'undefined') {
|
|
513
568
|
throw new RevenexxException('Missing required parameter: "listId"');
|
|
@@ -515,6 +570,15 @@ export class Prices {
|
|
|
515
570
|
|
|
516
571
|
const apiPath = '/v1/prices/lists/{list_id}/entries'.replace('{list_id}', listId);
|
|
517
572
|
const apiPayload: Payload = {};
|
|
573
|
+
if (typeof limit !== 'undefined') {
|
|
574
|
+
apiPayload['limit'] = limit;
|
|
575
|
+
}
|
|
576
|
+
if (typeof offset !== 'undefined') {
|
|
577
|
+
apiPayload['offset'] = offset;
|
|
578
|
+
}
|
|
579
|
+
if (typeof order !== 'undefined') {
|
|
580
|
+
apiPayload['order'] = order;
|
|
581
|
+
}
|
|
518
582
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
519
583
|
|
|
520
584
|
const apiHeaders: { [header: string]: string } = {
|
package/src/services/shipping.ts
CHANGED
|
@@ -14,13 +14,55 @@ export class Shipping {
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
18
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
19
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
17
20
|
* @throws {RevenexxException}
|
|
18
21
|
* @returns {Promise<{}>}
|
|
19
22
|
*/
|
|
20
|
-
shippingMethodsList(): Promise<{}
|
|
23
|
+
shippingMethodsList(params?: { limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
27
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
28
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
29
|
+
* @throws {RevenexxException}
|
|
30
|
+
* @returns {Promise<{}>}
|
|
31
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
32
|
+
*/
|
|
33
|
+
shippingMethodsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
34
|
+
shippingMethodsList(
|
|
35
|
+
paramsOrFirst?: { limit?: number, offset?: number, order?: string } | number,
|
|
36
|
+
...rest: [(number)?, (string)?]
|
|
37
|
+
): Promise<{}> {
|
|
38
|
+
let params: { limit?: number, offset?: number, order?: string };
|
|
39
|
+
|
|
40
|
+
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
41
|
+
params = (paramsOrFirst || {}) as { limit?: number, offset?: number, order?: string };
|
|
42
|
+
} else {
|
|
43
|
+
params = {
|
|
44
|
+
limit: paramsOrFirst as number,
|
|
45
|
+
offset: rest[0] as number,
|
|
46
|
+
order: rest[1] as string
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const limit = params.limit;
|
|
51
|
+
const offset = params.offset;
|
|
52
|
+
const order = params.order;
|
|
53
|
+
|
|
21
54
|
|
|
22
55
|
const apiPath = '/v1/shipping/methods';
|
|
23
56
|
const apiPayload: Payload = {};
|
|
57
|
+
if (typeof limit !== 'undefined') {
|
|
58
|
+
apiPayload['limit'] = limit;
|
|
59
|
+
}
|
|
60
|
+
if (typeof offset !== 'undefined') {
|
|
61
|
+
apiPayload['offset'] = offset;
|
|
62
|
+
}
|
|
63
|
+
if (typeof order !== 'undefined') {
|
|
64
|
+
apiPayload['order'] = order;
|
|
65
|
+
}
|
|
24
66
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
25
67
|
|
|
26
68
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -496,32 +538,45 @@ export class Shipping {
|
|
|
496
538
|
/**
|
|
497
539
|
*
|
|
498
540
|
* @param {string} params.methodId -
|
|
541
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
542
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
543
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
499
544
|
* @throws {RevenexxException}
|
|
500
545
|
* @returns {Promise<{}>}
|
|
501
546
|
*/
|
|
502
|
-
shippingTiersList(params: { methodId: string }): Promise<{}>;
|
|
547
|
+
shippingTiersList(params: { methodId: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
|
|
503
548
|
/**
|
|
504
549
|
*
|
|
505
550
|
* @param {string} methodId -
|
|
551
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
552
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
553
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
506
554
|
* @throws {RevenexxException}
|
|
507
555
|
* @returns {Promise<{}>}
|
|
508
556
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
509
557
|
*/
|
|
510
|
-
shippingTiersList(methodId: string): Promise<{}>;
|
|
558
|
+
shippingTiersList(methodId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
511
559
|
shippingTiersList(
|
|
512
|
-
paramsOrFirst: { methodId: string } | string
|
|
560
|
+
paramsOrFirst: { methodId: string, limit?: number, offset?: number, order?: string } | string,
|
|
561
|
+
...rest: [(number)?, (number)?, (string)?]
|
|
513
562
|
): Promise<{}> {
|
|
514
|
-
let params: { methodId: string };
|
|
563
|
+
let params: { methodId: string, limit?: number, offset?: number, order?: string };
|
|
515
564
|
|
|
516
565
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
517
|
-
params = (paramsOrFirst || {}) as { methodId: string };
|
|
566
|
+
params = (paramsOrFirst || {}) as { methodId: string, limit?: number, offset?: number, order?: string };
|
|
518
567
|
} else {
|
|
519
568
|
params = {
|
|
520
|
-
methodId: paramsOrFirst as string
|
|
569
|
+
methodId: paramsOrFirst as string,
|
|
570
|
+
limit: rest[0] as number,
|
|
571
|
+
offset: rest[1] as number,
|
|
572
|
+
order: rest[2] as string
|
|
521
573
|
};
|
|
522
574
|
}
|
|
523
575
|
|
|
524
576
|
const methodId = params.methodId;
|
|
577
|
+
const limit = params.limit;
|
|
578
|
+
const offset = params.offset;
|
|
579
|
+
const order = params.order;
|
|
525
580
|
|
|
526
581
|
if (typeof methodId === 'undefined') {
|
|
527
582
|
throw new RevenexxException('Missing required parameter: "methodId"');
|
|
@@ -529,6 +584,15 @@ export class Shipping {
|
|
|
529
584
|
|
|
530
585
|
const apiPath = '/v1/shipping/methods/{method_id}/tiers'.replace('{method_id}', methodId);
|
|
531
586
|
const apiPayload: Payload = {};
|
|
587
|
+
if (typeof limit !== 'undefined') {
|
|
588
|
+
apiPayload['limit'] = limit;
|
|
589
|
+
}
|
|
590
|
+
if (typeof offset !== 'undefined') {
|
|
591
|
+
apiPayload['offset'] = offset;
|
|
592
|
+
}
|
|
593
|
+
if (typeof order !== 'undefined') {
|
|
594
|
+
apiPayload['order'] = order;
|
|
595
|
+
}
|
|
532
596
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
533
597
|
|
|
534
598
|
const apiHeaders: { [header: string]: string } = {
|
package/types/models.d.ts
CHANGED
|
@@ -139,10 +139,27 @@ export declare class Carts {
|
|
|
139
139
|
cartsImport(contactId?: string, csv?: string, name?: string, payload?: object, profileId?: string, sessionKey?: string, targetCartId?: string): Promise<{}>;
|
|
140
140
|
/**
|
|
141
141
|
*
|
|
142
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
143
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
144
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
145
|
+
* @throws {RevenexxException}
|
|
146
|
+
* @returns {Promise<{}>}
|
|
147
|
+
*/
|
|
148
|
+
cartsIoProfilesList(params?: {
|
|
149
|
+
limit?: number;
|
|
150
|
+
offset?: number;
|
|
151
|
+
order?: string;
|
|
152
|
+
}): Promise<{}>;
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
156
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
157
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
142
158
|
* @throws {RevenexxException}
|
|
143
159
|
* @returns {Promise<{}>}
|
|
160
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
144
161
|
*/
|
|
145
|
-
cartsIoProfilesList(): Promise<{}>;
|
|
162
|
+
cartsIoProfilesList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
146
163
|
/**
|
|
147
164
|
*
|
|
148
165
|
* @param {CartIoDirection} params.direction -
|
|
@@ -7,10 +7,27 @@ export declare class Channels {
|
|
|
7
7
|
constructor(client: Client);
|
|
8
8
|
/**
|
|
9
9
|
*
|
|
10
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
11
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
12
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
10
13
|
* @throws {RevenexxException}
|
|
11
14
|
* @returns {Promise<{}>}
|
|
12
15
|
*/
|
|
13
|
-
channelsList(
|
|
16
|
+
channelsList(params?: {
|
|
17
|
+
limit?: number;
|
|
18
|
+
offset?: number;
|
|
19
|
+
order?: string;
|
|
20
|
+
}): Promise<{}>;
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
24
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
25
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
26
|
+
* @throws {RevenexxException}
|
|
27
|
+
* @returns {Promise<{}>}
|
|
28
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
29
|
+
*/
|
|
30
|
+
channelsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
14
31
|
/**
|
|
15
32
|
*
|
|
16
33
|
* @param {string} params.code - Stable channel code, unique per tenant (e.g. shop, punchout-acme).
|
|
@@ -473,10 +473,27 @@ export declare class Customers {
|
|
|
473
473
|
customersContactsUpdate(id: string, email?: string, firstName?: string, isPrimary?: boolean, lastName?: string, locale?: string, organizationId?: string, phone?: string, role?: ContactRole, status?: ContactStatus): Promise<Models.Contact>;
|
|
474
474
|
/**
|
|
475
475
|
*
|
|
476
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
477
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
478
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
479
|
+
* @throws {RevenexxException}
|
|
480
|
+
* @returns {Promise<{}>}
|
|
481
|
+
*/
|
|
482
|
+
customersOrganizationsList(params?: {
|
|
483
|
+
limit?: number;
|
|
484
|
+
offset?: number;
|
|
485
|
+
order?: string;
|
|
486
|
+
}): Promise<{}>;
|
|
487
|
+
/**
|
|
488
|
+
*
|
|
489
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
490
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
491
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
476
492
|
* @throws {RevenexxException}
|
|
477
493
|
* @returns {Promise<{}>}
|
|
494
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
478
495
|
*/
|
|
479
|
-
customersOrganizationsList(): Promise<{}>;
|
|
496
|
+
customersOrganizationsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
480
497
|
/**
|
|
481
498
|
*
|
|
482
499
|
* @param {string} params.name - Company name — mirrored to the platform team.
|
|
@@ -66,10 +66,27 @@ export declare class Inventories {
|
|
|
66
66
|
inventoriesCommit(orderRef: string): Promise<{}>;
|
|
67
67
|
/**
|
|
68
68
|
*
|
|
69
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
70
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
71
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
69
72
|
* @throws {RevenexxException}
|
|
70
73
|
* @returns {Promise<{}>}
|
|
71
74
|
*/
|
|
72
|
-
inventoriesLocationsList(
|
|
75
|
+
inventoriesLocationsList(params?: {
|
|
76
|
+
limit?: number;
|
|
77
|
+
offset?: number;
|
|
78
|
+
order?: string;
|
|
79
|
+
}): Promise<{}>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
83
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
84
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
85
|
+
* @throws {RevenexxException}
|
|
86
|
+
* @returns {Promise<{}>}
|
|
87
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
88
|
+
*/
|
|
89
|
+
inventoriesLocationsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
73
90
|
/**
|
|
74
91
|
*
|
|
75
92
|
* @param {string} params.code - Unique location code (per tenant).
|
|
@@ -191,10 +208,27 @@ export declare class Inventories {
|
|
|
191
208
|
inventoriesLocationsUpdate(id: string, address?: object, code?: string, enabled?: boolean, labels?: object, metadata?: object, name?: string, priority?: number, type?: LocationType): Promise<Models.Location>;
|
|
192
209
|
/**
|
|
193
210
|
*
|
|
211
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
212
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
213
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
194
214
|
* @throws {RevenexxException}
|
|
195
215
|
* @returns {Promise<{}>}
|
|
196
216
|
*/
|
|
197
|
-
inventoriesMovementsList(
|
|
217
|
+
inventoriesMovementsList(params?: {
|
|
218
|
+
limit?: number;
|
|
219
|
+
offset?: number;
|
|
220
|
+
order?: string;
|
|
221
|
+
}): Promise<{}>;
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
225
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
226
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
227
|
+
* @throws {RevenexxException}
|
|
228
|
+
* @returns {Promise<{}>}
|
|
229
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
230
|
+
*/
|
|
231
|
+
inventoriesMovementsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
198
232
|
/**
|
|
199
233
|
*
|
|
200
234
|
* @param {string} params.id -
|
|
@@ -254,10 +288,27 @@ export declare class Inventories {
|
|
|
254
288
|
inventoriesRelease(orderRef: string): Promise<{}>;
|
|
255
289
|
/**
|
|
256
290
|
*
|
|
291
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
292
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
293
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
257
294
|
* @throws {RevenexxException}
|
|
258
295
|
* @returns {Promise<{}>}
|
|
259
296
|
*/
|
|
260
|
-
inventoriesReservationsList(
|
|
297
|
+
inventoriesReservationsList(params?: {
|
|
298
|
+
limit?: number;
|
|
299
|
+
offset?: number;
|
|
300
|
+
order?: string;
|
|
301
|
+
}): Promise<{}>;
|
|
302
|
+
/**
|
|
303
|
+
*
|
|
304
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
305
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
306
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
307
|
+
* @throws {RevenexxException}
|
|
308
|
+
* @returns {Promise<{}>}
|
|
309
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
310
|
+
*/
|
|
311
|
+
inventoriesReservationsList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
261
312
|
/**
|
|
262
313
|
*
|
|
263
314
|
* @param {string} params.id -
|
|
@@ -326,10 +377,27 @@ export declare class Inventories {
|
|
|
326
377
|
inventoriesRestock(items: Models.InventoryStockItem[], locationCode?: string, orderRef?: string, reason?: string): Promise<{}>;
|
|
327
378
|
/**
|
|
328
379
|
*
|
|
380
|
+
* @param {number} params.limit - Page size (default 50, max 200).
|
|
381
|
+
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
382
|
+
* @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
329
383
|
* @throws {RevenexxException}
|
|
330
384
|
* @returns {Promise<{}>}
|
|
331
385
|
*/
|
|
332
|
-
inventoriesStockList(
|
|
386
|
+
inventoriesStockList(params?: {
|
|
387
|
+
limit?: number;
|
|
388
|
+
offset?: number;
|
|
389
|
+
order?: string;
|
|
390
|
+
}): Promise<{}>;
|
|
391
|
+
/**
|
|
392
|
+
*
|
|
393
|
+
* @param {number} limit - Page size (default 50, max 200).
|
|
394
|
+
* @param {number} offset - Row offset for pagination (default 0).
|
|
395
|
+
* @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
|
|
396
|
+
* @throws {RevenexxException}
|
|
397
|
+
* @returns {Promise<{}>}
|
|
398
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
399
|
+
*/
|
|
400
|
+
inventoriesStockList(limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
333
401
|
/**
|
|
334
402
|
*
|
|
335
403
|
* @param {string} params.locationId - Owning location.
|