@teemill/product-catalog 1.70.0 → 1.71.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/README.md +3 -3
- package/api.ts +20 -1691
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +21 -1692
- package/dist/api.js +1 -58
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +21 -1692
- package/dist/esm/api.js +1 -58
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -18
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApplicationPropertiesProperties.md +2 -0
- package/docs/CreateApplicationProperties.md +2 -0
- package/docs/CreateProductVariantImagesInner.md +2 -0
- package/docs/ProductsApi.md +2 -2
- package/docs/TextApplicationProperties.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.71.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,97 +13,46 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @export
|
|
19
|
-
* @interface AdditionalFile
|
|
20
|
-
*/
|
|
21
16
|
export interface AdditionalFile {
|
|
22
17
|
/**
|
|
23
18
|
* Publicly available file URL.
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof AdditionalFile
|
|
26
19
|
*/
|
|
27
20
|
'src'?: string;
|
|
28
21
|
}
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @export
|
|
32
|
-
* @interface ApiError
|
|
33
|
-
*/
|
|
34
22
|
export interface ApiError {
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof ApiError
|
|
39
|
-
*/
|
|
40
23
|
'code'?: string;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof ApiError
|
|
45
|
-
*/
|
|
46
24
|
'message': string;
|
|
47
25
|
}
|
|
48
|
-
/**
|
|
49
|
-
*
|
|
50
|
-
* @export
|
|
51
|
-
* @interface Application
|
|
52
|
-
*/
|
|
53
26
|
export interface Application {
|
|
54
27
|
/**
|
|
55
28
|
* Unique object identifier
|
|
56
|
-
* @type {string}
|
|
57
|
-
* @memberof Application
|
|
58
29
|
*/
|
|
59
30
|
'id'?: string;
|
|
60
31
|
/**
|
|
61
32
|
* Technology to use for the application.
|
|
62
|
-
* @type {string}
|
|
63
|
-
* @memberof Application
|
|
64
33
|
*/
|
|
65
34
|
'technology': ApplicationTechnologyEnum;
|
|
66
35
|
/**
|
|
67
36
|
* Placement of the application. Available placements depend on the chosen product and technology.
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof Application
|
|
70
37
|
*/
|
|
71
38
|
'placement': ApplicationPlacementEnum;
|
|
72
39
|
/**
|
|
73
40
|
* Any additional instructions for the application
|
|
74
|
-
* @type {string}
|
|
75
|
-
* @memberof Application
|
|
76
41
|
*/
|
|
77
42
|
'additionalInstructions'?: string | null;
|
|
78
43
|
/**
|
|
79
44
|
* Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area.
|
|
80
|
-
* @type {string}
|
|
81
|
-
* @memberof Application
|
|
82
45
|
*/
|
|
83
46
|
'src'?: string;
|
|
84
47
|
/**
|
|
85
48
|
* A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products.
|
|
86
|
-
* @type {string}
|
|
87
|
-
* @memberof Application
|
|
88
49
|
*/
|
|
89
50
|
'groupRef'?: string | null;
|
|
90
|
-
/**
|
|
91
|
-
*
|
|
92
|
-
* @type {ApplicationMockup}
|
|
93
|
-
* @memberof Application
|
|
94
|
-
*/
|
|
95
51
|
'mockup'?: ApplicationMockup | null;
|
|
96
52
|
/**
|
|
97
53
|
* If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF.
|
|
98
|
-
* @type {boolean}
|
|
99
|
-
* @memberof Application
|
|
100
54
|
*/
|
|
101
55
|
'stockedOnly'?: boolean;
|
|
102
|
-
/**
|
|
103
|
-
*
|
|
104
|
-
* @type {ApplicationPropertiesProperties}
|
|
105
|
-
* @memberof Application
|
|
106
|
-
*/
|
|
107
56
|
'properties'?: ApplicationPropertiesProperties | null;
|
|
108
57
|
}
|
|
109
58
|
export declare const ApplicationTechnologyEnum: {
|
|
@@ -127,165 +76,69 @@ export declare const ApplicationPlacementEnum: {
|
|
|
127
76
|
readonly Neck: "neck";
|
|
128
77
|
};
|
|
129
78
|
export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
|
|
130
|
-
/**
|
|
131
|
-
*
|
|
132
|
-
* @export
|
|
133
|
-
* @interface ApplicationGroup
|
|
134
|
-
*/
|
|
135
79
|
export interface ApplicationGroup {
|
|
136
80
|
/**
|
|
137
81
|
* Unique object identifier
|
|
138
|
-
* @type {string}
|
|
139
|
-
* @memberof ApplicationGroup
|
|
140
82
|
*/
|
|
141
83
|
'id': string;
|
|
142
84
|
/**
|
|
143
85
|
* A reference to the application group resource location
|
|
144
|
-
* @type {string}
|
|
145
|
-
* @memberof ApplicationGroup
|
|
146
86
|
*/
|
|
147
87
|
'ref': string;
|
|
148
88
|
/**
|
|
149
89
|
* Name of the application group
|
|
150
|
-
* @type {string}
|
|
151
|
-
* @memberof ApplicationGroup
|
|
152
90
|
*/
|
|
153
91
|
'name': string;
|
|
154
|
-
/**
|
|
155
|
-
*
|
|
156
|
-
* @type {string}
|
|
157
|
-
* @memberof ApplicationGroup
|
|
158
|
-
*/
|
|
159
92
|
'createdAt': string;
|
|
160
|
-
/**
|
|
161
|
-
*
|
|
162
|
-
* @type {string}
|
|
163
|
-
* @memberof ApplicationGroup
|
|
164
|
-
*/
|
|
165
93
|
'updatedAt': string;
|
|
166
94
|
}
|
|
167
|
-
/**
|
|
168
|
-
*
|
|
169
|
-
* @export
|
|
170
|
-
* @interface ApplicationGroupsResponse
|
|
171
|
-
*/
|
|
172
95
|
export interface ApplicationGroupsResponse {
|
|
173
|
-
/**
|
|
174
|
-
*
|
|
175
|
-
* @type {Array<ApplicationGroup>}
|
|
176
|
-
* @memberof ApplicationGroupsResponse
|
|
177
|
-
*/
|
|
178
96
|
'applicationGroups'?: Array<ApplicationGroup>;
|
|
179
97
|
/**
|
|
180
98
|
* The token referencing the next page number
|
|
181
|
-
* @type {number}
|
|
182
|
-
* @memberof ApplicationGroupsResponse
|
|
183
99
|
*/
|
|
184
100
|
'nextPageToken'?: number | null;
|
|
185
101
|
}
|
|
186
|
-
/**
|
|
187
|
-
*
|
|
188
|
-
* @export
|
|
189
|
-
* @interface ApplicationMockup
|
|
190
|
-
*/
|
|
191
102
|
export interface ApplicationMockup {
|
|
192
103
|
/**
|
|
193
104
|
* Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one.
|
|
194
|
-
* @type {string}
|
|
195
|
-
* @memberof ApplicationMockup
|
|
196
105
|
*/
|
|
197
106
|
'file': string;
|
|
198
107
|
/**
|
|
199
108
|
* Publicly available mockup image URL. This is a preview of the mockup image for the given application.
|
|
200
|
-
* @type {string}
|
|
201
|
-
* @memberof ApplicationMockup
|
|
202
109
|
*/
|
|
203
110
|
'preview'?: string;
|
|
204
111
|
}
|
|
205
|
-
/**
|
|
206
|
-
*
|
|
207
|
-
* @export
|
|
208
|
-
* @interface ApplicationProperties
|
|
209
|
-
*/
|
|
210
112
|
export interface ApplicationProperties {
|
|
211
113
|
/**
|
|
212
114
|
* Width of the application in pixels
|
|
213
|
-
* @type {number}
|
|
214
|
-
* @memberof ApplicationProperties
|
|
215
115
|
*/
|
|
216
116
|
'width'?: number | null;
|
|
217
117
|
/**
|
|
218
118
|
* Height of the application in pixels
|
|
219
|
-
* @type {number}
|
|
220
|
-
* @memberof ApplicationProperties
|
|
221
119
|
*/
|
|
222
120
|
'height'?: number | null;
|
|
223
|
-
/**
|
|
224
|
-
*
|
|
225
|
-
* @type {ApplicationPropertiesPosition}
|
|
226
|
-
* @memberof ApplicationProperties
|
|
227
|
-
*/
|
|
228
121
|
'position'?: ApplicationPropertiesPosition | null;
|
|
229
|
-
/**
|
|
230
|
-
*
|
|
231
|
-
* @type {ApplicationPropertiesPositionInference}
|
|
232
|
-
* @memberof ApplicationProperties
|
|
233
|
-
*/
|
|
234
122
|
'positionInference'?: ApplicationPropertiesPositionInference | null;
|
|
235
|
-
/**
|
|
236
|
-
*
|
|
237
|
-
* @type {ApplicationPropertiesMetadata}
|
|
238
|
-
* @memberof ApplicationProperties
|
|
239
|
-
*/
|
|
240
123
|
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
241
124
|
}
|
|
242
|
-
/**
|
|
243
|
-
*
|
|
244
|
-
* @export
|
|
245
|
-
* @interface ApplicationPropertiesMetadata
|
|
246
|
-
*/
|
|
247
125
|
export interface ApplicationPropertiesMetadata {
|
|
248
|
-
/**
|
|
249
|
-
*
|
|
250
|
-
* @type {ApplicationPropertiesMetadataPersonalization}
|
|
251
|
-
* @memberof ApplicationPropertiesMetadata
|
|
252
|
-
*/
|
|
253
126
|
'personalization'?: ApplicationPropertiesMetadataPersonalization;
|
|
254
127
|
}
|
|
255
128
|
/**
|
|
256
129
|
* @type ApplicationPropertiesMetadataPersonalization
|
|
257
|
-
* @export
|
|
258
130
|
*/
|
|
259
131
|
export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
|
|
260
|
-
/**
|
|
261
|
-
*
|
|
262
|
-
* @export
|
|
263
|
-
* @interface ApplicationPropertiesPersonalization
|
|
264
|
-
*/
|
|
265
132
|
export interface ApplicationPropertiesPersonalization {
|
|
266
133
|
/**
|
|
267
134
|
* The label to be displayed on the personalization field.
|
|
268
|
-
* @type {string}
|
|
269
|
-
* @memberof ApplicationPropertiesPersonalization
|
|
270
135
|
*/
|
|
271
136
|
'label'?: string;
|
|
272
|
-
/**
|
|
273
|
-
*
|
|
274
|
-
* @type {ApplicationPropertiesPersonalizationRules}
|
|
275
|
-
* @memberof ApplicationPropertiesPersonalization
|
|
276
|
-
*/
|
|
277
137
|
'rules'?: ApplicationPropertiesPersonalizationRules;
|
|
278
138
|
}
|
|
279
|
-
/**
|
|
280
|
-
*
|
|
281
|
-
* @export
|
|
282
|
-
* @interface ApplicationPropertiesPersonalizationRules
|
|
283
|
-
*/
|
|
284
139
|
export interface ApplicationPropertiesPersonalizationRules {
|
|
285
140
|
/**
|
|
286
141
|
* The fit of the image. This determines how an uploaded image will be resized to fit the application.
|
|
287
|
-
* @type {string}
|
|
288
|
-
* @memberof ApplicationPropertiesPersonalizationRules
|
|
289
142
|
*/
|
|
290
143
|
'fit'?: ApplicationPropertiesPersonalizationRulesFitEnum;
|
|
291
144
|
}
|
|
@@ -298,119 +151,73 @@ export declare const ApplicationPropertiesPersonalizationRulesFitEnum: {
|
|
|
298
151
|
export type ApplicationPropertiesPersonalizationRulesFitEnum = typeof ApplicationPropertiesPersonalizationRulesFitEnum[keyof typeof ApplicationPropertiesPersonalizationRulesFitEnum];
|
|
299
152
|
/**
|
|
300
153
|
* Position of the application relative to the bounding box of the product
|
|
301
|
-
* @export
|
|
302
|
-
* @interface ApplicationPropertiesPosition
|
|
303
154
|
*/
|
|
304
155
|
export interface ApplicationPropertiesPosition {
|
|
305
156
|
/**
|
|
306
157
|
* X coordinate of the application in pixels
|
|
307
|
-
* @type {number}
|
|
308
|
-
* @memberof ApplicationPropertiesPosition
|
|
309
158
|
*/
|
|
310
159
|
'x': number;
|
|
311
160
|
/**
|
|
312
161
|
* Y coordinate of the application in pixels
|
|
313
|
-
* @type {number}
|
|
314
|
-
* @memberof ApplicationPropertiesPosition
|
|
315
162
|
*/
|
|
316
163
|
'y': number;
|
|
317
164
|
/**
|
|
318
165
|
* The z layer of the application. This doesn\'t affect printing, but is used for ordering the applications when displaying them in a mockup.
|
|
319
|
-
* @type {number}
|
|
320
|
-
* @memberof ApplicationPropertiesPosition
|
|
321
166
|
*/
|
|
322
167
|
'z'?: number;
|
|
323
168
|
}
|
|
324
169
|
/**
|
|
325
170
|
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the warehouse product.
|
|
326
|
-
* @export
|
|
327
|
-
* @interface ApplicationPropertiesPositionInference
|
|
328
171
|
*/
|
|
329
172
|
export interface ApplicationPropertiesPositionInference {
|
|
330
173
|
/**
|
|
331
174
|
* Old mockup with applications. This is used to infer the position of the application.
|
|
332
|
-
* @type {string}
|
|
333
|
-
* @memberof ApplicationPropertiesPositionInference
|
|
334
175
|
*/
|
|
335
176
|
'mockup': string;
|
|
336
177
|
/**
|
|
337
178
|
* Base flat image. This is used to infer the position of the application.
|
|
338
|
-
* @type {string}
|
|
339
|
-
* @memberof ApplicationPropertiesPositionInference
|
|
340
179
|
*/
|
|
341
180
|
'baseFlat': string;
|
|
342
181
|
}
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
* @export
|
|
346
|
-
* @interface ApplicationPropertiesProperties
|
|
347
|
-
*/
|
|
348
182
|
export interface ApplicationPropertiesProperties {
|
|
349
|
-
/**
|
|
350
|
-
*
|
|
351
|
-
* @type {ApplicationPropertiesPosition}
|
|
352
|
-
* @memberof ApplicationPropertiesProperties
|
|
353
|
-
*/
|
|
354
183
|
'position'?: ApplicationPropertiesPosition | null;
|
|
355
|
-
/**
|
|
356
|
-
*
|
|
357
|
-
* @type {ApplicationPropertiesPositionInference}
|
|
358
|
-
* @memberof ApplicationPropertiesProperties
|
|
359
|
-
*/
|
|
360
184
|
'positionInference'?: ApplicationPropertiesPositionInference | null;
|
|
361
185
|
/**
|
|
362
186
|
* An array of text lines.
|
|
363
|
-
* @type {Array<string>}
|
|
364
|
-
* @memberof ApplicationPropertiesProperties
|
|
365
187
|
*/
|
|
366
188
|
'lines'?: Array<string>;
|
|
367
189
|
/**
|
|
368
190
|
* The font to be used for the text. This font must be available in the PodOS font library.
|
|
369
|
-
* @type {string}
|
|
370
|
-
* @memberof ApplicationPropertiesProperties
|
|
371
191
|
*/
|
|
372
192
|
'font'?: string;
|
|
373
193
|
/**
|
|
374
194
|
* The size of the text in pixels.
|
|
375
|
-
* @type {number}
|
|
376
|
-
* @memberof ApplicationPropertiesProperties
|
|
377
195
|
*/
|
|
378
196
|
'fontSize'?: number;
|
|
379
197
|
/**
|
|
380
198
|
* The weight of the text. This must be a valid CSS font-weight value.
|
|
381
|
-
* @type {string}
|
|
382
|
-
* @memberof ApplicationPropertiesProperties
|
|
383
199
|
*/
|
|
384
200
|
'fontWeight'?: ApplicationPropertiesPropertiesFontWeightEnum;
|
|
385
201
|
/**
|
|
386
202
|
* The style of the text. This must be a valid CSS font-style value.
|
|
387
|
-
* @type {string}
|
|
388
|
-
* @memberof ApplicationPropertiesProperties
|
|
389
203
|
*/
|
|
390
204
|
'fontStyle'?: ApplicationPropertiesPropertiesFontStyleEnum;
|
|
391
205
|
/**
|
|
392
206
|
* The colour of the text in hex format.
|
|
393
|
-
* @type {string}
|
|
394
|
-
* @memberof ApplicationPropertiesProperties
|
|
395
207
|
*/
|
|
396
208
|
'color'?: string;
|
|
209
|
+
/**
|
|
210
|
+
* The rotation of the text in degrees.
|
|
211
|
+
*/
|
|
212
|
+
'rotation'?: number;
|
|
397
213
|
/**
|
|
398
214
|
* Width of the application in pixels
|
|
399
|
-
* @type {number}
|
|
400
|
-
* @memberof ApplicationPropertiesProperties
|
|
401
215
|
*/
|
|
402
216
|
'width'?: number | null;
|
|
403
217
|
/**
|
|
404
218
|
* Height of the application in pixels
|
|
405
|
-
* @type {number}
|
|
406
|
-
* @memberof ApplicationPropertiesProperties
|
|
407
219
|
*/
|
|
408
220
|
'height'?: number | null;
|
|
409
|
-
/**
|
|
410
|
-
*
|
|
411
|
-
* @type {ApplicationPropertiesMetadata}
|
|
412
|
-
* @memberof ApplicationPropertiesProperties
|
|
413
|
-
*/
|
|
414
221
|
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
415
222
|
}
|
|
416
223
|
export declare const ApplicationPropertiesPropertiesFontWeightEnum: {
|
|
@@ -426,253 +233,122 @@ export declare const ApplicationPropertiesPropertiesFontStyleEnum: {
|
|
|
426
233
|
readonly Oblique: "oblique";
|
|
427
234
|
};
|
|
428
235
|
export type ApplicationPropertiesPropertiesFontStyleEnum = typeof ApplicationPropertiesPropertiesFontStyleEnum[keyof typeof ApplicationPropertiesPropertiesFontStyleEnum];
|
|
429
|
-
/**
|
|
430
|
-
*
|
|
431
|
-
* @export
|
|
432
|
-
* @interface ApplicationSet
|
|
433
|
-
*/
|
|
434
236
|
export interface ApplicationSet {
|
|
435
237
|
/**
|
|
436
238
|
* Unique object identifier
|
|
437
|
-
* @type {string}
|
|
438
|
-
* @memberof ApplicationSet
|
|
439
239
|
*/
|
|
440
240
|
'id': string;
|
|
441
241
|
/**
|
|
442
242
|
* A reference to the application set resource location
|
|
443
|
-
* @type {string}
|
|
444
|
-
* @memberof ApplicationSet
|
|
445
243
|
*/
|
|
446
244
|
'ref': string;
|
|
447
245
|
/**
|
|
448
246
|
* Name of the application set
|
|
449
|
-
* @type {string}
|
|
450
|
-
* @memberof ApplicationSet
|
|
451
247
|
*/
|
|
452
248
|
'name': string;
|
|
453
249
|
/**
|
|
454
250
|
* Description of the application set
|
|
455
|
-
* @type {string}
|
|
456
|
-
* @memberof ApplicationSet
|
|
457
251
|
*/
|
|
458
252
|
'description'?: string;
|
|
459
253
|
/**
|
|
460
254
|
* The width, in pixels of the images in the set
|
|
461
|
-
* @type {number}
|
|
462
|
-
* @memberof ApplicationSet
|
|
463
255
|
*/
|
|
464
256
|
'width': number;
|
|
465
257
|
/**
|
|
466
258
|
* The height, in pixels of the images in the set
|
|
467
|
-
* @type {number}
|
|
468
|
-
* @memberof ApplicationSet
|
|
469
259
|
*/
|
|
470
260
|
'height': number;
|
|
471
261
|
/**
|
|
472
262
|
* The DPI used when printing the images in the set
|
|
473
|
-
* @type {number}
|
|
474
|
-
* @memberof ApplicationSet
|
|
475
263
|
*/
|
|
476
264
|
'dpi': number;
|
|
477
265
|
/**
|
|
478
266
|
* List of application set records
|
|
479
|
-
* @type {Array<ApplicationSetRecord>}
|
|
480
|
-
* @memberof ApplicationSet
|
|
481
267
|
*/
|
|
482
268
|
'records': Array<ApplicationSetRecord>;
|
|
483
|
-
/**
|
|
484
|
-
*
|
|
485
|
-
* @type {string}
|
|
486
|
-
* @memberof ApplicationSet
|
|
487
|
-
*/
|
|
488
269
|
'createdAt': string;
|
|
489
|
-
/**
|
|
490
|
-
*
|
|
491
|
-
* @type {string}
|
|
492
|
-
* @memberof ApplicationSet
|
|
493
|
-
*/
|
|
494
270
|
'updatedAt': string;
|
|
495
271
|
}
|
|
496
|
-
/**
|
|
497
|
-
*
|
|
498
|
-
* @export
|
|
499
|
-
* @interface ApplicationSet1
|
|
500
|
-
*/
|
|
501
272
|
export interface ApplicationSet1 {
|
|
502
273
|
/**
|
|
503
274
|
* Unique object identifier
|
|
504
|
-
* @type {string}
|
|
505
|
-
* @memberof ApplicationSet1
|
|
506
275
|
*/
|
|
507
276
|
'id'?: string;
|
|
508
277
|
/**
|
|
509
278
|
* A reference to the application set resource location
|
|
510
|
-
* @type {string}
|
|
511
|
-
* @memberof ApplicationSet1
|
|
512
279
|
*/
|
|
513
280
|
'ref'?: string;
|
|
514
281
|
}
|
|
515
|
-
/**
|
|
516
|
-
*
|
|
517
|
-
* @export
|
|
518
|
-
* @interface ApplicationSetRecord
|
|
519
|
-
*/
|
|
520
282
|
export interface ApplicationSetRecord {
|
|
521
283
|
/**
|
|
522
284
|
* Unique object identifier
|
|
523
|
-
* @type {string}
|
|
524
|
-
* @memberof ApplicationSetRecord
|
|
525
285
|
*/
|
|
526
286
|
'id'?: string;
|
|
527
|
-
/**
|
|
528
|
-
*
|
|
529
|
-
* @type {ApplicationSet1}
|
|
530
|
-
* @memberof ApplicationSetRecord
|
|
531
|
-
*/
|
|
532
287
|
'set'?: ApplicationSet1;
|
|
533
288
|
/**
|
|
534
289
|
* Attributes associated to a variant such as Colour and Size.
|
|
535
|
-
* @type {Array<Attributes1Inner>}
|
|
536
|
-
* @memberof ApplicationSetRecord
|
|
537
290
|
*/
|
|
538
291
|
'attributes'?: Array<Attributes1Inner>;
|
|
539
292
|
/**
|
|
540
293
|
* List of applications for this record
|
|
541
|
-
* @type {Array<Application>}
|
|
542
|
-
* @memberof ApplicationSetRecord
|
|
543
294
|
*/
|
|
544
295
|
'applications'?: Array<Application>;
|
|
545
296
|
}
|
|
546
|
-
/**
|
|
547
|
-
*
|
|
548
|
-
* @export
|
|
549
|
-
* @interface ApplicationSetsResponse
|
|
550
|
-
*/
|
|
551
297
|
export interface ApplicationSetsResponse {
|
|
552
|
-
/**
|
|
553
|
-
*
|
|
554
|
-
* @type {Array<ApplicationSet>}
|
|
555
|
-
* @memberof ApplicationSetsResponse
|
|
556
|
-
*/
|
|
557
298
|
'applicationSets'?: Array<ApplicationSet>;
|
|
558
299
|
/**
|
|
559
300
|
* The token referencing the next page number
|
|
560
|
-
* @type {number}
|
|
561
|
-
* @memberof ApplicationSetsResponse
|
|
562
301
|
*/
|
|
563
302
|
'nextPageToken'?: number | null;
|
|
564
303
|
}
|
|
565
|
-
/**
|
|
566
|
-
*
|
|
567
|
-
* @export
|
|
568
|
-
* @interface ApplicationTechnologiesResponse
|
|
569
|
-
*/
|
|
570
304
|
export interface ApplicationTechnologiesResponse {
|
|
571
|
-
/**
|
|
572
|
-
*
|
|
573
|
-
* @type {Array<ApplicationTechnology>}
|
|
574
|
-
* @memberof ApplicationTechnologiesResponse
|
|
575
|
-
*/
|
|
576
305
|
'applicationTechnologies'?: Array<ApplicationTechnology>;
|
|
577
306
|
}
|
|
578
|
-
/**
|
|
579
|
-
*
|
|
580
|
-
* @export
|
|
581
|
-
* @interface ApplicationTechnology
|
|
582
|
-
*/
|
|
583
307
|
export interface ApplicationTechnology {
|
|
584
308
|
/**
|
|
585
309
|
* Unique object identifier
|
|
586
|
-
* @type {string}
|
|
587
|
-
* @memberof ApplicationTechnology
|
|
588
310
|
*/
|
|
589
311
|
'id'?: string;
|
|
590
312
|
/**
|
|
591
313
|
* Name of the application technology
|
|
592
|
-
* @type {string}
|
|
593
|
-
* @memberof ApplicationTechnology
|
|
594
314
|
*/
|
|
595
315
|
'name'?: string;
|
|
596
316
|
/**
|
|
597
317
|
* Code of the application technology
|
|
598
|
-
* @type {string}
|
|
599
|
-
* @memberof ApplicationTechnology
|
|
600
318
|
*/
|
|
601
319
|
'code'?: string;
|
|
602
|
-
/**
|
|
603
|
-
*
|
|
604
|
-
* @type {ApplicationTechnologyIntegrationProduct}
|
|
605
|
-
* @memberof ApplicationTechnology
|
|
606
|
-
*/
|
|
607
320
|
'integrationProduct'?: ApplicationTechnologyIntegrationProduct;
|
|
608
321
|
}
|
|
609
|
-
/**
|
|
610
|
-
*
|
|
611
|
-
* @export
|
|
612
|
-
* @interface ApplicationTechnologyIntegrationProduct
|
|
613
|
-
*/
|
|
614
322
|
export interface ApplicationTechnologyIntegrationProduct {
|
|
615
323
|
/**
|
|
616
324
|
* SKU of the product in the integration
|
|
617
|
-
* @type {string}
|
|
618
|
-
* @memberof ApplicationTechnologyIntegrationProduct
|
|
619
325
|
*/
|
|
620
326
|
'sku'?: string;
|
|
621
327
|
/**
|
|
622
328
|
* A reference to the integration product resource location
|
|
623
|
-
* @type {string}
|
|
624
|
-
* @memberof ApplicationTechnologyIntegrationProduct
|
|
625
329
|
*/
|
|
626
330
|
'ref'?: string;
|
|
627
331
|
}
|
|
628
|
-
/**
|
|
629
|
-
*
|
|
630
|
-
* @export
|
|
631
|
-
* @interface Attribute
|
|
632
|
-
*/
|
|
633
332
|
export interface Attribute {
|
|
634
333
|
/**
|
|
635
334
|
* Attribute name
|
|
636
|
-
* @type {string}
|
|
637
|
-
* @memberof Attribute
|
|
638
335
|
*/
|
|
639
336
|
'name': string;
|
|
640
337
|
/**
|
|
641
338
|
* Attribute value
|
|
642
|
-
* @type {string}
|
|
643
|
-
* @memberof Attribute
|
|
644
339
|
*/
|
|
645
340
|
'value': string;
|
|
646
|
-
/**
|
|
647
|
-
*
|
|
648
|
-
* @type {AttributeThumbnail}
|
|
649
|
-
* @memberof Attribute
|
|
650
|
-
*/
|
|
651
341
|
'thumbnail'?: AttributeThumbnail;
|
|
652
342
|
/**
|
|
653
343
|
* Attribute tags
|
|
654
|
-
* @type {Array<string>}
|
|
655
|
-
* @memberof Attribute
|
|
656
344
|
*/
|
|
657
345
|
'tags'?: Array<string>;
|
|
658
346
|
}
|
|
659
347
|
/**
|
|
660
348
|
* Attribute thumbnail, intended for interfaces like storefront colour selector.
|
|
661
|
-
* @export
|
|
662
|
-
* @interface AttributeThumbnail
|
|
663
349
|
*/
|
|
664
350
|
export interface AttributeThumbnail {
|
|
665
|
-
/**
|
|
666
|
-
*
|
|
667
|
-
* @type {string}
|
|
668
|
-
* @memberof AttributeThumbnail
|
|
669
|
-
*/
|
|
670
351
|
'type'?: AttributeThumbnailTypeEnum;
|
|
671
|
-
/**
|
|
672
|
-
*
|
|
673
|
-
* @type {string}
|
|
674
|
-
* @memberof AttributeThumbnail
|
|
675
|
-
*/
|
|
676
352
|
'value'?: string;
|
|
677
353
|
}
|
|
678
354
|
export declare const AttributeThumbnailTypeEnum: {
|
|
@@ -681,72 +357,35 @@ export declare const AttributeThumbnailTypeEnum: {
|
|
|
681
357
|
readonly Image: "image";
|
|
682
358
|
};
|
|
683
359
|
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
684
|
-
/**
|
|
685
|
-
*
|
|
686
|
-
* @export
|
|
687
|
-
* @interface Attributes1Inner
|
|
688
|
-
*/
|
|
689
360
|
export interface Attributes1Inner {
|
|
690
|
-
/**
|
|
691
|
-
*
|
|
692
|
-
* @type {string}
|
|
693
|
-
* @memberof Attributes1Inner
|
|
694
|
-
*/
|
|
695
361
|
'name'?: string;
|
|
696
|
-
/**
|
|
697
|
-
*
|
|
698
|
-
* @type {string}
|
|
699
|
-
* @memberof Attributes1Inner
|
|
700
|
-
*/
|
|
701
362
|
'value'?: string;
|
|
702
363
|
}
|
|
703
|
-
/**
|
|
704
|
-
*
|
|
705
|
-
* @export
|
|
706
|
-
* @interface CreateApplication
|
|
707
|
-
*/
|
|
708
364
|
export interface CreateApplication {
|
|
709
365
|
/**
|
|
710
366
|
* Technology to use for the application.
|
|
711
|
-
* @type {string}
|
|
712
|
-
* @memberof CreateApplication
|
|
713
367
|
*/
|
|
714
368
|
'technology': CreateApplicationTechnologyEnum;
|
|
715
369
|
/**
|
|
716
370
|
* Placement of the application. Available placements depend on the chosen product and technology.
|
|
717
|
-
* @type {string}
|
|
718
|
-
* @memberof CreateApplication
|
|
719
371
|
*/
|
|
720
372
|
'placement': CreateApplicationPlacementEnum;
|
|
721
373
|
/**
|
|
722
374
|
* Any additional instructions for the application
|
|
723
|
-
* @type {string}
|
|
724
|
-
* @memberof CreateApplication
|
|
725
375
|
*/
|
|
726
376
|
'additionalInstructions'?: string | null;
|
|
727
377
|
/**
|
|
728
378
|
* Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area.
|
|
729
|
-
* @type {string}
|
|
730
|
-
* @memberof CreateApplication
|
|
731
379
|
*/
|
|
732
380
|
'src': string;
|
|
733
381
|
/**
|
|
734
382
|
* A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products.
|
|
735
|
-
* @type {string}
|
|
736
|
-
* @memberof CreateApplication
|
|
737
383
|
*/
|
|
738
384
|
'groupRef'?: string | null;
|
|
739
385
|
/**
|
|
740
386
|
* If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF.
|
|
741
|
-
* @type {boolean}
|
|
742
|
-
* @memberof CreateApplication
|
|
743
387
|
*/
|
|
744
388
|
'stockedOnly'?: boolean;
|
|
745
|
-
/**
|
|
746
|
-
*
|
|
747
|
-
* @type {CreateApplicationProperties}
|
|
748
|
-
* @memberof CreateApplication
|
|
749
|
-
*/
|
|
750
389
|
'properties'?: CreateApplicationProperties | null;
|
|
751
390
|
}
|
|
752
391
|
export declare const CreateApplicationTechnologyEnum: {
|
|
@@ -770,90 +409,51 @@ export declare const CreateApplicationPlacementEnum: {
|
|
|
770
409
|
readonly Neck: "neck";
|
|
771
410
|
};
|
|
772
411
|
export type CreateApplicationPlacementEnum = typeof CreateApplicationPlacementEnum[keyof typeof CreateApplicationPlacementEnum];
|
|
773
|
-
/**
|
|
774
|
-
*
|
|
775
|
-
* @export
|
|
776
|
-
* @interface CreateApplicationGroupRequest
|
|
777
|
-
*/
|
|
778
412
|
export interface CreateApplicationGroupRequest {
|
|
779
413
|
/**
|
|
780
414
|
* Name of the application group
|
|
781
|
-
* @type {string}
|
|
782
|
-
* @memberof CreateApplicationGroupRequest
|
|
783
415
|
*/
|
|
784
416
|
'name': string;
|
|
785
417
|
}
|
|
786
|
-
/**
|
|
787
|
-
*
|
|
788
|
-
* @export
|
|
789
|
-
* @interface CreateApplicationProperties
|
|
790
|
-
*/
|
|
791
418
|
export interface CreateApplicationProperties {
|
|
792
|
-
/**
|
|
793
|
-
*
|
|
794
|
-
* @type {ApplicationPropertiesPosition}
|
|
795
|
-
* @memberof CreateApplicationProperties
|
|
796
|
-
*/
|
|
797
419
|
'position'?: ApplicationPropertiesPosition | null;
|
|
798
|
-
/**
|
|
799
|
-
*
|
|
800
|
-
* @type {ApplicationPropertiesPositionInference}
|
|
801
|
-
* @memberof CreateApplicationProperties
|
|
802
|
-
*/
|
|
803
420
|
'positionInference'?: ApplicationPropertiesPositionInference | null;
|
|
804
421
|
/**
|
|
805
422
|
* An array of text lines.
|
|
806
|
-
* @type {Array<string>}
|
|
807
|
-
* @memberof CreateApplicationProperties
|
|
808
423
|
*/
|
|
809
424
|
'lines'?: Array<string>;
|
|
810
425
|
/**
|
|
811
426
|
* The font to be used for the text. This font must be available in the PodOS font library.
|
|
812
|
-
* @type {string}
|
|
813
|
-
* @memberof CreateApplicationProperties
|
|
814
427
|
*/
|
|
815
428
|
'font'?: string;
|
|
816
429
|
/**
|
|
817
430
|
* The size of the text in pixels.
|
|
818
|
-
* @type {number}
|
|
819
|
-
* @memberof CreateApplicationProperties
|
|
820
431
|
*/
|
|
821
432
|
'fontSize'?: number;
|
|
822
433
|
/**
|
|
823
434
|
* The weight of the text. This must be a valid CSS font-weight value.
|
|
824
|
-
* @type {string}
|
|
825
|
-
* @memberof CreateApplicationProperties
|
|
826
435
|
*/
|
|
827
436
|
'fontWeight'?: CreateApplicationPropertiesFontWeightEnum;
|
|
828
437
|
/**
|
|
829
438
|
* The style of the text. This must be a valid CSS font-style value.
|
|
830
|
-
* @type {string}
|
|
831
|
-
* @memberof CreateApplicationProperties
|
|
832
439
|
*/
|
|
833
440
|
'fontStyle'?: CreateApplicationPropertiesFontStyleEnum;
|
|
834
441
|
/**
|
|
835
442
|
* The colour of the text in hex format.
|
|
836
|
-
* @type {string}
|
|
837
|
-
* @memberof CreateApplicationProperties
|
|
838
443
|
*/
|
|
839
444
|
'color'?: string;
|
|
445
|
+
/**
|
|
446
|
+
* The rotation of the text in degrees.
|
|
447
|
+
*/
|
|
448
|
+
'rotation'?: number;
|
|
840
449
|
/**
|
|
841
450
|
* Width of the application in pixels
|
|
842
|
-
* @type {number}
|
|
843
|
-
* @memberof CreateApplicationProperties
|
|
844
451
|
*/
|
|
845
452
|
'width'?: number | null;
|
|
846
453
|
/**
|
|
847
454
|
* Height of the application in pixels
|
|
848
|
-
* @type {number}
|
|
849
|
-
* @memberof CreateApplicationProperties
|
|
850
455
|
*/
|
|
851
456
|
'height'?: number | null;
|
|
852
|
-
/**
|
|
853
|
-
*
|
|
854
|
-
* @type {ApplicationPropertiesMetadata}
|
|
855
|
-
* @memberof CreateApplicationProperties
|
|
856
|
-
*/
|
|
857
457
|
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
858
458
|
}
|
|
859
459
|
export declare const CreateApplicationPropertiesFontWeightEnum: {
|
|
@@ -869,714 +469,384 @@ export declare const CreateApplicationPropertiesFontStyleEnum: {
|
|
|
869
469
|
readonly Oblique: "oblique";
|
|
870
470
|
};
|
|
871
471
|
export type CreateApplicationPropertiesFontStyleEnum = typeof CreateApplicationPropertiesFontStyleEnum[keyof typeof CreateApplicationPropertiesFontStyleEnum];
|
|
872
|
-
/**
|
|
873
|
-
*
|
|
874
|
-
* @export
|
|
875
|
-
* @interface CreateApplicationSetRequest
|
|
876
|
-
*/
|
|
877
472
|
export interface CreateApplicationSetRequest {
|
|
878
473
|
/**
|
|
879
474
|
* Name of the application set
|
|
880
|
-
* @type {string}
|
|
881
|
-
* @memberof CreateApplicationSetRequest
|
|
882
475
|
*/
|
|
883
476
|
'name': string;
|
|
884
477
|
/**
|
|
885
478
|
* Description of the application set
|
|
886
|
-
* @type {string}
|
|
887
|
-
* @memberof CreateApplicationSetRequest
|
|
888
479
|
*/
|
|
889
480
|
'description'?: string;
|
|
890
481
|
/**
|
|
891
482
|
* The width, in pixels of the images in the set
|
|
892
|
-
* @type {number}
|
|
893
|
-
* @memberof CreateApplicationSetRequest
|
|
894
483
|
*/
|
|
895
484
|
'width': number;
|
|
896
485
|
/**
|
|
897
486
|
* The height, in pixels of the images in the set
|
|
898
|
-
* @type {number}
|
|
899
|
-
* @memberof CreateApplicationSetRequest
|
|
900
487
|
*/
|
|
901
488
|
'height': number;
|
|
902
489
|
/**
|
|
903
490
|
* The DPI used when printing the images in the set
|
|
904
|
-
* @type {number}
|
|
905
|
-
* @memberof CreateApplicationSetRequest
|
|
906
491
|
*/
|
|
907
492
|
'dpi': number;
|
|
908
493
|
/**
|
|
909
494
|
* List of application set records
|
|
910
|
-
* @type {Array<CreateApplicationSetRequestRecordsInner>}
|
|
911
|
-
* @memberof CreateApplicationSetRequest
|
|
912
495
|
*/
|
|
913
496
|
'records': Array<CreateApplicationSetRequestRecordsInner>;
|
|
914
497
|
}
|
|
915
|
-
/**
|
|
916
|
-
*
|
|
917
|
-
* @export
|
|
918
|
-
* @interface CreateApplicationSetRequestRecordsInner
|
|
919
|
-
*/
|
|
920
498
|
export interface CreateApplicationSetRequestRecordsInner {
|
|
921
499
|
/**
|
|
922
500
|
* List of attributes this record applies to. Providing an empty array will apply the application set to all variants.
|
|
923
|
-
* @type {Array<CreateApplicationSetRequestRecordsInnerAttributesInner>}
|
|
924
|
-
* @memberof CreateApplicationSetRequestRecordsInner
|
|
925
501
|
*/
|
|
926
502
|
'attributes'?: Array<CreateApplicationSetRequestRecordsInnerAttributesInner>;
|
|
927
503
|
/**
|
|
928
504
|
* List of applications for this record
|
|
929
|
-
* @type {Array<CreateApplication>}
|
|
930
|
-
* @memberof CreateApplicationSetRequestRecordsInner
|
|
931
505
|
*/
|
|
932
506
|
'applications'?: Array<CreateApplication>;
|
|
933
507
|
}
|
|
934
|
-
/**
|
|
935
|
-
*
|
|
936
|
-
* @export
|
|
937
|
-
* @interface CreateApplicationSetRequestRecordsInnerAttributesInner
|
|
938
|
-
*/
|
|
939
508
|
export interface CreateApplicationSetRequestRecordsInnerAttributesInner {
|
|
940
509
|
/**
|
|
941
510
|
* The name of the option type. e.g. Size, Colour
|
|
942
|
-
* @type {string}
|
|
943
|
-
* @memberof CreateApplicationSetRequestRecordsInnerAttributesInner
|
|
944
511
|
*/
|
|
945
512
|
'name': string;
|
|
946
513
|
/**
|
|
947
514
|
* The value of the option this record applies to
|
|
948
|
-
* @type {string}
|
|
949
|
-
* @memberof CreateApplicationSetRequestRecordsInnerAttributesInner
|
|
950
515
|
*/
|
|
951
516
|
'value': string;
|
|
952
517
|
}
|
|
953
|
-
/**
|
|
954
|
-
*
|
|
955
|
-
* @export
|
|
956
|
-
* @interface CreateBundleProduct
|
|
957
|
-
*/
|
|
958
518
|
export interface CreateBundleProduct {
|
|
959
519
|
/**
|
|
960
520
|
* Product title
|
|
961
|
-
* @type {string}
|
|
962
|
-
* @memberof CreateBundleProduct
|
|
963
521
|
*/
|
|
964
522
|
'title'?: string;
|
|
965
523
|
/**
|
|
966
524
|
* Product description
|
|
967
|
-
* @type {string}
|
|
968
|
-
* @memberof CreateBundleProduct
|
|
969
525
|
*/
|
|
970
526
|
'description'?: string;
|
|
971
527
|
/**
|
|
972
528
|
* Whether the product is enabled upon creation.
|
|
973
|
-
* @type {boolean}
|
|
974
|
-
* @memberof CreateBundleProduct
|
|
975
529
|
*/
|
|
976
530
|
'enabled'?: boolean;
|
|
977
531
|
/**
|
|
978
532
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
979
|
-
* @type {string}
|
|
980
|
-
* @memberof CreateBundleProduct
|
|
981
533
|
*/
|
|
982
534
|
'slug'?: string;
|
|
983
|
-
/**
|
|
984
|
-
*
|
|
985
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
986
|
-
* @memberof CreateBundleProduct
|
|
987
|
-
*/
|
|
988
535
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
989
536
|
/**
|
|
990
537
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
991
|
-
* @type {string}
|
|
992
|
-
* @memberof CreateBundleProduct
|
|
993
538
|
*/
|
|
994
539
|
'targetSearchPhrase'?: string;
|
|
995
540
|
/**
|
|
996
541
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
997
|
-
* @type {Array<string>}
|
|
998
|
-
* @memberof CreateBundleProduct
|
|
999
542
|
*/
|
|
1000
543
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1001
544
|
/**
|
|
1002
545
|
* Additional product tags used for searching and filtering.
|
|
1003
|
-
* @type {Array<string>}
|
|
1004
|
-
* @memberof CreateBundleProduct
|
|
1005
546
|
*/
|
|
1006
547
|
'tags'?: Array<string>;
|
|
1007
548
|
/**
|
|
1008
549
|
* Internal tags used for internal searching and filtering.
|
|
1009
|
-
* @type {Array<string>}
|
|
1010
|
-
* @memberof CreateBundleProduct
|
|
1011
550
|
*/
|
|
1012
551
|
'internalTags'?: Array<string>;
|
|
1013
552
|
/**
|
|
1014
553
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
1015
|
-
* @type {Array<CreateProductImagesInner>}
|
|
1016
|
-
* @memberof CreateBundleProduct
|
|
1017
554
|
*/
|
|
1018
555
|
'images'?: Array<CreateProductImagesInner>;
|
|
1019
556
|
/**
|
|
1020
557
|
* Videos to attach to the product.
|
|
1021
|
-
* @type {Array<CreateProductVideosInner>}
|
|
1022
|
-
* @memberof CreateBundleProduct
|
|
1023
558
|
*/
|
|
1024
559
|
'videos'?: Array<CreateProductVideosInner>;
|
|
1025
560
|
/**
|
|
1026
561
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1027
|
-
* @type {Array<CreateProductAdditionalFilesInner>}
|
|
1028
|
-
* @memberof CreateBundleProduct
|
|
1029
562
|
*/
|
|
1030
563
|
'additionalFiles'?: Array<CreateProductAdditionalFilesInner>;
|
|
1031
564
|
/**
|
|
1032
565
|
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
1033
|
-
* @type {number}
|
|
1034
|
-
* @memberof CreateBundleProduct
|
|
1035
566
|
*/
|
|
1036
567
|
'shopifyId'?: number | null;
|
|
1037
568
|
/**
|
|
1038
569
|
* Key/value pairs that can be used to store additional information about the product
|
|
1039
|
-
* @type {Array<MetaField>}
|
|
1040
|
-
* @memberof CreateBundleProduct
|
|
1041
570
|
*/
|
|
1042
571
|
'metafields'?: Array<MetaField>;
|
|
1043
572
|
/**
|
|
1044
573
|
* A list of product uuids to include in this bundle
|
|
1045
|
-
* @type {Array<string>}
|
|
1046
|
-
* @memberof CreateBundleProduct
|
|
1047
574
|
*/
|
|
1048
575
|
'bundleItems': Array<string>;
|
|
1049
|
-
/**
|
|
1050
|
-
*
|
|
1051
|
-
* @type {Price}
|
|
1052
|
-
* @memberof CreateBundleProduct
|
|
1053
|
-
*/
|
|
1054
576
|
'retailPrice'?: Price;
|
|
1055
|
-
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @type {SalePrice}
|
|
1058
|
-
* @memberof CreateBundleProduct
|
|
1059
|
-
*/
|
|
1060
577
|
'salePrice'?: SalePrice | null;
|
|
1061
|
-
/**
|
|
1062
|
-
*
|
|
1063
|
-
* @type {Price}
|
|
1064
|
-
* @memberof CreateBundleProduct
|
|
1065
|
-
*/
|
|
1066
578
|
'price'?: Price;
|
|
1067
579
|
}
|
|
1068
|
-
/**
|
|
1069
|
-
*
|
|
1070
|
-
* @export
|
|
1071
|
-
* @interface CreateProduct
|
|
1072
|
-
*/
|
|
1073
580
|
export interface CreateProduct {
|
|
1074
581
|
/**
|
|
1075
582
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
1076
|
-
* @type {string}
|
|
1077
|
-
* @memberof CreateProduct
|
|
1078
583
|
*/
|
|
1079
584
|
'gfnProductRef': string;
|
|
1080
585
|
/**
|
|
1081
586
|
* Product title
|
|
1082
|
-
* @type {string}
|
|
1083
|
-
* @memberof CreateProduct
|
|
1084
587
|
*/
|
|
1085
588
|
'title'?: string;
|
|
1086
589
|
/**
|
|
1087
590
|
* Product description
|
|
1088
|
-
* @type {string}
|
|
1089
|
-
* @memberof CreateProduct
|
|
1090
591
|
*/
|
|
1091
592
|
'description'?: string;
|
|
1092
593
|
/**
|
|
1093
594
|
* Whether the product is enabled upon creation.
|
|
1094
|
-
* @type {boolean}
|
|
1095
|
-
* @memberof CreateProduct
|
|
1096
595
|
*/
|
|
1097
596
|
'enabled'?: boolean;
|
|
1098
597
|
/**
|
|
1099
598
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
1100
|
-
* @type {string}
|
|
1101
|
-
* @memberof CreateProduct
|
|
1102
599
|
*/
|
|
1103
600
|
'slug'?: string;
|
|
1104
601
|
/**
|
|
1105
602
|
* The brand of the product.
|
|
1106
|
-
* @type {string}
|
|
1107
|
-
* @memberof CreateProduct
|
|
1108
603
|
*/
|
|
1109
604
|
'brand'?: string | null;
|
|
1110
|
-
/**
|
|
1111
|
-
*
|
|
1112
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
1113
|
-
* @memberof CreateProduct
|
|
1114
|
-
*/
|
|
1115
605
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
1116
606
|
/**
|
|
1117
607
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
1118
|
-
* @type {string}
|
|
1119
|
-
* @memberof CreateProduct
|
|
1120
608
|
*/
|
|
1121
609
|
'targetSearchPhrase'?: string;
|
|
1122
610
|
/**
|
|
1123
611
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
1124
|
-
* @type {Array<string>}
|
|
1125
|
-
* @memberof CreateProduct
|
|
1126
612
|
*/
|
|
1127
613
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1128
614
|
/**
|
|
1129
615
|
* Additional product tags used for searching and filtering.
|
|
1130
|
-
* @type {Array<string>}
|
|
1131
|
-
* @memberof CreateProduct
|
|
1132
616
|
*/
|
|
1133
617
|
'tags'?: Array<string>;
|
|
1134
618
|
/**
|
|
1135
619
|
* Internal tags used for internal searching and filtering.
|
|
1136
|
-
* @type {Array<string>}
|
|
1137
|
-
* @memberof CreateProduct
|
|
1138
620
|
*/
|
|
1139
621
|
'internalTags'?: Array<string>;
|
|
1140
622
|
/**
|
|
1141
623
|
* Variants
|
|
1142
|
-
* @type {Array<CreateProductVariant>}
|
|
1143
|
-
* @memberof CreateProduct
|
|
1144
624
|
*/
|
|
1145
625
|
'variants': Array<CreateProductVariant>;
|
|
1146
626
|
/**
|
|
1147
627
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
1148
|
-
* @type {Array<CreateProductImagesInner>}
|
|
1149
|
-
* @memberof CreateProduct
|
|
1150
628
|
*/
|
|
1151
629
|
'images'?: Array<CreateProductImagesInner>;
|
|
1152
630
|
/**
|
|
1153
631
|
* Videos to attach to the product.
|
|
1154
|
-
* @type {Array<CreateProductVideosInner>}
|
|
1155
|
-
* @memberof CreateProduct
|
|
1156
632
|
*/
|
|
1157
633
|
'videos'?: Array<CreateProductVideosInner>;
|
|
1158
634
|
/**
|
|
1159
635
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1160
|
-
* @type {Array<CreateProductAdditionalFilesInner>}
|
|
1161
|
-
* @memberof CreateProduct
|
|
1162
636
|
*/
|
|
1163
637
|
'additionalFiles'?: Array<CreateProductAdditionalFilesInner>;
|
|
1164
638
|
/**
|
|
1165
639
|
* List of application set UUIDs to associate with this product
|
|
1166
|
-
* @type {Array<string>}
|
|
1167
|
-
* @memberof CreateProduct
|
|
1168
640
|
*/
|
|
1169
641
|
'applicationSets'?: Array<string>;
|
|
1170
642
|
/**
|
|
1171
643
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1172
|
-
* @type {boolean}
|
|
1173
|
-
* @memberof CreateProduct
|
|
1174
644
|
*/
|
|
1175
645
|
'includeInDataFeeds'?: boolean;
|
|
1176
646
|
/**
|
|
1177
647
|
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
1178
|
-
* @type {number}
|
|
1179
|
-
* @memberof CreateProduct
|
|
1180
648
|
*/
|
|
1181
649
|
'shopifyId'?: number | null;
|
|
1182
650
|
/**
|
|
1183
651
|
* Key/value pairs that can be used to store additional information about the product
|
|
1184
|
-
* @type {Array<MetaField>}
|
|
1185
|
-
* @memberof CreateProduct
|
|
1186
652
|
*/
|
|
1187
653
|
'metafields'?: Array<MetaField>;
|
|
1188
654
|
/**
|
|
1189
655
|
* A JSON object that defines the personalization template for the product.
|
|
1190
|
-
* @type {string}
|
|
1191
|
-
* @memberof CreateProduct
|
|
1192
656
|
*/
|
|
1193
657
|
'personalizationTemplate'?: string;
|
|
1194
658
|
}
|
|
1195
|
-
/**
|
|
1196
|
-
*
|
|
1197
|
-
* @export
|
|
1198
|
-
* @interface CreateProductAdditionalFilesInner
|
|
1199
|
-
*/
|
|
1200
659
|
export interface CreateProductAdditionalFilesInner {
|
|
1201
660
|
/**
|
|
1202
661
|
* Publicly available file URL.
|
|
1203
|
-
* @type {string}
|
|
1204
|
-
* @memberof CreateProductAdditionalFilesInner
|
|
1205
662
|
*/
|
|
1206
663
|
'src'?: string;
|
|
1207
664
|
}
|
|
1208
|
-
/**
|
|
1209
|
-
*
|
|
1210
|
-
* @export
|
|
1211
|
-
* @interface CreateProductImagesInner
|
|
1212
|
-
*/
|
|
1213
665
|
export interface CreateProductImagesInner {
|
|
1214
666
|
/**
|
|
1215
667
|
* Publicly available file URL.
|
|
1216
|
-
* @type {string}
|
|
1217
|
-
* @memberof CreateProductImagesInner
|
|
1218
668
|
*/
|
|
1219
669
|
'src'?: string;
|
|
1220
670
|
/**
|
|
1221
671
|
* Image type.
|
|
1222
|
-
* @type {string}
|
|
1223
|
-
* @memberof CreateProductImagesInner
|
|
1224
672
|
*/
|
|
1225
673
|
'type'?: string | null;
|
|
1226
674
|
}
|
|
1227
675
|
/**
|
|
1228
676
|
* @type CreateProductRequest
|
|
1229
|
-
* @export
|
|
1230
677
|
*/
|
|
1231
678
|
export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
1232
|
-
/**
|
|
1233
|
-
*
|
|
1234
|
-
* @export
|
|
1235
|
-
* @interface CreateProductVariant
|
|
1236
|
-
*/
|
|
1237
679
|
export interface CreateProductVariant {
|
|
1238
680
|
/**
|
|
1239
681
|
* Attributes associated to a variant such as Colour and Size.
|
|
1240
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
1241
|
-
* @memberof CreateProductVariant
|
|
1242
682
|
*/
|
|
1243
683
|
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
1244
|
-
/**
|
|
1245
|
-
*
|
|
1246
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
1247
|
-
* @memberof CreateProductVariant
|
|
1248
|
-
*/
|
|
1249
684
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
1250
|
-
/**
|
|
1251
|
-
*
|
|
1252
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
1253
|
-
* @memberof CreateProductVariant
|
|
1254
|
-
*/
|
|
1255
685
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
1256
686
|
/**
|
|
1257
687
|
* A custom stock keeping unit for the variant.
|
|
1258
|
-
* @type {string}
|
|
1259
|
-
* @memberof CreateProductVariant
|
|
1260
688
|
*/
|
|
1261
689
|
'sku'?: string;
|
|
1262
690
|
/**
|
|
1263
691
|
* Design applications. If not provided, the product will be blank.
|
|
1264
|
-
* @type {Array<Application>}
|
|
1265
|
-
* @memberof CreateProductVariant
|
|
1266
692
|
*/
|
|
1267
693
|
'applications'?: Array<Application>;
|
|
1268
694
|
/**
|
|
1269
695
|
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the warehouse product provided. Accepts PNG and JPEG files.
|
|
1270
|
-
* @type {Array<CreateProductVariantImagesInner>}
|
|
1271
|
-
* @memberof CreateProductVariant
|
|
1272
696
|
*/
|
|
1273
697
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
1274
698
|
/**
|
|
1275
699
|
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
|
|
1276
|
-
* @type {string}
|
|
1277
|
-
* @memberof CreateProductVariant
|
|
1278
700
|
*/
|
|
1279
701
|
'barcode'?: string | null;
|
|
1280
702
|
/**
|
|
1281
703
|
* For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one.
|
|
1282
|
-
* @type {number}
|
|
1283
|
-
* @memberof CreateProductVariant
|
|
1284
704
|
*/
|
|
1285
705
|
'shopifyId'?: number | null;
|
|
1286
|
-
/**
|
|
1287
|
-
*
|
|
1288
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}
|
|
1289
|
-
* @memberof CreateProductVariant
|
|
1290
|
-
*/
|
|
1291
706
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1292
707
|
}
|
|
1293
|
-
/**
|
|
1294
|
-
*
|
|
1295
|
-
* @export
|
|
1296
|
-
* @interface CreateProductVariantImagesInner
|
|
1297
|
-
*/
|
|
1298
708
|
export interface CreateProductVariantImagesInner {
|
|
709
|
+
/**
|
|
710
|
+
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
711
|
+
*/
|
|
712
|
+
'id'?: string | null;
|
|
1299
713
|
/**
|
|
1300
714
|
* Publicly available file URL.
|
|
1301
|
-
* @type {string}
|
|
1302
|
-
* @memberof CreateProductVariantImagesInner
|
|
1303
715
|
*/
|
|
1304
716
|
'src'?: string;
|
|
1305
717
|
}
|
|
1306
|
-
/**
|
|
1307
|
-
*
|
|
1308
|
-
* @export
|
|
1309
|
-
* @interface CreateProductVideosInner
|
|
1310
|
-
*/
|
|
1311
718
|
export interface CreateProductVideosInner {
|
|
1312
719
|
/**
|
|
1313
720
|
* Publicly available file URL.
|
|
1314
|
-
* @type {string}
|
|
1315
|
-
* @memberof CreateProductVideosInner
|
|
1316
721
|
*/
|
|
1317
722
|
'src'?: string;
|
|
1318
723
|
}
|
|
1319
|
-
/**
|
|
1320
|
-
*
|
|
1321
|
-
* @export
|
|
1322
|
-
* @interface DeleteProductsRequest
|
|
1323
|
-
*/
|
|
1324
724
|
export interface DeleteProductsRequest {
|
|
1325
|
-
/**
|
|
1326
|
-
*
|
|
1327
|
-
* @type {Array<string>}
|
|
1328
|
-
* @memberof DeleteProductsRequest
|
|
1329
|
-
*/
|
|
1330
725
|
'products'?: Array<string>;
|
|
1331
726
|
}
|
|
1332
|
-
/**
|
|
1333
|
-
*
|
|
1334
|
-
* @export
|
|
1335
|
-
* @interface DuplicateProducts202Response
|
|
1336
|
-
*/
|
|
1337
727
|
export interface DuplicateProducts202Response {
|
|
1338
728
|
/**
|
|
1339
729
|
* A message describing the duplication status
|
|
1340
|
-
* @type {string}
|
|
1341
|
-
* @memberof DuplicateProducts202Response
|
|
1342
730
|
*/
|
|
1343
731
|
'message'?: string;
|
|
1344
732
|
}
|
|
1345
|
-
/**
|
|
1346
|
-
*
|
|
1347
|
-
* @export
|
|
1348
|
-
* @interface DuplicateProductsRequest
|
|
1349
|
-
*/
|
|
1350
733
|
export interface DuplicateProductsRequest {
|
|
1351
734
|
/**
|
|
1352
735
|
* A set of product IDs to duplicate.
|
|
1353
|
-
* @type {Array<string>}
|
|
1354
|
-
* @memberof DuplicateProductsRequest
|
|
1355
736
|
*/
|
|
1356
737
|
'ids': Array<string>;
|
|
1357
738
|
/**
|
|
1358
739
|
* A set of project IDs to duplicate the products to.
|
|
1359
|
-
* @type {Array<string>}
|
|
1360
|
-
* @memberof DuplicateProductsRequest
|
|
1361
740
|
*/
|
|
1362
741
|
'projects': Array<string>;
|
|
1363
742
|
}
|
|
1364
|
-
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @export
|
|
1367
|
-
* @interface ExportProducts202Response
|
|
1368
|
-
*/
|
|
1369
743
|
export interface ExportProducts202Response {
|
|
1370
744
|
/**
|
|
1371
745
|
* A message describing the export status
|
|
1372
|
-
* @type {string}
|
|
1373
|
-
* @memberof ExportProducts202Response
|
|
1374
746
|
*/
|
|
1375
747
|
'message'?: string;
|
|
1376
748
|
}
|
|
1377
749
|
/**
|
|
1378
750
|
* Image description
|
|
1379
|
-
* @export
|
|
1380
|
-
* @interface Image
|
|
1381
751
|
*/
|
|
1382
752
|
export interface Image {
|
|
1383
753
|
/**
|
|
1384
754
|
* Unique object identifier
|
|
1385
|
-
* @type {string}
|
|
1386
|
-
* @memberof Image
|
|
1387
755
|
*/
|
|
1388
756
|
'id'?: string;
|
|
1389
|
-
/**
|
|
1390
|
-
*
|
|
1391
|
-
* @type {string}
|
|
1392
|
-
* @memberof Image
|
|
1393
|
-
*/
|
|
1394
757
|
'src': string;
|
|
1395
|
-
/**
|
|
1396
|
-
*
|
|
1397
|
-
* @type {string}
|
|
1398
|
-
* @memberof Image
|
|
1399
|
-
*/
|
|
1400
758
|
'type'?: string | null;
|
|
1401
|
-
/**
|
|
1402
|
-
*
|
|
1403
|
-
* @type {string}
|
|
1404
|
-
* @memberof Image
|
|
1405
|
-
*/
|
|
1406
759
|
'alt'?: string;
|
|
1407
760
|
/**
|
|
1408
761
|
* List of variant Ids
|
|
1409
|
-
* @type {Array<string>}
|
|
1410
|
-
* @memberof Image
|
|
1411
762
|
*/
|
|
1412
763
|
'variantIds'?: Array<string>;
|
|
1413
|
-
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @type {number}
|
|
1416
|
-
* @memberof Image
|
|
1417
|
-
*/
|
|
1418
764
|
'sortOrder'?: number;
|
|
1419
|
-
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @type {string}
|
|
1422
|
-
* @memberof Image
|
|
1423
|
-
*/
|
|
1424
765
|
'createdAt'?: string;
|
|
1425
|
-
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @type {string}
|
|
1428
|
-
* @memberof Image
|
|
1429
|
-
*/
|
|
1430
766
|
'updatedAt'?: string;
|
|
1431
767
|
}
|
|
1432
|
-
/**
|
|
1433
|
-
*
|
|
1434
|
-
* @export
|
|
1435
|
-
* @interface ImageFile
|
|
1436
|
-
*/
|
|
1437
768
|
export interface ImageFile {
|
|
1438
769
|
/**
|
|
1439
770
|
* Publicly available file URL.
|
|
1440
|
-
* @type {string}
|
|
1441
|
-
* @memberof ImageFile
|
|
1442
771
|
*/
|
|
1443
772
|
'src': string;
|
|
1444
773
|
/**
|
|
1445
774
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
1446
|
-
* @type {string}
|
|
1447
|
-
* @memberof ImageFile
|
|
1448
775
|
*/
|
|
1449
776
|
'id'?: string | null;
|
|
1450
777
|
/**
|
|
1451
778
|
* Image type.
|
|
1452
|
-
* @type {string}
|
|
1453
|
-
* @memberof ImageFile
|
|
1454
779
|
*/
|
|
1455
780
|
'type'?: string | null;
|
|
1456
781
|
/**
|
|
1457
782
|
* List of variant Ids to associate with the image.
|
|
1458
|
-
* @type {Array<string>}
|
|
1459
|
-
* @memberof ImageFile
|
|
1460
783
|
*/
|
|
1461
784
|
'variantIds'?: Array<string>;
|
|
1462
|
-
/**
|
|
1463
|
-
*
|
|
1464
|
-
* @type {ImageFileFocalPoint}
|
|
1465
|
-
* @memberof ImageFile
|
|
1466
|
-
*/
|
|
1467
785
|
'focalPoint'?: ImageFileFocalPoint;
|
|
1468
786
|
/**
|
|
1469
787
|
* The zoom level of the image, used for cropping the image when it\'s rendered to specific dimensions.
|
|
1470
|
-
* @type {number}
|
|
1471
|
-
* @memberof ImageFile
|
|
1472
788
|
*/
|
|
1473
789
|
'zoom'?: number;
|
|
1474
790
|
}
|
|
1475
791
|
/**
|
|
1476
792
|
* The focal point of the image, used for positioning the image when it\'s rendered to specific dimensions.
|
|
1477
|
-
* @export
|
|
1478
|
-
* @interface ImageFileFocalPoint
|
|
1479
793
|
*/
|
|
1480
794
|
export interface ImageFileFocalPoint {
|
|
1481
795
|
/**
|
|
1482
796
|
* The x-coordinate of the focal point, where 0 is the left edge and 1 is the right edge.
|
|
1483
|
-
* @type {number}
|
|
1484
|
-
* @memberof ImageFileFocalPoint
|
|
1485
797
|
*/
|
|
1486
798
|
'x': number;
|
|
1487
799
|
/**
|
|
1488
800
|
* The y-coordinate of the focal point, where 0 is the top edge and 1 is the bottom edge.
|
|
1489
|
-
* @type {number}
|
|
1490
|
-
* @memberof ImageFileFocalPoint
|
|
1491
801
|
*/
|
|
1492
802
|
'y': number;
|
|
1493
803
|
}
|
|
1494
|
-
|
|
1495
|
-
*
|
|
1496
|
-
* @export
|
|
1497
|
-
* @interface InlineObject
|
|
1498
|
-
*/
|
|
1499
|
-
export interface InlineObject {
|
|
804
|
+
export interface ImportProducts200Response {
|
|
1500
805
|
/**
|
|
1501
806
|
* Id of the product import
|
|
1502
|
-
* @type {string}
|
|
1503
|
-
* @memberof InlineObject
|
|
1504
807
|
*/
|
|
1505
808
|
'importId'?: string;
|
|
1506
809
|
}
|
|
1507
|
-
/**
|
|
1508
|
-
*
|
|
1509
|
-
* @export
|
|
1510
|
-
* @interface Location
|
|
1511
|
-
*/
|
|
1512
810
|
export interface Location {
|
|
1513
811
|
/**
|
|
1514
812
|
* The total number of units available at the location
|
|
1515
|
-
* @type {number}
|
|
1516
|
-
* @memberof Location
|
|
1517
813
|
*/
|
|
1518
814
|
'level': number;
|
|
1519
815
|
/**
|
|
1520
816
|
* ISO alpha-2 country code
|
|
1521
|
-
* @type {string}
|
|
1522
|
-
* @memberof Location
|
|
1523
817
|
*/
|
|
1524
818
|
'country': string;
|
|
1525
819
|
}
|
|
1526
820
|
/**
|
|
1527
821
|
* Key/value pairs that can be used to store additional information on the product
|
|
1528
|
-
* @export
|
|
1529
|
-
* @interface MetaField
|
|
1530
822
|
*/
|
|
1531
823
|
export interface MetaField {
|
|
1532
824
|
/**
|
|
1533
825
|
* The key of the property
|
|
1534
|
-
* @type {string}
|
|
1535
|
-
* @memberof MetaField
|
|
1536
826
|
*/
|
|
1537
827
|
'key': string;
|
|
1538
828
|
/**
|
|
1539
829
|
* The string value of the property
|
|
1540
|
-
* @type {string}
|
|
1541
|
-
* @memberof MetaField
|
|
1542
830
|
*/
|
|
1543
831
|
'value': string;
|
|
1544
832
|
}
|
|
1545
|
-
/**
|
|
1546
|
-
*
|
|
1547
|
-
* @export
|
|
1548
|
-
* @interface OptimisationHistoryItem
|
|
1549
|
-
*/
|
|
1550
833
|
export interface OptimisationHistoryItem {
|
|
1551
834
|
/**
|
|
1552
835
|
* Unique object identifier
|
|
1553
|
-
* @type {string}
|
|
1554
|
-
* @memberof OptimisationHistoryItem
|
|
1555
836
|
*/
|
|
1556
837
|
'id'?: string;
|
|
1557
|
-
/**
|
|
1558
|
-
*
|
|
1559
|
-
* @type {string}
|
|
1560
|
-
* @memberof OptimisationHistoryItem
|
|
1561
|
-
*/
|
|
1562
838
|
'createdAt'?: string;
|
|
1563
839
|
}
|
|
1564
840
|
/**
|
|
1565
841
|
* Standard price definition that defines the amount, tax rate and currency.
|
|
1566
|
-
* @export
|
|
1567
|
-
* @interface Price
|
|
1568
842
|
*/
|
|
1569
843
|
export interface Price {
|
|
1570
844
|
/**
|
|
1571
845
|
* Price including tax in the specified currency.
|
|
1572
|
-
* @type {number}
|
|
1573
|
-
* @memberof Price
|
|
1574
846
|
*/
|
|
1575
847
|
'amount'?: number;
|
|
1576
848
|
/**
|
|
1577
849
|
* Currency code for the currency the price is valued in.
|
|
1578
|
-
* @type {string}
|
|
1579
|
-
* @memberof Price
|
|
1580
850
|
*/
|
|
1581
851
|
'currencyCode'?: PriceCurrencyCodeEnum;
|
|
1582
852
|
}
|
|
@@ -1584,340 +854,152 @@ export declare const PriceCurrencyCodeEnum: {
|
|
|
1584
854
|
readonly Gbp: "GBP";
|
|
1585
855
|
};
|
|
1586
856
|
export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
|
|
1587
|
-
/**
|
|
1588
|
-
*
|
|
1589
|
-
* @export
|
|
1590
|
-
* @interface Product
|
|
1591
|
-
*/
|
|
1592
857
|
export interface Product {
|
|
1593
858
|
/**
|
|
1594
859
|
* Unique object identifier
|
|
1595
|
-
* @type {string}
|
|
1596
|
-
* @memberof Product
|
|
1597
860
|
*/
|
|
1598
861
|
'id'?: string;
|
|
1599
862
|
/**
|
|
1600
863
|
* A reference to the resource location
|
|
1601
|
-
* @type {string}
|
|
1602
|
-
* @memberof Product
|
|
1603
864
|
*/
|
|
1604
865
|
'ref'?: string;
|
|
1605
|
-
/**
|
|
1606
|
-
*
|
|
1607
|
-
* @type {string}
|
|
1608
|
-
* @memberof Product
|
|
1609
|
-
*/
|
|
1610
866
|
'title': string;
|
|
1611
|
-
/**
|
|
1612
|
-
*
|
|
1613
|
-
* @type {string}
|
|
1614
|
-
* @memberof Product
|
|
1615
|
-
*/
|
|
1616
867
|
'description': string;
|
|
1617
|
-
/**
|
|
1618
|
-
*
|
|
1619
|
-
* @type {string}
|
|
1620
|
-
* @memberof Product
|
|
1621
|
-
*/
|
|
1622
868
|
'slug'?: string;
|
|
1623
|
-
/**
|
|
1624
|
-
*
|
|
1625
|
-
* @type {string}
|
|
1626
|
-
* @memberof Product
|
|
1627
|
-
*/
|
|
1628
869
|
'brand'?: string;
|
|
1629
|
-
/**
|
|
1630
|
-
*
|
|
1631
|
-
* @type {boolean}
|
|
1632
|
-
* @memberof Product
|
|
1633
|
-
*/
|
|
1634
870
|
'enabled'?: boolean;
|
|
1635
|
-
/**
|
|
1636
|
-
*
|
|
1637
|
-
* @type {SEOMetadata}
|
|
1638
|
-
* @memberof Product
|
|
1639
|
-
*/
|
|
1640
871
|
'seoMetadata'?: SEOMetadata;
|
|
1641
|
-
/**
|
|
1642
|
-
*
|
|
1643
|
-
* @type {TargetSearchPhraseData}
|
|
1644
|
-
* @memberof Product
|
|
1645
|
-
*/
|
|
1646
872
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1647
|
-
/**
|
|
1648
|
-
*
|
|
1649
|
-
* @type {Array<string>}
|
|
1650
|
-
* @memberof Product
|
|
1651
|
-
*/
|
|
1652
873
|
'tags'?: Array<string>;
|
|
1653
|
-
/**
|
|
1654
|
-
*
|
|
1655
|
-
* @type {Array<string>}
|
|
1656
|
-
* @memberof Product
|
|
1657
|
-
*/
|
|
1658
874
|
'internalTags'?: Array<string>;
|
|
1659
|
-
/**
|
|
1660
|
-
*
|
|
1661
|
-
* @type {string}
|
|
1662
|
-
* @memberof Product
|
|
1663
|
-
*/
|
|
1664
875
|
'createdAt'?: string;
|
|
1665
|
-
/**
|
|
1666
|
-
*
|
|
1667
|
-
* @type {string}
|
|
1668
|
-
* @memberof Product
|
|
1669
|
-
*/
|
|
1670
876
|
'updatedAt'?: string;
|
|
1671
|
-
/**
|
|
1672
|
-
*
|
|
1673
|
-
* @type {string}
|
|
1674
|
-
* @memberof Product
|
|
1675
|
-
*/
|
|
1676
877
|
'publishedAt'?: string;
|
|
1677
878
|
/**
|
|
1678
879
|
* Images
|
|
1679
|
-
* @type {Array<Image>}
|
|
1680
|
-
* @memberof Product
|
|
1681
880
|
*/
|
|
1682
881
|
'images'?: Array<Image>;
|
|
1683
882
|
/**
|
|
1684
883
|
* Videos
|
|
1685
|
-
* @type {Array<Video>}
|
|
1686
|
-
* @memberof Product
|
|
1687
884
|
*/
|
|
1688
885
|
'videos'?: Array<Video>;
|
|
1689
886
|
/**
|
|
1690
887
|
* Variants
|
|
1691
|
-
* @type {Array<Variant>}
|
|
1692
|
-
* @memberof Product
|
|
1693
888
|
*/
|
|
1694
889
|
'variants'?: Array<Variant>;
|
|
1695
890
|
/**
|
|
1696
891
|
* Products in the bundle.
|
|
1697
|
-
* @type {Array<Product>}
|
|
1698
|
-
* @memberof Product
|
|
1699
892
|
*/
|
|
1700
893
|
'bundleItems'?: Array<Product>;
|
|
1701
|
-
/**
|
|
1702
|
-
*
|
|
1703
|
-
* @type {Price}
|
|
1704
|
-
* @memberof Product
|
|
1705
|
-
*/
|
|
1706
894
|
'retailPrice'?: Price;
|
|
1707
|
-
/**
|
|
1708
|
-
*
|
|
1709
|
-
* @type {SalePrice}
|
|
1710
|
-
* @memberof Product
|
|
1711
|
-
*/
|
|
1712
895
|
'salePrice'?: SalePrice | null;
|
|
1713
896
|
/**
|
|
1714
897
|
* Additional files attached to the product.
|
|
1715
|
-
* @type {Array<ProductAdditionalFilesInner>}
|
|
1716
|
-
* @memberof Product
|
|
1717
898
|
*/
|
|
1718
899
|
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1719
900
|
/**
|
|
1720
901
|
* List of application sets associated with this product
|
|
1721
|
-
* @type {Array<ProductApplicationSetsInner>}
|
|
1722
|
-
* @memberof Product
|
|
1723
902
|
*/
|
|
1724
903
|
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1725
904
|
/**
|
|
1726
905
|
* The average review rating. This field is only present if included in the fields query parameter
|
|
1727
|
-
* @type {number}
|
|
1728
|
-
* @memberof Product
|
|
1729
906
|
*/
|
|
1730
907
|
'reviewScore'?: number | null;
|
|
1731
908
|
/**
|
|
1732
909
|
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1733
|
-
* @type {number}
|
|
1734
|
-
* @memberof Product
|
|
1735
910
|
*/
|
|
1736
911
|
'reviewCount'?: number;
|
|
1737
|
-
/**
|
|
1738
|
-
*
|
|
1739
|
-
* @type {string}
|
|
1740
|
-
* @memberof Product
|
|
1741
|
-
*/
|
|
1742
912
|
'sku'?: string;
|
|
1743
913
|
/**
|
|
1744
914
|
* A count of sales. This field is only present if included in the fields query parameter
|
|
1745
|
-
* @type {number}
|
|
1746
|
-
* @memberof Product
|
|
1747
915
|
*/
|
|
1748
916
|
'sales'?: number;
|
|
1749
|
-
/**
|
|
1750
|
-
*
|
|
1751
|
-
* @type {string}
|
|
1752
|
-
* @memberof Product
|
|
1753
|
-
*/
|
|
1754
917
|
'salesStart'?: string;
|
|
1755
|
-
/**
|
|
1756
|
-
*
|
|
1757
|
-
* @type {string}
|
|
1758
|
-
* @memberof Product
|
|
1759
|
-
*/
|
|
1760
918
|
'salesEnd'?: string;
|
|
1761
|
-
/**
|
|
1762
|
-
*
|
|
1763
|
-
* @type {boolean}
|
|
1764
|
-
* @memberof Product
|
|
1765
|
-
*/
|
|
1766
919
|
'includeInDataFeeds'?: boolean;
|
|
1767
920
|
/**
|
|
1768
921
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1769
|
-
* @type {number}
|
|
1770
|
-
* @memberof Product
|
|
1771
922
|
*/
|
|
1772
923
|
'shopifyId'?: number | null;
|
|
1773
|
-
/**
|
|
1774
|
-
*
|
|
1775
|
-
* @type {ProductWarehouseProduct}
|
|
1776
|
-
* @memberof Product
|
|
1777
|
-
*/
|
|
1778
924
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1779
925
|
/**
|
|
1780
926
|
* Key/value pairs that can be used to store additional information about the product
|
|
1781
|
-
* @type {Array<MetaField>}
|
|
1782
|
-
* @memberof Product
|
|
1783
927
|
*/
|
|
1784
928
|
'metafields'?: Array<MetaField>;
|
|
1785
929
|
/**
|
|
1786
930
|
* a JSON string representing the personalization template for the product
|
|
1787
|
-
* @type {string}
|
|
1788
|
-
* @memberof Product
|
|
1789
931
|
*/
|
|
1790
932
|
'personalizationTemplate'?: string;
|
|
1791
933
|
/**
|
|
1792
934
|
* History of AI optimisations performed on the product
|
|
1793
|
-
* @type {Array<OptimisationHistoryItem>}
|
|
1794
|
-
* @memberof Product
|
|
1795
935
|
*/
|
|
1796
936
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1797
|
-
/**
|
|
1798
|
-
*
|
|
1799
|
-
* @type {Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>}
|
|
1800
|
-
* @memberof Product
|
|
1801
|
-
*/
|
|
1802
937
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1803
938
|
}
|
|
1804
|
-
/**
|
|
1805
|
-
*
|
|
1806
|
-
* @export
|
|
1807
|
-
* @interface ProductAdditionalFilesInner
|
|
1808
|
-
*/
|
|
1809
939
|
export interface ProductAdditionalFilesInner {
|
|
1810
940
|
/**
|
|
1811
941
|
* Unique object identifier
|
|
1812
|
-
* @type {string}
|
|
1813
|
-
* @memberof ProductAdditionalFilesInner
|
|
1814
942
|
*/
|
|
1815
943
|
'id'?: string;
|
|
1816
944
|
/**
|
|
1817
945
|
* File URL
|
|
1818
|
-
* @type {string}
|
|
1819
|
-
* @memberof ProductAdditionalFilesInner
|
|
1820
946
|
*/
|
|
1821
947
|
'src'?: string;
|
|
1822
948
|
}
|
|
1823
|
-
/**
|
|
1824
|
-
*
|
|
1825
|
-
* @export
|
|
1826
|
-
* @interface ProductApplicationSetsInner
|
|
1827
|
-
*/
|
|
1828
949
|
export interface ProductApplicationSetsInner {
|
|
1829
950
|
/**
|
|
1830
951
|
* Unique object identifier
|
|
1831
|
-
* @type {string}
|
|
1832
|
-
* @memberof ProductApplicationSetsInner
|
|
1833
952
|
*/
|
|
1834
953
|
'id'?: string;
|
|
1835
954
|
/**
|
|
1836
955
|
* A reference to the application set resource location
|
|
1837
|
-
* @type {string}
|
|
1838
|
-
* @memberof ProductApplicationSetsInner
|
|
1839
956
|
*/
|
|
1840
957
|
'ref'?: string;
|
|
1841
958
|
/**
|
|
1842
959
|
* Name of the application set
|
|
1843
|
-
* @type {string}
|
|
1844
|
-
* @memberof ProductApplicationSetsInner
|
|
1845
960
|
*/
|
|
1846
961
|
'name'?: string;
|
|
1847
962
|
}
|
|
1848
|
-
/**
|
|
1849
|
-
*
|
|
1850
|
-
* @export
|
|
1851
|
-
* @interface ProductWarehouseProduct
|
|
1852
|
-
*/
|
|
1853
963
|
export interface ProductWarehouseProduct {
|
|
1854
964
|
/**
|
|
1855
965
|
* Unique object identifier
|
|
1856
|
-
* @type {string}
|
|
1857
|
-
* @memberof ProductWarehouseProduct
|
|
1858
966
|
*/
|
|
1859
967
|
'id'?: string;
|
|
1860
968
|
/**
|
|
1861
969
|
* Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
1862
|
-
* @type {string}
|
|
1863
|
-
* @memberof ProductWarehouseProduct
|
|
1864
970
|
*/
|
|
1865
971
|
'gfnProductRef'?: string;
|
|
1866
972
|
}
|
|
1867
|
-
/**
|
|
1868
|
-
*
|
|
1869
|
-
* @export
|
|
1870
|
-
* @interface ProductsResponse
|
|
1871
|
-
*/
|
|
1872
973
|
export interface ProductsResponse {
|
|
1873
|
-
/**
|
|
1874
|
-
*
|
|
1875
|
-
* @type {Array<Product>}
|
|
1876
|
-
* @memberof ProductsResponse
|
|
1877
|
-
*/
|
|
1878
974
|
'products'?: Array<Product>;
|
|
1879
975
|
/**
|
|
1880
976
|
* The token referencing the next page number
|
|
1881
|
-
* @type {number}
|
|
1882
|
-
* @memberof ProductsResponse
|
|
1883
977
|
*/
|
|
1884
978
|
'nextPageToken'?: number | null;
|
|
1885
979
|
}
|
|
1886
980
|
/**
|
|
1887
981
|
* SEO metadata for the product
|
|
1888
|
-
* @export
|
|
1889
|
-
* @interface SEOMetadata
|
|
1890
982
|
*/
|
|
1891
983
|
export interface SEOMetadata {
|
|
1892
984
|
/**
|
|
1893
985
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
1894
|
-
* @type {string}
|
|
1895
|
-
* @memberof SEOMetadata
|
|
1896
986
|
*/
|
|
1897
987
|
'title'?: string;
|
|
1898
988
|
/**
|
|
1899
989
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1900
|
-
* @type {string}
|
|
1901
|
-
* @memberof SEOMetadata
|
|
1902
990
|
*/
|
|
1903
991
|
'description'?: string | null;
|
|
1904
992
|
}
|
|
1905
993
|
/**
|
|
1906
994
|
* Discounted price including tax.
|
|
1907
|
-
* @export
|
|
1908
|
-
* @interface SalePrice
|
|
1909
995
|
*/
|
|
1910
996
|
export interface SalePrice {
|
|
1911
997
|
/**
|
|
1912
998
|
* Discounted price including tax in the specified currency.
|
|
1913
|
-
* @type {number}
|
|
1914
|
-
* @memberof SalePrice
|
|
1915
999
|
*/
|
|
1916
1000
|
'amount': number;
|
|
1917
1001
|
/**
|
|
1918
1002
|
* Currency code for the currency the sale price is valued in.
|
|
1919
|
-
* @type {string}
|
|
1920
|
-
* @memberof SalePrice
|
|
1921
1003
|
*/
|
|
1922
1004
|
'currencyCode': SalePriceCurrencyCodeEnum;
|
|
1923
1005
|
}
|
|
@@ -1925,130 +1007,67 @@ export declare const SalePriceCurrencyCodeEnum: {
|
|
|
1925
1007
|
readonly Gbp: "GBP";
|
|
1926
1008
|
};
|
|
1927
1009
|
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1928
|
-
/**
|
|
1929
|
-
*
|
|
1930
|
-
* @export
|
|
1931
|
-
* @interface SeoOptimiseProducts202Response
|
|
1932
|
-
*/
|
|
1933
1010
|
export interface SeoOptimiseProducts202Response {
|
|
1934
1011
|
/**
|
|
1935
1012
|
* A message describing the optimisation status
|
|
1936
|
-
* @type {string}
|
|
1937
|
-
* @memberof SeoOptimiseProducts202Response
|
|
1938
1013
|
*/
|
|
1939
1014
|
'message'?: string;
|
|
1940
1015
|
}
|
|
1941
|
-
/**
|
|
1942
|
-
*
|
|
1943
|
-
* @export
|
|
1944
|
-
* @interface SeoOptimiseProductsRequest
|
|
1945
|
-
*/
|
|
1946
1016
|
export interface SeoOptimiseProductsRequest {
|
|
1947
1017
|
/**
|
|
1948
1018
|
* A set of product IDs to AI SEO optimise.
|
|
1949
|
-
* @type {Array<string>}
|
|
1950
|
-
* @memberof SeoOptimiseProductsRequest
|
|
1951
1019
|
*/
|
|
1952
1020
|
'ids'?: Array<string>;
|
|
1953
1021
|
/**
|
|
1954
1022
|
* If provided, only the specified fields will be updated.
|
|
1955
|
-
* @type {Array<string>}
|
|
1956
|
-
* @memberof SeoOptimiseProductsRequest
|
|
1957
1023
|
*/
|
|
1958
1024
|
'fields'?: Array<string>;
|
|
1959
1025
|
}
|
|
1960
|
-
/**
|
|
1961
|
-
*
|
|
1962
|
-
* @export
|
|
1963
|
-
* @interface Stock
|
|
1964
|
-
*/
|
|
1965
1026
|
export interface Stock {
|
|
1966
|
-
/**
|
|
1967
|
-
*
|
|
1968
|
-
* @type {number}
|
|
1969
|
-
* @memberof Stock
|
|
1970
|
-
*/
|
|
1971
1027
|
'level'?: number;
|
|
1972
|
-
/**
|
|
1973
|
-
*
|
|
1974
|
-
* @type {Array<Location>}
|
|
1975
|
-
* @memberof Stock
|
|
1976
|
-
*/
|
|
1977
1028
|
'locations'?: Array<Location>;
|
|
1978
1029
|
}
|
|
1979
|
-
/**
|
|
1980
|
-
*
|
|
1981
|
-
* @export
|
|
1982
|
-
* @interface TargetSearchPhraseData
|
|
1983
|
-
*/
|
|
1984
1030
|
export interface TargetSearchPhraseData {
|
|
1985
1031
|
/**
|
|
1986
1032
|
* The primary target search phrase for the product that you wish to rank for in search engine results.
|
|
1987
|
-
* @type {string}
|
|
1988
|
-
* @memberof TargetSearchPhraseData
|
|
1989
1033
|
*/
|
|
1990
1034
|
'targetSearchPhrase'?: string;
|
|
1991
1035
|
/**
|
|
1992
1036
|
* Synonyms for the target search phrase.
|
|
1993
|
-
* @type {Array<string>}
|
|
1994
|
-
* @memberof TargetSearchPhraseData
|
|
1995
1037
|
*/
|
|
1996
1038
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1997
1039
|
}
|
|
1998
|
-
/**
|
|
1999
|
-
*
|
|
2000
|
-
* @export
|
|
2001
|
-
* @interface TextApplicationProperties
|
|
2002
|
-
*/
|
|
2003
1040
|
export interface TextApplicationProperties {
|
|
2004
|
-
/**
|
|
2005
|
-
*
|
|
2006
|
-
* @type {TextApplicationPropertiesPosition}
|
|
2007
|
-
* @memberof TextApplicationProperties
|
|
2008
|
-
*/
|
|
2009
1041
|
'position'?: TextApplicationPropertiesPosition;
|
|
2010
|
-
/**
|
|
2011
|
-
*
|
|
2012
|
-
* @type {ApplicationPropertiesPositionInference}
|
|
2013
|
-
* @memberof TextApplicationProperties
|
|
2014
|
-
*/
|
|
2015
1042
|
'positionInference'?: ApplicationPropertiesPositionInference | null;
|
|
2016
1043
|
/**
|
|
2017
1044
|
* An array of text lines.
|
|
2018
|
-
* @type {Array<string>}
|
|
2019
|
-
* @memberof TextApplicationProperties
|
|
2020
1045
|
*/
|
|
2021
1046
|
'lines'?: Array<string>;
|
|
2022
1047
|
/**
|
|
2023
1048
|
* The font to be used for the text. This font must be available in the PodOS font library.
|
|
2024
|
-
* @type {string}
|
|
2025
|
-
* @memberof TextApplicationProperties
|
|
2026
1049
|
*/
|
|
2027
1050
|
'font'?: string;
|
|
2028
1051
|
/**
|
|
2029
1052
|
* The size of the text in pixels.
|
|
2030
|
-
* @type {number}
|
|
2031
|
-
* @memberof TextApplicationProperties
|
|
2032
1053
|
*/
|
|
2033
1054
|
'fontSize'?: number;
|
|
2034
1055
|
/**
|
|
2035
1056
|
* The weight of the text. This must be a valid CSS font-weight value.
|
|
2036
|
-
* @type {string}
|
|
2037
|
-
* @memberof TextApplicationProperties
|
|
2038
1057
|
*/
|
|
2039
1058
|
'fontWeight'?: TextApplicationPropertiesFontWeightEnum;
|
|
2040
1059
|
/**
|
|
2041
1060
|
* The style of the text. This must be a valid CSS font-style value.
|
|
2042
|
-
* @type {string}
|
|
2043
|
-
* @memberof TextApplicationProperties
|
|
2044
1061
|
*/
|
|
2045
1062
|
'fontStyle'?: TextApplicationPropertiesFontStyleEnum;
|
|
2046
1063
|
/**
|
|
2047
1064
|
* The colour of the text in hex format.
|
|
2048
|
-
* @type {string}
|
|
2049
|
-
* @memberof TextApplicationProperties
|
|
2050
1065
|
*/
|
|
2051
1066
|
'color'?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* The rotation of the text in degrees.
|
|
1069
|
+
*/
|
|
1070
|
+
'rotation'?: number;
|
|
2052
1071
|
}
|
|
2053
1072
|
export declare const TextApplicationPropertiesFontWeightEnum: {
|
|
2054
1073
|
readonly Lighter: "lighter";
|
|
@@ -2063,29 +1082,15 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
|
|
|
2063
1082
|
readonly Oblique: "oblique";
|
|
2064
1083
|
};
|
|
2065
1084
|
export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
|
|
2066
|
-
/**
|
|
2067
|
-
*
|
|
2068
|
-
* @export
|
|
2069
|
-
* @interface TextApplicationPropertiesPersonalization
|
|
2070
|
-
*/
|
|
2071
1085
|
export interface TextApplicationPropertiesPersonalization {
|
|
2072
1086
|
/**
|
|
2073
1087
|
* The label to be displayed on the personalization field.
|
|
2074
|
-
* @type {string}
|
|
2075
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2076
1088
|
*/
|
|
2077
1089
|
'label'?: string;
|
|
2078
1090
|
/**
|
|
2079
1091
|
* The type of the personalization field
|
|
2080
|
-
* @type {string}
|
|
2081
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2082
1092
|
*/
|
|
2083
1093
|
'type'?: TextApplicationPropertiesPersonalizationTypeEnum | null;
|
|
2084
|
-
/**
|
|
2085
|
-
*
|
|
2086
|
-
* @type {TextApplicationPropertiesPersonalizationRules}
|
|
2087
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2088
|
-
*/
|
|
2089
1094
|
'rules'?: TextApplicationPropertiesPersonalizationRules;
|
|
2090
1095
|
}
|
|
2091
1096
|
export declare const TextApplicationPropertiesPersonalizationTypeEnum: {
|
|
@@ -2093,533 +1098,289 @@ export declare const TextApplicationPropertiesPersonalizationTypeEnum: {
|
|
|
2093
1098
|
readonly Number: "number";
|
|
2094
1099
|
};
|
|
2095
1100
|
export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
|
|
2096
|
-
/**
|
|
2097
|
-
*
|
|
2098
|
-
* @export
|
|
2099
|
-
* @interface TextApplicationPropertiesPersonalizationRules
|
|
2100
|
-
*/
|
|
2101
1101
|
export interface TextApplicationPropertiesPersonalizationRules {
|
|
2102
1102
|
/**
|
|
2103
1103
|
* The maximum length of the text, in characters.
|
|
2104
|
-
* @type {number}
|
|
2105
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2106
1104
|
*/
|
|
2107
1105
|
'maxLength'?: number;
|
|
2108
1106
|
/**
|
|
2109
1107
|
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\"
|
|
2110
|
-
* @type {boolean}
|
|
2111
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2112
1108
|
*/
|
|
2113
1109
|
'profanityFilter'?: boolean;
|
|
2114
1110
|
/**
|
|
2115
1111
|
* If true, and the inputted text is longer than the original text, the font size will be reduced to keep the text within the application\'s original bounds.
|
|
2116
|
-
* @type {boolean}
|
|
2117
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2118
1112
|
*/
|
|
2119
1113
|
'scaleToFit'?: boolean;
|
|
2120
1114
|
/**
|
|
2121
1115
|
* The maximum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
2122
|
-
* @type {number}
|
|
2123
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2124
1116
|
*/
|
|
2125
1117
|
'maxValue'?: number;
|
|
2126
1118
|
/**
|
|
2127
1119
|
* The minimum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
2128
|
-
* @type {number}
|
|
2129
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2130
1120
|
*/
|
|
2131
1121
|
'minValue'?: number;
|
|
2132
1122
|
/**
|
|
2133
1123
|
* If the entered number is below the specified digits it will be padded with 0s. E.g. 7 will become 007 when pad is 3. Only valid when metadata.personalization.type is number
|
|
2134
|
-
* @type {number}
|
|
2135
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2136
1124
|
*/
|
|
2137
1125
|
'pad'?: number;
|
|
2138
1126
|
}
|
|
2139
|
-
/**
|
|
2140
|
-
*
|
|
2141
|
-
* @export
|
|
2142
|
-
* @interface TextApplicationPropertiesPosition
|
|
2143
|
-
*/
|
|
2144
1127
|
export interface TextApplicationPropertiesPosition {
|
|
2145
1128
|
/**
|
|
2146
1129
|
* The x position of the application in pixels.
|
|
2147
|
-
* @type {number}
|
|
2148
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2149
1130
|
*/
|
|
2150
1131
|
'x': number;
|
|
2151
1132
|
/**
|
|
2152
1133
|
* The y position of the application in pixels.
|
|
2153
|
-
* @type {number}
|
|
2154
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2155
1134
|
*/
|
|
2156
1135
|
'y': number;
|
|
2157
1136
|
/**
|
|
2158
1137
|
* The z layer of the application. This doesn\'t affect printing, but is used for ordering the applications when displaying them in a mockup.
|
|
2159
|
-
* @type {number}
|
|
2160
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2161
1138
|
*/
|
|
2162
1139
|
'z'?: number;
|
|
2163
1140
|
}
|
|
2164
|
-
/**
|
|
2165
|
-
*
|
|
2166
|
-
* @export
|
|
2167
|
-
* @interface UpdateApplicationGroupRequest
|
|
2168
|
-
*/
|
|
2169
1141
|
export interface UpdateApplicationGroupRequest {
|
|
2170
1142
|
/**
|
|
2171
1143
|
* Name of the application group
|
|
2172
|
-
* @type {string}
|
|
2173
|
-
* @memberof UpdateApplicationGroupRequest
|
|
2174
1144
|
*/
|
|
2175
1145
|
'name'?: string;
|
|
2176
1146
|
}
|
|
2177
|
-
/**
|
|
2178
|
-
*
|
|
2179
|
-
* @export
|
|
2180
|
-
* @interface UpdateApplicationSetRequest
|
|
2181
|
-
*/
|
|
2182
1147
|
export interface UpdateApplicationSetRequest {
|
|
2183
1148
|
/**
|
|
2184
1149
|
* Name of the application set
|
|
2185
|
-
* @type {string}
|
|
2186
|
-
* @memberof UpdateApplicationSetRequest
|
|
2187
1150
|
*/
|
|
2188
1151
|
'name'?: string;
|
|
2189
1152
|
/**
|
|
2190
1153
|
* Description of the application set
|
|
2191
|
-
* @type {string}
|
|
2192
|
-
* @memberof UpdateApplicationSetRequest
|
|
2193
1154
|
*/
|
|
2194
1155
|
'description'?: string;
|
|
2195
1156
|
/**
|
|
2196
1157
|
* The width, in pixels of the images in the set
|
|
2197
|
-
* @type {number}
|
|
2198
|
-
* @memberof UpdateApplicationSetRequest
|
|
2199
1158
|
*/
|
|
2200
1159
|
'width'?: number;
|
|
2201
1160
|
/**
|
|
2202
1161
|
* The height, in pixels of the images in the set
|
|
2203
|
-
* @type {number}
|
|
2204
|
-
* @memberof UpdateApplicationSetRequest
|
|
2205
1162
|
*/
|
|
2206
1163
|
'height'?: number;
|
|
2207
1164
|
/**
|
|
2208
1165
|
* The DPI used when printing the images in the set
|
|
2209
|
-
* @type {number}
|
|
2210
|
-
* @memberof UpdateApplicationSetRequest
|
|
2211
1166
|
*/
|
|
2212
1167
|
'dpi'?: number;
|
|
2213
1168
|
/**
|
|
2214
1169
|
* List of application set records
|
|
2215
|
-
* @type {Array<UpdateApplicationSetRequestRecordsInner>}
|
|
2216
|
-
* @memberof UpdateApplicationSetRequest
|
|
2217
1170
|
*/
|
|
2218
1171
|
'records'?: Array<UpdateApplicationSetRequestRecordsInner>;
|
|
2219
1172
|
}
|
|
2220
|
-
/**
|
|
2221
|
-
*
|
|
2222
|
-
* @export
|
|
2223
|
-
* @interface UpdateApplicationSetRequestRecordsInner
|
|
2224
|
-
*/
|
|
2225
1173
|
export interface UpdateApplicationSetRequestRecordsInner {
|
|
2226
1174
|
/**
|
|
2227
1175
|
* List of attributes this record applies to. Providing an empty array will apply the application set to all variants.
|
|
2228
|
-
* @type {Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>}
|
|
2229
|
-
* @memberof UpdateApplicationSetRequestRecordsInner
|
|
2230
1176
|
*/
|
|
2231
1177
|
'attributes'?: Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>;
|
|
2232
1178
|
/**
|
|
2233
1179
|
* List of applications for this record
|
|
2234
|
-
* @type {Array<Application>}
|
|
2235
|
-
* @memberof UpdateApplicationSetRequestRecordsInner
|
|
2236
1180
|
*/
|
|
2237
1181
|
'applications'?: Array<Application>;
|
|
2238
1182
|
}
|
|
2239
|
-
/**
|
|
2240
|
-
*
|
|
2241
|
-
* @export
|
|
2242
|
-
* @interface UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2243
|
-
*/
|
|
2244
1183
|
export interface UpdateApplicationSetRequestRecordsInnerAttributesInner {
|
|
2245
1184
|
/**
|
|
2246
1185
|
* The name of the option type. e.g. Size, Colour
|
|
2247
|
-
* @type {string}
|
|
2248
|
-
* @memberof UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2249
1186
|
*/
|
|
2250
1187
|
'name'?: string;
|
|
2251
1188
|
/**
|
|
2252
1189
|
* The value of the option this record applies to
|
|
2253
|
-
* @type {string}
|
|
2254
|
-
* @memberof UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2255
1190
|
*/
|
|
2256
1191
|
'value'?: string;
|
|
2257
1192
|
}
|
|
2258
|
-
/**
|
|
2259
|
-
*
|
|
2260
|
-
* @export
|
|
2261
|
-
* @interface UpdateProductRequest
|
|
2262
|
-
*/
|
|
2263
1193
|
export interface UpdateProductRequest {
|
|
2264
1194
|
/**
|
|
2265
1195
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
2266
|
-
* @type {string}
|
|
2267
|
-
* @memberof UpdateProductRequest
|
|
2268
1196
|
*/
|
|
2269
1197
|
'gfnProductRef'?: string;
|
|
2270
1198
|
/**
|
|
2271
1199
|
* Product title
|
|
2272
|
-
* @type {string}
|
|
2273
|
-
* @memberof UpdateProductRequest
|
|
2274
1200
|
*/
|
|
2275
1201
|
'title'?: string;
|
|
2276
1202
|
/**
|
|
2277
1203
|
* Product description
|
|
2278
|
-
* @type {string}
|
|
2279
|
-
* @memberof UpdateProductRequest
|
|
2280
1204
|
*/
|
|
2281
1205
|
'description'?: string;
|
|
2282
1206
|
/**
|
|
2283
1207
|
* Whether the product is enabled upon creation.
|
|
2284
|
-
* @type {boolean}
|
|
2285
|
-
* @memberof UpdateProductRequest
|
|
2286
1208
|
*/
|
|
2287
1209
|
'enabled'?: boolean;
|
|
2288
1210
|
/**
|
|
2289
1211
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
2290
|
-
* @type {string}
|
|
2291
|
-
* @memberof UpdateProductRequest
|
|
2292
1212
|
*/
|
|
2293
1213
|
'slug'?: string;
|
|
2294
1214
|
/**
|
|
2295
1215
|
* The brand of the product.
|
|
2296
|
-
* @type {string}
|
|
2297
|
-
* @memberof UpdateProductRequest
|
|
2298
1216
|
*/
|
|
2299
1217
|
'brand'?: string | null;
|
|
2300
|
-
/**
|
|
2301
|
-
*
|
|
2302
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
2303
|
-
* @memberof UpdateProductRequest
|
|
2304
|
-
*/
|
|
2305
1218
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
2306
1219
|
/**
|
|
2307
1220
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
2308
|
-
* @type {string}
|
|
2309
|
-
* @memberof UpdateProductRequest
|
|
2310
1221
|
*/
|
|
2311
1222
|
'targetSearchPhrase'?: string | null;
|
|
2312
1223
|
/**
|
|
2313
1224
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
2314
|
-
* @type {Array<string>}
|
|
2315
|
-
* @memberof UpdateProductRequest
|
|
2316
1225
|
*/
|
|
2317
1226
|
'targetSearchPhraseSynonyms'?: Array<string> | null;
|
|
2318
1227
|
/**
|
|
2319
1228
|
* Additional product tags used for searching and filtering.
|
|
2320
|
-
* @type {Array<string>}
|
|
2321
|
-
* @memberof UpdateProductRequest
|
|
2322
1229
|
*/
|
|
2323
1230
|
'tags'?: Array<string>;
|
|
2324
1231
|
/**
|
|
2325
1232
|
* Additional product tags used for internal searching and filtering.
|
|
2326
|
-
* @type {Array<string>}
|
|
2327
|
-
* @memberof UpdateProductRequest
|
|
2328
1233
|
*/
|
|
2329
1234
|
'internalTags'?: Array<string>;
|
|
2330
1235
|
/**
|
|
2331
1236
|
* Variants
|
|
2332
|
-
* @type {Array<CreateProductVariant>}
|
|
2333
|
-
* @memberof UpdateProductRequest
|
|
2334
1237
|
*/
|
|
2335
1238
|
'variants'?: Array<CreateProductVariant>;
|
|
2336
1239
|
/**
|
|
2337
1240
|
* A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
|
|
2338
|
-
* @type {Array<string>}
|
|
2339
|
-
* @memberof UpdateProductRequest
|
|
2340
1241
|
*/
|
|
2341
1242
|
'bundleItems'?: Array<string>;
|
|
2342
|
-
/**
|
|
2343
|
-
*
|
|
2344
|
-
* @type {Price}
|
|
2345
|
-
* @memberof UpdateProductRequest
|
|
2346
|
-
*/
|
|
2347
1243
|
'retailPrice'?: Price;
|
|
2348
|
-
/**
|
|
2349
|
-
*
|
|
2350
|
-
* @type {SalePrice}
|
|
2351
|
-
* @memberof UpdateProductRequest
|
|
2352
|
-
*/
|
|
2353
1244
|
'salePrice'?: SalePrice | null;
|
|
2354
1245
|
/**
|
|
2355
1246
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
2356
|
-
* @type {Array<ImageFile>}
|
|
2357
|
-
* @memberof UpdateProductRequest
|
|
2358
1247
|
*/
|
|
2359
1248
|
'images'?: Array<ImageFile>;
|
|
2360
1249
|
/**
|
|
2361
1250
|
* Videos to attach to the product.
|
|
2362
|
-
* @type {Array<VideoFile>}
|
|
2363
|
-
* @memberof UpdateProductRequest
|
|
2364
1251
|
*/
|
|
2365
1252
|
'videos'?: Array<VideoFile>;
|
|
2366
1253
|
/**
|
|
2367
1254
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
2368
|
-
* @type {Array<AdditionalFile>}
|
|
2369
|
-
* @memberof UpdateProductRequest
|
|
2370
1255
|
*/
|
|
2371
1256
|
'additionalFiles'?: Array<AdditionalFile>;
|
|
2372
1257
|
/**
|
|
2373
1258
|
* List of application set UUIDs to associate with this product
|
|
2374
|
-
* @type {Array<string>}
|
|
2375
|
-
* @memberof UpdateProductRequest
|
|
2376
1259
|
*/
|
|
2377
1260
|
'applicationSets'?: Array<string>;
|
|
2378
1261
|
/**
|
|
2379
1262
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
2380
|
-
* @type {boolean}
|
|
2381
|
-
* @memberof UpdateProductRequest
|
|
2382
1263
|
*/
|
|
2383
1264
|
'includeInDataFeeds'?: boolean;
|
|
2384
1265
|
/**
|
|
2385
1266
|
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
2386
|
-
* @type {number}
|
|
2387
|
-
* @memberof UpdateProductRequest
|
|
2388
1267
|
*/
|
|
2389
1268
|
'shopifyId'?: number | null;
|
|
2390
1269
|
/**
|
|
2391
1270
|
* Key/value pairs that can be used to store additional information about the product
|
|
2392
|
-
* @type {Array<MetaField>}
|
|
2393
|
-
* @memberof UpdateProductRequest
|
|
2394
1271
|
*/
|
|
2395
1272
|
'metafields'?: Array<MetaField>;
|
|
2396
1273
|
/**
|
|
2397
1274
|
* A JSON object that defines the personalization template for the product.
|
|
2398
|
-
* @type {string}
|
|
2399
|
-
* @memberof UpdateProductRequest
|
|
2400
1275
|
*/
|
|
2401
1276
|
'personalizationTemplate'?: string;
|
|
2402
1277
|
/**
|
|
2403
1278
|
* Integration connections for the product
|
|
2404
|
-
* @type {Array<UpdateProductRequestIntegrationConnectionsInner>}
|
|
2405
|
-
* @memberof UpdateProductRequest
|
|
2406
1279
|
*/
|
|
2407
1280
|
'integrationConnections'?: Array<UpdateProductRequestIntegrationConnectionsInner>;
|
|
2408
1281
|
}
|
|
2409
|
-
/**
|
|
2410
|
-
*
|
|
2411
|
-
* @export
|
|
2412
|
-
* @interface UpdateProductRequestIntegrationConnectionsInner
|
|
2413
|
-
*/
|
|
2414
1282
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
2415
1283
|
/**
|
|
2416
1284
|
* Code identifying the integration
|
|
2417
|
-
* @type {string}
|
|
2418
|
-
* @memberof UpdateProductRequestIntegrationConnectionsInner
|
|
2419
1285
|
*/
|
|
2420
1286
|
'integrationCode': string;
|
|
2421
1287
|
/**
|
|
2422
1288
|
* The value of the identifying property on the foreign product
|
|
2423
|
-
* @type {string}
|
|
2424
|
-
* @memberof UpdateProductRequestIntegrationConnectionsInner
|
|
2425
1289
|
*/
|
|
2426
1290
|
'foreignKey': string;
|
|
2427
1291
|
}
|
|
2428
|
-
/**
|
|
2429
|
-
*
|
|
2430
|
-
* @export
|
|
2431
|
-
* @interface UpdateProductsRequest
|
|
2432
|
-
*/
|
|
2433
1292
|
export interface UpdateProductsRequest {
|
|
2434
|
-
/**
|
|
2435
|
-
*
|
|
2436
|
-
* @type {Array<UpdateProductsRequestProductsInner>}
|
|
2437
|
-
* @memberof UpdateProductsRequest
|
|
2438
|
-
*/
|
|
2439
1293
|
'products'?: Array<UpdateProductsRequestProductsInner>;
|
|
2440
1294
|
}
|
|
2441
|
-
/**
|
|
2442
|
-
*
|
|
2443
|
-
* @export
|
|
2444
|
-
* @interface UpdateProductsRequestProductsInner
|
|
2445
|
-
*/
|
|
2446
1295
|
export interface UpdateProductsRequestProductsInner {
|
|
2447
1296
|
/**
|
|
2448
1297
|
* Unique object identifier
|
|
2449
|
-
* @type {string}
|
|
2450
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2451
1298
|
*/
|
|
2452
1299
|
'id': string;
|
|
2453
1300
|
/**
|
|
2454
1301
|
* Product title
|
|
2455
|
-
* @type {string}
|
|
2456
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2457
1302
|
*/
|
|
2458
1303
|
'title'?: string;
|
|
2459
1304
|
/**
|
|
2460
1305
|
* Product description
|
|
2461
|
-
* @type {string}
|
|
2462
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2463
1306
|
*/
|
|
2464
1307
|
'description'?: string;
|
|
2465
1308
|
/**
|
|
2466
1309
|
* Whether the product is enabled.
|
|
2467
|
-
* @type {boolean}
|
|
2468
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2469
1310
|
*/
|
|
2470
1311
|
'enabled'?: boolean;
|
|
2471
1312
|
/**
|
|
2472
1313
|
* The brand of the product.
|
|
2473
|
-
* @type {string}
|
|
2474
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2475
1314
|
*/
|
|
2476
1315
|
'brand'?: string | null;
|
|
2477
|
-
/**
|
|
2478
|
-
*
|
|
2479
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
2480
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2481
|
-
*/
|
|
2482
1316
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
2483
1317
|
/**
|
|
2484
1318
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
2485
|
-
* @type {string}
|
|
2486
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2487
1319
|
*/
|
|
2488
1320
|
'targetSearchPhrase'?: string;
|
|
2489
1321
|
/**
|
|
2490
1322
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
2491
|
-
* @type {Array<string>}
|
|
2492
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2493
1323
|
*/
|
|
2494
1324
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2495
1325
|
/**
|
|
2496
1326
|
* Additional product tags used for searching and filtering.
|
|
2497
|
-
* @type {Array<string>}
|
|
2498
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2499
1327
|
*/
|
|
2500
1328
|
'tags'?: Array<string>;
|
|
2501
1329
|
/**
|
|
2502
1330
|
* List of variants to update.
|
|
2503
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInner>}
|
|
2504
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2505
1331
|
*/
|
|
2506
1332
|
'variants'?: Array<UpdateProductsRequestProductsInnerVariantsInner>;
|
|
2507
1333
|
/**
|
|
2508
1334
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
2509
|
-
* @type {boolean}
|
|
2510
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2511
1335
|
*/
|
|
2512
1336
|
'includeInDataFeeds'?: boolean;
|
|
2513
1337
|
/**
|
|
2514
1338
|
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
2515
|
-
* @type {number}
|
|
2516
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2517
1339
|
*/
|
|
2518
1340
|
'shopifyId'?: number | null;
|
|
2519
|
-
/**
|
|
2520
|
-
*
|
|
2521
|
-
* @type {Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>}
|
|
2522
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2523
|
-
*/
|
|
2524
1341
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
2525
1342
|
}
|
|
2526
|
-
/**
|
|
2527
|
-
*
|
|
2528
|
-
* @export
|
|
2529
|
-
* @interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2530
|
-
*/
|
|
2531
1343
|
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
2532
|
-
/**
|
|
2533
|
-
*
|
|
2534
|
-
* @type {string}
|
|
2535
|
-
* @memberof UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2536
|
-
*/
|
|
2537
1344
|
'integrationCode': string;
|
|
2538
1345
|
/**
|
|
2539
1346
|
* The value of the identifying property on the foreign product
|
|
2540
|
-
* @type {string}
|
|
2541
|
-
* @memberof UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2542
1347
|
*/
|
|
2543
1348
|
'foreignKey': string;
|
|
2544
1349
|
}
|
|
2545
|
-
/**
|
|
2546
|
-
*
|
|
2547
|
-
* @export
|
|
2548
|
-
* @interface UpdateProductsRequestProductsInnerSeoMetadata
|
|
2549
|
-
*/
|
|
2550
1350
|
export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
2551
1351
|
/**
|
|
2552
1352
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
2553
|
-
* @type {string}
|
|
2554
|
-
* @memberof UpdateProductsRequestProductsInnerSeoMetadata
|
|
2555
1353
|
*/
|
|
2556
1354
|
'title'?: string;
|
|
2557
1355
|
/**
|
|
2558
1356
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
2559
|
-
* @type {string}
|
|
2560
|
-
* @memberof UpdateProductsRequestProductsInnerSeoMetadata
|
|
2561
1357
|
*/
|
|
2562
1358
|
'description'?: string | null;
|
|
2563
1359
|
}
|
|
2564
|
-
/**
|
|
2565
|
-
*
|
|
2566
|
-
* @export
|
|
2567
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInner
|
|
2568
|
-
*/
|
|
2569
1360
|
export interface UpdateProductsRequestProductsInnerVariantsInner {
|
|
2570
1361
|
/**
|
|
2571
1362
|
* Attributes associated to a variant such as Colour and Size.
|
|
2572
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
2573
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2574
1363
|
*/
|
|
2575
1364
|
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
2576
|
-
/**
|
|
2577
|
-
*
|
|
2578
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
2579
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2580
|
-
*/
|
|
2581
1365
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
2582
|
-
/**
|
|
2583
|
-
*
|
|
2584
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
2585
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2586
|
-
*/
|
|
2587
1366
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
2588
1367
|
/**
|
|
2589
1368
|
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
|
|
2590
|
-
* @type {string}
|
|
2591
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2592
1369
|
*/
|
|
2593
1370
|
'barcode'?: string | null;
|
|
2594
1371
|
/**
|
|
2595
1372
|
* For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one.
|
|
2596
|
-
* @type {number}
|
|
2597
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2598
1373
|
*/
|
|
2599
1374
|
'shopifyId'?: number | null;
|
|
2600
|
-
/**
|
|
2601
|
-
*
|
|
2602
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}
|
|
2603
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2604
|
-
*/
|
|
2605
1375
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2606
1376
|
}
|
|
2607
|
-
/**
|
|
2608
|
-
*
|
|
2609
|
-
* @export
|
|
2610
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2611
|
-
*/
|
|
2612
1377
|
export interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner {
|
|
2613
1378
|
/**
|
|
2614
1379
|
* Attribute name
|
|
2615
|
-
* @type {string}
|
|
2616
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2617
1380
|
*/
|
|
2618
1381
|
'name': UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum;
|
|
2619
1382
|
/**
|
|
2620
1383
|
* Attribute value
|
|
2621
|
-
* @type {string}
|
|
2622
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2623
1384
|
*/
|
|
2624
1385
|
'value': string;
|
|
2625
1386
|
}
|
|
@@ -2628,41 +1389,23 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerAttributesIn
|
|
|
2628
1389
|
readonly Colour: "Colour";
|
|
2629
1390
|
};
|
|
2630
1391
|
export type UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum];
|
|
2631
|
-
/**
|
|
2632
|
-
*
|
|
2633
|
-
* @export
|
|
2634
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2635
|
-
*/
|
|
2636
1392
|
export interface UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner {
|
|
2637
|
-
/**
|
|
2638
|
-
*
|
|
2639
|
-
* @type {string}
|
|
2640
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2641
|
-
*/
|
|
2642
1393
|
'integrationCode': string;
|
|
2643
1394
|
/**
|
|
2644
1395
|
* The value of the identifying property on the foreign variant
|
|
2645
|
-
* @type {string}
|
|
2646
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2647
1396
|
*/
|
|
2648
1397
|
'foreignKey': string;
|
|
2649
1398
|
}
|
|
2650
1399
|
/**
|
|
2651
1400
|
* Variant retail price including tax.
|
|
2652
|
-
* @export
|
|
2653
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2654
1401
|
*/
|
|
2655
1402
|
export interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice {
|
|
2656
1403
|
/**
|
|
2657
1404
|
* Price including tax in the specified currency.
|
|
2658
|
-
* @type {number}
|
|
2659
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2660
1405
|
*/
|
|
2661
1406
|
'amount': number;
|
|
2662
1407
|
/**
|
|
2663
1408
|
* Currency code for the currency the price is valued in.
|
|
2664
|
-
* @type {string}
|
|
2665
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2666
1409
|
*/
|
|
2667
1410
|
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum;
|
|
2668
1411
|
}
|
|
@@ -2672,20 +1415,14 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceC
|
|
|
2672
1415
|
export type UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum];
|
|
2673
1416
|
/**
|
|
2674
1417
|
* Variant discounted price including tax.
|
|
2675
|
-
* @export
|
|
2676
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2677
1418
|
*/
|
|
2678
1419
|
export interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice {
|
|
2679
1420
|
/**
|
|
2680
1421
|
* Discounted price including tax in the specified currency.
|
|
2681
|
-
* @type {number}
|
|
2682
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2683
1422
|
*/
|
|
2684
1423
|
'amount': number;
|
|
2685
1424
|
/**
|
|
2686
1425
|
* Currency code for the currency the sale price is valued in.
|
|
2687
|
-
* @type {string}
|
|
2688
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2689
1426
|
*/
|
|
2690
1427
|
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum;
|
|
2691
1428
|
}
|
|
@@ -2693,275 +1430,107 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
|
|
|
2693
1430
|
readonly Gbp: "GBP";
|
|
2694
1431
|
};
|
|
2695
1432
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
2696
|
-
/**
|
|
2697
|
-
*
|
|
2698
|
-
* @export
|
|
2699
|
-
* @interface Variant
|
|
2700
|
-
*/
|
|
2701
1433
|
export interface Variant {
|
|
2702
1434
|
/**
|
|
2703
1435
|
* Unique object identifier
|
|
2704
|
-
* @type {string}
|
|
2705
|
-
* @memberof Variant
|
|
2706
1436
|
*/
|
|
2707
1437
|
'id'?: string;
|
|
2708
1438
|
/**
|
|
2709
1439
|
* Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
|
|
2710
|
-
* @type {Array<Attribute>}
|
|
2711
|
-
* @memberof Variant
|
|
2712
1440
|
*/
|
|
2713
1441
|
'attributes': Array<Attribute>;
|
|
2714
|
-
/**
|
|
2715
|
-
*
|
|
2716
|
-
* @type {string}
|
|
2717
|
-
* @memberof Variant
|
|
2718
|
-
*/
|
|
2719
1442
|
'sku': string;
|
|
2720
1443
|
/**
|
|
2721
1444
|
* A reference to the variant resource location
|
|
2722
|
-
* @type {string}
|
|
2723
|
-
* @memberof Variant
|
|
2724
1445
|
*/
|
|
2725
1446
|
'ref'?: string;
|
|
2726
|
-
/**
|
|
2727
|
-
*
|
|
2728
|
-
* @type {VariantProduct}
|
|
2729
|
-
* @memberof Variant
|
|
2730
|
-
*/
|
|
2731
1447
|
'product'?: VariantProduct;
|
|
2732
|
-
/**
|
|
2733
|
-
*
|
|
2734
|
-
* @type {number}
|
|
2735
|
-
* @memberof Variant
|
|
2736
|
-
*/
|
|
2737
1448
|
'sortOrder'?: number;
|
|
2738
|
-
/**
|
|
2739
|
-
*
|
|
2740
|
-
* @type {Price}
|
|
2741
|
-
* @memberof Variant
|
|
2742
|
-
*/
|
|
2743
1449
|
'retailPrice'?: Price;
|
|
2744
|
-
/**
|
|
2745
|
-
*
|
|
2746
|
-
* @type {SalePrice}
|
|
2747
|
-
* @memberof Variant
|
|
2748
|
-
*/
|
|
2749
1450
|
'salePrice'?: SalePrice | null;
|
|
2750
|
-
/**
|
|
2751
|
-
*
|
|
2752
|
-
* @type {Price}
|
|
2753
|
-
* @memberof Variant
|
|
2754
|
-
*/
|
|
2755
1451
|
'price'?: Price;
|
|
2756
|
-
/**
|
|
2757
|
-
*
|
|
2758
|
-
* @type {Stock}
|
|
2759
|
-
* @memberof Variant
|
|
2760
|
-
*/
|
|
2761
1452
|
'stock'?: Stock;
|
|
2762
|
-
/**
|
|
2763
|
-
*
|
|
2764
|
-
* @type {string}
|
|
2765
|
-
* @memberof Variant
|
|
2766
|
-
*/
|
|
2767
1453
|
'createdAt'?: string;
|
|
2768
|
-
/**
|
|
2769
|
-
*
|
|
2770
|
-
* @type {string}
|
|
2771
|
-
* @memberof Variant
|
|
2772
|
-
*/
|
|
2773
1454
|
'updatedAt'?: string;
|
|
2774
|
-
/**
|
|
2775
|
-
*
|
|
2776
|
-
* @type {string}
|
|
2777
|
-
* @memberof Variant
|
|
2778
|
-
*/
|
|
2779
1455
|
'publishedAt'?: string;
|
|
2780
1456
|
/**
|
|
2781
1457
|
* Images
|
|
2782
|
-
* @type {Array<Image>}
|
|
2783
|
-
* @memberof Variant
|
|
2784
1458
|
*/
|
|
2785
1459
|
'images'?: Array<Image>;
|
|
2786
1460
|
/**
|
|
2787
1461
|
* Design applications. If not provided, the product will be blank.
|
|
2788
|
-
* @type {Array<Application>}
|
|
2789
|
-
* @memberof Variant
|
|
2790
1462
|
*/
|
|
2791
1463
|
'applications'?: Array<Application>;
|
|
2792
1464
|
/**
|
|
2793
1465
|
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
|
|
2794
|
-
* @type {string}
|
|
2795
|
-
* @memberof Variant
|
|
2796
1466
|
*/
|
|
2797
1467
|
'barcode'?: string | null;
|
|
2798
1468
|
/**
|
|
2799
1469
|
* Deprecated. Please use `barcode` instead.
|
|
2800
|
-
* @type {string}
|
|
2801
|
-
* @memberof Variant
|
|
2802
1470
|
* @deprecated
|
|
2803
1471
|
*/
|
|
2804
1472
|
'gtin'?: string | null;
|
|
2805
1473
|
/**
|
|
2806
1474
|
* For use with the Shopify integration. The Shopify variant ID that this variant is linked to.
|
|
2807
|
-
* @type {number}
|
|
2808
|
-
* @memberof Variant
|
|
2809
1475
|
*/
|
|
2810
1476
|
'shopifyId'?: number | null;
|
|
2811
1477
|
/**
|
|
2812
1478
|
* Key/value pairs that can be used to store additional information about the variant
|
|
2813
|
-
* @type {Array<MetaField>}
|
|
2814
|
-
* @memberof Variant
|
|
2815
1479
|
*/
|
|
2816
1480
|
'metafields'?: Array<MetaField>;
|
|
2817
|
-
/**
|
|
2818
|
-
*
|
|
2819
|
-
* @type {Array<VariantIntegrationConnectionsInner>}
|
|
2820
|
-
* @memberof Variant
|
|
2821
|
-
*/
|
|
2822
1481
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
2823
|
-
/**
|
|
2824
|
-
*
|
|
2825
|
-
* @type {VariantWholesaleCost}
|
|
2826
|
-
* @memberof Variant
|
|
2827
|
-
*/
|
|
2828
1482
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2829
1483
|
}
|
|
2830
|
-
/**
|
|
2831
|
-
*
|
|
2832
|
-
* @export
|
|
2833
|
-
* @interface VariantIntegrationConnectionsInner
|
|
2834
|
-
*/
|
|
2835
1484
|
export interface VariantIntegrationConnectionsInner {
|
|
2836
|
-
/**
|
|
2837
|
-
*
|
|
2838
|
-
* @type {string}
|
|
2839
|
-
* @memberof VariantIntegrationConnectionsInner
|
|
2840
|
-
*/
|
|
2841
1485
|
'integrationCode': string;
|
|
2842
1486
|
/**
|
|
2843
1487
|
* The value of the identifying property on the foreign variant
|
|
2844
|
-
* @type {string}
|
|
2845
|
-
* @memberof VariantIntegrationConnectionsInner
|
|
2846
1488
|
*/
|
|
2847
1489
|
'foreignKey': string;
|
|
2848
1490
|
}
|
|
2849
|
-
/**
|
|
2850
|
-
*
|
|
2851
|
-
* @export
|
|
2852
|
-
* @interface VariantProduct
|
|
2853
|
-
*/
|
|
2854
1491
|
export interface VariantProduct {
|
|
2855
1492
|
/**
|
|
2856
1493
|
* Unique object identifier
|
|
2857
|
-
* @type {string}
|
|
2858
|
-
* @memberof VariantProduct
|
|
2859
1494
|
*/
|
|
2860
1495
|
'id'?: string;
|
|
2861
1496
|
/**
|
|
2862
1497
|
* A reference to the resource location
|
|
2863
|
-
* @type {string}
|
|
2864
|
-
* @memberof VariantProduct
|
|
2865
1498
|
*/
|
|
2866
1499
|
'ref'?: string;
|
|
2867
1500
|
}
|
|
2868
|
-
/**
|
|
2869
|
-
*
|
|
2870
|
-
* @export
|
|
2871
|
-
* @interface VariantWholesaleCost
|
|
2872
|
-
*/
|
|
2873
1501
|
export interface VariantWholesaleCost {
|
|
2874
|
-
/**
|
|
2875
|
-
*
|
|
2876
|
-
* @type {Price}
|
|
2877
|
-
* @memberof VariantWholesaleCost
|
|
2878
|
-
*/
|
|
2879
1502
|
'item'?: Price;
|
|
2880
|
-
/**
|
|
2881
|
-
*
|
|
2882
|
-
* @type {Price}
|
|
2883
|
-
* @memberof VariantWholesaleCost
|
|
2884
|
-
*/
|
|
2885
1503
|
'fulfillment'?: Price;
|
|
2886
1504
|
}
|
|
2887
|
-
/**
|
|
2888
|
-
*
|
|
2889
|
-
* @export
|
|
2890
|
-
* @interface VariantsResponse
|
|
2891
|
-
*/
|
|
2892
1505
|
export interface VariantsResponse {
|
|
2893
|
-
/**
|
|
2894
|
-
*
|
|
2895
|
-
* @type {Array<Variant>}
|
|
2896
|
-
* @memberof VariantsResponse
|
|
2897
|
-
*/
|
|
2898
1506
|
'variants'?: Array<Variant>;
|
|
2899
1507
|
/**
|
|
2900
1508
|
* The token referencing the next page number
|
|
2901
|
-
* @type {number}
|
|
2902
|
-
* @memberof VariantsResponse
|
|
2903
1509
|
*/
|
|
2904
1510
|
'nextPageToken'?: number | null;
|
|
2905
1511
|
}
|
|
2906
1512
|
/**
|
|
2907
1513
|
* Video object
|
|
2908
|
-
* @export
|
|
2909
|
-
* @interface Video
|
|
2910
1514
|
*/
|
|
2911
1515
|
export interface Video {
|
|
2912
1516
|
/**
|
|
2913
1517
|
* Unique object identifier
|
|
2914
|
-
* @type {string}
|
|
2915
|
-
* @memberof Video
|
|
2916
1518
|
*/
|
|
2917
1519
|
'id'?: string;
|
|
2918
|
-
/**
|
|
2919
|
-
*
|
|
2920
|
-
* @type {string}
|
|
2921
|
-
* @memberof Video
|
|
2922
|
-
*/
|
|
2923
1520
|
'src'?: string;
|
|
2924
|
-
/**
|
|
2925
|
-
*
|
|
2926
|
-
* @type {string}
|
|
2927
|
-
* @memberof Video
|
|
2928
|
-
*/
|
|
2929
1521
|
'alt'?: string;
|
|
2930
|
-
/**
|
|
2931
|
-
*
|
|
2932
|
-
* @type {number}
|
|
2933
|
-
* @memberof Video
|
|
2934
|
-
*/
|
|
2935
1522
|
'sortOrder'?: number;
|
|
2936
|
-
/**
|
|
2937
|
-
*
|
|
2938
|
-
* @type {string}
|
|
2939
|
-
* @memberof Video
|
|
2940
|
-
*/
|
|
2941
1523
|
'createdAt'?: string;
|
|
2942
|
-
/**
|
|
2943
|
-
*
|
|
2944
|
-
* @type {string}
|
|
2945
|
-
* @memberof Video
|
|
2946
|
-
*/
|
|
2947
1524
|
'updatedAt'?: string;
|
|
2948
1525
|
}
|
|
2949
|
-
/**
|
|
2950
|
-
*
|
|
2951
|
-
* @export
|
|
2952
|
-
* @interface VideoFile
|
|
2953
|
-
*/
|
|
2954
1526
|
export interface VideoFile {
|
|
2955
1527
|
/**
|
|
2956
1528
|
* Publicly available file URL.
|
|
2957
|
-
* @type {string}
|
|
2958
|
-
* @memberof VideoFile
|
|
2959
1529
|
*/
|
|
2960
1530
|
'src'?: string;
|
|
2961
1531
|
}
|
|
2962
1532
|
/**
|
|
2963
1533
|
* ApplicationGroupsApi - axios parameter creator
|
|
2964
|
-
* @export
|
|
2965
1534
|
*/
|
|
2966
1535
|
export declare const ApplicationGroupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2967
1536
|
/**
|
|
@@ -3015,7 +1584,6 @@ export declare const ApplicationGroupsApiAxiosParamCreator: (configuration?: Con
|
|
|
3015
1584
|
};
|
|
3016
1585
|
/**
|
|
3017
1586
|
* ApplicationGroupsApi - functional programming interface
|
|
3018
|
-
* @export
|
|
3019
1587
|
*/
|
|
3020
1588
|
export declare const ApplicationGroupsApiFp: (configuration?: Configuration) => {
|
|
3021
1589
|
/**
|
|
@@ -3069,7 +1637,6 @@ export declare const ApplicationGroupsApiFp: (configuration?: Configuration) =>
|
|
|
3069
1637
|
};
|
|
3070
1638
|
/**
|
|
3071
1639
|
* ApplicationGroupsApi - factory interface
|
|
3072
|
-
* @export
|
|
3073
1640
|
*/
|
|
3074
1641
|
export declare const ApplicationGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3075
1642
|
/**
|
|
@@ -3115,122 +1682,83 @@ export declare const ApplicationGroupsApiFactory: (configuration?: Configuration
|
|
|
3115
1682
|
};
|
|
3116
1683
|
/**
|
|
3117
1684
|
* Request parameters for createApplicationGroup operation in ApplicationGroupsApi.
|
|
3118
|
-
* @export
|
|
3119
|
-
* @interface ApplicationGroupsApiCreateApplicationGroupRequest
|
|
3120
1685
|
*/
|
|
3121
1686
|
export interface ApplicationGroupsApiCreateApplicationGroupRequest {
|
|
3122
1687
|
/**
|
|
3123
1688
|
* What project it is
|
|
3124
|
-
* @type {string}
|
|
3125
|
-
* @memberof ApplicationGroupsApiCreateApplicationGroup
|
|
3126
1689
|
*/
|
|
3127
1690
|
readonly project: string;
|
|
3128
1691
|
/**
|
|
3129
1692
|
* Create a new application group.
|
|
3130
|
-
* @type {CreateApplicationGroupRequest}
|
|
3131
|
-
* @memberof ApplicationGroupsApiCreateApplicationGroup
|
|
3132
1693
|
*/
|
|
3133
1694
|
readonly createApplicationGroupRequest?: CreateApplicationGroupRequest;
|
|
3134
1695
|
}
|
|
3135
1696
|
/**
|
|
3136
1697
|
* Request parameters for deleteApplicationGroup operation in ApplicationGroupsApi.
|
|
3137
|
-
* @export
|
|
3138
|
-
* @interface ApplicationGroupsApiDeleteApplicationGroupRequest
|
|
3139
1698
|
*/
|
|
3140
1699
|
export interface ApplicationGroupsApiDeleteApplicationGroupRequest {
|
|
3141
1700
|
/**
|
|
3142
1701
|
* What project it is
|
|
3143
|
-
* @type {string}
|
|
3144
|
-
* @memberof ApplicationGroupsApiDeleteApplicationGroup
|
|
3145
1702
|
*/
|
|
3146
1703
|
readonly project: string;
|
|
3147
1704
|
/**
|
|
3148
1705
|
* Application group\'s unique identifier
|
|
3149
|
-
* @type {string}
|
|
3150
|
-
* @memberof ApplicationGroupsApiDeleteApplicationGroup
|
|
3151
1706
|
*/
|
|
3152
1707
|
readonly applicationGroupId: string;
|
|
3153
1708
|
}
|
|
3154
1709
|
/**
|
|
3155
1710
|
* Request parameters for getApplicationGroup operation in ApplicationGroupsApi.
|
|
3156
|
-
* @export
|
|
3157
|
-
* @interface ApplicationGroupsApiGetApplicationGroupRequest
|
|
3158
1711
|
*/
|
|
3159
1712
|
export interface ApplicationGroupsApiGetApplicationGroupRequest {
|
|
3160
1713
|
/**
|
|
3161
1714
|
* What project it is
|
|
3162
|
-
* @type {string}
|
|
3163
|
-
* @memberof ApplicationGroupsApiGetApplicationGroup
|
|
3164
1715
|
*/
|
|
3165
1716
|
readonly project: string;
|
|
3166
1717
|
/**
|
|
3167
1718
|
* Application group\'s unique identifier
|
|
3168
|
-
* @type {string}
|
|
3169
|
-
* @memberof ApplicationGroupsApiGetApplicationGroup
|
|
3170
1719
|
*/
|
|
3171
1720
|
readonly applicationGroupId: string;
|
|
3172
1721
|
}
|
|
3173
1722
|
/**
|
|
3174
1723
|
* Request parameters for listApplicationGroups operation in ApplicationGroupsApi.
|
|
3175
|
-
* @export
|
|
3176
|
-
* @interface ApplicationGroupsApiListApplicationGroupsRequest
|
|
3177
1724
|
*/
|
|
3178
1725
|
export interface ApplicationGroupsApiListApplicationGroupsRequest {
|
|
3179
1726
|
/**
|
|
3180
1727
|
* What project it is
|
|
3181
|
-
* @type {string}
|
|
3182
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3183
1728
|
*/
|
|
3184
1729
|
readonly project: string;
|
|
3185
1730
|
/**
|
|
3186
1731
|
* Page reference token
|
|
3187
|
-
* @type {number}
|
|
3188
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3189
1732
|
*/
|
|
3190
1733
|
readonly pageToken?: number;
|
|
3191
1734
|
/**
|
|
3192
1735
|
* Search query string to filter results. Supports field-specific filters like \'uuid:<id>\', \'name:\"application group name\"\'. Multiple filters can be combined with spaces and commas.
|
|
3193
|
-
* @type {string}
|
|
3194
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3195
1736
|
*/
|
|
3196
1737
|
readonly search?: string;
|
|
3197
1738
|
/**
|
|
3198
1739
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3199
|
-
* @type {number}
|
|
3200
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3201
1740
|
*/
|
|
3202
1741
|
readonly pageSize?: number;
|
|
3203
1742
|
}
|
|
3204
1743
|
/**
|
|
3205
1744
|
* Request parameters for updateApplicationGroup operation in ApplicationGroupsApi.
|
|
3206
|
-
* @export
|
|
3207
|
-
* @interface ApplicationGroupsApiUpdateApplicationGroupRequest
|
|
3208
1745
|
*/
|
|
3209
1746
|
export interface ApplicationGroupsApiUpdateApplicationGroupRequest {
|
|
3210
1747
|
/**
|
|
3211
1748
|
* What project it is
|
|
3212
|
-
* @type {string}
|
|
3213
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3214
1749
|
*/
|
|
3215
1750
|
readonly project: string;
|
|
3216
1751
|
/**
|
|
3217
1752
|
* Application group\'s unique identifier
|
|
3218
|
-
* @type {string}
|
|
3219
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3220
1753
|
*/
|
|
3221
1754
|
readonly applicationGroupId: string;
|
|
3222
1755
|
/**
|
|
3223
1756
|
* Update an existing application group.
|
|
3224
|
-
* @type {UpdateApplicationGroupRequest}
|
|
3225
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3226
1757
|
*/
|
|
3227
1758
|
readonly updateApplicationGroupRequest?: UpdateApplicationGroupRequest;
|
|
3228
1759
|
}
|
|
3229
1760
|
/**
|
|
3230
1761
|
* ApplicationGroupsApi - object-oriented interface
|
|
3231
|
-
* @export
|
|
3232
|
-
* @class ApplicationGroupsApi
|
|
3233
|
-
* @extends {BaseAPI}
|
|
3234
1762
|
*/
|
|
3235
1763
|
export declare class ApplicationGroupsApi extends BaseAPI {
|
|
3236
1764
|
/**
|
|
@@ -3239,7 +1767,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3239
1767
|
* @param {ApplicationGroupsApiCreateApplicationGroupRequest} requestParameters Request parameters.
|
|
3240
1768
|
* @param {*} [options] Override http request option.
|
|
3241
1769
|
* @throws {RequiredError}
|
|
3242
|
-
* @memberof ApplicationGroupsApi
|
|
3243
1770
|
*/
|
|
3244
1771
|
createApplicationGroup(requestParameters: ApplicationGroupsApiCreateApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3245
1772
|
/**
|
|
@@ -3248,7 +1775,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3248
1775
|
* @param {ApplicationGroupsApiDeleteApplicationGroupRequest} requestParameters Request parameters.
|
|
3249
1776
|
* @param {*} [options] Override http request option.
|
|
3250
1777
|
* @throws {RequiredError}
|
|
3251
|
-
* @memberof ApplicationGroupsApi
|
|
3252
1778
|
*/
|
|
3253
1779
|
deleteApplicationGroup(requestParameters: ApplicationGroupsApiDeleteApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3254
1780
|
/**
|
|
@@ -3257,7 +1783,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3257
1783
|
* @param {ApplicationGroupsApiGetApplicationGroupRequest} requestParameters Request parameters.
|
|
3258
1784
|
* @param {*} [options] Override http request option.
|
|
3259
1785
|
* @throws {RequiredError}
|
|
3260
|
-
* @memberof ApplicationGroupsApi
|
|
3261
1786
|
*/
|
|
3262
1787
|
getApplicationGroup(requestParameters: ApplicationGroupsApiGetApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3263
1788
|
/**
|
|
@@ -3266,7 +1791,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3266
1791
|
* @param {ApplicationGroupsApiListApplicationGroupsRequest} requestParameters Request parameters.
|
|
3267
1792
|
* @param {*} [options] Override http request option.
|
|
3268
1793
|
* @throws {RequiredError}
|
|
3269
|
-
* @memberof ApplicationGroupsApi
|
|
3270
1794
|
*/
|
|
3271
1795
|
listApplicationGroups(requestParameters: ApplicationGroupsApiListApplicationGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroupsResponse, any>>;
|
|
3272
1796
|
/**
|
|
@@ -3275,13 +1799,11 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3275
1799
|
* @param {ApplicationGroupsApiUpdateApplicationGroupRequest} requestParameters Request parameters.
|
|
3276
1800
|
* @param {*} [options] Override http request option.
|
|
3277
1801
|
* @throws {RequiredError}
|
|
3278
|
-
* @memberof ApplicationGroupsApi
|
|
3279
1802
|
*/
|
|
3280
1803
|
updateApplicationGroup(requestParameters: ApplicationGroupsApiUpdateApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3281
1804
|
}
|
|
3282
1805
|
/**
|
|
3283
1806
|
* ApplicationSetsApi - axios parameter creator
|
|
3284
|
-
* @export
|
|
3285
1807
|
*/
|
|
3286
1808
|
export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3287
1809
|
/**
|
|
@@ -3335,7 +1857,6 @@ export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3335
1857
|
};
|
|
3336
1858
|
/**
|
|
3337
1859
|
* ApplicationSetsApi - functional programming interface
|
|
3338
|
-
* @export
|
|
3339
1860
|
*/
|
|
3340
1861
|
export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
3341
1862
|
/**
|
|
@@ -3389,7 +1910,6 @@ export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
|
3389
1910
|
};
|
|
3390
1911
|
/**
|
|
3391
1912
|
* ApplicationSetsApi - factory interface
|
|
3392
|
-
* @export
|
|
3393
1913
|
*/
|
|
3394
1914
|
export declare const ApplicationSetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3395
1915
|
/**
|
|
@@ -3435,122 +1955,83 @@ export declare const ApplicationSetsApiFactory: (configuration?: Configuration,
|
|
|
3435
1955
|
};
|
|
3436
1956
|
/**
|
|
3437
1957
|
* Request parameters for createApplicationSet operation in ApplicationSetsApi.
|
|
3438
|
-
* @export
|
|
3439
|
-
* @interface ApplicationSetsApiCreateApplicationSetRequest
|
|
3440
1958
|
*/
|
|
3441
1959
|
export interface ApplicationSetsApiCreateApplicationSetRequest {
|
|
3442
1960
|
/**
|
|
3443
1961
|
* What project it is
|
|
3444
|
-
* @type {string}
|
|
3445
|
-
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
3446
1962
|
*/
|
|
3447
1963
|
readonly project: string;
|
|
3448
1964
|
/**
|
|
3449
1965
|
* Create a new application set.
|
|
3450
|
-
* @type {CreateApplicationSetRequest}
|
|
3451
|
-
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
3452
1966
|
*/
|
|
3453
1967
|
readonly createApplicationSetRequest?: CreateApplicationSetRequest;
|
|
3454
1968
|
}
|
|
3455
1969
|
/**
|
|
3456
1970
|
* Request parameters for deleteApplicationSet operation in ApplicationSetsApi.
|
|
3457
|
-
* @export
|
|
3458
|
-
* @interface ApplicationSetsApiDeleteApplicationSetRequest
|
|
3459
1971
|
*/
|
|
3460
1972
|
export interface ApplicationSetsApiDeleteApplicationSetRequest {
|
|
3461
1973
|
/**
|
|
3462
1974
|
* What project it is
|
|
3463
|
-
* @type {string}
|
|
3464
|
-
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
3465
1975
|
*/
|
|
3466
1976
|
readonly project: string;
|
|
3467
1977
|
/**
|
|
3468
1978
|
* Application set\'s unique identifier
|
|
3469
|
-
* @type {string}
|
|
3470
|
-
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
3471
1979
|
*/
|
|
3472
1980
|
readonly applicationSetId: string;
|
|
3473
1981
|
}
|
|
3474
1982
|
/**
|
|
3475
1983
|
* Request parameters for getApplicationSet operation in ApplicationSetsApi.
|
|
3476
|
-
* @export
|
|
3477
|
-
* @interface ApplicationSetsApiGetApplicationSetRequest
|
|
3478
1984
|
*/
|
|
3479
1985
|
export interface ApplicationSetsApiGetApplicationSetRequest {
|
|
3480
1986
|
/**
|
|
3481
1987
|
* What project it is
|
|
3482
|
-
* @type {string}
|
|
3483
|
-
* @memberof ApplicationSetsApiGetApplicationSet
|
|
3484
1988
|
*/
|
|
3485
1989
|
readonly project: string;
|
|
3486
1990
|
/**
|
|
3487
1991
|
* Application set\'s unique identifier
|
|
3488
|
-
* @type {string}
|
|
3489
|
-
* @memberof ApplicationSetsApiGetApplicationSet
|
|
3490
1992
|
*/
|
|
3491
1993
|
readonly applicationSetId: string;
|
|
3492
1994
|
}
|
|
3493
1995
|
/**
|
|
3494
1996
|
* Request parameters for listApplicationSets operation in ApplicationSetsApi.
|
|
3495
|
-
* @export
|
|
3496
|
-
* @interface ApplicationSetsApiListApplicationSetsRequest
|
|
3497
1997
|
*/
|
|
3498
1998
|
export interface ApplicationSetsApiListApplicationSetsRequest {
|
|
3499
1999
|
/**
|
|
3500
2000
|
* What project it is
|
|
3501
|
-
* @type {string}
|
|
3502
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3503
2001
|
*/
|
|
3504
2002
|
readonly project: string;
|
|
3505
2003
|
/**
|
|
3506
2004
|
* Page reference token
|
|
3507
|
-
* @type {number}
|
|
3508
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3509
2005
|
*/
|
|
3510
2006
|
readonly pageToken?: number;
|
|
3511
2007
|
/**
|
|
3512
2008
|
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
3513
|
-
* @type {string}
|
|
3514
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3515
2009
|
*/
|
|
3516
2010
|
readonly search?: string;
|
|
3517
2011
|
/**
|
|
3518
2012
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3519
|
-
* @type {number}
|
|
3520
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3521
2013
|
*/
|
|
3522
2014
|
readonly pageSize?: number;
|
|
3523
2015
|
}
|
|
3524
2016
|
/**
|
|
3525
2017
|
* Request parameters for updateApplicationSet operation in ApplicationSetsApi.
|
|
3526
|
-
* @export
|
|
3527
|
-
* @interface ApplicationSetsApiUpdateApplicationSetRequest
|
|
3528
2018
|
*/
|
|
3529
2019
|
export interface ApplicationSetsApiUpdateApplicationSetRequest {
|
|
3530
2020
|
/**
|
|
3531
2021
|
* What project it is
|
|
3532
|
-
* @type {string}
|
|
3533
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3534
2022
|
*/
|
|
3535
2023
|
readonly project: string;
|
|
3536
2024
|
/**
|
|
3537
2025
|
* Application set\'s unique identifier
|
|
3538
|
-
* @type {string}
|
|
3539
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3540
2026
|
*/
|
|
3541
2027
|
readonly applicationSetId: string;
|
|
3542
2028
|
/**
|
|
3543
2029
|
* Create a new application set.
|
|
3544
|
-
* @type {UpdateApplicationSetRequest}
|
|
3545
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3546
2030
|
*/
|
|
3547
2031
|
readonly updateApplicationSetRequest?: UpdateApplicationSetRequest;
|
|
3548
2032
|
}
|
|
3549
2033
|
/**
|
|
3550
2034
|
* ApplicationSetsApi - object-oriented interface
|
|
3551
|
-
* @export
|
|
3552
|
-
* @class ApplicationSetsApi
|
|
3553
|
-
* @extends {BaseAPI}
|
|
3554
2035
|
*/
|
|
3555
2036
|
export declare class ApplicationSetsApi extends BaseAPI {
|
|
3556
2037
|
/**
|
|
@@ -3559,7 +2040,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3559
2040
|
* @param {ApplicationSetsApiCreateApplicationSetRequest} requestParameters Request parameters.
|
|
3560
2041
|
* @param {*} [options] Override http request option.
|
|
3561
2042
|
* @throws {RequiredError}
|
|
3562
|
-
* @memberof ApplicationSetsApi
|
|
3563
2043
|
*/
|
|
3564
2044
|
createApplicationSet(requestParameters: ApplicationSetsApiCreateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3565
2045
|
/**
|
|
@@ -3568,7 +2048,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3568
2048
|
* @param {ApplicationSetsApiDeleteApplicationSetRequest} requestParameters Request parameters.
|
|
3569
2049
|
* @param {*} [options] Override http request option.
|
|
3570
2050
|
* @throws {RequiredError}
|
|
3571
|
-
* @memberof ApplicationSetsApi
|
|
3572
2051
|
*/
|
|
3573
2052
|
deleteApplicationSet(requestParameters: ApplicationSetsApiDeleteApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3574
2053
|
/**
|
|
@@ -3577,7 +2056,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3577
2056
|
* @param {ApplicationSetsApiGetApplicationSetRequest} requestParameters Request parameters.
|
|
3578
2057
|
* @param {*} [options] Override http request option.
|
|
3579
2058
|
* @throws {RequiredError}
|
|
3580
|
-
* @memberof ApplicationSetsApi
|
|
3581
2059
|
*/
|
|
3582
2060
|
getApplicationSet(requestParameters: ApplicationSetsApiGetApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3583
2061
|
/**
|
|
@@ -3586,7 +2064,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3586
2064
|
* @param {ApplicationSetsApiListApplicationSetsRequest} requestParameters Request parameters.
|
|
3587
2065
|
* @param {*} [options] Override http request option.
|
|
3588
2066
|
* @throws {RequiredError}
|
|
3589
|
-
* @memberof ApplicationSetsApi
|
|
3590
2067
|
*/
|
|
3591
2068
|
listApplicationSets(requestParameters: ApplicationSetsApiListApplicationSetsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSetsResponse, any>>;
|
|
3592
2069
|
/**
|
|
@@ -3595,13 +2072,11 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3595
2072
|
* @param {ApplicationSetsApiUpdateApplicationSetRequest} requestParameters Request parameters.
|
|
3596
2073
|
* @param {*} [options] Override http request option.
|
|
3597
2074
|
* @throws {RequiredError}
|
|
3598
|
-
* @memberof ApplicationSetsApi
|
|
3599
2075
|
*/
|
|
3600
2076
|
updateApplicationSet(requestParameters: ApplicationSetsApiUpdateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3601
2077
|
}
|
|
3602
2078
|
/**
|
|
3603
2079
|
* ApplicationTechnologiesApi - axios parameter creator
|
|
3604
|
-
* @export
|
|
3605
2080
|
*/
|
|
3606
2081
|
export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3607
2082
|
/**
|
|
@@ -3615,7 +2090,6 @@ export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration
|
|
|
3615
2090
|
};
|
|
3616
2091
|
/**
|
|
3617
2092
|
* ApplicationTechnologiesApi - functional programming interface
|
|
3618
|
-
* @export
|
|
3619
2093
|
*/
|
|
3620
2094
|
export declare const ApplicationTechnologiesApiFp: (configuration?: Configuration) => {
|
|
3621
2095
|
/**
|
|
@@ -3629,7 +2103,6 @@ export declare const ApplicationTechnologiesApiFp: (configuration?: Configuratio
|
|
|
3629
2103
|
};
|
|
3630
2104
|
/**
|
|
3631
2105
|
* ApplicationTechnologiesApi - factory interface
|
|
3632
|
-
* @export
|
|
3633
2106
|
*/
|
|
3634
2107
|
export declare const ApplicationTechnologiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3635
2108
|
/**
|
|
@@ -3643,22 +2116,15 @@ export declare const ApplicationTechnologiesApiFactory: (configuration?: Configu
|
|
|
3643
2116
|
};
|
|
3644
2117
|
/**
|
|
3645
2118
|
* Request parameters for listTechnologies operation in ApplicationTechnologiesApi.
|
|
3646
|
-
* @export
|
|
3647
|
-
* @interface ApplicationTechnologiesApiListTechnologiesRequest
|
|
3648
2119
|
*/
|
|
3649
2120
|
export interface ApplicationTechnologiesApiListTechnologiesRequest {
|
|
3650
2121
|
/**
|
|
3651
2122
|
* What project it is
|
|
3652
|
-
* @type {string}
|
|
3653
|
-
* @memberof ApplicationTechnologiesApiListTechnologies
|
|
3654
2123
|
*/
|
|
3655
2124
|
readonly project: string;
|
|
3656
2125
|
}
|
|
3657
2126
|
/**
|
|
3658
2127
|
* ApplicationTechnologiesApi - object-oriented interface
|
|
3659
|
-
* @export
|
|
3660
|
-
* @class ApplicationTechnologiesApi
|
|
3661
|
-
* @extends {BaseAPI}
|
|
3662
2128
|
*/
|
|
3663
2129
|
export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
3664
2130
|
/**
|
|
@@ -3667,13 +2133,11 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
3667
2133
|
* @param {ApplicationTechnologiesApiListTechnologiesRequest} requestParameters Request parameters.
|
|
3668
2134
|
* @param {*} [options] Override http request option.
|
|
3669
2135
|
* @throws {RequiredError}
|
|
3670
|
-
* @memberof ApplicationTechnologiesApi
|
|
3671
2136
|
*/
|
|
3672
2137
|
listTechnologies(requestParameters: ApplicationTechnologiesApiListTechnologiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationTechnologiesResponse, any>>;
|
|
3673
2138
|
}
|
|
3674
2139
|
/**
|
|
3675
2140
|
* ProductsApi - axios parameter creator
|
|
3676
|
-
* @export
|
|
3677
2141
|
*/
|
|
3678
2142
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3679
2143
|
/**
|
|
@@ -3786,7 +2250,6 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3786
2250
|
};
|
|
3787
2251
|
/**
|
|
3788
2252
|
* ProductsApi - functional programming interface
|
|
3789
|
-
* @export
|
|
3790
2253
|
*/
|
|
3791
2254
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3792
2255
|
/**
|
|
@@ -3851,7 +2314,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3851
2314
|
* @param {*} [options] Override http request option.
|
|
3852
2315
|
* @throws {RequiredError}
|
|
3853
2316
|
*/
|
|
3854
|
-
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2317
|
+
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
|
|
3855
2318
|
/**
|
|
3856
2319
|
* Lists all store listing products attached to the given project.
|
|
3857
2320
|
* @summary List products
|
|
@@ -3899,7 +2362,6 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3899
2362
|
};
|
|
3900
2363
|
/**
|
|
3901
2364
|
* ProductsApi - factory interface
|
|
3902
|
-
* @export
|
|
3903
2365
|
*/
|
|
3904
2366
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3905
2367
|
/**
|
|
@@ -3957,7 +2419,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3957
2419
|
* @param {*} [options] Override http request option.
|
|
3958
2420
|
* @throws {RequiredError}
|
|
3959
2421
|
*/
|
|
3960
|
-
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2422
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
|
|
3961
2423
|
/**
|
|
3962
2424
|
* Lists all store listing products attached to the given project.
|
|
3963
2425
|
* @summary List products
|
|
@@ -3993,266 +2455,175 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3993
2455
|
};
|
|
3994
2456
|
/**
|
|
3995
2457
|
* Request parameters for createProduct operation in ProductsApi.
|
|
3996
|
-
* @export
|
|
3997
|
-
* @interface ProductsApiCreateProductRequest
|
|
3998
2458
|
*/
|
|
3999
2459
|
export interface ProductsApiCreateProductRequest {
|
|
4000
2460
|
/**
|
|
4001
2461
|
* What project it is
|
|
4002
|
-
* @type {string}
|
|
4003
|
-
* @memberof ProductsApiCreateProduct
|
|
4004
2462
|
*/
|
|
4005
2463
|
readonly project: string;
|
|
4006
|
-
/**
|
|
4007
|
-
*
|
|
4008
|
-
* @type {CreateProductRequest}
|
|
4009
|
-
* @memberof ProductsApiCreateProduct
|
|
4010
|
-
*/
|
|
4011
2464
|
readonly createProductRequest?: CreateProductRequest;
|
|
4012
2465
|
}
|
|
4013
2466
|
/**
|
|
4014
2467
|
* Request parameters for deleteProduct operation in ProductsApi.
|
|
4015
|
-
* @export
|
|
4016
|
-
* @interface ProductsApiDeleteProductRequest
|
|
4017
2468
|
*/
|
|
4018
2469
|
export interface ProductsApiDeleteProductRequest {
|
|
4019
2470
|
/**
|
|
4020
2471
|
* What project it is
|
|
4021
|
-
* @type {string}
|
|
4022
|
-
* @memberof ProductsApiDeleteProduct
|
|
4023
2472
|
*/
|
|
4024
2473
|
readonly project: string;
|
|
4025
2474
|
/**
|
|
4026
2475
|
* Product\'s unique identifier
|
|
4027
|
-
* @type {string}
|
|
4028
|
-
* @memberof ProductsApiDeleteProduct
|
|
4029
2476
|
*/
|
|
4030
2477
|
readonly productId: string;
|
|
4031
2478
|
}
|
|
4032
2479
|
/**
|
|
4033
2480
|
* Request parameters for deleteProducts operation in ProductsApi.
|
|
4034
|
-
* @export
|
|
4035
|
-
* @interface ProductsApiDeleteProductsRequest
|
|
4036
2481
|
*/
|
|
4037
2482
|
export interface ProductsApiDeleteProductsRequest {
|
|
4038
2483
|
/**
|
|
4039
2484
|
* What project it is
|
|
4040
|
-
* @type {string}
|
|
4041
|
-
* @memberof ProductsApiDeleteProducts
|
|
4042
2485
|
*/
|
|
4043
2486
|
readonly project: string;
|
|
4044
2487
|
/**
|
|
4045
2488
|
* Delete products in bulk.
|
|
4046
|
-
* @type {DeleteProductsRequest}
|
|
4047
|
-
* @memberof ProductsApiDeleteProducts
|
|
4048
2489
|
*/
|
|
4049
2490
|
readonly deleteProductsRequest: DeleteProductsRequest;
|
|
4050
2491
|
}
|
|
4051
2492
|
/**
|
|
4052
2493
|
* Request parameters for duplicateProducts operation in ProductsApi.
|
|
4053
|
-
* @export
|
|
4054
|
-
* @interface ProductsApiDuplicateProductsRequest
|
|
4055
2494
|
*/
|
|
4056
2495
|
export interface ProductsApiDuplicateProductsRequest {
|
|
4057
2496
|
/**
|
|
4058
2497
|
* What project it is
|
|
4059
|
-
* @type {string}
|
|
4060
|
-
* @memberof ProductsApiDuplicateProducts
|
|
4061
2498
|
*/
|
|
4062
2499
|
readonly project: string;
|
|
4063
2500
|
/**
|
|
4064
2501
|
* A set of product IDs to duplicate and the project IDs to duplicate them to.
|
|
4065
|
-
* @type {DuplicateProductsRequest}
|
|
4066
|
-
* @memberof ProductsApiDuplicateProducts
|
|
4067
2502
|
*/
|
|
4068
2503
|
readonly duplicateProductsRequest?: DuplicateProductsRequest;
|
|
4069
2504
|
}
|
|
4070
2505
|
/**
|
|
4071
2506
|
* Request parameters for exportProducts operation in ProductsApi.
|
|
4072
|
-
* @export
|
|
4073
|
-
* @interface ProductsApiExportProductsRequest
|
|
4074
2507
|
*/
|
|
4075
2508
|
export interface ProductsApiExportProductsRequest {
|
|
4076
2509
|
/**
|
|
4077
2510
|
* What project it is
|
|
4078
|
-
* @type {string}
|
|
4079
|
-
* @memberof ProductsApiExportProducts
|
|
4080
2511
|
*/
|
|
4081
2512
|
readonly project: string;
|
|
4082
2513
|
}
|
|
4083
2514
|
/**
|
|
4084
2515
|
* Request parameters for getProduct operation in ProductsApi.
|
|
4085
|
-
* @export
|
|
4086
|
-
* @interface ProductsApiGetProductRequest
|
|
4087
2516
|
*/
|
|
4088
2517
|
export interface ProductsApiGetProductRequest {
|
|
4089
2518
|
/**
|
|
4090
2519
|
* What project it is
|
|
4091
|
-
* @type {string}
|
|
4092
|
-
* @memberof ProductsApiGetProduct
|
|
4093
2520
|
*/
|
|
4094
2521
|
readonly project: string;
|
|
4095
2522
|
/**
|
|
4096
2523
|
* Product\'s unique identifier
|
|
4097
|
-
* @type {string}
|
|
4098
|
-
* @memberof ProductsApiGetProduct
|
|
4099
2524
|
*/
|
|
4100
2525
|
readonly productId: string;
|
|
4101
2526
|
/**
|
|
4102
2527
|
* Filter response fields to only include a subset of the resource.
|
|
4103
|
-
* @type {string}
|
|
4104
|
-
* @memberof ProductsApiGetProduct
|
|
4105
2528
|
*/
|
|
4106
2529
|
readonly fields?: string;
|
|
4107
2530
|
}
|
|
4108
2531
|
/**
|
|
4109
2532
|
* Request parameters for importProducts operation in ProductsApi.
|
|
4110
|
-
* @export
|
|
4111
|
-
* @interface ProductsApiImportProductsRequest
|
|
4112
2533
|
*/
|
|
4113
2534
|
export interface ProductsApiImportProductsRequest {
|
|
4114
2535
|
/**
|
|
4115
2536
|
* What project it is
|
|
4116
|
-
* @type {string}
|
|
4117
|
-
* @memberof ProductsApiImportProducts
|
|
4118
2537
|
*/
|
|
4119
2538
|
readonly project: string;
|
|
4120
2539
|
/**
|
|
4121
2540
|
* A base64 data URL of a CSV file containing data for one or more products.
|
|
4122
|
-
* @type {string}
|
|
4123
|
-
* @memberof ProductsApiImportProducts
|
|
4124
2541
|
*/
|
|
4125
2542
|
readonly body?: string;
|
|
4126
2543
|
}
|
|
4127
2544
|
/**
|
|
4128
2545
|
* Request parameters for listProducts operation in ProductsApi.
|
|
4129
|
-
* @export
|
|
4130
|
-
* @interface ProductsApiListProductsRequest
|
|
4131
2546
|
*/
|
|
4132
2547
|
export interface ProductsApiListProductsRequest {
|
|
4133
2548
|
/**
|
|
4134
2549
|
* What project it is
|
|
4135
|
-
* @type {string}
|
|
4136
|
-
* @memberof ProductsApiListProducts
|
|
4137
2550
|
*/
|
|
4138
2551
|
readonly project: string;
|
|
4139
2552
|
/**
|
|
4140
2553
|
* Page reference token
|
|
4141
|
-
* @type {number}
|
|
4142
|
-
* @memberof ProductsApiListProducts
|
|
4143
2554
|
*/
|
|
4144
2555
|
readonly pageToken?: number;
|
|
4145
2556
|
/**
|
|
4146
2557
|
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
4147
|
-
* @type {string}
|
|
4148
|
-
* @memberof ProductsApiListProducts
|
|
4149
2558
|
*/
|
|
4150
2559
|
readonly search?: string;
|
|
4151
2560
|
/**
|
|
4152
2561
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4153
|
-
* @type {Array<string>}
|
|
4154
|
-
* @memberof ProductsApiListProducts
|
|
4155
2562
|
*/
|
|
4156
2563
|
readonly sortBy?: Array<string>;
|
|
4157
2564
|
/**
|
|
4158
2565
|
* Start of date range to filter
|
|
4159
|
-
* @type {string}
|
|
4160
|
-
* @memberof ProductsApiListProducts
|
|
4161
2566
|
*/
|
|
4162
2567
|
readonly start?: string;
|
|
4163
2568
|
/**
|
|
4164
2569
|
* End of date range to filter
|
|
4165
|
-
* @type {string}
|
|
4166
|
-
* @memberof ProductsApiListProducts
|
|
4167
2570
|
*/
|
|
4168
2571
|
readonly end?: string;
|
|
4169
2572
|
/**
|
|
4170
2573
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4171
|
-
* @type {'createdAt' | 'updatedAt'}
|
|
4172
|
-
* @memberof ProductsApiListProducts
|
|
4173
2574
|
*/
|
|
4174
2575
|
readonly dateFilterType?: ListProductsDateFilterTypeEnum;
|
|
4175
2576
|
/**
|
|
4176
2577
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4177
|
-
* @type {number}
|
|
4178
|
-
* @memberof ProductsApiListProducts
|
|
4179
2578
|
*/
|
|
4180
2579
|
readonly pageSize?: number;
|
|
4181
2580
|
/**
|
|
4182
2581
|
* Filter response fields to only include a subset of the resource.
|
|
4183
|
-
* @type {string}
|
|
4184
|
-
* @memberof ProductsApiListProducts
|
|
4185
2582
|
*/
|
|
4186
2583
|
readonly fields?: string;
|
|
4187
2584
|
}
|
|
4188
2585
|
/**
|
|
4189
2586
|
* Request parameters for seoOptimiseProducts operation in ProductsApi.
|
|
4190
|
-
* @export
|
|
4191
|
-
* @interface ProductsApiSeoOptimiseProductsRequest
|
|
4192
2587
|
*/
|
|
4193
2588
|
export interface ProductsApiSeoOptimiseProductsRequest {
|
|
4194
2589
|
/**
|
|
4195
2590
|
* What project it is
|
|
4196
|
-
* @type {string}
|
|
4197
|
-
* @memberof ProductsApiSeoOptimiseProducts
|
|
4198
2591
|
*/
|
|
4199
2592
|
readonly project: string;
|
|
4200
2593
|
/**
|
|
4201
2594
|
* A set of product IDs to AI SEO optimise.
|
|
4202
|
-
* @type {SeoOptimiseProductsRequest}
|
|
4203
|
-
* @memberof ProductsApiSeoOptimiseProducts
|
|
4204
2595
|
*/
|
|
4205
2596
|
readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest;
|
|
4206
2597
|
}
|
|
4207
2598
|
/**
|
|
4208
2599
|
* Request parameters for updateProduct operation in ProductsApi.
|
|
4209
|
-
* @export
|
|
4210
|
-
* @interface ProductsApiUpdateProductRequest
|
|
4211
2600
|
*/
|
|
4212
2601
|
export interface ProductsApiUpdateProductRequest {
|
|
4213
2602
|
/**
|
|
4214
2603
|
* What project it is
|
|
4215
|
-
* @type {string}
|
|
4216
|
-
* @memberof ProductsApiUpdateProduct
|
|
4217
2604
|
*/
|
|
4218
2605
|
readonly project: string;
|
|
4219
2606
|
/**
|
|
4220
2607
|
* Product\'s unique identifier
|
|
4221
|
-
* @type {string}
|
|
4222
|
-
* @memberof ProductsApiUpdateProduct
|
|
4223
2608
|
*/
|
|
4224
2609
|
readonly productId: string;
|
|
4225
|
-
/**
|
|
4226
|
-
*
|
|
4227
|
-
* @type {UpdateProductRequest}
|
|
4228
|
-
* @memberof ProductsApiUpdateProduct
|
|
4229
|
-
*/
|
|
4230
2610
|
readonly updateProductRequest?: UpdateProductRequest;
|
|
4231
2611
|
}
|
|
4232
2612
|
/**
|
|
4233
2613
|
* Request parameters for updateProducts operation in ProductsApi.
|
|
4234
|
-
* @export
|
|
4235
|
-
* @interface ProductsApiUpdateProductsRequest
|
|
4236
2614
|
*/
|
|
4237
2615
|
export interface ProductsApiUpdateProductsRequest {
|
|
4238
2616
|
/**
|
|
4239
2617
|
* What project it is
|
|
4240
|
-
* @type {string}
|
|
4241
|
-
* @memberof ProductsApiUpdateProducts
|
|
4242
2618
|
*/
|
|
4243
2619
|
readonly project: string;
|
|
4244
2620
|
/**
|
|
4245
2621
|
* Update products in bulk.
|
|
4246
|
-
* @type {UpdateProductsRequest}
|
|
4247
|
-
* @memberof ProductsApiUpdateProducts
|
|
4248
2622
|
*/
|
|
4249
2623
|
readonly updateProductsRequest: UpdateProductsRequest;
|
|
4250
2624
|
}
|
|
4251
2625
|
/**
|
|
4252
2626
|
* ProductsApi - object-oriented interface
|
|
4253
|
-
* @export
|
|
4254
|
-
* @class ProductsApi
|
|
4255
|
-
* @extends {BaseAPI}
|
|
4256
2627
|
*/
|
|
4257
2628
|
export declare class ProductsApi extends BaseAPI {
|
|
4258
2629
|
/**
|
|
@@ -4261,7 +2632,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4261
2632
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
4262
2633
|
* @param {*} [options] Override http request option.
|
|
4263
2634
|
* @throws {RequiredError}
|
|
4264
|
-
* @memberof ProductsApi
|
|
4265
2635
|
*/
|
|
4266
2636
|
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4267
2637
|
/**
|
|
@@ -4270,7 +2640,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4270
2640
|
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
4271
2641
|
* @param {*} [options] Override http request option.
|
|
4272
2642
|
* @throws {RequiredError}
|
|
4273
|
-
* @memberof ProductsApi
|
|
4274
2643
|
*/
|
|
4275
2644
|
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4276
2645
|
/**
|
|
@@ -4279,7 +2648,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4279
2648
|
* @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
|
|
4280
2649
|
* @param {*} [options] Override http request option.
|
|
4281
2650
|
* @throws {RequiredError}
|
|
4282
|
-
* @memberof ProductsApi
|
|
4283
2651
|
*/
|
|
4284
2652
|
deleteProducts(requestParameters: ProductsApiDeleteProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4285
2653
|
/**
|
|
@@ -4288,7 +2656,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4288
2656
|
* @param {ProductsApiDuplicateProductsRequest} requestParameters Request parameters.
|
|
4289
2657
|
* @param {*} [options] Override http request option.
|
|
4290
2658
|
* @throws {RequiredError}
|
|
4291
|
-
* @memberof ProductsApi
|
|
4292
2659
|
*/
|
|
4293
2660
|
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateProducts202Response, any>>;
|
|
4294
2661
|
/**
|
|
@@ -4297,7 +2664,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4297
2664
|
* @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
|
|
4298
2665
|
* @param {*} [options] Override http request option.
|
|
4299
2666
|
* @throws {RequiredError}
|
|
4300
|
-
* @memberof ProductsApi
|
|
4301
2667
|
*/
|
|
4302
2668
|
exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4303
2669
|
/**
|
|
@@ -4306,7 +2672,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4306
2672
|
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
4307
2673
|
* @param {*} [options] Override http request option.
|
|
4308
2674
|
* @throws {RequiredError}
|
|
4309
|
-
* @memberof ProductsApi
|
|
4310
2675
|
*/
|
|
4311
2676
|
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4312
2677
|
/**
|
|
@@ -4315,16 +2680,14 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4315
2680
|
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
4316
2681
|
* @param {*} [options] Override http request option.
|
|
4317
2682
|
* @throws {RequiredError}
|
|
4318
|
-
* @memberof ProductsApi
|
|
4319
2683
|
*/
|
|
4320
|
-
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2684
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
4321
2685
|
/**
|
|
4322
2686
|
* Lists all store listing products attached to the given project.
|
|
4323
2687
|
* @summary List products
|
|
4324
2688
|
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
4325
2689
|
* @param {*} [options] Override http request option.
|
|
4326
2690
|
* @throws {RequiredError}
|
|
4327
|
-
* @memberof ProductsApi
|
|
4328
2691
|
*/
|
|
4329
2692
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
4330
2693
|
/**
|
|
@@ -4333,7 +2696,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4333
2696
|
* @param {ProductsApiSeoOptimiseProductsRequest} requestParameters Request parameters.
|
|
4334
2697
|
* @param {*} [options] Override http request option.
|
|
4335
2698
|
* @throws {RequiredError}
|
|
4336
|
-
* @memberof ProductsApi
|
|
4337
2699
|
*/
|
|
4338
2700
|
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimiseProducts202Response, any>>;
|
|
4339
2701
|
/**
|
|
@@ -4342,7 +2704,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4342
2704
|
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
4343
2705
|
* @param {*} [options] Override http request option.
|
|
4344
2706
|
* @throws {RequiredError}
|
|
4345
|
-
* @memberof ProductsApi
|
|
4346
2707
|
*/
|
|
4347
2708
|
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4348
2709
|
/**
|
|
@@ -4351,13 +2712,9 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4351
2712
|
* @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
|
|
4352
2713
|
* @param {*} [options] Override http request option.
|
|
4353
2714
|
* @throws {RequiredError}
|
|
4354
|
-
* @memberof ProductsApi
|
|
4355
2715
|
*/
|
|
4356
2716
|
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
4357
2717
|
}
|
|
4358
|
-
/**
|
|
4359
|
-
* @export
|
|
4360
|
-
*/
|
|
4361
2718
|
export declare const ListProductsDateFilterTypeEnum: {
|
|
4362
2719
|
readonly CreatedAt: "createdAt";
|
|
4363
2720
|
readonly UpdatedAt: "updatedAt";
|
|
@@ -4365,7 +2722,6 @@ export declare const ListProductsDateFilterTypeEnum: {
|
|
|
4365
2722
|
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
4366
2723
|
/**
|
|
4367
2724
|
* VariantsApi - axios parameter creator
|
|
4368
|
-
* @export
|
|
4369
2725
|
*/
|
|
4370
2726
|
export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4371
2727
|
/**
|
|
@@ -4393,7 +2749,6 @@ export declare const VariantsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4393
2749
|
};
|
|
4394
2750
|
/**
|
|
4395
2751
|
* VariantsApi - functional programming interface
|
|
4396
|
-
* @export
|
|
4397
2752
|
*/
|
|
4398
2753
|
export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
4399
2754
|
/**
|
|
@@ -4421,7 +2776,6 @@ export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
|
4421
2776
|
};
|
|
4422
2777
|
/**
|
|
4423
2778
|
* VariantsApi - factory interface
|
|
4424
|
-
* @export
|
|
4425
2779
|
*/
|
|
4426
2780
|
export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4427
2781
|
/**
|
|
@@ -4443,71 +2797,48 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
|
|
|
4443
2797
|
};
|
|
4444
2798
|
/**
|
|
4445
2799
|
* Request parameters for getVariant operation in VariantsApi.
|
|
4446
|
-
* @export
|
|
4447
|
-
* @interface VariantsApiGetVariantRequest
|
|
4448
2800
|
*/
|
|
4449
2801
|
export interface VariantsApiGetVariantRequest {
|
|
4450
2802
|
/**
|
|
4451
2803
|
* What project it is
|
|
4452
|
-
* @type {string}
|
|
4453
|
-
* @memberof VariantsApiGetVariant
|
|
4454
2804
|
*/
|
|
4455
2805
|
readonly project: string;
|
|
4456
2806
|
/**
|
|
4457
2807
|
* Variants unique identifier
|
|
4458
|
-
* @type {string}
|
|
4459
|
-
* @memberof VariantsApiGetVariant
|
|
4460
2808
|
*/
|
|
4461
2809
|
readonly variantId: string;
|
|
4462
2810
|
/**
|
|
4463
2811
|
* Filter response fields to only include a subset of the resource.
|
|
4464
|
-
* @type {string}
|
|
4465
|
-
* @memberof VariantsApiGetVariant
|
|
4466
2812
|
*/
|
|
4467
2813
|
readonly fields?: string;
|
|
4468
2814
|
}
|
|
4469
2815
|
/**
|
|
4470
2816
|
* Request parameters for listVariants operation in VariantsApi.
|
|
4471
|
-
* @export
|
|
4472
|
-
* @interface VariantsApiListVariantsRequest
|
|
4473
2817
|
*/
|
|
4474
2818
|
export interface VariantsApiListVariantsRequest {
|
|
4475
2819
|
/**
|
|
4476
2820
|
* What project it is
|
|
4477
|
-
* @type {string}
|
|
4478
|
-
* @memberof VariantsApiListVariants
|
|
4479
2821
|
*/
|
|
4480
2822
|
readonly project: string;
|
|
4481
2823
|
/**
|
|
4482
2824
|
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
|
|
4483
|
-
* @type {string}
|
|
4484
|
-
* @memberof VariantsApiListVariants
|
|
4485
2825
|
*/
|
|
4486
2826
|
readonly search?: string;
|
|
4487
2827
|
/**
|
|
4488
2828
|
* Page reference token
|
|
4489
|
-
* @type {number}
|
|
4490
|
-
* @memberof VariantsApiListVariants
|
|
4491
2829
|
*/
|
|
4492
2830
|
readonly pageToken?: number;
|
|
4493
2831
|
/**
|
|
4494
2832
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4495
|
-
* @type {number}
|
|
4496
|
-
* @memberof VariantsApiListVariants
|
|
4497
2833
|
*/
|
|
4498
2834
|
readonly pageSize?: number;
|
|
4499
2835
|
/**
|
|
4500
2836
|
* Filter response fields to only include a subset of the resource.
|
|
4501
|
-
* @type {string}
|
|
4502
|
-
* @memberof VariantsApiListVariants
|
|
4503
2837
|
*/
|
|
4504
2838
|
readonly fields?: string;
|
|
4505
2839
|
}
|
|
4506
2840
|
/**
|
|
4507
2841
|
* VariantsApi - object-oriented interface
|
|
4508
|
-
* @export
|
|
4509
|
-
* @class VariantsApi
|
|
4510
|
-
* @extends {BaseAPI}
|
|
4511
2842
|
*/
|
|
4512
2843
|
export declare class VariantsApi extends BaseAPI {
|
|
4513
2844
|
/**
|
|
@@ -4516,7 +2847,6 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
4516
2847
|
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
4517
2848
|
* @param {*} [options] Override http request option.
|
|
4518
2849
|
* @throws {RequiredError}
|
|
4519
|
-
* @memberof VariantsApi
|
|
4520
2850
|
*/
|
|
4521
2851
|
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
4522
2852
|
/**
|
|
@@ -4525,7 +2855,6 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
4525
2855
|
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
4526
2856
|
* @param {*} [options] Override http request option.
|
|
4527
2857
|
* @throws {RequiredError}
|
|
4528
|
-
* @memberof VariantsApi
|
|
4529
2858
|
*/
|
|
4530
2859
|
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
|
|
4531
2860
|
}
|