@revenexx/sdk 0.0.13 → 0.0.15
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 +109 -68
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +109 -69
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +109 -68
- package/package.json +1 -1
- package/src/client.ts +19 -1
- package/src/index.ts +1 -0
- package/src/models.ts +12 -36
- package/src/services/carts.ts +17 -31
- package/src/services/orders.ts +25 -39
- package/src/services/prices.ts +33 -33
- package/src/services/settings.ts +71 -0
- package/types/client.d.ts +12 -0
- package/types/index.d.ts +1 -0
- package/types/models.d.ts +12 -36
- package/types/services/carts.d.ts +2 -8
- package/types/services/orders.d.ts +2 -8
- package/types/services/prices.d.ts +8 -8
- package/types/services/settings.d.ts +27 -0
package/types/models.d.ts
CHANGED
|
@@ -1115,10 +1115,6 @@ export declare namespace Models {
|
|
|
1115
1115
|
*
|
|
1116
1116
|
*/
|
|
1117
1117
|
item_count?: number;
|
|
1118
|
-
/**
|
|
1119
|
-
*
|
|
1120
|
-
*/
|
|
1121
|
-
market_id?: string | null;
|
|
1122
1118
|
/**
|
|
1123
1119
|
*
|
|
1124
1120
|
*/
|
|
@@ -1193,10 +1189,6 @@ export declare namespace Models {
|
|
|
1193
1189
|
* Make this THE current cart of its owner.
|
|
1194
1190
|
*/
|
|
1195
1191
|
is_current?: boolean | null;
|
|
1196
|
-
/**
|
|
1197
|
-
*
|
|
1198
|
-
*/
|
|
1199
|
-
market_id?: string | null;
|
|
1200
1192
|
/**
|
|
1201
1193
|
* Free-form metadata.
|
|
1202
1194
|
*/
|
|
@@ -1490,10 +1482,6 @@ export declare namespace Models {
|
|
|
1490
1482
|
* ISO 4217 code.
|
|
1491
1483
|
*/
|
|
1492
1484
|
currency?: string | null;
|
|
1493
|
-
/**
|
|
1494
|
-
*
|
|
1495
|
-
*/
|
|
1496
|
-
market_id?: string | null;
|
|
1497
1485
|
/**
|
|
1498
1486
|
* Free-form metadata.
|
|
1499
1487
|
*/
|
|
@@ -3513,10 +3501,6 @@ export declare namespace Models {
|
|
|
3513
3501
|
*
|
|
3514
3502
|
*/
|
|
3515
3503
|
item_count?: number;
|
|
3516
|
-
/**
|
|
3517
|
-
*
|
|
3518
|
-
*/
|
|
3519
|
-
market_id?: string | null;
|
|
3520
3504
|
/**
|
|
3521
3505
|
*
|
|
3522
3506
|
*/
|
|
@@ -3772,10 +3756,6 @@ export declare namespace Models {
|
|
|
3772
3756
|
*
|
|
3773
3757
|
*/
|
|
3774
3758
|
items?: OrderItem[];
|
|
3775
|
-
/**
|
|
3776
|
-
*
|
|
3777
|
-
*/
|
|
3778
|
-
market_id?: string | null;
|
|
3779
3759
|
/**
|
|
3780
3760
|
*
|
|
3781
3761
|
*/
|
|
@@ -4581,10 +4561,6 @@ export declare namespace Models {
|
|
|
4581
4561
|
* The order positions (at most 500).
|
|
4582
4562
|
*/
|
|
4583
4563
|
items: OrderItemCreateRequest[];
|
|
4584
|
-
/**
|
|
4585
|
-
*
|
|
4586
|
-
*/
|
|
4587
|
-
market_id?: string | null;
|
|
4588
4564
|
/**
|
|
4589
4565
|
* Free-form metadata.
|
|
4590
4566
|
*/
|
|
@@ -5817,10 +5793,6 @@ export declare namespace Models {
|
|
|
5817
5793
|
*
|
|
5818
5794
|
*/
|
|
5819
5795
|
labels?: object | null;
|
|
5820
|
-
/**
|
|
5821
|
-
*
|
|
5822
|
-
*/
|
|
5823
|
-
market_id?: string | null;
|
|
5824
5796
|
/**
|
|
5825
5797
|
*
|
|
5826
5798
|
*/
|
|
@@ -5837,6 +5809,10 @@ export declare namespace Models {
|
|
|
5837
5809
|
*
|
|
5838
5810
|
*/
|
|
5839
5811
|
priority?: number;
|
|
5812
|
+
/**
|
|
5813
|
+
*
|
|
5814
|
+
*/
|
|
5815
|
+
requires_auth?: boolean;
|
|
5840
5816
|
/**
|
|
5841
5817
|
*
|
|
5842
5818
|
*/
|
|
@@ -5890,10 +5866,6 @@ export declare namespace Models {
|
|
|
5890
5866
|
* Localised names ({de, en, …}).
|
|
5891
5867
|
*/
|
|
5892
5868
|
labels?: object | null;
|
|
5893
|
-
/**
|
|
5894
|
-
* Scope: only this market.
|
|
5895
|
-
*/
|
|
5896
|
-
market_id?: string | null;
|
|
5897
5869
|
/**
|
|
5898
5870
|
* Free-form metadata.
|
|
5899
5871
|
*/
|
|
@@ -5910,6 +5882,10 @@ export declare namespace Models {
|
|
|
5910
5882
|
* Tie-breaker within a specificity group (higher wins, default 0).
|
|
5911
5883
|
*/
|
|
5912
5884
|
priority?: number;
|
|
5885
|
+
/**
|
|
5886
|
+
* Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
5887
|
+
*/
|
|
5888
|
+
requires_auth?: boolean;
|
|
5913
5889
|
/**
|
|
5914
5890
|
* Default 'active' — only active lists resolve.
|
|
5915
5891
|
*/
|
|
@@ -5959,10 +5935,6 @@ export declare namespace Models {
|
|
|
5959
5935
|
* Localised names ({de, en, …}).
|
|
5960
5936
|
*/
|
|
5961
5937
|
labels?: object | null;
|
|
5962
|
-
/**
|
|
5963
|
-
* Scope: only this market.
|
|
5964
|
-
*/
|
|
5965
|
-
market_id?: string | null;
|
|
5966
5938
|
/**
|
|
5967
5939
|
* Free-form metadata.
|
|
5968
5940
|
*/
|
|
@@ -5979,6 +5951,10 @@ export declare namespace Models {
|
|
|
5979
5951
|
* Tie-breaker within a specificity group (higher wins, default 0).
|
|
5980
5952
|
*/
|
|
5981
5953
|
priority?: number;
|
|
5954
|
+
/**
|
|
5955
|
+
* Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
5956
|
+
*/
|
|
5957
|
+
requires_auth?: boolean;
|
|
5982
5958
|
/**
|
|
5983
5959
|
* Default 'active' — only active lists resolve.
|
|
5984
5960
|
*/
|
|
@@ -47,7 +47,6 @@ export declare class Carts {
|
|
|
47
47
|
* @param {string} params.contactId - Owning customer contact.
|
|
48
48
|
* @param {string} params.currency - ISO 4217 code (default EUR).
|
|
49
49
|
* @param {boolean} params.isCurrent - Make this THE current cart of its owner.
|
|
50
|
-
* @param {string} params.marketId -
|
|
51
50
|
* @param {object} params.metadata - Free-form metadata.
|
|
52
51
|
* @param {string} params.name - Display name (default 'Cart').
|
|
53
52
|
* @param {string} params.sessionKey - Owning guest session.
|
|
@@ -59,7 +58,6 @@ export declare class Carts {
|
|
|
59
58
|
contactId?: string;
|
|
60
59
|
currency?: string;
|
|
61
60
|
isCurrent?: boolean;
|
|
62
|
-
marketId?: string;
|
|
63
61
|
metadata?: object;
|
|
64
62
|
name?: string;
|
|
65
63
|
sessionKey?: string;
|
|
@@ -70,7 +68,6 @@ export declare class Carts {
|
|
|
70
68
|
* @param {string} contactId - Owning customer contact.
|
|
71
69
|
* @param {string} currency - ISO 4217 code (default EUR).
|
|
72
70
|
* @param {boolean} isCurrent - Make this THE current cart of its owner.
|
|
73
|
-
* @param {string} marketId -
|
|
74
71
|
* @param {object} metadata - Free-form metadata.
|
|
75
72
|
* @param {string} name - Display name (default 'Cart').
|
|
76
73
|
* @param {string} sessionKey - Owning guest session.
|
|
@@ -78,7 +75,7 @@ export declare class Carts {
|
|
|
78
75
|
* @returns {Promise<Models.Cart>}
|
|
79
76
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
80
77
|
*/
|
|
81
|
-
cartsCreate(channelId?: string, contactId?: string, currency?: string, isCurrent?: boolean,
|
|
78
|
+
cartsCreate(channelId?: string, contactId?: string, currency?: string, isCurrent?: boolean, metadata?: object, name?: string, sessionKey?: string): Promise<Models.Cart>;
|
|
82
79
|
/**
|
|
83
80
|
*
|
|
84
81
|
* @param {string} params.contactId - Contact taking ownership.
|
|
@@ -530,7 +527,6 @@ export declare class Carts {
|
|
|
530
527
|
* @param {string} params.id -
|
|
531
528
|
* @param {string} params.channelId -
|
|
532
529
|
* @param {string} params.currency - ISO 4217 code.
|
|
533
|
-
* @param {string} params.marketId -
|
|
534
530
|
* @param {object} params.metadata - Free-form metadata.
|
|
535
531
|
* @param {string} params.name -
|
|
536
532
|
* @throws {RevenexxException}
|
|
@@ -540,7 +536,6 @@ export declare class Carts {
|
|
|
540
536
|
id: string;
|
|
541
537
|
channelId?: string;
|
|
542
538
|
currency?: string;
|
|
543
|
-
marketId?: string;
|
|
544
539
|
metadata?: object;
|
|
545
540
|
name?: string;
|
|
546
541
|
}): Promise<Models.Cart>;
|
|
@@ -549,14 +544,13 @@ export declare class Carts {
|
|
|
549
544
|
* @param {string} id -
|
|
550
545
|
* @param {string} channelId -
|
|
551
546
|
* @param {string} currency - ISO 4217 code.
|
|
552
|
-
* @param {string} marketId -
|
|
553
547
|
* @param {object} metadata - Free-form metadata.
|
|
554
548
|
* @param {string} name -
|
|
555
549
|
* @throws {RevenexxException}
|
|
556
550
|
* @returns {Promise<Models.Cart>}
|
|
557
551
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
558
552
|
*/
|
|
559
|
-
cartsUpdate(id: string, channelId?: string, currency?: string,
|
|
553
|
+
cartsUpdate(id: string, channelId?: string, currency?: string, metadata?: object, name?: string): Promise<Models.Cart>;
|
|
560
554
|
/**
|
|
561
555
|
*
|
|
562
556
|
* @param {string} params.id -
|
|
@@ -15,7 +15,6 @@ export declare class Orders {
|
|
|
15
15
|
* @param {string} params.contactId - Filter to one ordering contact.
|
|
16
16
|
* @param {string} params.organizationId - Filter to one B2B organization.
|
|
17
17
|
* @param {string} params.channelId - Filter to one sales channel.
|
|
18
|
-
* @param {string} params.marketId - Filter to one market.
|
|
19
18
|
* @param {string} params.number - Filter by exact order number.
|
|
20
19
|
* @param {number} params.limit - Page size (default 50, max 200).
|
|
21
20
|
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
@@ -30,7 +29,6 @@ export declare class Orders {
|
|
|
30
29
|
contactId?: string;
|
|
31
30
|
organizationId?: string;
|
|
32
31
|
channelId?: string;
|
|
33
|
-
marketId?: string;
|
|
34
32
|
number?: string;
|
|
35
33
|
limit?: number;
|
|
36
34
|
offset?: number;
|
|
@@ -44,7 +42,6 @@ export declare class Orders {
|
|
|
44
42
|
* @param {string} contactId - Filter to one ordering contact.
|
|
45
43
|
* @param {string} organizationId - Filter to one B2B organization.
|
|
46
44
|
* @param {string} channelId - Filter to one sales channel.
|
|
47
|
-
* @param {string} marketId - Filter to one market.
|
|
48
45
|
* @param {string} number - Filter by exact order number.
|
|
49
46
|
* @param {number} limit - Page size (default 50, max 200).
|
|
50
47
|
* @param {number} offset - Row offset for pagination (default 0).
|
|
@@ -53,7 +50,7 @@ export declare class Orders {
|
|
|
53
50
|
* @returns {Promise<{}>}
|
|
54
51
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
55
52
|
*/
|
|
56
|
-
ordersList(status?: OrderStatus, paymentStatus?: OrderPaymentStatus, fulfillmentStatus?: OrderFulfillmentStatus, contactId?: string, organizationId?: string, channelId?: string,
|
|
53
|
+
ordersList(status?: OrderStatus, paymentStatus?: OrderPaymentStatus, fulfillmentStatus?: OrderFulfillmentStatus, contactId?: string, organizationId?: string, channelId?: string, number?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
57
54
|
/**
|
|
58
55
|
*
|
|
59
56
|
* @param {number} params.limit - Page size (default 50, max 200).
|
|
@@ -213,7 +210,6 @@ export declare class Orders {
|
|
|
213
210
|
* @param {string} params.currency - ISO 4217 code (default EUR).
|
|
214
211
|
* @param {string} params.customerOrderNumber - The buyer's own order/PO number.
|
|
215
212
|
* @param {number} params.grandTotal - Override — computed as subtotal + shipping + tax when omitted.
|
|
216
|
-
* @param {string} params.marketId -
|
|
217
213
|
* @param {object} params.metadata - Free-form metadata.
|
|
218
214
|
* @param {string} params.organizationId - B2B organization.
|
|
219
215
|
* @param {object} params.payment - Frozen payment snapshot — a known 'payment.status' seeds payment_status (otherwise 'open').
|
|
@@ -234,7 +230,6 @@ export declare class Orders {
|
|
|
234
230
|
currency?: string;
|
|
235
231
|
customerOrderNumber?: string;
|
|
236
232
|
grandTotal?: number;
|
|
237
|
-
marketId?: string;
|
|
238
233
|
metadata?: object;
|
|
239
234
|
organizationId?: string;
|
|
240
235
|
payment?: object;
|
|
@@ -254,7 +249,6 @@ export declare class Orders {
|
|
|
254
249
|
* @param {string} currency - ISO 4217 code (default EUR).
|
|
255
250
|
* @param {string} customerOrderNumber - The buyer's own order/PO number.
|
|
256
251
|
* @param {number} grandTotal - Override — computed as subtotal + shipping + tax when omitted.
|
|
257
|
-
* @param {string} marketId -
|
|
258
252
|
* @param {object} metadata - Free-form metadata.
|
|
259
253
|
* @param {string} organizationId - B2B organization.
|
|
260
254
|
* @param {object} payment - Frozen payment snapshot — a known 'payment.status' seeds payment_status (otherwise 'open').
|
|
@@ -266,7 +260,7 @@ export declare class Orders {
|
|
|
266
260
|
* @returns {Promise<Models.OrderDetail>}
|
|
267
261
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
268
262
|
*/
|
|
269
|
-
ordersPlace(items: Models.OrderItemCreateRequest[], billingAddress?: object, buyer?: object, cartId?: string, channelId?: string, contactId?: string, currency?: string, customerOrderNumber?: string, grandTotal?: number,
|
|
263
|
+
ordersPlace(items: Models.OrderItemCreateRequest[], billingAddress?: object, buyer?: object, cartId?: string, channelId?: string, contactId?: string, currency?: string, customerOrderNumber?: string, grandTotal?: number, metadata?: object, organizationId?: string, payment?: object, shipping?: object, shippingAddress?: object, shippingTotal?: number, userData?: object): Promise<Models.OrderDetail>;
|
|
270
264
|
/**
|
|
271
265
|
*
|
|
272
266
|
* @param {string} params.id -
|
|
@@ -38,10 +38,10 @@ export declare class Prices {
|
|
|
38
38
|
* @param {string} params.description -
|
|
39
39
|
* @param {boolean} params.isDefault - Default lists resolve last within their group.
|
|
40
40
|
* @param {object} params.labels - Localised names ({de, en, …}).
|
|
41
|
-
* @param {string} params.marketId - Scope: only this market.
|
|
42
41
|
* @param {object} params.metadata - Free-form metadata.
|
|
43
42
|
* @param {string} params.organizationId - Scope: only this organization.
|
|
44
43
|
* @param {number} params.priority - Tie-breaker within a specificity group (higher wins, default 0).
|
|
44
|
+
* @param {boolean} params.requiresAuth - Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
45
45
|
* @param {PriceListStatus} params.status - Default 'active' — only active lists resolve.
|
|
46
46
|
* @param {boolean} params.taxIncluded - Gross (true) or net (false, default) prices.
|
|
47
47
|
* @param {string} params.validFrom - Validity window start.
|
|
@@ -58,10 +58,10 @@ export declare class Prices {
|
|
|
58
58
|
description?: string;
|
|
59
59
|
isDefault?: boolean;
|
|
60
60
|
labels?: object;
|
|
61
|
-
marketId?: string;
|
|
62
61
|
metadata?: object;
|
|
63
62
|
organizationId?: string;
|
|
64
63
|
priority?: number;
|
|
64
|
+
requiresAuth?: boolean;
|
|
65
65
|
status?: PriceListStatus;
|
|
66
66
|
taxIncluded?: boolean;
|
|
67
67
|
validFrom?: string;
|
|
@@ -77,10 +77,10 @@ export declare class Prices {
|
|
|
77
77
|
* @param {string} description -
|
|
78
78
|
* @param {boolean} isDefault - Default lists resolve last within their group.
|
|
79
79
|
* @param {object} labels - Localised names ({de, en, …}).
|
|
80
|
-
* @param {string} marketId - Scope: only this market.
|
|
81
80
|
* @param {object} metadata - Free-form metadata.
|
|
82
81
|
* @param {string} organizationId - Scope: only this organization.
|
|
83
82
|
* @param {number} priority - Tie-breaker within a specificity group (higher wins, default 0).
|
|
83
|
+
* @param {boolean} requiresAuth - Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
84
84
|
* @param {PriceListStatus} status - Default 'active' — only active lists resolve.
|
|
85
85
|
* @param {boolean} taxIncluded - Gross (true) or net (false, default) prices.
|
|
86
86
|
* @param {string} validFrom - Validity window start.
|
|
@@ -89,7 +89,7 @@ export declare class Prices {
|
|
|
89
89
|
* @returns {Promise<Models.PriceList>}
|
|
90
90
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
91
91
|
*/
|
|
92
|
-
pricesListsCreate(code: string, name: string, channelId?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object,
|
|
92
|
+
pricesListsCreate(code: string, name: string, channelId?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.PriceList>;
|
|
93
93
|
/**
|
|
94
94
|
*
|
|
95
95
|
* @throws {RevenexxException}
|
|
@@ -140,11 +140,11 @@ export declare class Prices {
|
|
|
140
140
|
* @param {string} params.description -
|
|
141
141
|
* @param {boolean} params.isDefault - Default lists resolve last within their group.
|
|
142
142
|
* @param {object} params.labels - Localised names ({de, en, …}).
|
|
143
|
-
* @param {string} params.marketId - Scope: only this market.
|
|
144
143
|
* @param {object} params.metadata - Free-form metadata.
|
|
145
144
|
* @param {string} params.name -
|
|
146
145
|
* @param {string} params.organizationId - Scope: only this organization.
|
|
147
146
|
* @param {number} params.priority - Tie-breaker within a specificity group (higher wins, default 0).
|
|
147
|
+
* @param {boolean} params.requiresAuth - Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
148
148
|
* @param {PriceListStatus} params.status - Default 'active' — only active lists resolve.
|
|
149
149
|
* @param {boolean} params.taxIncluded - Gross (true) or net (false, default) prices.
|
|
150
150
|
* @param {string} params.validFrom - Validity window start.
|
|
@@ -161,11 +161,11 @@ export declare class Prices {
|
|
|
161
161
|
description?: string;
|
|
162
162
|
isDefault?: boolean;
|
|
163
163
|
labels?: object;
|
|
164
|
-
marketId?: string;
|
|
165
164
|
metadata?: object;
|
|
166
165
|
name?: string;
|
|
167
166
|
organizationId?: string;
|
|
168
167
|
priority?: number;
|
|
168
|
+
requiresAuth?: boolean;
|
|
169
169
|
status?: PriceListStatus;
|
|
170
170
|
taxIncluded?: boolean;
|
|
171
171
|
validFrom?: string;
|
|
@@ -181,11 +181,11 @@ export declare class Prices {
|
|
|
181
181
|
* @param {string} description -
|
|
182
182
|
* @param {boolean} isDefault - Default lists resolve last within their group.
|
|
183
183
|
* @param {object} labels - Localised names ({de, en, …}).
|
|
184
|
-
* @param {string} marketId - Scope: only this market.
|
|
185
184
|
* @param {object} metadata - Free-form metadata.
|
|
186
185
|
* @param {string} name -
|
|
187
186
|
* @param {string} organizationId - Scope: only this organization.
|
|
188
187
|
* @param {number} priority - Tie-breaker within a specificity group (higher wins, default 0).
|
|
188
|
+
* @param {boolean} requiresAuth - Gate: when true the list resolves only for an authenticated buyer (contact or organization context); anonymous resolve calls get on_request. Default false (open to everyone).
|
|
189
189
|
* @param {PriceListStatus} status - Default 'active' — only active lists resolve.
|
|
190
190
|
* @param {boolean} taxIncluded - Gross (true) or net (false, default) prices.
|
|
191
191
|
* @param {string} validFrom - Validity window start.
|
|
@@ -194,7 +194,7 @@ export declare class Prices {
|
|
|
194
194
|
* @returns {Promise<Models.PriceList>}
|
|
195
195
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
196
196
|
*/
|
|
197
|
-
pricesListsUpdate(id: string, channelId?: string, code?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object,
|
|
197
|
+
pricesListsUpdate(id: string, channelId?: string, code?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, name?: string, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.PriceList>;
|
|
198
198
|
/**
|
|
199
199
|
*
|
|
200
200
|
* @param {string} params.listId -
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
export declare class Settings {
|
|
3
|
+
client: Client;
|
|
4
|
+
constructor(client: Client);
|
|
5
|
+
/**
|
|
6
|
+
* The tenant's effective settings for the app — the declared schema's defaults merged with stored tenant/market values. Sensitive settings are masked (listed in `masked`, omitted from `settings`).
|
|
7
|
+
*
|
|
8
|
+
* @param {string} params.app - App name, e.g. `pages`.
|
|
9
|
+
* @param {string} params.market - Resolve market-scoped settings for this market code; falls back to the tenant value.
|
|
10
|
+
* @throws {RevenexxException}
|
|
11
|
+
* @returns {Promise<{}>}
|
|
12
|
+
*/
|
|
13
|
+
settingsGetAppSettings(params: {
|
|
14
|
+
app: string;
|
|
15
|
+
market?: string;
|
|
16
|
+
}): Promise<{}>;
|
|
17
|
+
/**
|
|
18
|
+
* The tenant's effective settings for the app — the declared schema's defaults merged with stored tenant/market values. Sensitive settings are masked (listed in `masked`, omitted from `settings`).
|
|
19
|
+
*
|
|
20
|
+
* @param {string} app - App name, e.g. `pages`.
|
|
21
|
+
* @param {string} market - Resolve market-scoped settings for this market code; falls back to the tenant value.
|
|
22
|
+
* @throws {RevenexxException}
|
|
23
|
+
* @returns {Promise<{}>}
|
|
24
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
25
|
+
*/
|
|
26
|
+
settingsGetAppSettings(app: string, market?: string): Promise<{}>;
|
|
27
|
+
}
|