@constructor-io/constructorio-node 4.6.0 → 4.6.1
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/package.json +2 -2
- package/src/types/catalog.d.ts +275 -231
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@constructor-io/constructorio-node",
|
|
3
|
-
"version": "4.6.
|
|
3
|
+
"version": "4.6.1",
|
|
4
4
|
"description": "Constructor.io Node.js client",
|
|
5
5
|
"main": "src/constructorio.js",
|
|
6
6
|
"types": "src/types/constructorio.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
|
|
9
9
|
"version": "npm run verify-node-version && npm run docs && git add ./docs/*",
|
|
10
|
-
"check-
|
|
10
|
+
"check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause'",
|
|
11
11
|
"lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
|
|
12
12
|
"test:parallel": "mkdir -p test && cp -rf src/* test && mocha --parallel ./spec/*",
|
|
13
13
|
"test": "mkdir -p test && cp -rf src/* test && mocha ./spec/*",
|
package/src/types/catalog.d.ts
CHANGED
|
@@ -14,90 +14,278 @@ import {
|
|
|
14
14
|
|
|
15
15
|
export default Catalog;
|
|
16
16
|
|
|
17
|
+
export interface CreateOrReplaceItemsParameters {
|
|
18
|
+
items: Item[];
|
|
19
|
+
force?: boolean;
|
|
20
|
+
notificationEmail?: string;
|
|
21
|
+
section?: string;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface UpdateItemsParameters extends CreateOrReplaceItemsParameters {}
|
|
25
|
+
|
|
26
|
+
export interface DeleteItemsParameters {
|
|
27
|
+
items: Pick<Item, 'id'>[];
|
|
28
|
+
section?: string;
|
|
29
|
+
notificationEmail?: string;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export interface RetrieveItemsParameters {
|
|
33
|
+
ids?: string[];
|
|
34
|
+
section?: string;
|
|
35
|
+
numResultsPerPage?: number;
|
|
36
|
+
page?: number;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface CreateOrReplaceVariationsParameters {
|
|
40
|
+
variations: Variation[];
|
|
41
|
+
force?: boolean;
|
|
42
|
+
notificationEmail?: string;
|
|
43
|
+
section?: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface UpdateVariationsParameters
|
|
47
|
+
extends CreateOrReplaceVariationsParameters {}
|
|
48
|
+
|
|
49
|
+
export interface DeleteVariationsParameters {
|
|
50
|
+
variations: Pick<Variation, 'id'>[];
|
|
51
|
+
force?: boolean;
|
|
52
|
+
notificationEmail?: string;
|
|
53
|
+
section?: string;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface RetrieveVariationsParameters {
|
|
57
|
+
section?: string;
|
|
58
|
+
ids?: string[];
|
|
59
|
+
itemId?: string;
|
|
60
|
+
numResultsPerPage?: number;
|
|
61
|
+
page?: number;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface AddItemGroupParameters {
|
|
65
|
+
id: string;
|
|
66
|
+
name: string;
|
|
67
|
+
parent_id?: string;
|
|
68
|
+
data?: Record<string, any>;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface AddItemGroupsParameters {
|
|
72
|
+
item_groups: ItemGroup[];
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export interface GetItemGroupParameters {
|
|
76
|
+
id: string;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface AddOrUpdateItemGroupsParameters
|
|
80
|
+
extends AddItemGroupsParameters {}
|
|
81
|
+
|
|
82
|
+
export interface AddOneWaySynonymParameters {
|
|
83
|
+
phrase: string;
|
|
84
|
+
child_phrases: string[];
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface ModifyOneWaySynonymParameters
|
|
88
|
+
extends AddOneWaySynonymParameters {}
|
|
89
|
+
|
|
90
|
+
export interface GetOneWaySynonymParameters {
|
|
91
|
+
phrase: string;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export interface GetOneWaySynonymsParameters {
|
|
95
|
+
num_results_per_page?: number;
|
|
96
|
+
page?: number;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export interface RemoveOneWaySynonymParameters {
|
|
100
|
+
phrase: string;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export interface AddSynonymGroupParameters {
|
|
104
|
+
synonyms: string[];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export interface ModifySynonymGroupParameters {
|
|
108
|
+
id: number;
|
|
109
|
+
synonyms: string[];
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export interface GetSynonymGroupParameters {
|
|
113
|
+
id: number;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export interface GetSynonymGroupsParameters {
|
|
117
|
+
phrase?: string;
|
|
118
|
+
num_results_per_page?: number;
|
|
119
|
+
page?: number;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
export interface RemoveSynonymGroupParameters {
|
|
123
|
+
id: number;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export interface AddRedirectRuleParameters {
|
|
127
|
+
url: string;
|
|
128
|
+
matches: RedirectRuleMatchObject[];
|
|
129
|
+
start_time?: string;
|
|
130
|
+
end_time?: string;
|
|
131
|
+
user_segments?: string[];
|
|
132
|
+
metadata?: Record<string, any>;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export interface UpdateRedirectRuleParameters
|
|
136
|
+
extends AddRedirectRuleParameters {
|
|
137
|
+
id: string;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
export interface ModifyRedirectRuleParameters
|
|
141
|
+
extends AddRedirectRuleParameters {
|
|
142
|
+
id: string;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
export interface GetRedirectRuleParameters {
|
|
146
|
+
id: string;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
export interface GetRedirectRulesParameters {
|
|
150
|
+
num_results_per_page?: number;
|
|
151
|
+
page?: number;
|
|
152
|
+
query?: string;
|
|
153
|
+
status?: string;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export interface RemoveRedirectRuleParameters {
|
|
157
|
+
id: string;
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
export interface ReplaceCatalogParameters {
|
|
161
|
+
section: string;
|
|
162
|
+
notification_email?: string;
|
|
163
|
+
force?: boolean;
|
|
164
|
+
items?: File;
|
|
165
|
+
variations?: File;
|
|
166
|
+
item_groups?: File;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
export interface UpdateCatalogParameters extends ReplaceCatalogParameters {}
|
|
170
|
+
|
|
171
|
+
export interface PatchCatalogParameters {
|
|
172
|
+
section: string;
|
|
173
|
+
notification_email?: string;
|
|
174
|
+
force?: boolean;
|
|
175
|
+
onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
|
|
176
|
+
items?: File;
|
|
177
|
+
variations?: File;
|
|
178
|
+
item_groups?: File;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
export interface ReplaceCatalogUsingTarArchiveParameters {
|
|
182
|
+
section: string;
|
|
183
|
+
notification_email?: string;
|
|
184
|
+
force?: boolean;
|
|
185
|
+
tarArchive?: File;
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
export interface UpdateCatalogUsingTarArchiveParameters
|
|
189
|
+
extends ReplaceCatalogUsingTarArchiveParameters {}
|
|
190
|
+
|
|
191
|
+
export interface PatchCatalogUsingTarArchiveParameters
|
|
192
|
+
extends ReplaceCatalogUsingTarArchiveParameters {}
|
|
193
|
+
|
|
194
|
+
export interface GetFacetConfigurationsParameters {
|
|
195
|
+
page?: number;
|
|
196
|
+
num_results_per_page?: number;
|
|
197
|
+
section?: string;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
export interface GetFacetConfigurationParameters {
|
|
201
|
+
name?: string;
|
|
202
|
+
section?: string;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
export interface ModifyFacetConfigurationsParameters {
|
|
206
|
+
facetConfigurations: FacetConfiguration[];
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
export interface RemoveFacetConfigurationParameters {
|
|
210
|
+
name: string;
|
|
211
|
+
section?: string;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
export type AddFacetOptionConfigurationParameters = FacetOptionConfiguration & {
|
|
215
|
+
facetGroupName: string;
|
|
216
|
+
section?: string;
|
|
217
|
+
};
|
|
218
|
+
|
|
219
|
+
export interface AddOrModifyFacetOptionConfigurationsParameters {
|
|
220
|
+
facetGroupName: string;
|
|
221
|
+
facetOptionConfigurations: FacetOptionConfiguration[];
|
|
222
|
+
section?: string;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
export interface GetFacetOptionConfigurationsParameters {
|
|
226
|
+
facetGroupName: string;
|
|
227
|
+
page?: number;
|
|
228
|
+
num_results_per_page?: number;
|
|
229
|
+
section?: string;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
export interface GetFacetOptionConfigurationParameters {
|
|
233
|
+
facetGroupName: string;
|
|
234
|
+
value: string;
|
|
235
|
+
section?: string;
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
export type ReplaceFacetOptionConfigurationParameters = {
|
|
239
|
+
facetGroupName: string;
|
|
240
|
+
section?: string;
|
|
241
|
+
} & FacetOptionConfiguration;
|
|
242
|
+
|
|
243
|
+
export type ModifyFacetOptionConfigurationParameters = ReplaceFacetOptionConfigurationParameters
|
|
244
|
+
|
|
245
|
+
export interface RemoveFacetOptionConfiguration extends GetFacetOptionConfigurationParameters {}
|
|
246
|
+
|
|
17
247
|
declare class Catalog {
|
|
18
248
|
constructor(options: ConstructorClientOptions);
|
|
19
249
|
|
|
20
250
|
options: ConstructorClientOptions;
|
|
21
251
|
|
|
22
252
|
createOrReplaceItems(
|
|
23
|
-
parameters:
|
|
24
|
-
items: Item[];
|
|
25
|
-
force?: boolean;
|
|
26
|
-
notificationEmail?: string;
|
|
27
|
-
section?: string;
|
|
28
|
-
},
|
|
253
|
+
parameters: CreateOrReplaceItemsParameters,
|
|
29
254
|
networkParameters?: NetworkParameters
|
|
30
255
|
): Promise<void>;
|
|
31
256
|
|
|
32
257
|
updateItems(
|
|
33
|
-
parameters:
|
|
34
|
-
items: Item[];
|
|
35
|
-
force?: boolean;
|
|
36
|
-
notificationEmail?: string;
|
|
37
|
-
section?: string;
|
|
38
|
-
onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
|
|
39
|
-
},
|
|
258
|
+
parameters: UpdateItemsParameters,
|
|
40
259
|
networkParameters?: NetworkParameters
|
|
41
260
|
): Promise<void>;
|
|
42
261
|
|
|
43
262
|
deleteItems(
|
|
44
|
-
parameters:
|
|
45
|
-
items: Pick<Item, 'id'>[];
|
|
46
|
-
section?: string;
|
|
47
|
-
notificationEmail?: string;
|
|
48
|
-
},
|
|
263
|
+
parameters: DeleteItemsParameters,
|
|
49
264
|
networkParameters?: NetworkParameters
|
|
50
265
|
): Promise<void>;
|
|
51
266
|
|
|
52
267
|
retrieveItems(
|
|
53
|
-
parameters:
|
|
54
|
-
ids?: string[];
|
|
55
|
-
section?: string;
|
|
56
|
-
numResultsPerPage?: number;
|
|
57
|
-
page?: number;
|
|
58
|
-
},
|
|
268
|
+
parameters: RetrieveItemsParameters,
|
|
59
269
|
networkParameters?: NetworkParameters
|
|
60
270
|
): Promise<{ items: Item[]; total_count: number; [key: string]: any }>;
|
|
61
271
|
|
|
62
272
|
createOrReplaceVariations(
|
|
63
|
-
parameters:
|
|
64
|
-
variations: Variation[];
|
|
65
|
-
force?: boolean;
|
|
66
|
-
notificationEmail?: string;
|
|
67
|
-
section?: string;
|
|
68
|
-
},
|
|
273
|
+
parameters: CreateOrReplaceVariationsParameters,
|
|
69
274
|
networkParameters?: NetworkParameters
|
|
70
275
|
): Promise<void>;
|
|
71
276
|
|
|
72
277
|
updateVariations(
|
|
73
|
-
parameters:
|
|
74
|
-
variations: Variation[];
|
|
75
|
-
force?: boolean;
|
|
76
|
-
notificationEmail?: string;
|
|
77
|
-
section?: string;
|
|
78
|
-
onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
|
|
79
|
-
},
|
|
278
|
+
parameters: UpdateVariationsParameters,
|
|
80
279
|
networkParameters?: NetworkParameters
|
|
81
280
|
): Promise<void>;
|
|
82
281
|
|
|
83
282
|
deleteVariations(
|
|
84
|
-
parameters:
|
|
85
|
-
variations: Pick<Variation, 'id'>[];
|
|
86
|
-
force?: boolean;
|
|
87
|
-
notificationEmail?: string;
|
|
88
|
-
section?: string;
|
|
89
|
-
},
|
|
283
|
+
parameters: DeleteVariationsParameters,
|
|
90
284
|
networkParameters?: NetworkParameters
|
|
91
285
|
): Promise<void>;
|
|
92
286
|
|
|
93
287
|
retrieveVariations(
|
|
94
|
-
parameters:
|
|
95
|
-
section?: string;
|
|
96
|
-
ids?: string[];
|
|
97
|
-
itemId?: string;
|
|
98
|
-
numResultsPerPage?: number;
|
|
99
|
-
page?: number;
|
|
100
|
-
},
|
|
288
|
+
parameters: RetrieveVariationsParameters,
|
|
101
289
|
networkParameters?: NetworkParameters
|
|
102
290
|
): Promise<{
|
|
103
291
|
variations: Variation[];
|
|
@@ -106,26 +294,17 @@ declare class Catalog {
|
|
|
106
294
|
}>;
|
|
107
295
|
|
|
108
296
|
addItemGroup(
|
|
109
|
-
parameters:
|
|
110
|
-
id: string;
|
|
111
|
-
name: string;
|
|
112
|
-
parent_id?: string;
|
|
113
|
-
data?: Record<string, any>;
|
|
114
|
-
},
|
|
297
|
+
parameters: AddItemGroupParameters,
|
|
115
298
|
networkParameters?: NetworkParameters
|
|
116
299
|
): Promise<void>;
|
|
117
300
|
|
|
118
301
|
addItemGroups(
|
|
119
|
-
parameters:
|
|
120
|
-
item_groups: ItemGroup[];
|
|
121
|
-
},
|
|
302
|
+
parameters: AddItemGroupsParameters,
|
|
122
303
|
networkParameters?: NetworkParameters
|
|
123
304
|
): Promise<void>;
|
|
124
305
|
|
|
125
306
|
getItemGroup(
|
|
126
|
-
parameters:
|
|
127
|
-
id: string;
|
|
128
|
-
},
|
|
307
|
+
parameters: GetItemGroupParameters,
|
|
129
308
|
networkParameters?: NetworkParameters
|
|
130
309
|
): Promise<{
|
|
131
310
|
item_groups: ItemGroup[];
|
|
@@ -140,9 +319,7 @@ declare class Catalog {
|
|
|
140
319
|
}>;
|
|
141
320
|
|
|
142
321
|
addOrUpdateItemGroups(
|
|
143
|
-
parameters:
|
|
144
|
-
item_groups: ItemGroup[];
|
|
145
|
-
},
|
|
322
|
+
parameters: AddOrUpdateItemGroupsParameters,
|
|
146
323
|
networkParameters?: NetworkParameters
|
|
147
324
|
): Promise<{
|
|
148
325
|
item_groups: {
|
|
@@ -171,35 +348,24 @@ declare class Catalog {
|
|
|
171
348
|
): Promise<{ message: string }>;
|
|
172
349
|
|
|
173
350
|
addOneWaySynonym(
|
|
174
|
-
parameters:
|
|
175
|
-
phrase: string;
|
|
176
|
-
child_phrases: string[];
|
|
177
|
-
},
|
|
351
|
+
parameters: AddOneWaySynonymParameters,
|
|
178
352
|
networkParameters?: NetworkParameters
|
|
179
353
|
): Promise<void>;
|
|
180
354
|
|
|
181
355
|
modifyOneWaySynonym(
|
|
182
|
-
parameters:
|
|
183
|
-
phrase: string;
|
|
184
|
-
child_phrases: string[];
|
|
185
|
-
},
|
|
356
|
+
parameters: ModifyOneWaySynonymParameters,
|
|
186
357
|
networkParameters?: NetworkParameters
|
|
187
358
|
): Promise<void>;
|
|
188
359
|
|
|
189
360
|
getOneWaySynonym(
|
|
190
|
-
parameters:
|
|
191
|
-
phrase: string;
|
|
192
|
-
},
|
|
361
|
+
parameters: GetOneWaySynonymParameters,
|
|
193
362
|
networkParameters?: NetworkParameters
|
|
194
363
|
): Promise<{
|
|
195
364
|
one_way_synonym_relations: OneWaySynonymRelation[];
|
|
196
365
|
}>;
|
|
197
366
|
|
|
198
367
|
getOneWaySynonyms(
|
|
199
|
-
parameters?:
|
|
200
|
-
num_results_per_page?: number;
|
|
201
|
-
page?: number;
|
|
202
|
-
},
|
|
368
|
+
parameters?: GetOneWaySynonymsParameters,
|
|
203
369
|
networkParameters?: NetworkParameters
|
|
204
370
|
): Promise<{
|
|
205
371
|
one_way_synonym_relations: OneWaySynonymRelation[];
|
|
@@ -207,33 +373,24 @@ declare class Catalog {
|
|
|
207
373
|
}>;
|
|
208
374
|
|
|
209
375
|
removeOneWaySynonym(
|
|
210
|
-
parameters:
|
|
211
|
-
phrase: string;
|
|
212
|
-
},
|
|
376
|
+
parameters: RemoveOneWaySynonymParameters,
|
|
213
377
|
networkParameters?: NetworkParameters
|
|
214
378
|
): Promise<void>;
|
|
215
379
|
|
|
216
380
|
removeOneWaySynonyms(networkParameters?: NetworkParameters): Promise<void>;
|
|
217
381
|
|
|
218
382
|
addSynonymGroup(
|
|
219
|
-
parameters:
|
|
220
|
-
synonyms: string[];
|
|
221
|
-
},
|
|
383
|
+
parameters: AddSynonymGroupParameters,
|
|
222
384
|
networkParameters?: NetworkParameters
|
|
223
385
|
): Promise<{ group_id: number; [key: string]: any }>;
|
|
224
386
|
|
|
225
387
|
modifySynonymGroup(
|
|
226
|
-
parameters:
|
|
227
|
-
id: number;
|
|
228
|
-
synonyms: string[];
|
|
229
|
-
},
|
|
388
|
+
parameters: ModifySynonymGroupParameters,
|
|
230
389
|
networkParameters?: NetworkParameters
|
|
231
390
|
): Promise<void>;
|
|
232
391
|
|
|
233
392
|
getSynonymGroup(
|
|
234
|
-
parameters:
|
|
235
|
-
id: number;
|
|
236
|
-
},
|
|
393
|
+
parameters: GetSynonymGroupParameters,
|
|
237
394
|
networkParameters?: NetworkParameters
|
|
238
395
|
): Promise<{
|
|
239
396
|
synonym_groups: SynonymGroup[];
|
|
@@ -242,11 +399,7 @@ declare class Catalog {
|
|
|
242
399
|
}>;
|
|
243
400
|
|
|
244
401
|
getSynonymGroups(
|
|
245
|
-
parameters?:
|
|
246
|
-
phrase?: string;
|
|
247
|
-
num_results_per_page?: number;
|
|
248
|
-
page?: number;
|
|
249
|
-
},
|
|
402
|
+
parameters?: GetSynonymGroupsParameters,
|
|
250
403
|
networkParameters?: NetworkParameters
|
|
251
404
|
): Promise<{
|
|
252
405
|
synonym_groups: SynonymGroup[];
|
|
@@ -255,66 +408,34 @@ declare class Catalog {
|
|
|
255
408
|
}>;
|
|
256
409
|
|
|
257
410
|
removeSynonymGroup(
|
|
258
|
-
parameters:
|
|
259
|
-
id: number;
|
|
260
|
-
},
|
|
411
|
+
parameters:RemoveSynonymGroupParameters,
|
|
261
412
|
networkParameters?: NetworkParameters
|
|
262
413
|
): Promise<void>;
|
|
263
414
|
|
|
264
415
|
removeSynonymGroups(networkParameters?: NetworkParameters): Promise<void>;
|
|
265
416
|
|
|
266
417
|
addRedirectRule(
|
|
267
|
-
parameters:
|
|
268
|
-
url: string;
|
|
269
|
-
matches: RedirectRuleMatchObject[];
|
|
270
|
-
start_time?: string;
|
|
271
|
-
end_time?: string;
|
|
272
|
-
user_segments?: string[];
|
|
273
|
-
metadata?: Record<string, any>;
|
|
274
|
-
},
|
|
418
|
+
parameters: AddRedirectRuleParameters,
|
|
275
419
|
networkParameters?: NetworkParameters
|
|
276
420
|
): Promise<RedirectRuleResponse>;
|
|
277
421
|
|
|
278
422
|
updateRedirectRule(
|
|
279
|
-
parameters:
|
|
280
|
-
id: string;
|
|
281
|
-
url: string;
|
|
282
|
-
matches: RedirectRuleMatchObject[];
|
|
283
|
-
start_time?: string;
|
|
284
|
-
end_time?: string;
|
|
285
|
-
user_segments?: string[];
|
|
286
|
-
metadata?: Record<string, any>;
|
|
287
|
-
},
|
|
423
|
+
parameters: UpdateRedirectRuleParameters,
|
|
288
424
|
networkParameters?: NetworkParameters
|
|
289
425
|
): Promise<RedirectRuleResponse>;
|
|
290
426
|
|
|
291
427
|
modifyRedirectRule(
|
|
292
|
-
parameters:
|
|
293
|
-
id: string;
|
|
294
|
-
url: string;
|
|
295
|
-
matches: RedirectRuleMatchObject[];
|
|
296
|
-
start_time?: string;
|
|
297
|
-
end_time?: string;
|
|
298
|
-
user_segments?: string[];
|
|
299
|
-
metadata?: Record<string, any>;
|
|
300
|
-
},
|
|
428
|
+
parameters: ModifyRedirectRuleParameters,
|
|
301
429
|
networkParameters?: NetworkParameters
|
|
302
430
|
): Promise<RedirectRuleResponse>;
|
|
303
431
|
|
|
304
432
|
getRedirectRule(
|
|
305
|
-
parameters:
|
|
306
|
-
id: string;
|
|
307
|
-
},
|
|
433
|
+
parameters: GetRedirectRuleParameters,
|
|
308
434
|
networkParameters?: NetworkParameters
|
|
309
435
|
): Promise<RedirectRuleResponse>;
|
|
310
436
|
|
|
311
437
|
getRedirectRules(
|
|
312
|
-
parameters?:
|
|
313
|
-
num_results_per_page?: number;
|
|
314
|
-
page?: number;
|
|
315
|
-
query?: string;
|
|
316
|
-
status?: string;
|
|
317
|
-
},
|
|
438
|
+
parameters?: GetRedirectRulesParameters,
|
|
318
439
|
networkParameters?: NetworkParameters
|
|
319
440
|
): Promise<{
|
|
320
441
|
redirect_rules: RedirectRuleResponse[];
|
|
@@ -323,21 +444,12 @@ declare class Catalog {
|
|
|
323
444
|
}>;
|
|
324
445
|
|
|
325
446
|
removeRedirectRule(
|
|
326
|
-
parameters:
|
|
327
|
-
id: string;
|
|
328
|
-
},
|
|
447
|
+
parameters: RemoveRedirectRuleParameters,
|
|
329
448
|
networkParameters?: NetworkParameters
|
|
330
449
|
): Promise<RedirectRuleResponse>;
|
|
331
450
|
|
|
332
451
|
replaceCatalog(
|
|
333
|
-
parameters:
|
|
334
|
-
section: string;
|
|
335
|
-
notification_email?: string;
|
|
336
|
-
force?: boolean;
|
|
337
|
-
items?: File;
|
|
338
|
-
variations?: File;
|
|
339
|
-
item_groups?: File;
|
|
340
|
-
},
|
|
452
|
+
parameters: ReplaceCatalogParameters,
|
|
341
453
|
networkParameters?: NetworkParameters
|
|
342
454
|
): Promise<{
|
|
343
455
|
task_id: string;
|
|
@@ -346,14 +458,7 @@ declare class Catalog {
|
|
|
346
458
|
}>;
|
|
347
459
|
|
|
348
460
|
updateCatalog(
|
|
349
|
-
parameters:
|
|
350
|
-
section: string;
|
|
351
|
-
notification_email?: string;
|
|
352
|
-
force?: boolean;
|
|
353
|
-
items?: File;
|
|
354
|
-
variations?: File;
|
|
355
|
-
item_groups?: File;
|
|
356
|
-
},
|
|
461
|
+
parameters: UpdateCatalogParameters,
|
|
357
462
|
networkParameters?: NetworkParameters
|
|
358
463
|
): Promise<{
|
|
359
464
|
task_id: string;
|
|
@@ -362,15 +467,7 @@ declare class Catalog {
|
|
|
362
467
|
}>;
|
|
363
468
|
|
|
364
469
|
patchCatalog(
|
|
365
|
-
parameters:
|
|
366
|
-
section: string;
|
|
367
|
-
notification_email?: string;
|
|
368
|
-
force?: boolean;
|
|
369
|
-
onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
|
|
370
|
-
items?: File;
|
|
371
|
-
variations?: File;
|
|
372
|
-
item_groups?: File;
|
|
373
|
-
},
|
|
470
|
+
parameters: PatchCatalogParameters,
|
|
374
471
|
networkParameters?: NetworkParameters
|
|
375
472
|
): Promise<{
|
|
376
473
|
task_id: string;
|
|
@@ -379,12 +476,7 @@ declare class Catalog {
|
|
|
379
476
|
}>;
|
|
380
477
|
|
|
381
478
|
replaceCatalogUsingTarArchive(
|
|
382
|
-
parameters:
|
|
383
|
-
section: string;
|
|
384
|
-
notification_email?: string;
|
|
385
|
-
force?: boolean;
|
|
386
|
-
tarArchive?: File;
|
|
387
|
-
},
|
|
479
|
+
parameters: ReplaceCatalogUsingTarArchiveParameters,
|
|
388
480
|
networkParameters?: NetworkParameters
|
|
389
481
|
): Promise<{
|
|
390
482
|
task_id: string;
|
|
@@ -393,12 +485,7 @@ declare class Catalog {
|
|
|
393
485
|
}>;
|
|
394
486
|
|
|
395
487
|
updateCatalogUsingTarArchive(
|
|
396
|
-
parameters:
|
|
397
|
-
section: string;
|
|
398
|
-
notification_email?: string;
|
|
399
|
-
force?: boolean;
|
|
400
|
-
tarArchive?: File;
|
|
401
|
-
},
|
|
488
|
+
parameters: UpdateCatalogUsingTarArchiveParameters,
|
|
402
489
|
networkParameters?: NetworkParameters
|
|
403
490
|
): Promise<{
|
|
404
491
|
task_id: string;
|
|
@@ -407,12 +494,7 @@ declare class Catalog {
|
|
|
407
494
|
}>;
|
|
408
495
|
|
|
409
496
|
patchCatalogUsingTarArchive(
|
|
410
|
-
parameters:
|
|
411
|
-
section: string;
|
|
412
|
-
notification_email?: string;
|
|
413
|
-
force?: boolean;
|
|
414
|
-
tarArchive?: File;
|
|
415
|
-
},
|
|
497
|
+
parameters: PatchCatalogUsingTarArchiveParameters,
|
|
416
498
|
networkParameters?: NetworkParameters
|
|
417
499
|
): Promise<{
|
|
418
500
|
task_id: string;
|
|
@@ -426,11 +508,7 @@ declare class Catalog {
|
|
|
426
508
|
): Promise<FacetConfiguration>;
|
|
427
509
|
|
|
428
510
|
getFacetConfigurations(
|
|
429
|
-
parameters:
|
|
430
|
-
page?: number;
|
|
431
|
-
num_results_per_page?: number;
|
|
432
|
-
section?: string;
|
|
433
|
-
},
|
|
511
|
+
parameters: GetFacetConfigurationsParameters,
|
|
434
512
|
networkParameters?: NetworkParameters
|
|
435
513
|
): Promise<{
|
|
436
514
|
facets: FacetConfiguration[];
|
|
@@ -439,17 +517,12 @@ declare class Catalog {
|
|
|
439
517
|
}>;
|
|
440
518
|
|
|
441
519
|
getFacetConfiguration(
|
|
442
|
-
parameters:
|
|
443
|
-
name?: string;
|
|
444
|
-
section?: string;
|
|
445
|
-
},
|
|
520
|
+
parameters: GetFacetConfigurationParameters,
|
|
446
521
|
networkParameters?: NetworkParameters
|
|
447
522
|
): Promise<FacetConfiguration>;
|
|
448
523
|
|
|
449
524
|
modifyFacetConfigurations(
|
|
450
|
-
parameters?:
|
|
451
|
-
facetConfigurations: FacetConfiguration[];
|
|
452
|
-
},
|
|
525
|
+
parameters?: ModifyFacetConfigurationsParameters,
|
|
453
526
|
networkParameters?: NetworkParameters
|
|
454
527
|
): Promise<FacetConfiguration[]>;
|
|
455
528
|
|
|
@@ -464,37 +537,22 @@ declare class Catalog {
|
|
|
464
537
|
): Promise<FacetConfiguration>;
|
|
465
538
|
|
|
466
539
|
removeFacetConfiguration(
|
|
467
|
-
parameters?:
|
|
468
|
-
name: string;
|
|
469
|
-
section?: string;
|
|
470
|
-
},
|
|
540
|
+
parameters?: RemoveFacetConfigurationParameters,
|
|
471
541
|
networkParameters?: NetworkParameters
|
|
472
542
|
): Promise<FacetConfiguration>;
|
|
473
543
|
|
|
474
544
|
addFacetOptionConfiguration(
|
|
475
|
-
parameters:
|
|
476
|
-
facetGroupName: string;
|
|
477
|
-
section?: string;
|
|
478
|
-
},
|
|
545
|
+
parameters: AddFacetOptionConfigurationParameters,
|
|
479
546
|
networkParameters?: NetworkParameters
|
|
480
547
|
): Promise<FacetOptionConfiguration>;
|
|
481
548
|
|
|
482
549
|
addOrModifyFacetOptionConfigurations(
|
|
483
|
-
parameters:
|
|
484
|
-
facetGroupName: string;
|
|
485
|
-
facetOptionConfigurations: FacetOptionConfiguration[];
|
|
486
|
-
section?: string;
|
|
487
|
-
},
|
|
550
|
+
parameters: AddOrModifyFacetOptionConfigurationsParameters,
|
|
488
551
|
networkParameters?: NetworkParameters
|
|
489
552
|
): Promise<FacetOptionConfiguration[]>;
|
|
490
553
|
|
|
491
554
|
getFacetOptionConfigurations(
|
|
492
|
-
parameters:
|
|
493
|
-
facetGroupName: string;
|
|
494
|
-
page?: number;
|
|
495
|
-
num_results_per_page?: number;
|
|
496
|
-
section?: string;
|
|
497
|
-
},
|
|
555
|
+
parameters: GetFacetOptionConfigurationsParameters,
|
|
498
556
|
networkParameters?: NetworkParameters
|
|
499
557
|
): Promise<{
|
|
500
558
|
facet_options: FacetOptionConfiguration[];
|
|
@@ -503,36 +561,22 @@ declare class Catalog {
|
|
|
503
561
|
}>;
|
|
504
562
|
|
|
505
563
|
getFacetOptionConfiguration(
|
|
506
|
-
parameters:
|
|
507
|
-
facetGroupName: string;
|
|
508
|
-
value: string;
|
|
509
|
-
section?: string;
|
|
510
|
-
},
|
|
564
|
+
parameters: GetFacetOptionConfigurationParameters,
|
|
511
565
|
networkParameters?: NetworkParameters
|
|
512
566
|
): Promise<FacetOptionConfiguration>;
|
|
513
567
|
|
|
514
568
|
replaceFacetOptionConfiguration(
|
|
515
|
-
parameters:
|
|
516
|
-
facetGroupName: string;
|
|
517
|
-
section?: string;
|
|
518
|
-
} & FacetOptionConfiguration,
|
|
569
|
+
parameters: ReplaceFacetOptionConfigurationParameters,
|
|
519
570
|
networkParameters?: NetworkParameters
|
|
520
571
|
): Promise<FacetOptionConfiguration>;
|
|
521
572
|
|
|
522
573
|
modifyFacetOptionConfiguration(
|
|
523
|
-
parameters?:
|
|
524
|
-
facetGroupName: string;
|
|
525
|
-
section?: string;
|
|
526
|
-
} & FacetOptionConfiguration,
|
|
574
|
+
parameters?: ModifyFacetOptionConfigurationParameters,
|
|
527
575
|
networkParameters?: NetworkParameters
|
|
528
576
|
): Promise<FacetOptionConfiguration>;
|
|
529
577
|
|
|
530
578
|
removeFacetOptionConfiguration(
|
|
531
|
-
parameters:
|
|
532
|
-
facetGroupName: string;
|
|
533
|
-
value: string;
|
|
534
|
-
section?: string;
|
|
535
|
-
},
|
|
579
|
+
parameters: RemoveFacetOptionConfiguration,
|
|
536
580
|
networkParameters?: NetworkParameters
|
|
537
581
|
): Promise<FacetOptionConfiguration>;
|
|
538
582
|
}
|