@revenexx/sdk 0.0.5 → 0.0.7
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 +7188 -5721
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +7185 -5720
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +7188 -5721
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/order-list-kind.ts +4 -0
- package/src/enums/store-asset-request-visibility.ts +4 -0
- package/src/enums/visibility.ts +4 -0
- package/src/index.ts +4 -2
- package/src/models.ts +1232 -294
- package/src/services/customers.ts +14 -6
- package/src/services/markets.ts +317 -0
- package/src/services/orderlists.ts +889 -0
- package/src/services/pages.ts +293 -7
- package/src/services/prices.ts +70 -9
- package/src/services/products.ts +86 -14
- package/src/services/shipping.ts +26 -19
- package/src/services/storage.ts +910 -576
- package/types/enums/order-list-kind.d.ts +4 -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 +4 -2
- package/types/models.d.ts +1199 -283
- package/types/services/customers.d.ts +4 -1
- package/types/services/markets.d.ts +112 -0
- package/types/services/orderlists.d.ts +324 -0
- package/types/services/pages.d.ts +96 -1
- package/types/services/prices.d.ts +24 -4
- package/types/services/products.d.ts +28 -2
- package/types/services/shipping.d.ts +8 -5
- package/types/services/storage.d.ts +353 -285
|
@@ -199,20 +199,23 @@ export declare class Customers {
|
|
|
199
199
|
/**
|
|
200
200
|
*
|
|
201
201
|
* @param {string} params.userId -
|
|
202
|
+
* @param {string} params.sessionId - Optional session to verify — answers 401 when the session is expired or revoked.
|
|
202
203
|
* @throws {RevenexxException}
|
|
203
204
|
* @returns {Promise<Models.AuthMeResponse>}
|
|
204
205
|
*/
|
|
205
206
|
customersAuthMe(params: {
|
|
206
207
|
userId: string;
|
|
208
|
+
sessionId?: string;
|
|
207
209
|
}): Promise<Models.AuthMeResponse>;
|
|
208
210
|
/**
|
|
209
211
|
*
|
|
210
212
|
* @param {string} userId -
|
|
213
|
+
* @param {string} sessionId - Optional session to verify — answers 401 when the session is expired or revoked.
|
|
211
214
|
* @throws {RevenexxException}
|
|
212
215
|
* @returns {Promise<Models.AuthMeResponse>}
|
|
213
216
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
214
217
|
*/
|
|
215
|
-
customersAuthMe(userId: string): Promise<Models.AuthMeResponse>;
|
|
218
|
+
customersAuthMe(userId: string, sessionId?: string): Promise<Models.AuthMeResponse>;
|
|
216
219
|
/**
|
|
217
220
|
*
|
|
218
221
|
* @param {string} params.email -
|
|
@@ -134,6 +134,118 @@ export declare class Markets {
|
|
|
134
134
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
135
135
|
*/
|
|
136
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>;
|
|
137
249
|
/**
|
|
138
250
|
*
|
|
139
251
|
* @param {string} params.marketId -
|
|
@@ -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.shared - 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
|
+
shared?: 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} shared - 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, shared?: 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.shared -
|
|
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
|
+
shared?: 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} shared -
|
|
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, shared?: 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
|
+
}
|
|
@@ -4,6 +4,12 @@ import { PageStatus } from '../enums/page-status';
|
|
|
4
4
|
export declare class Pages {
|
|
5
5
|
client: Client;
|
|
6
6
|
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @throws {RevenexxException}
|
|
10
|
+
* @returns {Promise<{}>}
|
|
11
|
+
*/
|
|
12
|
+
pagesDeliveryMenus(): Promise<{}>;
|
|
7
13
|
/**
|
|
8
14
|
*
|
|
9
15
|
* @throws {RevenexxException}
|
|
@@ -576,6 +582,92 @@ export declare class Pages {
|
|
|
576
582
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
577
583
|
*/
|
|
578
584
|
pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.LibraryItem>;
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @throws {RevenexxException}
|
|
588
|
+
* @returns {Promise<{}>}
|
|
589
|
+
*/
|
|
590
|
+
pagesMenusList(): Promise<{}>;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @param {string} params.label -
|
|
594
|
+
* @param {string} params.menuKey - Stable menu identifier, e.g. "main", "footer", "account".
|
|
595
|
+
* @param {object[]} params.items - Ordered menu entries ({ label, to?, items? }).
|
|
596
|
+
* @throws {RevenexxException}
|
|
597
|
+
* @returns {Promise<Models.Menu>}
|
|
598
|
+
*/
|
|
599
|
+
pagesMenusUpsert(params: {
|
|
600
|
+
label: string;
|
|
601
|
+
menuKey: string;
|
|
602
|
+
items?: object[];
|
|
603
|
+
}): Promise<Models.Menu>;
|
|
604
|
+
/**
|
|
605
|
+
*
|
|
606
|
+
* @param {string} label -
|
|
607
|
+
* @param {string} menuKey - Stable menu identifier, e.g. "main", "footer", "account".
|
|
608
|
+
* @param {object[]} items - Ordered menu entries ({ label, to?, items? }).
|
|
609
|
+
* @throws {RevenexxException}
|
|
610
|
+
* @returns {Promise<Models.Menu>}
|
|
611
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
612
|
+
*/
|
|
613
|
+
pagesMenusUpsert(label: string, menuKey: string, items?: object[]): Promise<Models.Menu>;
|
|
614
|
+
/**
|
|
615
|
+
*
|
|
616
|
+
* @param {string} params.id -
|
|
617
|
+
* @throws {RevenexxException}
|
|
618
|
+
* @returns {Promise<{}>}
|
|
619
|
+
*/
|
|
620
|
+
pagesMenusDelete(params: {
|
|
621
|
+
id: string;
|
|
622
|
+
}): Promise<{}>;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @param {string} id -
|
|
626
|
+
* @throws {RevenexxException}
|
|
627
|
+
* @returns {Promise<{}>}
|
|
628
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
629
|
+
*/
|
|
630
|
+
pagesMenusDelete(id: string): Promise<{}>;
|
|
631
|
+
/**
|
|
632
|
+
*
|
|
633
|
+
* @param {string} params.id -
|
|
634
|
+
* @throws {RevenexxException}
|
|
635
|
+
* @returns {Promise<Models.Menu>}
|
|
636
|
+
*/
|
|
637
|
+
pagesMenusGet(params: {
|
|
638
|
+
id: string;
|
|
639
|
+
}): Promise<Models.Menu>;
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @param {string} id -
|
|
643
|
+
* @throws {RevenexxException}
|
|
644
|
+
* @returns {Promise<Models.Menu>}
|
|
645
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
646
|
+
*/
|
|
647
|
+
pagesMenusGet(id: string): Promise<Models.Menu>;
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
* @param {string} params.id -
|
|
651
|
+
* @param {object[]} params.items -
|
|
652
|
+
* @param {string} params.label -
|
|
653
|
+
* @throws {RevenexxException}
|
|
654
|
+
* @returns {Promise<Models.Menu>}
|
|
655
|
+
*/
|
|
656
|
+
pagesMenusUpdate(params: {
|
|
657
|
+
id: string;
|
|
658
|
+
items?: object[];
|
|
659
|
+
label?: string;
|
|
660
|
+
}): Promise<Models.Menu>;
|
|
661
|
+
/**
|
|
662
|
+
*
|
|
663
|
+
* @param {string} id -
|
|
664
|
+
* @param {object[]} items -
|
|
665
|
+
* @param {string} label -
|
|
666
|
+
* @throws {RevenexxException}
|
|
667
|
+
* @returns {Promise<Models.Menu>}
|
|
668
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
669
|
+
*/
|
|
670
|
+
pagesMenusUpdate(id: string, items?: object[], label?: string): Promise<Models.Menu>;
|
|
579
671
|
/**
|
|
580
672
|
*
|
|
581
673
|
* @throws {RevenexxException}
|
|
@@ -699,21 +791,24 @@ export declare class Pages {
|
|
|
699
791
|
pagesPagesRevisions(id: string): Promise<{}>;
|
|
700
792
|
/**
|
|
701
793
|
*
|
|
794
|
+
* @param {object[]} params.menus -
|
|
702
795
|
* @param {object[]} params.pages -
|
|
703
796
|
* @throws {RevenexxException}
|
|
704
797
|
* @returns {Promise<{}>}
|
|
705
798
|
*/
|
|
706
799
|
pagesSeed(params?: {
|
|
800
|
+
menus?: object[];
|
|
707
801
|
pages?: object[];
|
|
708
802
|
}): Promise<{}>;
|
|
709
803
|
/**
|
|
710
804
|
*
|
|
805
|
+
* @param {object[]} menus -
|
|
711
806
|
* @param {object[]} pages -
|
|
712
807
|
* @throws {RevenexxException}
|
|
713
808
|
* @returns {Promise<{}>}
|
|
714
809
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
715
810
|
*/
|
|
716
|
-
pagesSeed(pages?: object[]): Promise<{}>;
|
|
811
|
+
pagesSeed(menus?: object[], pages?: object[]): Promise<{}>;
|
|
717
812
|
/**
|
|
718
813
|
*
|
|
719
814
|
* @throws {RevenexxException}
|
|
@@ -242,23 +242,43 @@ export declare class Prices {
|
|
|
242
242
|
/**
|
|
243
243
|
*
|
|
244
244
|
* @param {string} params.listId -
|
|
245
|
-
* @param {Models.
|
|
245
|
+
* @param {Models.PriceEntryReplaceItem[]} params.entries - The complete new entry set (set semantics).
|
|
246
246
|
* @throws {RevenexxException}
|
|
247
247
|
* @returns {Promise<{}>}
|
|
248
248
|
*/
|
|
249
249
|
pricesEntriesReplace(params: {
|
|
250
250
|
listId: string;
|
|
251
|
-
entries: Models.
|
|
251
|
+
entries: Models.PriceEntryReplaceItem[];
|
|
252
252
|
}): Promise<{}>;
|
|
253
253
|
/**
|
|
254
254
|
*
|
|
255
255
|
* @param {string} listId -
|
|
256
|
-
* @param {Models.
|
|
256
|
+
* @param {Models.PriceEntryReplaceItem[]} entries - The complete new entry set (set semantics).
|
|
257
257
|
* @throws {RevenexxException}
|
|
258
258
|
* @returns {Promise<{}>}
|
|
259
259
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
260
260
|
*/
|
|
261
|
-
pricesEntriesReplace(listId: string, entries: Models.
|
|
261
|
+
pricesEntriesReplace(listId: string, entries: Models.PriceEntryReplaceItem[]): Promise<{}>;
|
|
262
|
+
/**
|
|
263
|
+
*
|
|
264
|
+
* @param {string} params.listId -
|
|
265
|
+
* @param {Models.PriceEntryReplaceItem[]} params.entries - The complete new entry set (set semantics).
|
|
266
|
+
* @throws {RevenexxException}
|
|
267
|
+
* @returns {Promise<{}>}
|
|
268
|
+
*/
|
|
269
|
+
pricesEntriesBulk(params: {
|
|
270
|
+
listId: string;
|
|
271
|
+
entries: Models.PriceEntryReplaceItem[];
|
|
272
|
+
}): Promise<{}>;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @param {string} listId -
|
|
276
|
+
* @param {Models.PriceEntryReplaceItem[]} entries - The complete new entry set (set semantics).
|
|
277
|
+
* @throws {RevenexxException}
|
|
278
|
+
* @returns {Promise<{}>}
|
|
279
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
280
|
+
*/
|
|
281
|
+
pricesEntriesBulk(listId: string, entries: Models.PriceEntryReplaceItem[]): Promise<{}>;
|
|
262
282
|
/**
|
|
263
283
|
*
|
|
264
284
|
* @param {string} params.listId -
|