@revenexx/sdk 0.0.4 → 0.0.6
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 +13491 -6163
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +13464 -6162
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +13491 -6163
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/address-type.ts +4 -0
- package/src/enums/cart-export-format.ts +4 -0
- package/src/enums/cart-io-apply-mode.ts +5 -0
- package/src/enums/cart-io-direction.ts +4 -0
- package/src/enums/cart-io-entity.ts +4 -0
- package/src/enums/cart-io-format.ts +4 -0
- package/src/enums/cart-item-type.ts +5 -0
- package/src/enums/channel-status.ts +4 -0
- package/src/enums/channel-type.ts +7 -0
- package/src/enums/contact-role.ts +6 -0
- package/src/enums/contact-status.ts +5 -0
- package/src/enums/location-type.ts +6 -0
- package/src/enums/market-status.ts +4 -0
- package/src/enums/order-comment-visibility.ts +4 -0
- package/src/enums/order-item-type.ts +5 -0
- package/src/enums/order-list-kind.ts +4 -0
- package/src/enums/order-payment-status.ts +9 -0
- package/src/enums/organization-status.ts +4 -0
- package/src/enums/page-status.ts +5 -0
- package/src/enums/payment-fee-type.ts +5 -0
- package/src/enums/payment-method-kind.ts +4 -0
- package/src/enums/price-entry-type.ts +4 -0
- package/src/enums/price-list-status.ts +4 -0
- package/src/enums/shipping-method-matrix-basis.ts +6 -0
- package/src/enums/shipping-method-pricing-type.ts +5 -0
- package/src/enums/store-asset-request-visibility.ts +4 -0
- package/src/enums/visibility.ts +4 -0
- package/src/index.ts +28 -2
- package/src/models.ts +5309 -1009
- package/src/services/apps.ts +154 -154
- package/src/services/avatars.ts +57 -57
- package/src/services/carts.ts +739 -104
- package/src/services/channels.ts +147 -19
- package/src/services/customers.ts +809 -69
- package/src/services/greetings.ts +18 -18
- package/src/services/inventories.ts +620 -65
- package/src/services/locale.ts +16 -16
- package/src/services/markets.ts +690 -75
- package/src/services/messaging.ts +273 -273
- package/src/services/orderlists.ts +889 -0
- package/src/services/orders.ts +692 -137
- package/src/services/pages.ts +661 -155
- package/src/services/payments.ts +591 -64
- package/src/services/prices.ts +585 -59
- package/src/services/products.ts +1908 -272
- package/src/services/search.ts +24 -24
- package/src/services/shipping.ts +451 -59
- package/src/services/sites.ts +116 -116
- package/src/services/storage.ts +933 -599
- package/src/services/tokens.ts +14 -14
- package/types/enums/address-type.d.ts +4 -0
- package/types/enums/cart-export-format.d.ts +4 -0
- package/types/enums/cart-io-apply-mode.d.ts +5 -0
- package/types/enums/cart-io-direction.d.ts +4 -0
- package/types/enums/cart-io-entity.d.ts +4 -0
- package/types/enums/cart-io-format.d.ts +4 -0
- package/types/enums/cart-item-type.d.ts +5 -0
- package/types/enums/channel-status.d.ts +4 -0
- package/types/enums/channel-type.d.ts +7 -0
- package/types/enums/contact-role.d.ts +6 -0
- package/types/enums/contact-status.d.ts +5 -0
- package/types/enums/location-type.d.ts +6 -0
- package/types/enums/market-status.d.ts +4 -0
- package/types/enums/order-comment-visibility.d.ts +4 -0
- package/types/enums/order-item-type.d.ts +5 -0
- package/types/enums/order-list-kind.d.ts +4 -0
- package/types/enums/order-payment-status.d.ts +9 -0
- package/types/enums/organization-status.d.ts +4 -0
- package/types/enums/page-status.d.ts +5 -0
- package/types/enums/payment-fee-type.d.ts +5 -0
- package/types/enums/payment-method-kind.d.ts +4 -0
- package/types/enums/price-entry-type.d.ts +4 -0
- package/types/enums/price-list-status.d.ts +4 -0
- package/types/enums/shipping-method-matrix-basis.d.ts +6 -0
- package/types/enums/shipping-method-pricing-type.d.ts +5 -0
- package/types/enums/store-asset-request-visibility.d.ts +4 -0
- package/types/enums/visibility.d.ts +4 -0
- package/types/index.d.ts +28 -2
- package/types/models.d.ts +5170 -1010
- package/types/services/carts.d.ts +271 -12
- package/types/services/channels.d.ts +54 -2
- package/types/services/customers.d.ts +298 -12
- package/types/services/inventories.d.ts +225 -11
- package/types/services/markets.d.ts +235 -6
- package/types/services/orderlists.d.ts +324 -0
- package/types/services/orders.d.ts +238 -16
- package/types/services/pages.d.ts +190 -6
- package/types/services/payments.d.ts +221 -7
- package/types/services/prices.d.ts +218 -6
- package/types/services/products.d.ts +672 -32
- package/types/services/shipping.d.ts +168 -6
- package/types/services/storage.d.ts +353 -285
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { MarketStatus } from '../enums/market-status';
|
|
3
4
|
export declare class Markets {
|
|
4
5
|
client: Client;
|
|
5
6
|
constructor(client: Client);
|
|
@@ -11,10 +12,39 @@ export declare class Markets {
|
|
|
11
12
|
marketsList(): Promise<{}>;
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
15
|
+
* @param {string} params.code - Market code (unique per tenant).
|
|
16
|
+
* @param {string} params.name -
|
|
17
|
+
* @param {string} params.currency - ISO 4217 code (default 'EUR').
|
|
18
|
+
* @param {boolean} params.isDefault -
|
|
19
|
+
* @param {object} params.labels - Localized display names ({locale: label}).
|
|
20
|
+
* @param {number} params.position - Sort position (default 0).
|
|
21
|
+
* @param {MarketStatus} params.status - Default 'active'.
|
|
14
22
|
* @throws {RevenexxException}
|
|
15
23
|
* @returns {Promise<Models.Market>}
|
|
16
24
|
*/
|
|
17
|
-
marketsCreate(
|
|
25
|
+
marketsCreate(params: {
|
|
26
|
+
code: string;
|
|
27
|
+
name: string;
|
|
28
|
+
currency?: string;
|
|
29
|
+
isDefault?: boolean;
|
|
30
|
+
labels?: object;
|
|
31
|
+
position?: number;
|
|
32
|
+
status?: MarketStatus;
|
|
33
|
+
}): Promise<Models.Market>;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @param {string} code - Market code (unique per tenant).
|
|
37
|
+
* @param {string} name -
|
|
38
|
+
* @param {string} currency - ISO 4217 code (default 'EUR').
|
|
39
|
+
* @param {boolean} isDefault -
|
|
40
|
+
* @param {object} labels - Localized display names ({locale: label}).
|
|
41
|
+
* @param {number} position - Sort position (default 0).
|
|
42
|
+
* @param {MarketStatus} status - Default 'active'.
|
|
43
|
+
* @throws {RevenexxException}
|
|
44
|
+
* @returns {Promise<Models.Market>}
|
|
45
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
46
|
+
*/
|
|
47
|
+
marketsCreate(code: string, name: string, currency?: string, isDefault?: boolean, labels?: object, position?: number, status?: MarketStatus): Promise<Models.Market>;
|
|
18
48
|
/**
|
|
19
49
|
*
|
|
20
50
|
* @param {string} params.id -
|
|
@@ -52,20 +82,41 @@ export declare class Markets {
|
|
|
52
82
|
/**
|
|
53
83
|
*
|
|
54
84
|
* @param {string} params.id -
|
|
85
|
+
* @param {string} params.code - Market code (unique per tenant).
|
|
86
|
+
* @param {string} params.currency - ISO 4217 code (default 'EUR').
|
|
87
|
+
* @param {boolean} params.isDefault -
|
|
88
|
+
* @param {object} params.labels - Localized display names ({locale: label}).
|
|
89
|
+
* @param {string} params.name -
|
|
90
|
+
* @param {number} params.position - Sort position (default 0).
|
|
91
|
+
* @param {MarketStatus} params.status - Default 'active'.
|
|
55
92
|
* @throws {RevenexxException}
|
|
56
93
|
* @returns {Promise<Models.Market>}
|
|
57
94
|
*/
|
|
58
95
|
marketsUpdate(params: {
|
|
59
96
|
id: string;
|
|
97
|
+
code?: string;
|
|
98
|
+
currency?: string;
|
|
99
|
+
isDefault?: boolean;
|
|
100
|
+
labels?: object;
|
|
101
|
+
name?: string;
|
|
102
|
+
position?: number;
|
|
103
|
+
status?: MarketStatus;
|
|
60
104
|
}): Promise<Models.Market>;
|
|
61
105
|
/**
|
|
62
106
|
*
|
|
63
107
|
* @param {string} id -
|
|
108
|
+
* @param {string} code - Market code (unique per tenant).
|
|
109
|
+
* @param {string} currency - ISO 4217 code (default 'EUR').
|
|
110
|
+
* @param {boolean} isDefault -
|
|
111
|
+
* @param {object} labels - Localized display names ({locale: label}).
|
|
112
|
+
* @param {string} name -
|
|
113
|
+
* @param {number} position - Sort position (default 0).
|
|
114
|
+
* @param {MarketStatus} status - Default 'active'.
|
|
64
115
|
* @throws {RevenexxException}
|
|
65
116
|
* @returns {Promise<Models.Market>}
|
|
66
117
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
67
118
|
*/
|
|
68
|
-
marketsUpdate(id: string): Promise<Models.Market>;
|
|
119
|
+
marketsUpdate(id: string, code?: string, currency?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, status?: MarketStatus): Promise<Models.Market>;
|
|
69
120
|
/**
|
|
70
121
|
*
|
|
71
122
|
* @param {string} params.id -
|
|
@@ -83,6 +134,118 @@ export declare class Markets {
|
|
|
83
134
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
84
135
|
*/
|
|
85
136
|
marketsContext(id: string): Promise<Models.MarketContext>;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @param {string} params.marketId -
|
|
140
|
+
* @throws {RevenexxException}
|
|
141
|
+
* @returns {Promise<{}>}
|
|
142
|
+
*/
|
|
143
|
+
marketsCurrenciesList(params: {
|
|
144
|
+
marketId: string;
|
|
145
|
+
}): Promise<{}>;
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
* @param {string} marketId -
|
|
149
|
+
* @throws {RevenexxException}
|
|
150
|
+
* @returns {Promise<{}>}
|
|
151
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
152
|
+
*/
|
|
153
|
+
marketsCurrenciesList(marketId: string): Promise<{}>;
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @param {string} params.marketId -
|
|
157
|
+
* @param {string} params.code - ISO 4217 code, e.g. EUR (unique per market).
|
|
158
|
+
* @param {boolean} params.isDefault -
|
|
159
|
+
* @param {number} params.position - Sort position (default 0).
|
|
160
|
+
* @throws {RevenexxException}
|
|
161
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
162
|
+
*/
|
|
163
|
+
marketsCurrenciesCreate(params: {
|
|
164
|
+
marketId: string;
|
|
165
|
+
code: string;
|
|
166
|
+
isDefault?: boolean;
|
|
167
|
+
position?: number;
|
|
168
|
+
}): Promise<Models.MarketCurrency>;
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @param {string} marketId -
|
|
172
|
+
* @param {string} code - ISO 4217 code, e.g. EUR (unique per market).
|
|
173
|
+
* @param {boolean} isDefault -
|
|
174
|
+
* @param {number} position - Sort position (default 0).
|
|
175
|
+
* @throws {RevenexxException}
|
|
176
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
177
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
178
|
+
*/
|
|
179
|
+
marketsCurrenciesCreate(marketId: string, code: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
|
|
180
|
+
/**
|
|
181
|
+
*
|
|
182
|
+
* @param {string} params.marketId -
|
|
183
|
+
* @param {string} params.id -
|
|
184
|
+
* @throws {RevenexxException}
|
|
185
|
+
* @returns {Promise<{}>}
|
|
186
|
+
*/
|
|
187
|
+
marketsCurrenciesDelete(params: {
|
|
188
|
+
marketId: string;
|
|
189
|
+
id: string;
|
|
190
|
+
}): Promise<{}>;
|
|
191
|
+
/**
|
|
192
|
+
*
|
|
193
|
+
* @param {string} marketId -
|
|
194
|
+
* @param {string} id -
|
|
195
|
+
* @throws {RevenexxException}
|
|
196
|
+
* @returns {Promise<{}>}
|
|
197
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
198
|
+
*/
|
|
199
|
+
marketsCurrenciesDelete(marketId: string, id: string): Promise<{}>;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @param {string} params.marketId -
|
|
203
|
+
* @param {string} params.id -
|
|
204
|
+
* @throws {RevenexxException}
|
|
205
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
206
|
+
*/
|
|
207
|
+
marketsCurrenciesGet(params: {
|
|
208
|
+
marketId: string;
|
|
209
|
+
id: string;
|
|
210
|
+
}): Promise<Models.MarketCurrency>;
|
|
211
|
+
/**
|
|
212
|
+
*
|
|
213
|
+
* @param {string} marketId -
|
|
214
|
+
* @param {string} id -
|
|
215
|
+
* @throws {RevenexxException}
|
|
216
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
217
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
218
|
+
*/
|
|
219
|
+
marketsCurrenciesGet(marketId: string, id: string): Promise<Models.MarketCurrency>;
|
|
220
|
+
/**
|
|
221
|
+
*
|
|
222
|
+
* @param {string} params.marketId -
|
|
223
|
+
* @param {string} params.id -
|
|
224
|
+
* @param {string} params.code - ISO 4217 code, e.g. EUR (unique per market).
|
|
225
|
+
* @param {boolean} params.isDefault -
|
|
226
|
+
* @param {number} params.position - Sort position (default 0).
|
|
227
|
+
* @throws {RevenexxException}
|
|
228
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
229
|
+
*/
|
|
230
|
+
marketsCurrenciesUpdate(params: {
|
|
231
|
+
marketId: string;
|
|
232
|
+
id: string;
|
|
233
|
+
code?: string;
|
|
234
|
+
isDefault?: boolean;
|
|
235
|
+
position?: number;
|
|
236
|
+
}): Promise<Models.MarketCurrency>;
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @param {string} marketId -
|
|
240
|
+
* @param {string} id -
|
|
241
|
+
* @param {string} code - ISO 4217 code, e.g. EUR (unique per market).
|
|
242
|
+
* @param {boolean} isDefault -
|
|
243
|
+
* @param {number} position - Sort position (default 0).
|
|
244
|
+
* @throws {RevenexxException}
|
|
245
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
246
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
247
|
+
*/
|
|
248
|
+
marketsCurrenciesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
|
|
86
249
|
/**
|
|
87
250
|
*
|
|
88
251
|
* @param {string} params.marketId -
|
|
@@ -103,20 +266,35 @@ export declare class Markets {
|
|
|
103
266
|
/**
|
|
104
267
|
*
|
|
105
268
|
* @param {string} params.marketId -
|
|
269
|
+
* @param {string} params.code - Locale code, e.g. 'de-DE' (unique per market).
|
|
270
|
+
* @param {string} params.country - ISO 3166-1 alpha-2 country code.
|
|
271
|
+
* @param {string} params.language - ISO 639-1 language code.
|
|
272
|
+
* @param {boolean} params.isDefault -
|
|
273
|
+
* @param {number} params.position - Sort position (default 0).
|
|
106
274
|
* @throws {RevenexxException}
|
|
107
275
|
* @returns {Promise<Models.MarketLocale>}
|
|
108
276
|
*/
|
|
109
277
|
marketsLocalesCreate(params: {
|
|
110
278
|
marketId: string;
|
|
279
|
+
code: string;
|
|
280
|
+
country: string;
|
|
281
|
+
language: string;
|
|
282
|
+
isDefault?: boolean;
|
|
283
|
+
position?: number;
|
|
111
284
|
}): Promise<Models.MarketLocale>;
|
|
112
285
|
/**
|
|
113
286
|
*
|
|
114
287
|
* @param {string} marketId -
|
|
288
|
+
* @param {string} code - Locale code, e.g. 'de-DE' (unique per market).
|
|
289
|
+
* @param {string} country - ISO 3166-1 alpha-2 country code.
|
|
290
|
+
* @param {string} language - ISO 639-1 language code.
|
|
291
|
+
* @param {boolean} isDefault -
|
|
292
|
+
* @param {number} position - Sort position (default 0).
|
|
115
293
|
* @throws {RevenexxException}
|
|
116
294
|
* @returns {Promise<Models.MarketLocale>}
|
|
117
295
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
118
296
|
*/
|
|
119
|
-
marketsLocalesCreate(marketId: string): Promise<Models.MarketLocale>;
|
|
297
|
+
marketsLocalesCreate(marketId: string, code: string, country: string, language: string, isDefault?: boolean, position?: number): Promise<Models.MarketLocale>;
|
|
120
298
|
/**
|
|
121
299
|
*
|
|
122
300
|
* @param {string} params.marketId -
|
|
@@ -161,22 +339,37 @@ export declare class Markets {
|
|
|
161
339
|
*
|
|
162
340
|
* @param {string} params.marketId -
|
|
163
341
|
* @param {string} params.id -
|
|
342
|
+
* @param {string} params.code - Locale code, e.g. 'de-DE' (unique per market).
|
|
343
|
+
* @param {string} params.country - ISO 3166-1 alpha-2 country code.
|
|
344
|
+
* @param {boolean} params.isDefault -
|
|
345
|
+
* @param {string} params.language - ISO 639-1 language code.
|
|
346
|
+
* @param {number} params.position - Sort position (default 0).
|
|
164
347
|
* @throws {RevenexxException}
|
|
165
348
|
* @returns {Promise<Models.MarketLocale>}
|
|
166
349
|
*/
|
|
167
350
|
marketsLocalesUpdate(params: {
|
|
168
351
|
marketId: string;
|
|
169
352
|
id: string;
|
|
353
|
+
code?: string;
|
|
354
|
+
country?: string;
|
|
355
|
+
isDefault?: boolean;
|
|
356
|
+
language?: string;
|
|
357
|
+
position?: number;
|
|
170
358
|
}): Promise<Models.MarketLocale>;
|
|
171
359
|
/**
|
|
172
360
|
*
|
|
173
361
|
* @param {string} marketId -
|
|
174
362
|
* @param {string} id -
|
|
363
|
+
* @param {string} code - Locale code, e.g. 'de-DE' (unique per market).
|
|
364
|
+
* @param {string} country - ISO 3166-1 alpha-2 country code.
|
|
365
|
+
* @param {boolean} isDefault -
|
|
366
|
+
* @param {string} language - ISO 639-1 language code.
|
|
367
|
+
* @param {number} position - Sort position (default 0).
|
|
175
368
|
* @throws {RevenexxException}
|
|
176
369
|
* @returns {Promise<Models.MarketLocale>}
|
|
177
370
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
178
371
|
*/
|
|
179
|
-
marketsLocalesUpdate(marketId: string, id: string): Promise<Models.MarketLocale>;
|
|
372
|
+
marketsLocalesUpdate(marketId: string, id: string, code?: string, country?: string, isDefault?: boolean, language?: string, position?: number): Promise<Models.MarketLocale>;
|
|
180
373
|
/**
|
|
181
374
|
*
|
|
182
375
|
* @param {string} params.marketId -
|
|
@@ -197,20 +390,38 @@ export declare class Markets {
|
|
|
197
390
|
/**
|
|
198
391
|
*
|
|
199
392
|
* @param {string} params.marketId -
|
|
393
|
+
* @param {string} params.code - Tax class code (unique per market).
|
|
394
|
+
* @param {string} params.name -
|
|
395
|
+
* @param {boolean} params.isDefault -
|
|
396
|
+
* @param {object} params.labels - Localized display names ({locale: label}).
|
|
397
|
+
* @param {number} params.position - Sort position (default 0).
|
|
398
|
+
* @param {number} params.rate - Tax rate in percent, 0–100 (default 0).
|
|
200
399
|
* @throws {RevenexxException}
|
|
201
400
|
* @returns {Promise<Models.MarketTaxClass>}
|
|
202
401
|
*/
|
|
203
402
|
marketsTaxClassesCreate(params: {
|
|
204
403
|
marketId: string;
|
|
404
|
+
code: string;
|
|
405
|
+
name: string;
|
|
406
|
+
isDefault?: boolean;
|
|
407
|
+
labels?: object;
|
|
408
|
+
position?: number;
|
|
409
|
+
rate?: number;
|
|
205
410
|
}): Promise<Models.MarketTaxClass>;
|
|
206
411
|
/**
|
|
207
412
|
*
|
|
208
413
|
* @param {string} marketId -
|
|
414
|
+
* @param {string} code - Tax class code (unique per market).
|
|
415
|
+
* @param {string} name -
|
|
416
|
+
* @param {boolean} isDefault -
|
|
417
|
+
* @param {object} labels - Localized display names ({locale: label}).
|
|
418
|
+
* @param {number} position - Sort position (default 0).
|
|
419
|
+
* @param {number} rate - Tax rate in percent, 0–100 (default 0).
|
|
209
420
|
* @throws {RevenexxException}
|
|
210
421
|
* @returns {Promise<Models.MarketTaxClass>}
|
|
211
422
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
212
423
|
*/
|
|
213
|
-
marketsTaxClassesCreate(marketId: string): Promise<Models.MarketTaxClass>;
|
|
424
|
+
marketsTaxClassesCreate(marketId: string, code: string, name: string, isDefault?: boolean, labels?: object, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
|
|
214
425
|
/**
|
|
215
426
|
*
|
|
216
427
|
* @param {string} params.marketId -
|
|
@@ -255,20 +466,38 @@ export declare class Markets {
|
|
|
255
466
|
*
|
|
256
467
|
* @param {string} params.marketId -
|
|
257
468
|
* @param {string} params.id -
|
|
469
|
+
* @param {string} params.code - Tax class code (unique per market).
|
|
470
|
+
* @param {boolean} params.isDefault -
|
|
471
|
+
* @param {object} params.labels - Localized display names ({locale: label}).
|
|
472
|
+
* @param {string} params.name -
|
|
473
|
+
* @param {number} params.position - Sort position (default 0).
|
|
474
|
+
* @param {number} params.rate - Tax rate in percent, 0–100 (default 0).
|
|
258
475
|
* @throws {RevenexxException}
|
|
259
476
|
* @returns {Promise<Models.MarketTaxClass>}
|
|
260
477
|
*/
|
|
261
478
|
marketsTaxClassesUpdate(params: {
|
|
262
479
|
marketId: string;
|
|
263
480
|
id: string;
|
|
481
|
+
code?: string;
|
|
482
|
+
isDefault?: boolean;
|
|
483
|
+
labels?: object;
|
|
484
|
+
name?: string;
|
|
485
|
+
position?: number;
|
|
486
|
+
rate?: number;
|
|
264
487
|
}): Promise<Models.MarketTaxClass>;
|
|
265
488
|
/**
|
|
266
489
|
*
|
|
267
490
|
* @param {string} marketId -
|
|
268
491
|
* @param {string} id -
|
|
492
|
+
* @param {string} code - Tax class code (unique per market).
|
|
493
|
+
* @param {boolean} isDefault -
|
|
494
|
+
* @param {object} labels - Localized display names ({locale: label}).
|
|
495
|
+
* @param {string} name -
|
|
496
|
+
* @param {number} position - Sort position (default 0).
|
|
497
|
+
* @param {number} rate - Tax rate in percent, 0–100 (default 0).
|
|
269
498
|
* @throws {RevenexxException}
|
|
270
499
|
* @returns {Promise<Models.MarketTaxClass>}
|
|
271
500
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
272
501
|
*/
|
|
273
|
-
marketsTaxClassesUpdate(marketId: string, id: string): Promise<Models.MarketTaxClass>;
|
|
502
|
+
marketsTaxClassesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
|
|
274
503
|
}
|
|
@@ -0,0 +1,324 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
import { OrderListKind } from '../enums/order-list-kind';
|
|
4
|
+
export declare class Orderlists {
|
|
5
|
+
client: Client;
|
|
6
|
+
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @throws {RevenexxException}
|
|
10
|
+
* @returns {Promise<{}>}
|
|
11
|
+
*/
|
|
12
|
+
orderlistsList(): Promise<{}>;
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @param {string} params.name -
|
|
16
|
+
* @param {string} params.ownerId - Owning contact.
|
|
17
|
+
* @param {string} params.ownerName - Owner display name (snapshot).
|
|
18
|
+
* @param {Models.OrderListItemInput[]} params.items - Optional initial positions.
|
|
19
|
+
* @param {OrderListKind} params.kind - List kind (default 'shopping').
|
|
20
|
+
* @param {object} params.metadata -
|
|
21
|
+
* @param {string} params.organizationId - Owning organization (scopes public sharing).
|
|
22
|
+
* @param {boolean} params.xpublic - Shared read-only across the organization (default false).
|
|
23
|
+
* @throws {RevenexxException}
|
|
24
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
25
|
+
*/
|
|
26
|
+
orderlistsCreate(params: {
|
|
27
|
+
name: string;
|
|
28
|
+
ownerId: string;
|
|
29
|
+
ownerName: string;
|
|
30
|
+
items?: Models.OrderListItemInput[];
|
|
31
|
+
kind?: OrderListKind;
|
|
32
|
+
metadata?: object;
|
|
33
|
+
organizationId?: string;
|
|
34
|
+
xpublic?: boolean;
|
|
35
|
+
}): Promise<Models.OrderListWithItems>;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @param {string} name -
|
|
39
|
+
* @param {string} ownerId - Owning contact.
|
|
40
|
+
* @param {string} ownerName - Owner display name (snapshot).
|
|
41
|
+
* @param {Models.OrderListItemInput[]} items - Optional initial positions.
|
|
42
|
+
* @param {OrderListKind} kind - List kind (default 'shopping').
|
|
43
|
+
* @param {object} metadata -
|
|
44
|
+
* @param {string} organizationId - Owning organization (scopes public sharing).
|
|
45
|
+
* @param {boolean} xpublic - Shared read-only across the organization (default false).
|
|
46
|
+
* @throws {RevenexxException}
|
|
47
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
48
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
49
|
+
*/
|
|
50
|
+
orderlistsCreate(name: string, ownerId: string, ownerName: string, items?: Models.OrderListItemInput[], kind?: OrderListKind, metadata?: object, organizationId?: string, xpublic?: boolean): Promise<Models.OrderListWithItems>;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @throws {RevenexxException}
|
|
54
|
+
* @returns {Promise<{}>}
|
|
55
|
+
*/
|
|
56
|
+
orderlistsDefaults(): Promise<{}>;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @param {string} params.id -
|
|
60
|
+
* @throws {RevenexxException}
|
|
61
|
+
* @returns {Promise<{}>}
|
|
62
|
+
*/
|
|
63
|
+
orderlistsDelete(params: {
|
|
64
|
+
id: string;
|
|
65
|
+
}): Promise<{}>;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @param {string} id -
|
|
69
|
+
* @throws {RevenexxException}
|
|
70
|
+
* @returns {Promise<{}>}
|
|
71
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
72
|
+
*/
|
|
73
|
+
orderlistsDelete(id: string): Promise<{}>;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @param {string} params.id -
|
|
77
|
+
* @throws {RevenexxException}
|
|
78
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
79
|
+
*/
|
|
80
|
+
orderlistsGet(params: {
|
|
81
|
+
id: string;
|
|
82
|
+
}): Promise<Models.OrderListWithItems>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @param {string} id -
|
|
86
|
+
* @throws {RevenexxException}
|
|
87
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
88
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
89
|
+
*/
|
|
90
|
+
orderlistsGet(id: string): Promise<Models.OrderListWithItems>;
|
|
91
|
+
/**
|
|
92
|
+
*
|
|
93
|
+
* @param {string} params.id -
|
|
94
|
+
* @param {OrderListKind} params.kind - List kind (default 'shopping').
|
|
95
|
+
* @param {object} params.metadata -
|
|
96
|
+
* @param {string} params.name -
|
|
97
|
+
* @param {boolean} params.xpublic -
|
|
98
|
+
* @throws {RevenexxException}
|
|
99
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
100
|
+
*/
|
|
101
|
+
orderlistsUpdate(params: {
|
|
102
|
+
id: string;
|
|
103
|
+
kind?: OrderListKind;
|
|
104
|
+
metadata?: object;
|
|
105
|
+
name?: string;
|
|
106
|
+
xpublic?: boolean;
|
|
107
|
+
}): Promise<Models.OrderListWithItems>;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @param {string} id -
|
|
111
|
+
* @param {OrderListKind} kind - List kind (default 'shopping').
|
|
112
|
+
* @param {object} metadata -
|
|
113
|
+
* @param {string} name -
|
|
114
|
+
* @param {boolean} xpublic -
|
|
115
|
+
* @throws {RevenexxException}
|
|
116
|
+
* @returns {Promise<Models.OrderListWithItems>}
|
|
117
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
118
|
+
*/
|
|
119
|
+
orderlistsUpdate(id: string, kind?: OrderListKind, metadata?: object, name?: string, xpublic?: boolean): Promise<Models.OrderListWithItems>;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @param {string} params.listId -
|
|
123
|
+
* @throws {RevenexxException}
|
|
124
|
+
* @returns {Promise<{}>}
|
|
125
|
+
*/
|
|
126
|
+
orderlistsItemsList(params: {
|
|
127
|
+
listId: string;
|
|
128
|
+
}): Promise<{}>;
|
|
129
|
+
/**
|
|
130
|
+
*
|
|
131
|
+
* @param {string} listId -
|
|
132
|
+
* @throws {RevenexxException}
|
|
133
|
+
* @returns {Promise<{}>}
|
|
134
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
135
|
+
*/
|
|
136
|
+
orderlistsItemsList(listId: string): Promise<{}>;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @param {string} params.listId -
|
|
140
|
+
* @param {string} params.name - Display name (snapshot).
|
|
141
|
+
* @param {string} params.categorySlug -
|
|
142
|
+
* @param {string} params.costCenterId - Cost center reference (free-text).
|
|
143
|
+
* @param {string} params.customSku - Customer's own article number.
|
|
144
|
+
* @param {string} params.image -
|
|
145
|
+
* @param {object} params.metadata -
|
|
146
|
+
* @param {number} params.position - Sort order (assigned automatically when omitted).
|
|
147
|
+
* @param {string[]} params.positionTexts - Per-position notes.
|
|
148
|
+
* @param {number} params.price - Unit price snapshot.
|
|
149
|
+
* @param {string} params.productId - Catalog product (alternative to sku).
|
|
150
|
+
* @param {number} params.quantity - Default 1.
|
|
151
|
+
* @param {string} params.sku - Article SKU (alternative to product_id).
|
|
152
|
+
* @param {string} params.subcategorySlug -
|
|
153
|
+
* @param {number} params.taxRate -
|
|
154
|
+
* @param {string} params.unit -
|
|
155
|
+
* @throws {RevenexxException}
|
|
156
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
157
|
+
*/
|
|
158
|
+
orderlistsItemsCreate(params: {
|
|
159
|
+
listId: string;
|
|
160
|
+
name: string;
|
|
161
|
+
categorySlug?: string;
|
|
162
|
+
costCenterId?: string;
|
|
163
|
+
customSku?: string;
|
|
164
|
+
image?: string;
|
|
165
|
+
metadata?: object;
|
|
166
|
+
position?: number;
|
|
167
|
+
positionTexts?: string[];
|
|
168
|
+
price?: number;
|
|
169
|
+
productId?: string;
|
|
170
|
+
quantity?: number;
|
|
171
|
+
sku?: string;
|
|
172
|
+
subcategorySlug?: string;
|
|
173
|
+
taxRate?: number;
|
|
174
|
+
unit?: string;
|
|
175
|
+
}): Promise<Models.OrderListItem>;
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @param {string} listId -
|
|
179
|
+
* @param {string} name - Display name (snapshot).
|
|
180
|
+
* @param {string} categorySlug -
|
|
181
|
+
* @param {string} costCenterId - Cost center reference (free-text).
|
|
182
|
+
* @param {string} customSku - Customer's own article number.
|
|
183
|
+
* @param {string} image -
|
|
184
|
+
* @param {object} metadata -
|
|
185
|
+
* @param {number} position - Sort order (assigned automatically when omitted).
|
|
186
|
+
* @param {string[]} positionTexts - Per-position notes.
|
|
187
|
+
* @param {number} price - Unit price snapshot.
|
|
188
|
+
* @param {string} productId - Catalog product (alternative to sku).
|
|
189
|
+
* @param {number} quantity - Default 1.
|
|
190
|
+
* @param {string} sku - Article SKU (alternative to product_id).
|
|
191
|
+
* @param {string} subcategorySlug -
|
|
192
|
+
* @param {number} taxRate -
|
|
193
|
+
* @param {string} unit -
|
|
194
|
+
* @throws {RevenexxException}
|
|
195
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
196
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
197
|
+
*/
|
|
198
|
+
orderlistsItemsCreate(listId: string, name: string, categorySlug?: string, costCenterId?: string, customSku?: string, image?: string, metadata?: object, position?: number, positionTexts?: string[], price?: number, productId?: string, quantity?: number, sku?: string, subcategorySlug?: string, taxRate?: number, unit?: string): Promise<Models.OrderListItem>;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @param {string} params.listId -
|
|
202
|
+
* @param {Models.OrderListItemInput[]} params.items - The new full set of positions.
|
|
203
|
+
* @throws {RevenexxException}
|
|
204
|
+
* @returns {Promise<{}>}
|
|
205
|
+
*/
|
|
206
|
+
orderlistsItemsReplace(params: {
|
|
207
|
+
listId: string;
|
|
208
|
+
items: Models.OrderListItemInput[];
|
|
209
|
+
}): Promise<{}>;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @param {string} listId -
|
|
213
|
+
* @param {Models.OrderListItemInput[]} items - The new full set of positions.
|
|
214
|
+
* @throws {RevenexxException}
|
|
215
|
+
* @returns {Promise<{}>}
|
|
216
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
217
|
+
*/
|
|
218
|
+
orderlistsItemsReplace(listId: string, items: Models.OrderListItemInput[]): Promise<{}>;
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @param {string} params.listId -
|
|
222
|
+
* @param {string} params.id -
|
|
223
|
+
* @throws {RevenexxException}
|
|
224
|
+
* @returns {Promise<{}>}
|
|
225
|
+
*/
|
|
226
|
+
orderlistsItemsDelete(params: {
|
|
227
|
+
listId: string;
|
|
228
|
+
id: string;
|
|
229
|
+
}): Promise<{}>;
|
|
230
|
+
/**
|
|
231
|
+
*
|
|
232
|
+
* @param {string} listId -
|
|
233
|
+
* @param {string} id -
|
|
234
|
+
* @throws {RevenexxException}
|
|
235
|
+
* @returns {Promise<{}>}
|
|
236
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
237
|
+
*/
|
|
238
|
+
orderlistsItemsDelete(listId: string, id: string): Promise<{}>;
|
|
239
|
+
/**
|
|
240
|
+
*
|
|
241
|
+
* @param {string} params.listId -
|
|
242
|
+
* @param {string} params.id -
|
|
243
|
+
* @throws {RevenexxException}
|
|
244
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
245
|
+
*/
|
|
246
|
+
orderlistsItemsGet(params: {
|
|
247
|
+
listId: string;
|
|
248
|
+
id: string;
|
|
249
|
+
}): Promise<Models.OrderListItem>;
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @param {string} listId -
|
|
253
|
+
* @param {string} id -
|
|
254
|
+
* @throws {RevenexxException}
|
|
255
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
256
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
257
|
+
*/
|
|
258
|
+
orderlistsItemsGet(listId: string, id: string): Promise<Models.OrderListItem>;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
* @param {string} params.listId -
|
|
262
|
+
* @param {string} params.id -
|
|
263
|
+
* @param {string} params.categorySlug -
|
|
264
|
+
* @param {string} params.costCenterId - Cost center reference (free-text).
|
|
265
|
+
* @param {string} params.customSku - Customer's own article number.
|
|
266
|
+
* @param {string} params.image -
|
|
267
|
+
* @param {object} params.metadata -
|
|
268
|
+
* @param {string} params.name - Display name (snapshot).
|
|
269
|
+
* @param {number} params.position - Sort order (assigned automatically when omitted).
|
|
270
|
+
* @param {string[]} params.positionTexts - Per-position notes.
|
|
271
|
+
* @param {number} params.price - Unit price snapshot.
|
|
272
|
+
* @param {string} params.productId - Catalog product (alternative to sku).
|
|
273
|
+
* @param {number} params.quantity - Default 1.
|
|
274
|
+
* @param {string} params.sku - Article SKU (alternative to product_id).
|
|
275
|
+
* @param {string} params.subcategorySlug -
|
|
276
|
+
* @param {number} params.taxRate -
|
|
277
|
+
* @param {string} params.unit -
|
|
278
|
+
* @throws {RevenexxException}
|
|
279
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
280
|
+
*/
|
|
281
|
+
orderlistsItemsUpdate(params: {
|
|
282
|
+
listId: string;
|
|
283
|
+
id: string;
|
|
284
|
+
categorySlug?: string;
|
|
285
|
+
costCenterId?: string;
|
|
286
|
+
customSku?: string;
|
|
287
|
+
image?: string;
|
|
288
|
+
metadata?: object;
|
|
289
|
+
name?: string;
|
|
290
|
+
position?: number;
|
|
291
|
+
positionTexts?: string[];
|
|
292
|
+
price?: number;
|
|
293
|
+
productId?: string;
|
|
294
|
+
quantity?: number;
|
|
295
|
+
sku?: string;
|
|
296
|
+
subcategorySlug?: string;
|
|
297
|
+
taxRate?: number;
|
|
298
|
+
unit?: string;
|
|
299
|
+
}): Promise<Models.OrderListItem>;
|
|
300
|
+
/**
|
|
301
|
+
*
|
|
302
|
+
* @param {string} listId -
|
|
303
|
+
* @param {string} id -
|
|
304
|
+
* @param {string} categorySlug -
|
|
305
|
+
* @param {string} costCenterId - Cost center reference (free-text).
|
|
306
|
+
* @param {string} customSku - Customer's own article number.
|
|
307
|
+
* @param {string} image -
|
|
308
|
+
* @param {object} metadata -
|
|
309
|
+
* @param {string} name - Display name (snapshot).
|
|
310
|
+
* @param {number} position - Sort order (assigned automatically when omitted).
|
|
311
|
+
* @param {string[]} positionTexts - Per-position notes.
|
|
312
|
+
* @param {number} price - Unit price snapshot.
|
|
313
|
+
* @param {string} productId - Catalog product (alternative to sku).
|
|
314
|
+
* @param {number} quantity - Default 1.
|
|
315
|
+
* @param {string} sku - Article SKU (alternative to product_id).
|
|
316
|
+
* @param {string} subcategorySlug -
|
|
317
|
+
* @param {number} taxRate -
|
|
318
|
+
* @param {string} unit -
|
|
319
|
+
* @throws {RevenexxException}
|
|
320
|
+
* @returns {Promise<Models.OrderListItem>}
|
|
321
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
322
|
+
*/
|
|
323
|
+
orderlistsItemsUpdate(listId: string, id: string, categorySlug?: string, costCenterId?: string, customSku?: string, image?: string, metadata?: object, name?: string, position?: number, positionTexts?: string[], price?: number, productId?: string, quantity?: number, sku?: string, subcategorySlug?: string, taxRate?: number, unit?: string): Promise<Models.OrderListItem>;
|
|
324
|
+
}
|