@teemill/product-catalog 1.69.2 → 1.71.0
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 +18 -1687
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +19 -1688
- 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 +19 -1688
- 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/CreateProduct.md +2 -0
- package/docs/CreateProductRequest.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.0
|
|
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,708 +469,380 @@ 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
|
-
*
|
|
1106
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
1107
|
-
* @memberof CreateProduct
|
|
602
|
+
* The brand of the product.
|
|
1108
603
|
*/
|
|
604
|
+
'brand'?: string | null;
|
|
1109
605
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
1110
606
|
/**
|
|
1111
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
|
|
1112
|
-
* @type {string}
|
|
1113
|
-
* @memberof CreateProduct
|
|
1114
608
|
*/
|
|
1115
609
|
'targetSearchPhrase'?: string;
|
|
1116
610
|
/**
|
|
1117
611
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
1118
|
-
* @type {Array<string>}
|
|
1119
|
-
* @memberof CreateProduct
|
|
1120
612
|
*/
|
|
1121
613
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1122
614
|
/**
|
|
1123
615
|
* Additional product tags used for searching and filtering.
|
|
1124
|
-
* @type {Array<string>}
|
|
1125
|
-
* @memberof CreateProduct
|
|
1126
616
|
*/
|
|
1127
617
|
'tags'?: Array<string>;
|
|
1128
618
|
/**
|
|
1129
619
|
* Internal tags used for internal searching and filtering.
|
|
1130
|
-
* @type {Array<string>}
|
|
1131
|
-
* @memberof CreateProduct
|
|
1132
620
|
*/
|
|
1133
621
|
'internalTags'?: Array<string>;
|
|
1134
622
|
/**
|
|
1135
623
|
* Variants
|
|
1136
|
-
* @type {Array<CreateProductVariant>}
|
|
1137
|
-
* @memberof CreateProduct
|
|
1138
624
|
*/
|
|
1139
625
|
'variants': Array<CreateProductVariant>;
|
|
1140
626
|
/**
|
|
1141
627
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
1142
|
-
* @type {Array<CreateProductImagesInner>}
|
|
1143
|
-
* @memberof CreateProduct
|
|
1144
628
|
*/
|
|
1145
629
|
'images'?: Array<CreateProductImagesInner>;
|
|
1146
630
|
/**
|
|
1147
631
|
* Videos to attach to the product.
|
|
1148
|
-
* @type {Array<CreateProductVideosInner>}
|
|
1149
|
-
* @memberof CreateProduct
|
|
1150
632
|
*/
|
|
1151
633
|
'videos'?: Array<CreateProductVideosInner>;
|
|
1152
634
|
/**
|
|
1153
635
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1154
|
-
* @type {Array<CreateProductAdditionalFilesInner>}
|
|
1155
|
-
* @memberof CreateProduct
|
|
1156
636
|
*/
|
|
1157
637
|
'additionalFiles'?: Array<CreateProductAdditionalFilesInner>;
|
|
1158
638
|
/**
|
|
1159
639
|
* List of application set UUIDs to associate with this product
|
|
1160
|
-
* @type {Array<string>}
|
|
1161
|
-
* @memberof CreateProduct
|
|
1162
640
|
*/
|
|
1163
641
|
'applicationSets'?: Array<string>;
|
|
1164
642
|
/**
|
|
1165
643
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1166
|
-
* @type {boolean}
|
|
1167
|
-
* @memberof CreateProduct
|
|
1168
644
|
*/
|
|
1169
645
|
'includeInDataFeeds'?: boolean;
|
|
1170
646
|
/**
|
|
1171
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.
|
|
1172
|
-
* @type {number}
|
|
1173
|
-
* @memberof CreateProduct
|
|
1174
648
|
*/
|
|
1175
649
|
'shopifyId'?: number | null;
|
|
1176
650
|
/**
|
|
1177
651
|
* Key/value pairs that can be used to store additional information about the product
|
|
1178
|
-
* @type {Array<MetaField>}
|
|
1179
|
-
* @memberof CreateProduct
|
|
1180
652
|
*/
|
|
1181
653
|
'metafields'?: Array<MetaField>;
|
|
1182
654
|
/**
|
|
1183
655
|
* A JSON object that defines the personalization template for the product.
|
|
1184
|
-
* @type {string}
|
|
1185
|
-
* @memberof CreateProduct
|
|
1186
656
|
*/
|
|
1187
657
|
'personalizationTemplate'?: string;
|
|
1188
658
|
}
|
|
1189
|
-
/**
|
|
1190
|
-
*
|
|
1191
|
-
* @export
|
|
1192
|
-
* @interface CreateProductAdditionalFilesInner
|
|
1193
|
-
*/
|
|
1194
659
|
export interface CreateProductAdditionalFilesInner {
|
|
1195
660
|
/**
|
|
1196
661
|
* Publicly available file URL.
|
|
1197
|
-
* @type {string}
|
|
1198
|
-
* @memberof CreateProductAdditionalFilesInner
|
|
1199
662
|
*/
|
|
1200
663
|
'src'?: string;
|
|
1201
664
|
}
|
|
1202
|
-
/**
|
|
1203
|
-
*
|
|
1204
|
-
* @export
|
|
1205
|
-
* @interface CreateProductImagesInner
|
|
1206
|
-
*/
|
|
1207
665
|
export interface CreateProductImagesInner {
|
|
1208
666
|
/**
|
|
1209
667
|
* Publicly available file URL.
|
|
1210
|
-
* @type {string}
|
|
1211
|
-
* @memberof CreateProductImagesInner
|
|
1212
668
|
*/
|
|
1213
669
|
'src'?: string;
|
|
1214
670
|
/**
|
|
1215
671
|
* Image type.
|
|
1216
|
-
* @type {string}
|
|
1217
|
-
* @memberof CreateProductImagesInner
|
|
1218
672
|
*/
|
|
1219
673
|
'type'?: string | null;
|
|
1220
674
|
}
|
|
1221
675
|
/**
|
|
1222
676
|
* @type CreateProductRequest
|
|
1223
|
-
* @export
|
|
1224
677
|
*/
|
|
1225
678
|
export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
1226
|
-
/**
|
|
1227
|
-
*
|
|
1228
|
-
* @export
|
|
1229
|
-
* @interface CreateProductVariant
|
|
1230
|
-
*/
|
|
1231
679
|
export interface CreateProductVariant {
|
|
1232
680
|
/**
|
|
1233
681
|
* Attributes associated to a variant such as Colour and Size.
|
|
1234
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
1235
|
-
* @memberof CreateProductVariant
|
|
1236
682
|
*/
|
|
1237
683
|
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
1238
|
-
/**
|
|
1239
|
-
*
|
|
1240
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
1241
|
-
* @memberof CreateProductVariant
|
|
1242
|
-
*/
|
|
1243
684
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
1244
|
-
/**
|
|
1245
|
-
*
|
|
1246
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
1247
|
-
* @memberof CreateProductVariant
|
|
1248
|
-
*/
|
|
1249
685
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
1250
686
|
/**
|
|
1251
687
|
* A custom stock keeping unit for the variant.
|
|
1252
|
-
* @type {string}
|
|
1253
|
-
* @memberof CreateProductVariant
|
|
1254
688
|
*/
|
|
1255
689
|
'sku'?: string;
|
|
1256
690
|
/**
|
|
1257
691
|
* Design applications. If not provided, the product will be blank.
|
|
1258
|
-
* @type {Array<Application>}
|
|
1259
|
-
* @memberof CreateProductVariant
|
|
1260
692
|
*/
|
|
1261
693
|
'applications'?: Array<Application>;
|
|
1262
694
|
/**
|
|
1263
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.
|
|
1264
|
-
* @type {Array<CreateProductVariantImagesInner>}
|
|
1265
|
-
* @memberof CreateProductVariant
|
|
1266
696
|
*/
|
|
1267
697
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
1268
698
|
/**
|
|
1269
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.
|
|
1270
|
-
* @type {string}
|
|
1271
|
-
* @memberof CreateProductVariant
|
|
1272
700
|
*/
|
|
1273
701
|
'barcode'?: string | null;
|
|
1274
702
|
/**
|
|
1275
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.
|
|
1276
|
-
* @type {number}
|
|
1277
|
-
* @memberof CreateProductVariant
|
|
1278
704
|
*/
|
|
1279
705
|
'shopifyId'?: number | null;
|
|
1280
|
-
/**
|
|
1281
|
-
*
|
|
1282
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}
|
|
1283
|
-
* @memberof CreateProductVariant
|
|
1284
|
-
*/
|
|
1285
706
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1286
707
|
}
|
|
1287
|
-
/**
|
|
1288
|
-
*
|
|
1289
|
-
* @export
|
|
1290
|
-
* @interface CreateProductVariantImagesInner
|
|
1291
|
-
*/
|
|
1292
708
|
export interface CreateProductVariantImagesInner {
|
|
1293
709
|
/**
|
|
1294
710
|
* Publicly available file URL.
|
|
1295
|
-
* @type {string}
|
|
1296
|
-
* @memberof CreateProductVariantImagesInner
|
|
1297
711
|
*/
|
|
1298
712
|
'src'?: string;
|
|
1299
713
|
}
|
|
1300
|
-
/**
|
|
1301
|
-
*
|
|
1302
|
-
* @export
|
|
1303
|
-
* @interface CreateProductVideosInner
|
|
1304
|
-
*/
|
|
1305
714
|
export interface CreateProductVideosInner {
|
|
1306
715
|
/**
|
|
1307
716
|
* Publicly available file URL.
|
|
1308
|
-
* @type {string}
|
|
1309
|
-
* @memberof CreateProductVideosInner
|
|
1310
717
|
*/
|
|
1311
718
|
'src'?: string;
|
|
1312
719
|
}
|
|
1313
|
-
/**
|
|
1314
|
-
*
|
|
1315
|
-
* @export
|
|
1316
|
-
* @interface DeleteProductsRequest
|
|
1317
|
-
*/
|
|
1318
720
|
export interface DeleteProductsRequest {
|
|
1319
|
-
/**
|
|
1320
|
-
*
|
|
1321
|
-
* @type {Array<string>}
|
|
1322
|
-
* @memberof DeleteProductsRequest
|
|
1323
|
-
*/
|
|
1324
721
|
'products'?: Array<string>;
|
|
1325
722
|
}
|
|
1326
|
-
/**
|
|
1327
|
-
*
|
|
1328
|
-
* @export
|
|
1329
|
-
* @interface DuplicateProducts202Response
|
|
1330
|
-
*/
|
|
1331
723
|
export interface DuplicateProducts202Response {
|
|
1332
724
|
/**
|
|
1333
725
|
* A message describing the duplication status
|
|
1334
|
-
* @type {string}
|
|
1335
|
-
* @memberof DuplicateProducts202Response
|
|
1336
726
|
*/
|
|
1337
727
|
'message'?: string;
|
|
1338
728
|
}
|
|
1339
|
-
/**
|
|
1340
|
-
*
|
|
1341
|
-
* @export
|
|
1342
|
-
* @interface DuplicateProductsRequest
|
|
1343
|
-
*/
|
|
1344
729
|
export interface DuplicateProductsRequest {
|
|
1345
730
|
/**
|
|
1346
731
|
* A set of product IDs to duplicate.
|
|
1347
|
-
* @type {Array<string>}
|
|
1348
|
-
* @memberof DuplicateProductsRequest
|
|
1349
732
|
*/
|
|
1350
733
|
'ids': Array<string>;
|
|
1351
734
|
/**
|
|
1352
735
|
* A set of project IDs to duplicate the products to.
|
|
1353
|
-
* @type {Array<string>}
|
|
1354
|
-
* @memberof DuplicateProductsRequest
|
|
1355
736
|
*/
|
|
1356
737
|
'projects': Array<string>;
|
|
1357
738
|
}
|
|
1358
|
-
/**
|
|
1359
|
-
*
|
|
1360
|
-
* @export
|
|
1361
|
-
* @interface ExportProducts202Response
|
|
1362
|
-
*/
|
|
1363
739
|
export interface ExportProducts202Response {
|
|
1364
740
|
/**
|
|
1365
741
|
* A message describing the export status
|
|
1366
|
-
* @type {string}
|
|
1367
|
-
* @memberof ExportProducts202Response
|
|
1368
742
|
*/
|
|
1369
743
|
'message'?: string;
|
|
1370
744
|
}
|
|
1371
745
|
/**
|
|
1372
746
|
* Image description
|
|
1373
|
-
* @export
|
|
1374
|
-
* @interface Image
|
|
1375
747
|
*/
|
|
1376
748
|
export interface Image {
|
|
1377
749
|
/**
|
|
1378
750
|
* Unique object identifier
|
|
1379
|
-
* @type {string}
|
|
1380
|
-
* @memberof Image
|
|
1381
751
|
*/
|
|
1382
752
|
'id'?: string;
|
|
1383
|
-
/**
|
|
1384
|
-
*
|
|
1385
|
-
* @type {string}
|
|
1386
|
-
* @memberof Image
|
|
1387
|
-
*/
|
|
1388
753
|
'src': string;
|
|
1389
|
-
/**
|
|
1390
|
-
*
|
|
1391
|
-
* @type {string}
|
|
1392
|
-
* @memberof Image
|
|
1393
|
-
*/
|
|
1394
754
|
'type'?: string | null;
|
|
1395
|
-
/**
|
|
1396
|
-
*
|
|
1397
|
-
* @type {string}
|
|
1398
|
-
* @memberof Image
|
|
1399
|
-
*/
|
|
1400
755
|
'alt'?: string;
|
|
1401
756
|
/**
|
|
1402
757
|
* List of variant Ids
|
|
1403
|
-
* @type {Array<string>}
|
|
1404
|
-
* @memberof Image
|
|
1405
758
|
*/
|
|
1406
759
|
'variantIds'?: Array<string>;
|
|
1407
|
-
/**
|
|
1408
|
-
*
|
|
1409
|
-
* @type {number}
|
|
1410
|
-
* @memberof Image
|
|
1411
|
-
*/
|
|
1412
760
|
'sortOrder'?: number;
|
|
1413
|
-
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @type {string}
|
|
1416
|
-
* @memberof Image
|
|
1417
|
-
*/
|
|
1418
761
|
'createdAt'?: string;
|
|
1419
|
-
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @type {string}
|
|
1422
|
-
* @memberof Image
|
|
1423
|
-
*/
|
|
1424
762
|
'updatedAt'?: string;
|
|
1425
763
|
}
|
|
1426
|
-
/**
|
|
1427
|
-
*
|
|
1428
|
-
* @export
|
|
1429
|
-
* @interface ImageFile
|
|
1430
|
-
*/
|
|
1431
764
|
export interface ImageFile {
|
|
1432
765
|
/**
|
|
1433
766
|
* Publicly available file URL.
|
|
1434
|
-
* @type {string}
|
|
1435
|
-
* @memberof ImageFile
|
|
1436
767
|
*/
|
|
1437
768
|
'src': string;
|
|
1438
769
|
/**
|
|
1439
770
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
1440
|
-
* @type {string}
|
|
1441
|
-
* @memberof ImageFile
|
|
1442
771
|
*/
|
|
1443
772
|
'id'?: string | null;
|
|
1444
773
|
/**
|
|
1445
774
|
* Image type.
|
|
1446
|
-
* @type {string}
|
|
1447
|
-
* @memberof ImageFile
|
|
1448
775
|
*/
|
|
1449
776
|
'type'?: string | null;
|
|
1450
777
|
/**
|
|
1451
778
|
* List of variant Ids to associate with the image.
|
|
1452
|
-
* @type {Array<string>}
|
|
1453
|
-
* @memberof ImageFile
|
|
1454
779
|
*/
|
|
1455
780
|
'variantIds'?: Array<string>;
|
|
1456
|
-
/**
|
|
1457
|
-
*
|
|
1458
|
-
* @type {ImageFileFocalPoint}
|
|
1459
|
-
* @memberof ImageFile
|
|
1460
|
-
*/
|
|
1461
781
|
'focalPoint'?: ImageFileFocalPoint;
|
|
1462
782
|
/**
|
|
1463
783
|
* The zoom level of the image, used for cropping the image when it\'s rendered to specific dimensions.
|
|
1464
|
-
* @type {number}
|
|
1465
|
-
* @memberof ImageFile
|
|
1466
784
|
*/
|
|
1467
785
|
'zoom'?: number;
|
|
1468
786
|
}
|
|
1469
787
|
/**
|
|
1470
788
|
* The focal point of the image, used for positioning the image when it\'s rendered to specific dimensions.
|
|
1471
|
-
* @export
|
|
1472
|
-
* @interface ImageFileFocalPoint
|
|
1473
789
|
*/
|
|
1474
790
|
export interface ImageFileFocalPoint {
|
|
1475
791
|
/**
|
|
1476
792
|
* The x-coordinate of the focal point, where 0 is the left edge and 1 is the right edge.
|
|
1477
|
-
* @type {number}
|
|
1478
|
-
* @memberof ImageFileFocalPoint
|
|
1479
793
|
*/
|
|
1480
794
|
'x': number;
|
|
1481
795
|
/**
|
|
1482
796
|
* The y-coordinate of the focal point, where 0 is the top edge and 1 is the bottom edge.
|
|
1483
|
-
* @type {number}
|
|
1484
|
-
* @memberof ImageFileFocalPoint
|
|
1485
797
|
*/
|
|
1486
798
|
'y': number;
|
|
1487
799
|
}
|
|
1488
|
-
|
|
1489
|
-
*
|
|
1490
|
-
* @export
|
|
1491
|
-
* @interface InlineObject
|
|
1492
|
-
*/
|
|
1493
|
-
export interface InlineObject {
|
|
800
|
+
export interface ImportProducts200Response {
|
|
1494
801
|
/**
|
|
1495
802
|
* Id of the product import
|
|
1496
|
-
* @type {string}
|
|
1497
|
-
* @memberof InlineObject
|
|
1498
803
|
*/
|
|
1499
804
|
'importId'?: string;
|
|
1500
805
|
}
|
|
1501
|
-
/**
|
|
1502
|
-
*
|
|
1503
|
-
* @export
|
|
1504
|
-
* @interface Location
|
|
1505
|
-
*/
|
|
1506
806
|
export interface Location {
|
|
1507
807
|
/**
|
|
1508
808
|
* The total number of units available at the location
|
|
1509
|
-
* @type {number}
|
|
1510
|
-
* @memberof Location
|
|
1511
809
|
*/
|
|
1512
810
|
'level': number;
|
|
1513
811
|
/**
|
|
1514
812
|
* ISO alpha-2 country code
|
|
1515
|
-
* @type {string}
|
|
1516
|
-
* @memberof Location
|
|
1517
813
|
*/
|
|
1518
814
|
'country': string;
|
|
1519
815
|
}
|
|
1520
816
|
/**
|
|
1521
817
|
* Key/value pairs that can be used to store additional information on the product
|
|
1522
|
-
* @export
|
|
1523
|
-
* @interface MetaField
|
|
1524
818
|
*/
|
|
1525
819
|
export interface MetaField {
|
|
1526
820
|
/**
|
|
1527
821
|
* The key of the property
|
|
1528
|
-
* @type {string}
|
|
1529
|
-
* @memberof MetaField
|
|
1530
822
|
*/
|
|
1531
823
|
'key': string;
|
|
1532
824
|
/**
|
|
1533
825
|
* The string value of the property
|
|
1534
|
-
* @type {string}
|
|
1535
|
-
* @memberof MetaField
|
|
1536
826
|
*/
|
|
1537
827
|
'value': string;
|
|
1538
828
|
}
|
|
1539
|
-
/**
|
|
1540
|
-
*
|
|
1541
|
-
* @export
|
|
1542
|
-
* @interface OptimisationHistoryItem
|
|
1543
|
-
*/
|
|
1544
829
|
export interface OptimisationHistoryItem {
|
|
1545
830
|
/**
|
|
1546
831
|
* Unique object identifier
|
|
1547
|
-
* @type {string}
|
|
1548
|
-
* @memberof OptimisationHistoryItem
|
|
1549
832
|
*/
|
|
1550
833
|
'id'?: string;
|
|
1551
|
-
/**
|
|
1552
|
-
*
|
|
1553
|
-
* @type {string}
|
|
1554
|
-
* @memberof OptimisationHistoryItem
|
|
1555
|
-
*/
|
|
1556
834
|
'createdAt'?: string;
|
|
1557
835
|
}
|
|
1558
836
|
/**
|
|
1559
837
|
* Standard price definition that defines the amount, tax rate and currency.
|
|
1560
|
-
* @export
|
|
1561
|
-
* @interface Price
|
|
1562
838
|
*/
|
|
1563
839
|
export interface Price {
|
|
1564
840
|
/**
|
|
1565
841
|
* Price including tax in the specified currency.
|
|
1566
|
-
* @type {number}
|
|
1567
|
-
* @memberof Price
|
|
1568
842
|
*/
|
|
1569
843
|
'amount'?: number;
|
|
1570
844
|
/**
|
|
1571
845
|
* Currency code for the currency the price is valued in.
|
|
1572
|
-
* @type {string}
|
|
1573
|
-
* @memberof Price
|
|
1574
846
|
*/
|
|
1575
847
|
'currencyCode'?: PriceCurrencyCodeEnum;
|
|
1576
848
|
}
|
|
@@ -1578,340 +850,152 @@ export declare const PriceCurrencyCodeEnum: {
|
|
|
1578
850
|
readonly Gbp: "GBP";
|
|
1579
851
|
};
|
|
1580
852
|
export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
|
|
1581
|
-
/**
|
|
1582
|
-
*
|
|
1583
|
-
* @export
|
|
1584
|
-
* @interface Product
|
|
1585
|
-
*/
|
|
1586
853
|
export interface Product {
|
|
1587
854
|
/**
|
|
1588
855
|
* Unique object identifier
|
|
1589
|
-
* @type {string}
|
|
1590
|
-
* @memberof Product
|
|
1591
856
|
*/
|
|
1592
857
|
'id'?: string;
|
|
1593
858
|
/**
|
|
1594
859
|
* A reference to the resource location
|
|
1595
|
-
* @type {string}
|
|
1596
|
-
* @memberof Product
|
|
1597
860
|
*/
|
|
1598
861
|
'ref'?: string;
|
|
1599
|
-
/**
|
|
1600
|
-
*
|
|
1601
|
-
* @type {string}
|
|
1602
|
-
* @memberof Product
|
|
1603
|
-
*/
|
|
1604
862
|
'title': string;
|
|
1605
|
-
/**
|
|
1606
|
-
*
|
|
1607
|
-
* @type {string}
|
|
1608
|
-
* @memberof Product
|
|
1609
|
-
*/
|
|
1610
863
|
'description': string;
|
|
1611
|
-
/**
|
|
1612
|
-
*
|
|
1613
|
-
* @type {string}
|
|
1614
|
-
* @memberof Product
|
|
1615
|
-
*/
|
|
1616
864
|
'slug'?: string;
|
|
1617
|
-
/**
|
|
1618
|
-
*
|
|
1619
|
-
* @type {string}
|
|
1620
|
-
* @memberof Product
|
|
1621
|
-
*/
|
|
1622
865
|
'brand'?: string;
|
|
1623
|
-
/**
|
|
1624
|
-
*
|
|
1625
|
-
* @type {boolean}
|
|
1626
|
-
* @memberof Product
|
|
1627
|
-
*/
|
|
1628
866
|
'enabled'?: boolean;
|
|
1629
|
-
/**
|
|
1630
|
-
*
|
|
1631
|
-
* @type {SEOMetadata}
|
|
1632
|
-
* @memberof Product
|
|
1633
|
-
*/
|
|
1634
867
|
'seoMetadata'?: SEOMetadata;
|
|
1635
|
-
/**
|
|
1636
|
-
*
|
|
1637
|
-
* @type {TargetSearchPhraseData}
|
|
1638
|
-
* @memberof Product
|
|
1639
|
-
*/
|
|
1640
868
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1641
|
-
/**
|
|
1642
|
-
*
|
|
1643
|
-
* @type {Array<string>}
|
|
1644
|
-
* @memberof Product
|
|
1645
|
-
*/
|
|
1646
869
|
'tags'?: Array<string>;
|
|
1647
|
-
/**
|
|
1648
|
-
*
|
|
1649
|
-
* @type {Array<string>}
|
|
1650
|
-
* @memberof Product
|
|
1651
|
-
*/
|
|
1652
870
|
'internalTags'?: Array<string>;
|
|
1653
|
-
/**
|
|
1654
|
-
*
|
|
1655
|
-
* @type {string}
|
|
1656
|
-
* @memberof Product
|
|
1657
|
-
*/
|
|
1658
871
|
'createdAt'?: string;
|
|
1659
|
-
/**
|
|
1660
|
-
*
|
|
1661
|
-
* @type {string}
|
|
1662
|
-
* @memberof Product
|
|
1663
|
-
*/
|
|
1664
872
|
'updatedAt'?: string;
|
|
1665
|
-
/**
|
|
1666
|
-
*
|
|
1667
|
-
* @type {string}
|
|
1668
|
-
* @memberof Product
|
|
1669
|
-
*/
|
|
1670
873
|
'publishedAt'?: string;
|
|
1671
874
|
/**
|
|
1672
875
|
* Images
|
|
1673
|
-
* @type {Array<Image>}
|
|
1674
|
-
* @memberof Product
|
|
1675
876
|
*/
|
|
1676
877
|
'images'?: Array<Image>;
|
|
1677
878
|
/**
|
|
1678
879
|
* Videos
|
|
1679
|
-
* @type {Array<Video>}
|
|
1680
|
-
* @memberof Product
|
|
1681
880
|
*/
|
|
1682
881
|
'videos'?: Array<Video>;
|
|
1683
882
|
/**
|
|
1684
883
|
* Variants
|
|
1685
|
-
* @type {Array<Variant>}
|
|
1686
|
-
* @memberof Product
|
|
1687
884
|
*/
|
|
1688
885
|
'variants'?: Array<Variant>;
|
|
1689
886
|
/**
|
|
1690
887
|
* Products in the bundle.
|
|
1691
|
-
* @type {Array<Product>}
|
|
1692
|
-
* @memberof Product
|
|
1693
888
|
*/
|
|
1694
889
|
'bundleItems'?: Array<Product>;
|
|
1695
|
-
/**
|
|
1696
|
-
*
|
|
1697
|
-
* @type {Price}
|
|
1698
|
-
* @memberof Product
|
|
1699
|
-
*/
|
|
1700
890
|
'retailPrice'?: Price;
|
|
1701
|
-
/**
|
|
1702
|
-
*
|
|
1703
|
-
* @type {SalePrice}
|
|
1704
|
-
* @memberof Product
|
|
1705
|
-
*/
|
|
1706
891
|
'salePrice'?: SalePrice | null;
|
|
1707
892
|
/**
|
|
1708
893
|
* Additional files attached to the product.
|
|
1709
|
-
* @type {Array<ProductAdditionalFilesInner>}
|
|
1710
|
-
* @memberof Product
|
|
1711
894
|
*/
|
|
1712
895
|
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1713
896
|
/**
|
|
1714
897
|
* List of application sets associated with this product
|
|
1715
|
-
* @type {Array<ProductApplicationSetsInner>}
|
|
1716
|
-
* @memberof Product
|
|
1717
898
|
*/
|
|
1718
899
|
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1719
900
|
/**
|
|
1720
901
|
* The average review rating. This field is only present if included in the fields query parameter
|
|
1721
|
-
* @type {number}
|
|
1722
|
-
* @memberof Product
|
|
1723
902
|
*/
|
|
1724
903
|
'reviewScore'?: number | null;
|
|
1725
904
|
/**
|
|
1726
905
|
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1727
|
-
* @type {number}
|
|
1728
|
-
* @memberof Product
|
|
1729
906
|
*/
|
|
1730
907
|
'reviewCount'?: number;
|
|
1731
|
-
/**
|
|
1732
|
-
*
|
|
1733
|
-
* @type {string}
|
|
1734
|
-
* @memberof Product
|
|
1735
|
-
*/
|
|
1736
908
|
'sku'?: string;
|
|
1737
909
|
/**
|
|
1738
910
|
* A count of sales. This field is only present if included in the fields query parameter
|
|
1739
|
-
* @type {number}
|
|
1740
|
-
* @memberof Product
|
|
1741
911
|
*/
|
|
1742
912
|
'sales'?: number;
|
|
1743
|
-
/**
|
|
1744
|
-
*
|
|
1745
|
-
* @type {string}
|
|
1746
|
-
* @memberof Product
|
|
1747
|
-
*/
|
|
1748
913
|
'salesStart'?: string;
|
|
1749
|
-
/**
|
|
1750
|
-
*
|
|
1751
|
-
* @type {string}
|
|
1752
|
-
* @memberof Product
|
|
1753
|
-
*/
|
|
1754
914
|
'salesEnd'?: string;
|
|
1755
|
-
/**
|
|
1756
|
-
*
|
|
1757
|
-
* @type {boolean}
|
|
1758
|
-
* @memberof Product
|
|
1759
|
-
*/
|
|
1760
915
|
'includeInDataFeeds'?: boolean;
|
|
1761
916
|
/**
|
|
1762
917
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1763
|
-
* @type {number}
|
|
1764
|
-
* @memberof Product
|
|
1765
918
|
*/
|
|
1766
919
|
'shopifyId'?: number | null;
|
|
1767
|
-
/**
|
|
1768
|
-
*
|
|
1769
|
-
* @type {ProductWarehouseProduct}
|
|
1770
|
-
* @memberof Product
|
|
1771
|
-
*/
|
|
1772
920
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1773
921
|
/**
|
|
1774
922
|
* Key/value pairs that can be used to store additional information about the product
|
|
1775
|
-
* @type {Array<MetaField>}
|
|
1776
|
-
* @memberof Product
|
|
1777
923
|
*/
|
|
1778
924
|
'metafields'?: Array<MetaField>;
|
|
1779
925
|
/**
|
|
1780
926
|
* a JSON string representing the personalization template for the product
|
|
1781
|
-
* @type {string}
|
|
1782
|
-
* @memberof Product
|
|
1783
927
|
*/
|
|
1784
928
|
'personalizationTemplate'?: string;
|
|
1785
929
|
/**
|
|
1786
930
|
* History of AI optimisations performed on the product
|
|
1787
|
-
* @type {Array<OptimisationHistoryItem>}
|
|
1788
|
-
* @memberof Product
|
|
1789
931
|
*/
|
|
1790
932
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1791
|
-
/**
|
|
1792
|
-
*
|
|
1793
|
-
* @type {Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>}
|
|
1794
|
-
* @memberof Product
|
|
1795
|
-
*/
|
|
1796
933
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1797
934
|
}
|
|
1798
|
-
/**
|
|
1799
|
-
*
|
|
1800
|
-
* @export
|
|
1801
|
-
* @interface ProductAdditionalFilesInner
|
|
1802
|
-
*/
|
|
1803
935
|
export interface ProductAdditionalFilesInner {
|
|
1804
936
|
/**
|
|
1805
937
|
* Unique object identifier
|
|
1806
|
-
* @type {string}
|
|
1807
|
-
* @memberof ProductAdditionalFilesInner
|
|
1808
938
|
*/
|
|
1809
939
|
'id'?: string;
|
|
1810
940
|
/**
|
|
1811
941
|
* File URL
|
|
1812
|
-
* @type {string}
|
|
1813
|
-
* @memberof ProductAdditionalFilesInner
|
|
1814
942
|
*/
|
|
1815
943
|
'src'?: string;
|
|
1816
944
|
}
|
|
1817
|
-
/**
|
|
1818
|
-
*
|
|
1819
|
-
* @export
|
|
1820
|
-
* @interface ProductApplicationSetsInner
|
|
1821
|
-
*/
|
|
1822
945
|
export interface ProductApplicationSetsInner {
|
|
1823
946
|
/**
|
|
1824
947
|
* Unique object identifier
|
|
1825
|
-
* @type {string}
|
|
1826
|
-
* @memberof ProductApplicationSetsInner
|
|
1827
948
|
*/
|
|
1828
949
|
'id'?: string;
|
|
1829
950
|
/**
|
|
1830
951
|
* A reference to the application set resource location
|
|
1831
|
-
* @type {string}
|
|
1832
|
-
* @memberof ProductApplicationSetsInner
|
|
1833
952
|
*/
|
|
1834
953
|
'ref'?: string;
|
|
1835
954
|
/**
|
|
1836
955
|
* Name of the application set
|
|
1837
|
-
* @type {string}
|
|
1838
|
-
* @memberof ProductApplicationSetsInner
|
|
1839
956
|
*/
|
|
1840
957
|
'name'?: string;
|
|
1841
958
|
}
|
|
1842
|
-
/**
|
|
1843
|
-
*
|
|
1844
|
-
* @export
|
|
1845
|
-
* @interface ProductWarehouseProduct
|
|
1846
|
-
*/
|
|
1847
959
|
export interface ProductWarehouseProduct {
|
|
1848
960
|
/**
|
|
1849
961
|
* Unique object identifier
|
|
1850
|
-
* @type {string}
|
|
1851
|
-
* @memberof ProductWarehouseProduct
|
|
1852
962
|
*/
|
|
1853
963
|
'id'?: string;
|
|
1854
964
|
/**
|
|
1855
965
|
* 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.
|
|
1856
|
-
* @type {string}
|
|
1857
|
-
* @memberof ProductWarehouseProduct
|
|
1858
966
|
*/
|
|
1859
967
|
'gfnProductRef'?: string;
|
|
1860
968
|
}
|
|
1861
|
-
/**
|
|
1862
|
-
*
|
|
1863
|
-
* @export
|
|
1864
|
-
* @interface ProductsResponse
|
|
1865
|
-
*/
|
|
1866
969
|
export interface ProductsResponse {
|
|
1867
|
-
/**
|
|
1868
|
-
*
|
|
1869
|
-
* @type {Array<Product>}
|
|
1870
|
-
* @memberof ProductsResponse
|
|
1871
|
-
*/
|
|
1872
970
|
'products'?: Array<Product>;
|
|
1873
971
|
/**
|
|
1874
972
|
* The token referencing the next page number
|
|
1875
|
-
* @type {number}
|
|
1876
|
-
* @memberof ProductsResponse
|
|
1877
973
|
*/
|
|
1878
974
|
'nextPageToken'?: number | null;
|
|
1879
975
|
}
|
|
1880
976
|
/**
|
|
1881
977
|
* SEO metadata for the product
|
|
1882
|
-
* @export
|
|
1883
|
-
* @interface SEOMetadata
|
|
1884
978
|
*/
|
|
1885
979
|
export interface SEOMetadata {
|
|
1886
980
|
/**
|
|
1887
981
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
1888
|
-
* @type {string}
|
|
1889
|
-
* @memberof SEOMetadata
|
|
1890
982
|
*/
|
|
1891
983
|
'title'?: string;
|
|
1892
984
|
/**
|
|
1893
985
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1894
|
-
* @type {string}
|
|
1895
|
-
* @memberof SEOMetadata
|
|
1896
986
|
*/
|
|
1897
987
|
'description'?: string | null;
|
|
1898
988
|
}
|
|
1899
989
|
/**
|
|
1900
990
|
* Discounted price including tax.
|
|
1901
|
-
* @export
|
|
1902
|
-
* @interface SalePrice
|
|
1903
991
|
*/
|
|
1904
992
|
export interface SalePrice {
|
|
1905
993
|
/**
|
|
1906
994
|
* Discounted price including tax in the specified currency.
|
|
1907
|
-
* @type {number}
|
|
1908
|
-
* @memberof SalePrice
|
|
1909
995
|
*/
|
|
1910
996
|
'amount': number;
|
|
1911
997
|
/**
|
|
1912
998
|
* Currency code for the currency the sale price is valued in.
|
|
1913
|
-
* @type {string}
|
|
1914
|
-
* @memberof SalePrice
|
|
1915
999
|
*/
|
|
1916
1000
|
'currencyCode': SalePriceCurrencyCodeEnum;
|
|
1917
1001
|
}
|
|
@@ -1919,130 +1003,67 @@ export declare const SalePriceCurrencyCodeEnum: {
|
|
|
1919
1003
|
readonly Gbp: "GBP";
|
|
1920
1004
|
};
|
|
1921
1005
|
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1922
|
-
/**
|
|
1923
|
-
*
|
|
1924
|
-
* @export
|
|
1925
|
-
* @interface SeoOptimiseProducts202Response
|
|
1926
|
-
*/
|
|
1927
1006
|
export interface SeoOptimiseProducts202Response {
|
|
1928
1007
|
/**
|
|
1929
1008
|
* A message describing the optimisation status
|
|
1930
|
-
* @type {string}
|
|
1931
|
-
* @memberof SeoOptimiseProducts202Response
|
|
1932
1009
|
*/
|
|
1933
1010
|
'message'?: string;
|
|
1934
1011
|
}
|
|
1935
|
-
/**
|
|
1936
|
-
*
|
|
1937
|
-
* @export
|
|
1938
|
-
* @interface SeoOptimiseProductsRequest
|
|
1939
|
-
*/
|
|
1940
1012
|
export interface SeoOptimiseProductsRequest {
|
|
1941
1013
|
/**
|
|
1942
1014
|
* A set of product IDs to AI SEO optimise.
|
|
1943
|
-
* @type {Array<string>}
|
|
1944
|
-
* @memberof SeoOptimiseProductsRequest
|
|
1945
1015
|
*/
|
|
1946
1016
|
'ids'?: Array<string>;
|
|
1947
1017
|
/**
|
|
1948
1018
|
* If provided, only the specified fields will be updated.
|
|
1949
|
-
* @type {Array<string>}
|
|
1950
|
-
* @memberof SeoOptimiseProductsRequest
|
|
1951
1019
|
*/
|
|
1952
1020
|
'fields'?: Array<string>;
|
|
1953
1021
|
}
|
|
1954
|
-
/**
|
|
1955
|
-
*
|
|
1956
|
-
* @export
|
|
1957
|
-
* @interface Stock
|
|
1958
|
-
*/
|
|
1959
1022
|
export interface Stock {
|
|
1960
|
-
/**
|
|
1961
|
-
*
|
|
1962
|
-
* @type {number}
|
|
1963
|
-
* @memberof Stock
|
|
1964
|
-
*/
|
|
1965
1023
|
'level'?: number;
|
|
1966
|
-
/**
|
|
1967
|
-
*
|
|
1968
|
-
* @type {Array<Location>}
|
|
1969
|
-
* @memberof Stock
|
|
1970
|
-
*/
|
|
1971
1024
|
'locations'?: Array<Location>;
|
|
1972
1025
|
}
|
|
1973
|
-
/**
|
|
1974
|
-
*
|
|
1975
|
-
* @export
|
|
1976
|
-
* @interface TargetSearchPhraseData
|
|
1977
|
-
*/
|
|
1978
1026
|
export interface TargetSearchPhraseData {
|
|
1979
1027
|
/**
|
|
1980
1028
|
* The primary target search phrase for the product that you wish to rank for in search engine results.
|
|
1981
|
-
* @type {string}
|
|
1982
|
-
* @memberof TargetSearchPhraseData
|
|
1983
1029
|
*/
|
|
1984
1030
|
'targetSearchPhrase'?: string;
|
|
1985
1031
|
/**
|
|
1986
1032
|
* Synonyms for the target search phrase.
|
|
1987
|
-
* @type {Array<string>}
|
|
1988
|
-
* @memberof TargetSearchPhraseData
|
|
1989
1033
|
*/
|
|
1990
1034
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1991
1035
|
}
|
|
1992
|
-
/**
|
|
1993
|
-
*
|
|
1994
|
-
* @export
|
|
1995
|
-
* @interface TextApplicationProperties
|
|
1996
|
-
*/
|
|
1997
1036
|
export interface TextApplicationProperties {
|
|
1998
|
-
/**
|
|
1999
|
-
*
|
|
2000
|
-
* @type {TextApplicationPropertiesPosition}
|
|
2001
|
-
* @memberof TextApplicationProperties
|
|
2002
|
-
*/
|
|
2003
1037
|
'position'?: TextApplicationPropertiesPosition;
|
|
2004
|
-
/**
|
|
2005
|
-
*
|
|
2006
|
-
* @type {ApplicationPropertiesPositionInference}
|
|
2007
|
-
* @memberof TextApplicationProperties
|
|
2008
|
-
*/
|
|
2009
1038
|
'positionInference'?: ApplicationPropertiesPositionInference | null;
|
|
2010
1039
|
/**
|
|
2011
1040
|
* An array of text lines.
|
|
2012
|
-
* @type {Array<string>}
|
|
2013
|
-
* @memberof TextApplicationProperties
|
|
2014
1041
|
*/
|
|
2015
1042
|
'lines'?: Array<string>;
|
|
2016
1043
|
/**
|
|
2017
1044
|
* The font to be used for the text. This font must be available in the PodOS font library.
|
|
2018
|
-
* @type {string}
|
|
2019
|
-
* @memberof TextApplicationProperties
|
|
2020
1045
|
*/
|
|
2021
1046
|
'font'?: string;
|
|
2022
1047
|
/**
|
|
2023
1048
|
* The size of the text in pixels.
|
|
2024
|
-
* @type {number}
|
|
2025
|
-
* @memberof TextApplicationProperties
|
|
2026
1049
|
*/
|
|
2027
1050
|
'fontSize'?: number;
|
|
2028
1051
|
/**
|
|
2029
1052
|
* The weight of the text. This must be a valid CSS font-weight value.
|
|
2030
|
-
* @type {string}
|
|
2031
|
-
* @memberof TextApplicationProperties
|
|
2032
1053
|
*/
|
|
2033
1054
|
'fontWeight'?: TextApplicationPropertiesFontWeightEnum;
|
|
2034
1055
|
/**
|
|
2035
1056
|
* The style of the text. This must be a valid CSS font-style value.
|
|
2036
|
-
* @type {string}
|
|
2037
|
-
* @memberof TextApplicationProperties
|
|
2038
1057
|
*/
|
|
2039
1058
|
'fontStyle'?: TextApplicationPropertiesFontStyleEnum;
|
|
2040
1059
|
/**
|
|
2041
1060
|
* The colour of the text in hex format.
|
|
2042
|
-
* @type {string}
|
|
2043
|
-
* @memberof TextApplicationProperties
|
|
2044
1061
|
*/
|
|
2045
1062
|
'color'?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* The rotation of the text in degrees.
|
|
1065
|
+
*/
|
|
1066
|
+
'rotation'?: number;
|
|
2046
1067
|
}
|
|
2047
1068
|
export declare const TextApplicationPropertiesFontWeightEnum: {
|
|
2048
1069
|
readonly Lighter: "lighter";
|
|
@@ -2057,29 +1078,15 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
|
|
|
2057
1078
|
readonly Oblique: "oblique";
|
|
2058
1079
|
};
|
|
2059
1080
|
export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
|
|
2060
|
-
/**
|
|
2061
|
-
*
|
|
2062
|
-
* @export
|
|
2063
|
-
* @interface TextApplicationPropertiesPersonalization
|
|
2064
|
-
*/
|
|
2065
1081
|
export interface TextApplicationPropertiesPersonalization {
|
|
2066
1082
|
/**
|
|
2067
1083
|
* The label to be displayed on the personalization field.
|
|
2068
|
-
* @type {string}
|
|
2069
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2070
1084
|
*/
|
|
2071
1085
|
'label'?: string;
|
|
2072
1086
|
/**
|
|
2073
1087
|
* The type of the personalization field
|
|
2074
|
-
* @type {string}
|
|
2075
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2076
1088
|
*/
|
|
2077
1089
|
'type'?: TextApplicationPropertiesPersonalizationTypeEnum | null;
|
|
2078
|
-
/**
|
|
2079
|
-
*
|
|
2080
|
-
* @type {TextApplicationPropertiesPersonalizationRules}
|
|
2081
|
-
* @memberof TextApplicationPropertiesPersonalization
|
|
2082
|
-
*/
|
|
2083
1090
|
'rules'?: TextApplicationPropertiesPersonalizationRules;
|
|
2084
1091
|
}
|
|
2085
1092
|
export declare const TextApplicationPropertiesPersonalizationTypeEnum: {
|
|
@@ -2087,533 +1094,289 @@ export declare const TextApplicationPropertiesPersonalizationTypeEnum: {
|
|
|
2087
1094
|
readonly Number: "number";
|
|
2088
1095
|
};
|
|
2089
1096
|
export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
|
|
2090
|
-
/**
|
|
2091
|
-
*
|
|
2092
|
-
* @export
|
|
2093
|
-
* @interface TextApplicationPropertiesPersonalizationRules
|
|
2094
|
-
*/
|
|
2095
1097
|
export interface TextApplicationPropertiesPersonalizationRules {
|
|
2096
1098
|
/**
|
|
2097
1099
|
* The maximum length of the text, in characters.
|
|
2098
|
-
* @type {number}
|
|
2099
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2100
1100
|
*/
|
|
2101
1101
|
'maxLength'?: number;
|
|
2102
1102
|
/**
|
|
2103
1103
|
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\"
|
|
2104
|
-
* @type {boolean}
|
|
2105
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2106
1104
|
*/
|
|
2107
1105
|
'profanityFilter'?: boolean;
|
|
2108
1106
|
/**
|
|
2109
1107
|
* 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.
|
|
2110
|
-
* @type {boolean}
|
|
2111
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2112
1108
|
*/
|
|
2113
1109
|
'scaleToFit'?: boolean;
|
|
2114
1110
|
/**
|
|
2115
1111
|
* The maximum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
2116
|
-
* @type {number}
|
|
2117
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2118
1112
|
*/
|
|
2119
1113
|
'maxValue'?: number;
|
|
2120
1114
|
/**
|
|
2121
1115
|
* The minimum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
2122
|
-
* @type {number}
|
|
2123
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2124
1116
|
*/
|
|
2125
1117
|
'minValue'?: number;
|
|
2126
1118
|
/**
|
|
2127
1119
|
* 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
|
|
2128
|
-
* @type {number}
|
|
2129
|
-
* @memberof TextApplicationPropertiesPersonalizationRules
|
|
2130
1120
|
*/
|
|
2131
1121
|
'pad'?: number;
|
|
2132
1122
|
}
|
|
2133
|
-
/**
|
|
2134
|
-
*
|
|
2135
|
-
* @export
|
|
2136
|
-
* @interface TextApplicationPropertiesPosition
|
|
2137
|
-
*/
|
|
2138
1123
|
export interface TextApplicationPropertiesPosition {
|
|
2139
1124
|
/**
|
|
2140
1125
|
* The x position of the application in pixels.
|
|
2141
|
-
* @type {number}
|
|
2142
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2143
1126
|
*/
|
|
2144
1127
|
'x': number;
|
|
2145
1128
|
/**
|
|
2146
1129
|
* The y position of the application in pixels.
|
|
2147
|
-
* @type {number}
|
|
2148
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2149
1130
|
*/
|
|
2150
1131
|
'y': number;
|
|
2151
1132
|
/**
|
|
2152
1133
|
* The z layer of the application. This doesn\'t affect printing, but is used for ordering the applications when displaying them in a mockup.
|
|
2153
|
-
* @type {number}
|
|
2154
|
-
* @memberof TextApplicationPropertiesPosition
|
|
2155
1134
|
*/
|
|
2156
1135
|
'z'?: number;
|
|
2157
1136
|
}
|
|
2158
|
-
/**
|
|
2159
|
-
*
|
|
2160
|
-
* @export
|
|
2161
|
-
* @interface UpdateApplicationGroupRequest
|
|
2162
|
-
*/
|
|
2163
1137
|
export interface UpdateApplicationGroupRequest {
|
|
2164
1138
|
/**
|
|
2165
1139
|
* Name of the application group
|
|
2166
|
-
* @type {string}
|
|
2167
|
-
* @memberof UpdateApplicationGroupRequest
|
|
2168
1140
|
*/
|
|
2169
1141
|
'name'?: string;
|
|
2170
1142
|
}
|
|
2171
|
-
/**
|
|
2172
|
-
*
|
|
2173
|
-
* @export
|
|
2174
|
-
* @interface UpdateApplicationSetRequest
|
|
2175
|
-
*/
|
|
2176
1143
|
export interface UpdateApplicationSetRequest {
|
|
2177
1144
|
/**
|
|
2178
1145
|
* Name of the application set
|
|
2179
|
-
* @type {string}
|
|
2180
|
-
* @memberof UpdateApplicationSetRequest
|
|
2181
1146
|
*/
|
|
2182
1147
|
'name'?: string;
|
|
2183
1148
|
/**
|
|
2184
1149
|
* Description of the application set
|
|
2185
|
-
* @type {string}
|
|
2186
|
-
* @memberof UpdateApplicationSetRequest
|
|
2187
1150
|
*/
|
|
2188
1151
|
'description'?: string;
|
|
2189
1152
|
/**
|
|
2190
1153
|
* The width, in pixels of the images in the set
|
|
2191
|
-
* @type {number}
|
|
2192
|
-
* @memberof UpdateApplicationSetRequest
|
|
2193
1154
|
*/
|
|
2194
1155
|
'width'?: number;
|
|
2195
1156
|
/**
|
|
2196
1157
|
* The height, in pixels of the images in the set
|
|
2197
|
-
* @type {number}
|
|
2198
|
-
* @memberof UpdateApplicationSetRequest
|
|
2199
1158
|
*/
|
|
2200
1159
|
'height'?: number;
|
|
2201
1160
|
/**
|
|
2202
1161
|
* The DPI used when printing the images in the set
|
|
2203
|
-
* @type {number}
|
|
2204
|
-
* @memberof UpdateApplicationSetRequest
|
|
2205
1162
|
*/
|
|
2206
1163
|
'dpi'?: number;
|
|
2207
1164
|
/**
|
|
2208
1165
|
* List of application set records
|
|
2209
|
-
* @type {Array<UpdateApplicationSetRequestRecordsInner>}
|
|
2210
|
-
* @memberof UpdateApplicationSetRequest
|
|
2211
1166
|
*/
|
|
2212
1167
|
'records'?: Array<UpdateApplicationSetRequestRecordsInner>;
|
|
2213
1168
|
}
|
|
2214
|
-
/**
|
|
2215
|
-
*
|
|
2216
|
-
* @export
|
|
2217
|
-
* @interface UpdateApplicationSetRequestRecordsInner
|
|
2218
|
-
*/
|
|
2219
1169
|
export interface UpdateApplicationSetRequestRecordsInner {
|
|
2220
1170
|
/**
|
|
2221
1171
|
* List of attributes this record applies to. Providing an empty array will apply the application set to all variants.
|
|
2222
|
-
* @type {Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>}
|
|
2223
|
-
* @memberof UpdateApplicationSetRequestRecordsInner
|
|
2224
1172
|
*/
|
|
2225
1173
|
'attributes'?: Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>;
|
|
2226
1174
|
/**
|
|
2227
1175
|
* List of applications for this record
|
|
2228
|
-
* @type {Array<Application>}
|
|
2229
|
-
* @memberof UpdateApplicationSetRequestRecordsInner
|
|
2230
1176
|
*/
|
|
2231
1177
|
'applications'?: Array<Application>;
|
|
2232
1178
|
}
|
|
2233
|
-
/**
|
|
2234
|
-
*
|
|
2235
|
-
* @export
|
|
2236
|
-
* @interface UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2237
|
-
*/
|
|
2238
1179
|
export interface UpdateApplicationSetRequestRecordsInnerAttributesInner {
|
|
2239
1180
|
/**
|
|
2240
1181
|
* The name of the option type. e.g. Size, Colour
|
|
2241
|
-
* @type {string}
|
|
2242
|
-
* @memberof UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2243
1182
|
*/
|
|
2244
1183
|
'name'?: string;
|
|
2245
1184
|
/**
|
|
2246
1185
|
* The value of the option this record applies to
|
|
2247
|
-
* @type {string}
|
|
2248
|
-
* @memberof UpdateApplicationSetRequestRecordsInnerAttributesInner
|
|
2249
1186
|
*/
|
|
2250
1187
|
'value'?: string;
|
|
2251
1188
|
}
|
|
2252
|
-
/**
|
|
2253
|
-
*
|
|
2254
|
-
* @export
|
|
2255
|
-
* @interface UpdateProductRequest
|
|
2256
|
-
*/
|
|
2257
1189
|
export interface UpdateProductRequest {
|
|
2258
1190
|
/**
|
|
2259
1191
|
* 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.
|
|
2260
|
-
* @type {string}
|
|
2261
|
-
* @memberof UpdateProductRequest
|
|
2262
1192
|
*/
|
|
2263
1193
|
'gfnProductRef'?: string;
|
|
2264
1194
|
/**
|
|
2265
1195
|
* Product title
|
|
2266
|
-
* @type {string}
|
|
2267
|
-
* @memberof UpdateProductRequest
|
|
2268
1196
|
*/
|
|
2269
1197
|
'title'?: string;
|
|
2270
1198
|
/**
|
|
2271
1199
|
* Product description
|
|
2272
|
-
* @type {string}
|
|
2273
|
-
* @memberof UpdateProductRequest
|
|
2274
1200
|
*/
|
|
2275
1201
|
'description'?: string;
|
|
2276
1202
|
/**
|
|
2277
1203
|
* Whether the product is enabled upon creation.
|
|
2278
|
-
* @type {boolean}
|
|
2279
|
-
* @memberof UpdateProductRequest
|
|
2280
1204
|
*/
|
|
2281
1205
|
'enabled'?: boolean;
|
|
2282
1206
|
/**
|
|
2283
1207
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
2284
|
-
* @type {string}
|
|
2285
|
-
* @memberof UpdateProductRequest
|
|
2286
1208
|
*/
|
|
2287
1209
|
'slug'?: string;
|
|
2288
1210
|
/**
|
|
2289
1211
|
* The brand of the product.
|
|
2290
|
-
* @type {string}
|
|
2291
|
-
* @memberof UpdateProductRequest
|
|
2292
1212
|
*/
|
|
2293
1213
|
'brand'?: string | null;
|
|
2294
|
-
/**
|
|
2295
|
-
*
|
|
2296
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
2297
|
-
* @memberof UpdateProductRequest
|
|
2298
|
-
*/
|
|
2299
1214
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
2300
1215
|
/**
|
|
2301
1216
|
* 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
|
|
2302
|
-
* @type {string}
|
|
2303
|
-
* @memberof UpdateProductRequest
|
|
2304
1217
|
*/
|
|
2305
1218
|
'targetSearchPhrase'?: string | null;
|
|
2306
1219
|
/**
|
|
2307
1220
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
2308
|
-
* @type {Array<string>}
|
|
2309
|
-
* @memberof UpdateProductRequest
|
|
2310
1221
|
*/
|
|
2311
1222
|
'targetSearchPhraseSynonyms'?: Array<string> | null;
|
|
2312
1223
|
/**
|
|
2313
1224
|
* Additional product tags used for searching and filtering.
|
|
2314
|
-
* @type {Array<string>}
|
|
2315
|
-
* @memberof UpdateProductRequest
|
|
2316
1225
|
*/
|
|
2317
1226
|
'tags'?: Array<string>;
|
|
2318
1227
|
/**
|
|
2319
1228
|
* Additional product tags used for internal searching and filtering.
|
|
2320
|
-
* @type {Array<string>}
|
|
2321
|
-
* @memberof UpdateProductRequest
|
|
2322
1229
|
*/
|
|
2323
1230
|
'internalTags'?: Array<string>;
|
|
2324
1231
|
/**
|
|
2325
1232
|
* Variants
|
|
2326
|
-
* @type {Array<CreateProductVariant>}
|
|
2327
|
-
* @memberof UpdateProductRequest
|
|
2328
1233
|
*/
|
|
2329
1234
|
'variants'?: Array<CreateProductVariant>;
|
|
2330
1235
|
/**
|
|
2331
1236
|
* A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
|
|
2332
|
-
* @type {Array<string>}
|
|
2333
|
-
* @memberof UpdateProductRequest
|
|
2334
1237
|
*/
|
|
2335
1238
|
'bundleItems'?: Array<string>;
|
|
2336
|
-
/**
|
|
2337
|
-
*
|
|
2338
|
-
* @type {Price}
|
|
2339
|
-
* @memberof UpdateProductRequest
|
|
2340
|
-
*/
|
|
2341
1239
|
'retailPrice'?: Price;
|
|
2342
|
-
/**
|
|
2343
|
-
*
|
|
2344
|
-
* @type {SalePrice}
|
|
2345
|
-
* @memberof UpdateProductRequest
|
|
2346
|
-
*/
|
|
2347
1240
|
'salePrice'?: SalePrice | null;
|
|
2348
1241
|
/**
|
|
2349
1242
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
2350
|
-
* @type {Array<ImageFile>}
|
|
2351
|
-
* @memberof UpdateProductRequest
|
|
2352
1243
|
*/
|
|
2353
1244
|
'images'?: Array<ImageFile>;
|
|
2354
1245
|
/**
|
|
2355
1246
|
* Videos to attach to the product.
|
|
2356
|
-
* @type {Array<VideoFile>}
|
|
2357
|
-
* @memberof UpdateProductRequest
|
|
2358
1247
|
*/
|
|
2359
1248
|
'videos'?: Array<VideoFile>;
|
|
2360
1249
|
/**
|
|
2361
1250
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
2362
|
-
* @type {Array<AdditionalFile>}
|
|
2363
|
-
* @memberof UpdateProductRequest
|
|
2364
1251
|
*/
|
|
2365
1252
|
'additionalFiles'?: Array<AdditionalFile>;
|
|
2366
1253
|
/**
|
|
2367
1254
|
* List of application set UUIDs to associate with this product
|
|
2368
|
-
* @type {Array<string>}
|
|
2369
|
-
* @memberof UpdateProductRequest
|
|
2370
1255
|
*/
|
|
2371
1256
|
'applicationSets'?: Array<string>;
|
|
2372
1257
|
/**
|
|
2373
1258
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
2374
|
-
* @type {boolean}
|
|
2375
|
-
* @memberof UpdateProductRequest
|
|
2376
1259
|
*/
|
|
2377
1260
|
'includeInDataFeeds'?: boolean;
|
|
2378
1261
|
/**
|
|
2379
1262
|
* 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.
|
|
2380
|
-
* @type {number}
|
|
2381
|
-
* @memberof UpdateProductRequest
|
|
2382
1263
|
*/
|
|
2383
1264
|
'shopifyId'?: number | null;
|
|
2384
1265
|
/**
|
|
2385
1266
|
* Key/value pairs that can be used to store additional information about the product
|
|
2386
|
-
* @type {Array<MetaField>}
|
|
2387
|
-
* @memberof UpdateProductRequest
|
|
2388
1267
|
*/
|
|
2389
1268
|
'metafields'?: Array<MetaField>;
|
|
2390
1269
|
/**
|
|
2391
1270
|
* A JSON object that defines the personalization template for the product.
|
|
2392
|
-
* @type {string}
|
|
2393
|
-
* @memberof UpdateProductRequest
|
|
2394
1271
|
*/
|
|
2395
1272
|
'personalizationTemplate'?: string;
|
|
2396
1273
|
/**
|
|
2397
1274
|
* Integration connections for the product
|
|
2398
|
-
* @type {Array<UpdateProductRequestIntegrationConnectionsInner>}
|
|
2399
|
-
* @memberof UpdateProductRequest
|
|
2400
1275
|
*/
|
|
2401
1276
|
'integrationConnections'?: Array<UpdateProductRequestIntegrationConnectionsInner>;
|
|
2402
1277
|
}
|
|
2403
|
-
/**
|
|
2404
|
-
*
|
|
2405
|
-
* @export
|
|
2406
|
-
* @interface UpdateProductRequestIntegrationConnectionsInner
|
|
2407
|
-
*/
|
|
2408
1278
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
2409
1279
|
/**
|
|
2410
1280
|
* Code identifying the integration
|
|
2411
|
-
* @type {string}
|
|
2412
|
-
* @memberof UpdateProductRequestIntegrationConnectionsInner
|
|
2413
1281
|
*/
|
|
2414
1282
|
'integrationCode': string;
|
|
2415
1283
|
/**
|
|
2416
1284
|
* The value of the identifying property on the foreign product
|
|
2417
|
-
* @type {string}
|
|
2418
|
-
* @memberof UpdateProductRequestIntegrationConnectionsInner
|
|
2419
1285
|
*/
|
|
2420
1286
|
'foreignKey': string;
|
|
2421
1287
|
}
|
|
2422
|
-
/**
|
|
2423
|
-
*
|
|
2424
|
-
* @export
|
|
2425
|
-
* @interface UpdateProductsRequest
|
|
2426
|
-
*/
|
|
2427
1288
|
export interface UpdateProductsRequest {
|
|
2428
|
-
/**
|
|
2429
|
-
*
|
|
2430
|
-
* @type {Array<UpdateProductsRequestProductsInner>}
|
|
2431
|
-
* @memberof UpdateProductsRequest
|
|
2432
|
-
*/
|
|
2433
1289
|
'products'?: Array<UpdateProductsRequestProductsInner>;
|
|
2434
1290
|
}
|
|
2435
|
-
/**
|
|
2436
|
-
*
|
|
2437
|
-
* @export
|
|
2438
|
-
* @interface UpdateProductsRequestProductsInner
|
|
2439
|
-
*/
|
|
2440
1291
|
export interface UpdateProductsRequestProductsInner {
|
|
2441
1292
|
/**
|
|
2442
1293
|
* Unique object identifier
|
|
2443
|
-
* @type {string}
|
|
2444
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2445
1294
|
*/
|
|
2446
1295
|
'id': string;
|
|
2447
1296
|
/**
|
|
2448
1297
|
* Product title
|
|
2449
|
-
* @type {string}
|
|
2450
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2451
1298
|
*/
|
|
2452
1299
|
'title'?: string;
|
|
2453
1300
|
/**
|
|
2454
1301
|
* Product description
|
|
2455
|
-
* @type {string}
|
|
2456
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2457
1302
|
*/
|
|
2458
1303
|
'description'?: string;
|
|
2459
1304
|
/**
|
|
2460
1305
|
* Whether the product is enabled.
|
|
2461
|
-
* @type {boolean}
|
|
2462
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2463
1306
|
*/
|
|
2464
1307
|
'enabled'?: boolean;
|
|
2465
1308
|
/**
|
|
2466
1309
|
* The brand of the product.
|
|
2467
|
-
* @type {string}
|
|
2468
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2469
1310
|
*/
|
|
2470
1311
|
'brand'?: string | null;
|
|
2471
|
-
/**
|
|
2472
|
-
*
|
|
2473
|
-
* @type {UpdateProductsRequestProductsInnerSeoMetadata}
|
|
2474
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2475
|
-
*/
|
|
2476
1312
|
'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
|
|
2477
1313
|
/**
|
|
2478
1314
|
* 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
|
|
2479
|
-
* @type {string}
|
|
2480
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2481
1315
|
*/
|
|
2482
1316
|
'targetSearchPhrase'?: string;
|
|
2483
1317
|
/**
|
|
2484
1318
|
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
2485
|
-
* @type {Array<string>}
|
|
2486
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2487
1319
|
*/
|
|
2488
1320
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2489
1321
|
/**
|
|
2490
1322
|
* Additional product tags used for searching and filtering.
|
|
2491
|
-
* @type {Array<string>}
|
|
2492
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2493
1323
|
*/
|
|
2494
1324
|
'tags'?: Array<string>;
|
|
2495
1325
|
/**
|
|
2496
1326
|
* List of variants to update.
|
|
2497
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInner>}
|
|
2498
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2499
1327
|
*/
|
|
2500
1328
|
'variants'?: Array<UpdateProductsRequestProductsInnerVariantsInner>;
|
|
2501
1329
|
/**
|
|
2502
1330
|
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
2503
|
-
* @type {boolean}
|
|
2504
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2505
1331
|
*/
|
|
2506
1332
|
'includeInDataFeeds'?: boolean;
|
|
2507
1333
|
/**
|
|
2508
1334
|
* 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.
|
|
2509
|
-
* @type {number}
|
|
2510
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2511
1335
|
*/
|
|
2512
1336
|
'shopifyId'?: number | null;
|
|
2513
|
-
/**
|
|
2514
|
-
*
|
|
2515
|
-
* @type {Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>}
|
|
2516
|
-
* @memberof UpdateProductsRequestProductsInner
|
|
2517
|
-
*/
|
|
2518
1337
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
2519
1338
|
}
|
|
2520
|
-
/**
|
|
2521
|
-
*
|
|
2522
|
-
* @export
|
|
2523
|
-
* @interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2524
|
-
*/
|
|
2525
1339
|
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
2526
|
-
/**
|
|
2527
|
-
*
|
|
2528
|
-
* @type {string}
|
|
2529
|
-
* @memberof UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2530
|
-
*/
|
|
2531
1340
|
'integrationCode': string;
|
|
2532
1341
|
/**
|
|
2533
1342
|
* The value of the identifying property on the foreign product
|
|
2534
|
-
* @type {string}
|
|
2535
|
-
* @memberof UpdateProductsRequestProductsInnerIntegrationConnectionsInner
|
|
2536
1343
|
*/
|
|
2537
1344
|
'foreignKey': string;
|
|
2538
1345
|
}
|
|
2539
|
-
/**
|
|
2540
|
-
*
|
|
2541
|
-
* @export
|
|
2542
|
-
* @interface UpdateProductsRequestProductsInnerSeoMetadata
|
|
2543
|
-
*/
|
|
2544
1346
|
export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
2545
1347
|
/**
|
|
2546
1348
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
2547
|
-
* @type {string}
|
|
2548
|
-
* @memberof UpdateProductsRequestProductsInnerSeoMetadata
|
|
2549
1349
|
*/
|
|
2550
1350
|
'title'?: string;
|
|
2551
1351
|
/**
|
|
2552
1352
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
2553
|
-
* @type {string}
|
|
2554
|
-
* @memberof UpdateProductsRequestProductsInnerSeoMetadata
|
|
2555
1353
|
*/
|
|
2556
1354
|
'description'?: string | null;
|
|
2557
1355
|
}
|
|
2558
|
-
/**
|
|
2559
|
-
*
|
|
2560
|
-
* @export
|
|
2561
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInner
|
|
2562
|
-
*/
|
|
2563
1356
|
export interface UpdateProductsRequestProductsInnerVariantsInner {
|
|
2564
1357
|
/**
|
|
2565
1358
|
* Attributes associated to a variant such as Colour and Size.
|
|
2566
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
2567
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2568
1359
|
*/
|
|
2569
1360
|
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
2570
|
-
/**
|
|
2571
|
-
*
|
|
2572
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
2573
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2574
|
-
*/
|
|
2575
1361
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
2576
|
-
/**
|
|
2577
|
-
*
|
|
2578
|
-
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
2579
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2580
|
-
*/
|
|
2581
1362
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
2582
1363
|
/**
|
|
2583
1364
|
* 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.
|
|
2584
|
-
* @type {string}
|
|
2585
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2586
1365
|
*/
|
|
2587
1366
|
'barcode'?: string | null;
|
|
2588
1367
|
/**
|
|
2589
1368
|
* 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.
|
|
2590
|
-
* @type {number}
|
|
2591
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2592
1369
|
*/
|
|
2593
1370
|
'shopifyId'?: number | null;
|
|
2594
|
-
/**
|
|
2595
|
-
*
|
|
2596
|
-
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}
|
|
2597
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
2598
|
-
*/
|
|
2599
1371
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2600
1372
|
}
|
|
2601
|
-
/**
|
|
2602
|
-
*
|
|
2603
|
-
* @export
|
|
2604
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2605
|
-
*/
|
|
2606
1373
|
export interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner {
|
|
2607
1374
|
/**
|
|
2608
1375
|
* Attribute name
|
|
2609
|
-
* @type {string}
|
|
2610
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2611
1376
|
*/
|
|
2612
1377
|
'name': UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum;
|
|
2613
1378
|
/**
|
|
2614
1379
|
* Attribute value
|
|
2615
|
-
* @type {string}
|
|
2616
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
2617
1380
|
*/
|
|
2618
1381
|
'value': string;
|
|
2619
1382
|
}
|
|
@@ -2622,41 +1385,23 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerAttributesIn
|
|
|
2622
1385
|
readonly Colour: "Colour";
|
|
2623
1386
|
};
|
|
2624
1387
|
export type UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum];
|
|
2625
|
-
/**
|
|
2626
|
-
*
|
|
2627
|
-
* @export
|
|
2628
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2629
|
-
*/
|
|
2630
1388
|
export interface UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner {
|
|
2631
|
-
/**
|
|
2632
|
-
*
|
|
2633
|
-
* @type {string}
|
|
2634
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2635
|
-
*/
|
|
2636
1389
|
'integrationCode': string;
|
|
2637
1390
|
/**
|
|
2638
1391
|
* The value of the identifying property on the foreign variant
|
|
2639
|
-
* @type {string}
|
|
2640
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner
|
|
2641
1392
|
*/
|
|
2642
1393
|
'foreignKey': string;
|
|
2643
1394
|
}
|
|
2644
1395
|
/**
|
|
2645
1396
|
* Variant retail price including tax.
|
|
2646
|
-
* @export
|
|
2647
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2648
1397
|
*/
|
|
2649
1398
|
export interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice {
|
|
2650
1399
|
/**
|
|
2651
1400
|
* Price including tax in the specified currency.
|
|
2652
|
-
* @type {number}
|
|
2653
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2654
1401
|
*/
|
|
2655
1402
|
'amount': number;
|
|
2656
1403
|
/**
|
|
2657
1404
|
* Currency code for the currency the price is valued in.
|
|
2658
|
-
* @type {string}
|
|
2659
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
2660
1405
|
*/
|
|
2661
1406
|
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum;
|
|
2662
1407
|
}
|
|
@@ -2666,20 +1411,14 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceC
|
|
|
2666
1411
|
export type UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum];
|
|
2667
1412
|
/**
|
|
2668
1413
|
* Variant discounted price including tax.
|
|
2669
|
-
* @export
|
|
2670
|
-
* @interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2671
1414
|
*/
|
|
2672
1415
|
export interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice {
|
|
2673
1416
|
/**
|
|
2674
1417
|
* Discounted price including tax in the specified currency.
|
|
2675
|
-
* @type {number}
|
|
2676
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2677
1418
|
*/
|
|
2678
1419
|
'amount': number;
|
|
2679
1420
|
/**
|
|
2680
1421
|
* Currency code for the currency the sale price is valued in.
|
|
2681
|
-
* @type {string}
|
|
2682
|
-
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
2683
1422
|
*/
|
|
2684
1423
|
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum;
|
|
2685
1424
|
}
|
|
@@ -2687,275 +1426,107 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
|
|
|
2687
1426
|
readonly Gbp: "GBP";
|
|
2688
1427
|
};
|
|
2689
1428
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
2690
|
-
/**
|
|
2691
|
-
*
|
|
2692
|
-
* @export
|
|
2693
|
-
* @interface Variant
|
|
2694
|
-
*/
|
|
2695
1429
|
export interface Variant {
|
|
2696
1430
|
/**
|
|
2697
1431
|
* Unique object identifier
|
|
2698
|
-
* @type {string}
|
|
2699
|
-
* @memberof Variant
|
|
2700
1432
|
*/
|
|
2701
1433
|
'id'?: string;
|
|
2702
1434
|
/**
|
|
2703
1435
|
* 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.
|
|
2704
|
-
* @type {Array<Attribute>}
|
|
2705
|
-
* @memberof Variant
|
|
2706
1436
|
*/
|
|
2707
1437
|
'attributes': Array<Attribute>;
|
|
2708
|
-
/**
|
|
2709
|
-
*
|
|
2710
|
-
* @type {string}
|
|
2711
|
-
* @memberof Variant
|
|
2712
|
-
*/
|
|
2713
1438
|
'sku': string;
|
|
2714
1439
|
/**
|
|
2715
1440
|
* A reference to the variant resource location
|
|
2716
|
-
* @type {string}
|
|
2717
|
-
* @memberof Variant
|
|
2718
1441
|
*/
|
|
2719
1442
|
'ref'?: string;
|
|
2720
|
-
/**
|
|
2721
|
-
*
|
|
2722
|
-
* @type {VariantProduct}
|
|
2723
|
-
* @memberof Variant
|
|
2724
|
-
*/
|
|
2725
1443
|
'product'?: VariantProduct;
|
|
2726
|
-
/**
|
|
2727
|
-
*
|
|
2728
|
-
* @type {number}
|
|
2729
|
-
* @memberof Variant
|
|
2730
|
-
*/
|
|
2731
1444
|
'sortOrder'?: number;
|
|
2732
|
-
/**
|
|
2733
|
-
*
|
|
2734
|
-
* @type {Price}
|
|
2735
|
-
* @memberof Variant
|
|
2736
|
-
*/
|
|
2737
1445
|
'retailPrice'?: Price;
|
|
2738
|
-
/**
|
|
2739
|
-
*
|
|
2740
|
-
* @type {SalePrice}
|
|
2741
|
-
* @memberof Variant
|
|
2742
|
-
*/
|
|
2743
1446
|
'salePrice'?: SalePrice | null;
|
|
2744
|
-
/**
|
|
2745
|
-
*
|
|
2746
|
-
* @type {Price}
|
|
2747
|
-
* @memberof Variant
|
|
2748
|
-
*/
|
|
2749
1447
|
'price'?: Price;
|
|
2750
|
-
/**
|
|
2751
|
-
*
|
|
2752
|
-
* @type {Stock}
|
|
2753
|
-
* @memberof Variant
|
|
2754
|
-
*/
|
|
2755
1448
|
'stock'?: Stock;
|
|
2756
|
-
/**
|
|
2757
|
-
*
|
|
2758
|
-
* @type {string}
|
|
2759
|
-
* @memberof Variant
|
|
2760
|
-
*/
|
|
2761
1449
|
'createdAt'?: string;
|
|
2762
|
-
/**
|
|
2763
|
-
*
|
|
2764
|
-
* @type {string}
|
|
2765
|
-
* @memberof Variant
|
|
2766
|
-
*/
|
|
2767
1450
|
'updatedAt'?: string;
|
|
2768
|
-
/**
|
|
2769
|
-
*
|
|
2770
|
-
* @type {string}
|
|
2771
|
-
* @memberof Variant
|
|
2772
|
-
*/
|
|
2773
1451
|
'publishedAt'?: string;
|
|
2774
1452
|
/**
|
|
2775
1453
|
* Images
|
|
2776
|
-
* @type {Array<Image>}
|
|
2777
|
-
* @memberof Variant
|
|
2778
1454
|
*/
|
|
2779
1455
|
'images'?: Array<Image>;
|
|
2780
1456
|
/**
|
|
2781
1457
|
* Design applications. If not provided, the product will be blank.
|
|
2782
|
-
* @type {Array<Application>}
|
|
2783
|
-
* @memberof Variant
|
|
2784
1458
|
*/
|
|
2785
1459
|
'applications'?: Array<Application>;
|
|
2786
1460
|
/**
|
|
2787
1461
|
* 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.
|
|
2788
|
-
* @type {string}
|
|
2789
|
-
* @memberof Variant
|
|
2790
1462
|
*/
|
|
2791
1463
|
'barcode'?: string | null;
|
|
2792
1464
|
/**
|
|
2793
1465
|
* Deprecated. Please use `barcode` instead.
|
|
2794
|
-
* @type {string}
|
|
2795
|
-
* @memberof Variant
|
|
2796
1466
|
* @deprecated
|
|
2797
1467
|
*/
|
|
2798
1468
|
'gtin'?: string | null;
|
|
2799
1469
|
/**
|
|
2800
1470
|
* For use with the Shopify integration. The Shopify variant ID that this variant is linked to.
|
|
2801
|
-
* @type {number}
|
|
2802
|
-
* @memberof Variant
|
|
2803
1471
|
*/
|
|
2804
1472
|
'shopifyId'?: number | null;
|
|
2805
1473
|
/**
|
|
2806
1474
|
* Key/value pairs that can be used to store additional information about the variant
|
|
2807
|
-
* @type {Array<MetaField>}
|
|
2808
|
-
* @memberof Variant
|
|
2809
1475
|
*/
|
|
2810
1476
|
'metafields'?: Array<MetaField>;
|
|
2811
|
-
/**
|
|
2812
|
-
*
|
|
2813
|
-
* @type {Array<VariantIntegrationConnectionsInner>}
|
|
2814
|
-
* @memberof Variant
|
|
2815
|
-
*/
|
|
2816
1477
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
2817
|
-
/**
|
|
2818
|
-
*
|
|
2819
|
-
* @type {VariantWholesaleCost}
|
|
2820
|
-
* @memberof Variant
|
|
2821
|
-
*/
|
|
2822
1478
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2823
1479
|
}
|
|
2824
|
-
/**
|
|
2825
|
-
*
|
|
2826
|
-
* @export
|
|
2827
|
-
* @interface VariantIntegrationConnectionsInner
|
|
2828
|
-
*/
|
|
2829
1480
|
export interface VariantIntegrationConnectionsInner {
|
|
2830
|
-
/**
|
|
2831
|
-
*
|
|
2832
|
-
* @type {string}
|
|
2833
|
-
* @memberof VariantIntegrationConnectionsInner
|
|
2834
|
-
*/
|
|
2835
1481
|
'integrationCode': string;
|
|
2836
1482
|
/**
|
|
2837
1483
|
* The value of the identifying property on the foreign variant
|
|
2838
|
-
* @type {string}
|
|
2839
|
-
* @memberof VariantIntegrationConnectionsInner
|
|
2840
1484
|
*/
|
|
2841
1485
|
'foreignKey': string;
|
|
2842
1486
|
}
|
|
2843
|
-
/**
|
|
2844
|
-
*
|
|
2845
|
-
* @export
|
|
2846
|
-
* @interface VariantProduct
|
|
2847
|
-
*/
|
|
2848
1487
|
export interface VariantProduct {
|
|
2849
1488
|
/**
|
|
2850
1489
|
* Unique object identifier
|
|
2851
|
-
* @type {string}
|
|
2852
|
-
* @memberof VariantProduct
|
|
2853
1490
|
*/
|
|
2854
1491
|
'id'?: string;
|
|
2855
1492
|
/**
|
|
2856
1493
|
* A reference to the resource location
|
|
2857
|
-
* @type {string}
|
|
2858
|
-
* @memberof VariantProduct
|
|
2859
1494
|
*/
|
|
2860
1495
|
'ref'?: string;
|
|
2861
1496
|
}
|
|
2862
|
-
/**
|
|
2863
|
-
*
|
|
2864
|
-
* @export
|
|
2865
|
-
* @interface VariantWholesaleCost
|
|
2866
|
-
*/
|
|
2867
1497
|
export interface VariantWholesaleCost {
|
|
2868
|
-
/**
|
|
2869
|
-
*
|
|
2870
|
-
* @type {Price}
|
|
2871
|
-
* @memberof VariantWholesaleCost
|
|
2872
|
-
*/
|
|
2873
1498
|
'item'?: Price;
|
|
2874
|
-
/**
|
|
2875
|
-
*
|
|
2876
|
-
* @type {Price}
|
|
2877
|
-
* @memberof VariantWholesaleCost
|
|
2878
|
-
*/
|
|
2879
1499
|
'fulfillment'?: Price;
|
|
2880
1500
|
}
|
|
2881
|
-
/**
|
|
2882
|
-
*
|
|
2883
|
-
* @export
|
|
2884
|
-
* @interface VariantsResponse
|
|
2885
|
-
*/
|
|
2886
1501
|
export interface VariantsResponse {
|
|
2887
|
-
/**
|
|
2888
|
-
*
|
|
2889
|
-
* @type {Array<Variant>}
|
|
2890
|
-
* @memberof VariantsResponse
|
|
2891
|
-
*/
|
|
2892
1502
|
'variants'?: Array<Variant>;
|
|
2893
1503
|
/**
|
|
2894
1504
|
* The token referencing the next page number
|
|
2895
|
-
* @type {number}
|
|
2896
|
-
* @memberof VariantsResponse
|
|
2897
1505
|
*/
|
|
2898
1506
|
'nextPageToken'?: number | null;
|
|
2899
1507
|
}
|
|
2900
1508
|
/**
|
|
2901
1509
|
* Video object
|
|
2902
|
-
* @export
|
|
2903
|
-
* @interface Video
|
|
2904
1510
|
*/
|
|
2905
1511
|
export interface Video {
|
|
2906
1512
|
/**
|
|
2907
1513
|
* Unique object identifier
|
|
2908
|
-
* @type {string}
|
|
2909
|
-
* @memberof Video
|
|
2910
1514
|
*/
|
|
2911
1515
|
'id'?: string;
|
|
2912
|
-
/**
|
|
2913
|
-
*
|
|
2914
|
-
* @type {string}
|
|
2915
|
-
* @memberof Video
|
|
2916
|
-
*/
|
|
2917
1516
|
'src'?: string;
|
|
2918
|
-
/**
|
|
2919
|
-
*
|
|
2920
|
-
* @type {string}
|
|
2921
|
-
* @memberof Video
|
|
2922
|
-
*/
|
|
2923
1517
|
'alt'?: string;
|
|
2924
|
-
/**
|
|
2925
|
-
*
|
|
2926
|
-
* @type {number}
|
|
2927
|
-
* @memberof Video
|
|
2928
|
-
*/
|
|
2929
1518
|
'sortOrder'?: number;
|
|
2930
|
-
/**
|
|
2931
|
-
*
|
|
2932
|
-
* @type {string}
|
|
2933
|
-
* @memberof Video
|
|
2934
|
-
*/
|
|
2935
1519
|
'createdAt'?: string;
|
|
2936
|
-
/**
|
|
2937
|
-
*
|
|
2938
|
-
* @type {string}
|
|
2939
|
-
* @memberof Video
|
|
2940
|
-
*/
|
|
2941
1520
|
'updatedAt'?: string;
|
|
2942
1521
|
}
|
|
2943
|
-
/**
|
|
2944
|
-
*
|
|
2945
|
-
* @export
|
|
2946
|
-
* @interface VideoFile
|
|
2947
|
-
*/
|
|
2948
1522
|
export interface VideoFile {
|
|
2949
1523
|
/**
|
|
2950
1524
|
* Publicly available file URL.
|
|
2951
|
-
* @type {string}
|
|
2952
|
-
* @memberof VideoFile
|
|
2953
1525
|
*/
|
|
2954
1526
|
'src'?: string;
|
|
2955
1527
|
}
|
|
2956
1528
|
/**
|
|
2957
1529
|
* ApplicationGroupsApi - axios parameter creator
|
|
2958
|
-
* @export
|
|
2959
1530
|
*/
|
|
2960
1531
|
export declare const ApplicationGroupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2961
1532
|
/**
|
|
@@ -3009,7 +1580,6 @@ export declare const ApplicationGroupsApiAxiosParamCreator: (configuration?: Con
|
|
|
3009
1580
|
};
|
|
3010
1581
|
/**
|
|
3011
1582
|
* ApplicationGroupsApi - functional programming interface
|
|
3012
|
-
* @export
|
|
3013
1583
|
*/
|
|
3014
1584
|
export declare const ApplicationGroupsApiFp: (configuration?: Configuration) => {
|
|
3015
1585
|
/**
|
|
@@ -3063,7 +1633,6 @@ export declare const ApplicationGroupsApiFp: (configuration?: Configuration) =>
|
|
|
3063
1633
|
};
|
|
3064
1634
|
/**
|
|
3065
1635
|
* ApplicationGroupsApi - factory interface
|
|
3066
|
-
* @export
|
|
3067
1636
|
*/
|
|
3068
1637
|
export declare const ApplicationGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3069
1638
|
/**
|
|
@@ -3109,122 +1678,83 @@ export declare const ApplicationGroupsApiFactory: (configuration?: Configuration
|
|
|
3109
1678
|
};
|
|
3110
1679
|
/**
|
|
3111
1680
|
* Request parameters for createApplicationGroup operation in ApplicationGroupsApi.
|
|
3112
|
-
* @export
|
|
3113
|
-
* @interface ApplicationGroupsApiCreateApplicationGroupRequest
|
|
3114
1681
|
*/
|
|
3115
1682
|
export interface ApplicationGroupsApiCreateApplicationGroupRequest {
|
|
3116
1683
|
/**
|
|
3117
1684
|
* What project it is
|
|
3118
|
-
* @type {string}
|
|
3119
|
-
* @memberof ApplicationGroupsApiCreateApplicationGroup
|
|
3120
1685
|
*/
|
|
3121
1686
|
readonly project: string;
|
|
3122
1687
|
/**
|
|
3123
1688
|
* Create a new application group.
|
|
3124
|
-
* @type {CreateApplicationGroupRequest}
|
|
3125
|
-
* @memberof ApplicationGroupsApiCreateApplicationGroup
|
|
3126
1689
|
*/
|
|
3127
1690
|
readonly createApplicationGroupRequest?: CreateApplicationGroupRequest;
|
|
3128
1691
|
}
|
|
3129
1692
|
/**
|
|
3130
1693
|
* Request parameters for deleteApplicationGroup operation in ApplicationGroupsApi.
|
|
3131
|
-
* @export
|
|
3132
|
-
* @interface ApplicationGroupsApiDeleteApplicationGroupRequest
|
|
3133
1694
|
*/
|
|
3134
1695
|
export interface ApplicationGroupsApiDeleteApplicationGroupRequest {
|
|
3135
1696
|
/**
|
|
3136
1697
|
* What project it is
|
|
3137
|
-
* @type {string}
|
|
3138
|
-
* @memberof ApplicationGroupsApiDeleteApplicationGroup
|
|
3139
1698
|
*/
|
|
3140
1699
|
readonly project: string;
|
|
3141
1700
|
/**
|
|
3142
1701
|
* Application group\'s unique identifier
|
|
3143
|
-
* @type {string}
|
|
3144
|
-
* @memberof ApplicationGroupsApiDeleteApplicationGroup
|
|
3145
1702
|
*/
|
|
3146
1703
|
readonly applicationGroupId: string;
|
|
3147
1704
|
}
|
|
3148
1705
|
/**
|
|
3149
1706
|
* Request parameters for getApplicationGroup operation in ApplicationGroupsApi.
|
|
3150
|
-
* @export
|
|
3151
|
-
* @interface ApplicationGroupsApiGetApplicationGroupRequest
|
|
3152
1707
|
*/
|
|
3153
1708
|
export interface ApplicationGroupsApiGetApplicationGroupRequest {
|
|
3154
1709
|
/**
|
|
3155
1710
|
* What project it is
|
|
3156
|
-
* @type {string}
|
|
3157
|
-
* @memberof ApplicationGroupsApiGetApplicationGroup
|
|
3158
1711
|
*/
|
|
3159
1712
|
readonly project: string;
|
|
3160
1713
|
/**
|
|
3161
1714
|
* Application group\'s unique identifier
|
|
3162
|
-
* @type {string}
|
|
3163
|
-
* @memberof ApplicationGroupsApiGetApplicationGroup
|
|
3164
1715
|
*/
|
|
3165
1716
|
readonly applicationGroupId: string;
|
|
3166
1717
|
}
|
|
3167
1718
|
/**
|
|
3168
1719
|
* Request parameters for listApplicationGroups operation in ApplicationGroupsApi.
|
|
3169
|
-
* @export
|
|
3170
|
-
* @interface ApplicationGroupsApiListApplicationGroupsRequest
|
|
3171
1720
|
*/
|
|
3172
1721
|
export interface ApplicationGroupsApiListApplicationGroupsRequest {
|
|
3173
1722
|
/**
|
|
3174
1723
|
* What project it is
|
|
3175
|
-
* @type {string}
|
|
3176
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3177
1724
|
*/
|
|
3178
1725
|
readonly project: string;
|
|
3179
1726
|
/**
|
|
3180
1727
|
* Page reference token
|
|
3181
|
-
* @type {number}
|
|
3182
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3183
1728
|
*/
|
|
3184
1729
|
readonly pageToken?: number;
|
|
3185
1730
|
/**
|
|
3186
1731
|
* 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.
|
|
3187
|
-
* @type {string}
|
|
3188
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3189
1732
|
*/
|
|
3190
1733
|
readonly search?: string;
|
|
3191
1734
|
/**
|
|
3192
1735
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3193
|
-
* @type {number}
|
|
3194
|
-
* @memberof ApplicationGroupsApiListApplicationGroups
|
|
3195
1736
|
*/
|
|
3196
1737
|
readonly pageSize?: number;
|
|
3197
1738
|
}
|
|
3198
1739
|
/**
|
|
3199
1740
|
* Request parameters for updateApplicationGroup operation in ApplicationGroupsApi.
|
|
3200
|
-
* @export
|
|
3201
|
-
* @interface ApplicationGroupsApiUpdateApplicationGroupRequest
|
|
3202
1741
|
*/
|
|
3203
1742
|
export interface ApplicationGroupsApiUpdateApplicationGroupRequest {
|
|
3204
1743
|
/**
|
|
3205
1744
|
* What project it is
|
|
3206
|
-
* @type {string}
|
|
3207
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3208
1745
|
*/
|
|
3209
1746
|
readonly project: string;
|
|
3210
1747
|
/**
|
|
3211
1748
|
* Application group\'s unique identifier
|
|
3212
|
-
* @type {string}
|
|
3213
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3214
1749
|
*/
|
|
3215
1750
|
readonly applicationGroupId: string;
|
|
3216
1751
|
/**
|
|
3217
1752
|
* Update an existing application group.
|
|
3218
|
-
* @type {UpdateApplicationGroupRequest}
|
|
3219
|
-
* @memberof ApplicationGroupsApiUpdateApplicationGroup
|
|
3220
1753
|
*/
|
|
3221
1754
|
readonly updateApplicationGroupRequest?: UpdateApplicationGroupRequest;
|
|
3222
1755
|
}
|
|
3223
1756
|
/**
|
|
3224
1757
|
* ApplicationGroupsApi - object-oriented interface
|
|
3225
|
-
* @export
|
|
3226
|
-
* @class ApplicationGroupsApi
|
|
3227
|
-
* @extends {BaseAPI}
|
|
3228
1758
|
*/
|
|
3229
1759
|
export declare class ApplicationGroupsApi extends BaseAPI {
|
|
3230
1760
|
/**
|
|
@@ -3233,7 +1763,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3233
1763
|
* @param {ApplicationGroupsApiCreateApplicationGroupRequest} requestParameters Request parameters.
|
|
3234
1764
|
* @param {*} [options] Override http request option.
|
|
3235
1765
|
* @throws {RequiredError}
|
|
3236
|
-
* @memberof ApplicationGroupsApi
|
|
3237
1766
|
*/
|
|
3238
1767
|
createApplicationGroup(requestParameters: ApplicationGroupsApiCreateApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3239
1768
|
/**
|
|
@@ -3242,7 +1771,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3242
1771
|
* @param {ApplicationGroupsApiDeleteApplicationGroupRequest} requestParameters Request parameters.
|
|
3243
1772
|
* @param {*} [options] Override http request option.
|
|
3244
1773
|
* @throws {RequiredError}
|
|
3245
|
-
* @memberof ApplicationGroupsApi
|
|
3246
1774
|
*/
|
|
3247
1775
|
deleteApplicationGroup(requestParameters: ApplicationGroupsApiDeleteApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3248
1776
|
/**
|
|
@@ -3251,7 +1779,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3251
1779
|
* @param {ApplicationGroupsApiGetApplicationGroupRequest} requestParameters Request parameters.
|
|
3252
1780
|
* @param {*} [options] Override http request option.
|
|
3253
1781
|
* @throws {RequiredError}
|
|
3254
|
-
* @memberof ApplicationGroupsApi
|
|
3255
1782
|
*/
|
|
3256
1783
|
getApplicationGroup(requestParameters: ApplicationGroupsApiGetApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3257
1784
|
/**
|
|
@@ -3260,7 +1787,6 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3260
1787
|
* @param {ApplicationGroupsApiListApplicationGroupsRequest} requestParameters Request parameters.
|
|
3261
1788
|
* @param {*} [options] Override http request option.
|
|
3262
1789
|
* @throws {RequiredError}
|
|
3263
|
-
* @memberof ApplicationGroupsApi
|
|
3264
1790
|
*/
|
|
3265
1791
|
listApplicationGroups(requestParameters: ApplicationGroupsApiListApplicationGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroupsResponse, any>>;
|
|
3266
1792
|
/**
|
|
@@ -3269,13 +1795,11 @@ export declare class ApplicationGroupsApi extends BaseAPI {
|
|
|
3269
1795
|
* @param {ApplicationGroupsApiUpdateApplicationGroupRequest} requestParameters Request parameters.
|
|
3270
1796
|
* @param {*} [options] Override http request option.
|
|
3271
1797
|
* @throws {RequiredError}
|
|
3272
|
-
* @memberof ApplicationGroupsApi
|
|
3273
1798
|
*/
|
|
3274
1799
|
updateApplicationGroup(requestParameters: ApplicationGroupsApiUpdateApplicationGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationGroup, any>>;
|
|
3275
1800
|
}
|
|
3276
1801
|
/**
|
|
3277
1802
|
* ApplicationSetsApi - axios parameter creator
|
|
3278
|
-
* @export
|
|
3279
1803
|
*/
|
|
3280
1804
|
export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3281
1805
|
/**
|
|
@@ -3329,7 +1853,6 @@ export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3329
1853
|
};
|
|
3330
1854
|
/**
|
|
3331
1855
|
* ApplicationSetsApi - functional programming interface
|
|
3332
|
-
* @export
|
|
3333
1856
|
*/
|
|
3334
1857
|
export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
3335
1858
|
/**
|
|
@@ -3383,7 +1906,6 @@ export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
|
3383
1906
|
};
|
|
3384
1907
|
/**
|
|
3385
1908
|
* ApplicationSetsApi - factory interface
|
|
3386
|
-
* @export
|
|
3387
1909
|
*/
|
|
3388
1910
|
export declare const ApplicationSetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3389
1911
|
/**
|
|
@@ -3429,122 +1951,83 @@ export declare const ApplicationSetsApiFactory: (configuration?: Configuration,
|
|
|
3429
1951
|
};
|
|
3430
1952
|
/**
|
|
3431
1953
|
* Request parameters for createApplicationSet operation in ApplicationSetsApi.
|
|
3432
|
-
* @export
|
|
3433
|
-
* @interface ApplicationSetsApiCreateApplicationSetRequest
|
|
3434
1954
|
*/
|
|
3435
1955
|
export interface ApplicationSetsApiCreateApplicationSetRequest {
|
|
3436
1956
|
/**
|
|
3437
1957
|
* What project it is
|
|
3438
|
-
* @type {string}
|
|
3439
|
-
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
3440
1958
|
*/
|
|
3441
1959
|
readonly project: string;
|
|
3442
1960
|
/**
|
|
3443
1961
|
* Create a new application set.
|
|
3444
|
-
* @type {CreateApplicationSetRequest}
|
|
3445
|
-
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
3446
1962
|
*/
|
|
3447
1963
|
readonly createApplicationSetRequest?: CreateApplicationSetRequest;
|
|
3448
1964
|
}
|
|
3449
1965
|
/**
|
|
3450
1966
|
* Request parameters for deleteApplicationSet operation in ApplicationSetsApi.
|
|
3451
|
-
* @export
|
|
3452
|
-
* @interface ApplicationSetsApiDeleteApplicationSetRequest
|
|
3453
1967
|
*/
|
|
3454
1968
|
export interface ApplicationSetsApiDeleteApplicationSetRequest {
|
|
3455
1969
|
/**
|
|
3456
1970
|
* What project it is
|
|
3457
|
-
* @type {string}
|
|
3458
|
-
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
3459
1971
|
*/
|
|
3460
1972
|
readonly project: string;
|
|
3461
1973
|
/**
|
|
3462
1974
|
* Application set\'s unique identifier
|
|
3463
|
-
* @type {string}
|
|
3464
|
-
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
3465
1975
|
*/
|
|
3466
1976
|
readonly applicationSetId: string;
|
|
3467
1977
|
}
|
|
3468
1978
|
/**
|
|
3469
1979
|
* Request parameters for getApplicationSet operation in ApplicationSetsApi.
|
|
3470
|
-
* @export
|
|
3471
|
-
* @interface ApplicationSetsApiGetApplicationSetRequest
|
|
3472
1980
|
*/
|
|
3473
1981
|
export interface ApplicationSetsApiGetApplicationSetRequest {
|
|
3474
1982
|
/**
|
|
3475
1983
|
* What project it is
|
|
3476
|
-
* @type {string}
|
|
3477
|
-
* @memberof ApplicationSetsApiGetApplicationSet
|
|
3478
1984
|
*/
|
|
3479
1985
|
readonly project: string;
|
|
3480
1986
|
/**
|
|
3481
1987
|
* Application set\'s unique identifier
|
|
3482
|
-
* @type {string}
|
|
3483
|
-
* @memberof ApplicationSetsApiGetApplicationSet
|
|
3484
1988
|
*/
|
|
3485
1989
|
readonly applicationSetId: string;
|
|
3486
1990
|
}
|
|
3487
1991
|
/**
|
|
3488
1992
|
* Request parameters for listApplicationSets operation in ApplicationSetsApi.
|
|
3489
|
-
* @export
|
|
3490
|
-
* @interface ApplicationSetsApiListApplicationSetsRequest
|
|
3491
1993
|
*/
|
|
3492
1994
|
export interface ApplicationSetsApiListApplicationSetsRequest {
|
|
3493
1995
|
/**
|
|
3494
1996
|
* What project it is
|
|
3495
|
-
* @type {string}
|
|
3496
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3497
1997
|
*/
|
|
3498
1998
|
readonly project: string;
|
|
3499
1999
|
/**
|
|
3500
2000
|
* Page reference token
|
|
3501
|
-
* @type {number}
|
|
3502
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3503
2001
|
*/
|
|
3504
2002
|
readonly pageToken?: number;
|
|
3505
2003
|
/**
|
|
3506
2004
|
* 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.
|
|
3507
|
-
* @type {string}
|
|
3508
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3509
2005
|
*/
|
|
3510
2006
|
readonly search?: string;
|
|
3511
2007
|
/**
|
|
3512
2008
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3513
|
-
* @type {number}
|
|
3514
|
-
* @memberof ApplicationSetsApiListApplicationSets
|
|
3515
2009
|
*/
|
|
3516
2010
|
readonly pageSize?: number;
|
|
3517
2011
|
}
|
|
3518
2012
|
/**
|
|
3519
2013
|
* Request parameters for updateApplicationSet operation in ApplicationSetsApi.
|
|
3520
|
-
* @export
|
|
3521
|
-
* @interface ApplicationSetsApiUpdateApplicationSetRequest
|
|
3522
2014
|
*/
|
|
3523
2015
|
export interface ApplicationSetsApiUpdateApplicationSetRequest {
|
|
3524
2016
|
/**
|
|
3525
2017
|
* What project it is
|
|
3526
|
-
* @type {string}
|
|
3527
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3528
2018
|
*/
|
|
3529
2019
|
readonly project: string;
|
|
3530
2020
|
/**
|
|
3531
2021
|
* Application set\'s unique identifier
|
|
3532
|
-
* @type {string}
|
|
3533
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3534
2022
|
*/
|
|
3535
2023
|
readonly applicationSetId: string;
|
|
3536
2024
|
/**
|
|
3537
2025
|
* Create a new application set.
|
|
3538
|
-
* @type {UpdateApplicationSetRequest}
|
|
3539
|
-
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
3540
2026
|
*/
|
|
3541
2027
|
readonly updateApplicationSetRequest?: UpdateApplicationSetRequest;
|
|
3542
2028
|
}
|
|
3543
2029
|
/**
|
|
3544
2030
|
* ApplicationSetsApi - object-oriented interface
|
|
3545
|
-
* @export
|
|
3546
|
-
* @class ApplicationSetsApi
|
|
3547
|
-
* @extends {BaseAPI}
|
|
3548
2031
|
*/
|
|
3549
2032
|
export declare class ApplicationSetsApi extends BaseAPI {
|
|
3550
2033
|
/**
|
|
@@ -3553,7 +2036,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3553
2036
|
* @param {ApplicationSetsApiCreateApplicationSetRequest} requestParameters Request parameters.
|
|
3554
2037
|
* @param {*} [options] Override http request option.
|
|
3555
2038
|
* @throws {RequiredError}
|
|
3556
|
-
* @memberof ApplicationSetsApi
|
|
3557
2039
|
*/
|
|
3558
2040
|
createApplicationSet(requestParameters: ApplicationSetsApiCreateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3559
2041
|
/**
|
|
@@ -3562,7 +2044,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3562
2044
|
* @param {ApplicationSetsApiDeleteApplicationSetRequest} requestParameters Request parameters.
|
|
3563
2045
|
* @param {*} [options] Override http request option.
|
|
3564
2046
|
* @throws {RequiredError}
|
|
3565
|
-
* @memberof ApplicationSetsApi
|
|
3566
2047
|
*/
|
|
3567
2048
|
deleteApplicationSet(requestParameters: ApplicationSetsApiDeleteApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3568
2049
|
/**
|
|
@@ -3571,7 +2052,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3571
2052
|
* @param {ApplicationSetsApiGetApplicationSetRequest} requestParameters Request parameters.
|
|
3572
2053
|
* @param {*} [options] Override http request option.
|
|
3573
2054
|
* @throws {RequiredError}
|
|
3574
|
-
* @memberof ApplicationSetsApi
|
|
3575
2055
|
*/
|
|
3576
2056
|
getApplicationSet(requestParameters: ApplicationSetsApiGetApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3577
2057
|
/**
|
|
@@ -3580,7 +2060,6 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3580
2060
|
* @param {ApplicationSetsApiListApplicationSetsRequest} requestParameters Request parameters.
|
|
3581
2061
|
* @param {*} [options] Override http request option.
|
|
3582
2062
|
* @throws {RequiredError}
|
|
3583
|
-
* @memberof ApplicationSetsApi
|
|
3584
2063
|
*/
|
|
3585
2064
|
listApplicationSets(requestParameters: ApplicationSetsApiListApplicationSetsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSetsResponse, any>>;
|
|
3586
2065
|
/**
|
|
@@ -3589,13 +2068,11 @@ export declare class ApplicationSetsApi extends BaseAPI {
|
|
|
3589
2068
|
* @param {ApplicationSetsApiUpdateApplicationSetRequest} requestParameters Request parameters.
|
|
3590
2069
|
* @param {*} [options] Override http request option.
|
|
3591
2070
|
* @throws {RequiredError}
|
|
3592
|
-
* @memberof ApplicationSetsApi
|
|
3593
2071
|
*/
|
|
3594
2072
|
updateApplicationSet(requestParameters: ApplicationSetsApiUpdateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
3595
2073
|
}
|
|
3596
2074
|
/**
|
|
3597
2075
|
* ApplicationTechnologiesApi - axios parameter creator
|
|
3598
|
-
* @export
|
|
3599
2076
|
*/
|
|
3600
2077
|
export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3601
2078
|
/**
|
|
@@ -3609,7 +2086,6 @@ export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration
|
|
|
3609
2086
|
};
|
|
3610
2087
|
/**
|
|
3611
2088
|
* ApplicationTechnologiesApi - functional programming interface
|
|
3612
|
-
* @export
|
|
3613
2089
|
*/
|
|
3614
2090
|
export declare const ApplicationTechnologiesApiFp: (configuration?: Configuration) => {
|
|
3615
2091
|
/**
|
|
@@ -3623,7 +2099,6 @@ export declare const ApplicationTechnologiesApiFp: (configuration?: Configuratio
|
|
|
3623
2099
|
};
|
|
3624
2100
|
/**
|
|
3625
2101
|
* ApplicationTechnologiesApi - factory interface
|
|
3626
|
-
* @export
|
|
3627
2102
|
*/
|
|
3628
2103
|
export declare const ApplicationTechnologiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3629
2104
|
/**
|
|
@@ -3637,22 +2112,15 @@ export declare const ApplicationTechnologiesApiFactory: (configuration?: Configu
|
|
|
3637
2112
|
};
|
|
3638
2113
|
/**
|
|
3639
2114
|
* Request parameters for listTechnologies operation in ApplicationTechnologiesApi.
|
|
3640
|
-
* @export
|
|
3641
|
-
* @interface ApplicationTechnologiesApiListTechnologiesRequest
|
|
3642
2115
|
*/
|
|
3643
2116
|
export interface ApplicationTechnologiesApiListTechnologiesRequest {
|
|
3644
2117
|
/**
|
|
3645
2118
|
* What project it is
|
|
3646
|
-
* @type {string}
|
|
3647
|
-
* @memberof ApplicationTechnologiesApiListTechnologies
|
|
3648
2119
|
*/
|
|
3649
2120
|
readonly project: string;
|
|
3650
2121
|
}
|
|
3651
2122
|
/**
|
|
3652
2123
|
* ApplicationTechnologiesApi - object-oriented interface
|
|
3653
|
-
* @export
|
|
3654
|
-
* @class ApplicationTechnologiesApi
|
|
3655
|
-
* @extends {BaseAPI}
|
|
3656
2124
|
*/
|
|
3657
2125
|
export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
3658
2126
|
/**
|
|
@@ -3661,13 +2129,11 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
3661
2129
|
* @param {ApplicationTechnologiesApiListTechnologiesRequest} requestParameters Request parameters.
|
|
3662
2130
|
* @param {*} [options] Override http request option.
|
|
3663
2131
|
* @throws {RequiredError}
|
|
3664
|
-
* @memberof ApplicationTechnologiesApi
|
|
3665
2132
|
*/
|
|
3666
2133
|
listTechnologies(requestParameters: ApplicationTechnologiesApiListTechnologiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationTechnologiesResponse, any>>;
|
|
3667
2134
|
}
|
|
3668
2135
|
/**
|
|
3669
2136
|
* ProductsApi - axios parameter creator
|
|
3670
|
-
* @export
|
|
3671
2137
|
*/
|
|
3672
2138
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3673
2139
|
/**
|
|
@@ -3780,7 +2246,6 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3780
2246
|
};
|
|
3781
2247
|
/**
|
|
3782
2248
|
* ProductsApi - functional programming interface
|
|
3783
|
-
* @export
|
|
3784
2249
|
*/
|
|
3785
2250
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3786
2251
|
/**
|
|
@@ -3845,7 +2310,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3845
2310
|
* @param {*} [options] Override http request option.
|
|
3846
2311
|
* @throws {RequiredError}
|
|
3847
2312
|
*/
|
|
3848
|
-
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2313
|
+
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
|
|
3849
2314
|
/**
|
|
3850
2315
|
* Lists all store listing products attached to the given project.
|
|
3851
2316
|
* @summary List products
|
|
@@ -3893,7 +2358,6 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3893
2358
|
};
|
|
3894
2359
|
/**
|
|
3895
2360
|
* ProductsApi - factory interface
|
|
3896
|
-
* @export
|
|
3897
2361
|
*/
|
|
3898
2362
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3899
2363
|
/**
|
|
@@ -3951,7 +2415,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3951
2415
|
* @param {*} [options] Override http request option.
|
|
3952
2416
|
* @throws {RequiredError}
|
|
3953
2417
|
*/
|
|
3954
|
-
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2418
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
|
|
3955
2419
|
/**
|
|
3956
2420
|
* Lists all store listing products attached to the given project.
|
|
3957
2421
|
* @summary List products
|
|
@@ -3987,266 +2451,175 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3987
2451
|
};
|
|
3988
2452
|
/**
|
|
3989
2453
|
* Request parameters for createProduct operation in ProductsApi.
|
|
3990
|
-
* @export
|
|
3991
|
-
* @interface ProductsApiCreateProductRequest
|
|
3992
2454
|
*/
|
|
3993
2455
|
export interface ProductsApiCreateProductRequest {
|
|
3994
2456
|
/**
|
|
3995
2457
|
* What project it is
|
|
3996
|
-
* @type {string}
|
|
3997
|
-
* @memberof ProductsApiCreateProduct
|
|
3998
2458
|
*/
|
|
3999
2459
|
readonly project: string;
|
|
4000
|
-
/**
|
|
4001
|
-
*
|
|
4002
|
-
* @type {CreateProductRequest}
|
|
4003
|
-
* @memberof ProductsApiCreateProduct
|
|
4004
|
-
*/
|
|
4005
2460
|
readonly createProductRequest?: CreateProductRequest;
|
|
4006
2461
|
}
|
|
4007
2462
|
/**
|
|
4008
2463
|
* Request parameters for deleteProduct operation in ProductsApi.
|
|
4009
|
-
* @export
|
|
4010
|
-
* @interface ProductsApiDeleteProductRequest
|
|
4011
2464
|
*/
|
|
4012
2465
|
export interface ProductsApiDeleteProductRequest {
|
|
4013
2466
|
/**
|
|
4014
2467
|
* What project it is
|
|
4015
|
-
* @type {string}
|
|
4016
|
-
* @memberof ProductsApiDeleteProduct
|
|
4017
2468
|
*/
|
|
4018
2469
|
readonly project: string;
|
|
4019
2470
|
/**
|
|
4020
2471
|
* Product\'s unique identifier
|
|
4021
|
-
* @type {string}
|
|
4022
|
-
* @memberof ProductsApiDeleteProduct
|
|
4023
2472
|
*/
|
|
4024
2473
|
readonly productId: string;
|
|
4025
2474
|
}
|
|
4026
2475
|
/**
|
|
4027
2476
|
* Request parameters for deleteProducts operation in ProductsApi.
|
|
4028
|
-
* @export
|
|
4029
|
-
* @interface ProductsApiDeleteProductsRequest
|
|
4030
2477
|
*/
|
|
4031
2478
|
export interface ProductsApiDeleteProductsRequest {
|
|
4032
2479
|
/**
|
|
4033
2480
|
* What project it is
|
|
4034
|
-
* @type {string}
|
|
4035
|
-
* @memberof ProductsApiDeleteProducts
|
|
4036
2481
|
*/
|
|
4037
2482
|
readonly project: string;
|
|
4038
2483
|
/**
|
|
4039
2484
|
* Delete products in bulk.
|
|
4040
|
-
* @type {DeleteProductsRequest}
|
|
4041
|
-
* @memberof ProductsApiDeleteProducts
|
|
4042
2485
|
*/
|
|
4043
2486
|
readonly deleteProductsRequest: DeleteProductsRequest;
|
|
4044
2487
|
}
|
|
4045
2488
|
/**
|
|
4046
2489
|
* Request parameters for duplicateProducts operation in ProductsApi.
|
|
4047
|
-
* @export
|
|
4048
|
-
* @interface ProductsApiDuplicateProductsRequest
|
|
4049
2490
|
*/
|
|
4050
2491
|
export interface ProductsApiDuplicateProductsRequest {
|
|
4051
2492
|
/**
|
|
4052
2493
|
* What project it is
|
|
4053
|
-
* @type {string}
|
|
4054
|
-
* @memberof ProductsApiDuplicateProducts
|
|
4055
2494
|
*/
|
|
4056
2495
|
readonly project: string;
|
|
4057
2496
|
/**
|
|
4058
2497
|
* A set of product IDs to duplicate and the project IDs to duplicate them to.
|
|
4059
|
-
* @type {DuplicateProductsRequest}
|
|
4060
|
-
* @memberof ProductsApiDuplicateProducts
|
|
4061
2498
|
*/
|
|
4062
2499
|
readonly duplicateProductsRequest?: DuplicateProductsRequest;
|
|
4063
2500
|
}
|
|
4064
2501
|
/**
|
|
4065
2502
|
* Request parameters for exportProducts operation in ProductsApi.
|
|
4066
|
-
* @export
|
|
4067
|
-
* @interface ProductsApiExportProductsRequest
|
|
4068
2503
|
*/
|
|
4069
2504
|
export interface ProductsApiExportProductsRequest {
|
|
4070
2505
|
/**
|
|
4071
2506
|
* What project it is
|
|
4072
|
-
* @type {string}
|
|
4073
|
-
* @memberof ProductsApiExportProducts
|
|
4074
2507
|
*/
|
|
4075
2508
|
readonly project: string;
|
|
4076
2509
|
}
|
|
4077
2510
|
/**
|
|
4078
2511
|
* Request parameters for getProduct operation in ProductsApi.
|
|
4079
|
-
* @export
|
|
4080
|
-
* @interface ProductsApiGetProductRequest
|
|
4081
2512
|
*/
|
|
4082
2513
|
export interface ProductsApiGetProductRequest {
|
|
4083
2514
|
/**
|
|
4084
2515
|
* What project it is
|
|
4085
|
-
* @type {string}
|
|
4086
|
-
* @memberof ProductsApiGetProduct
|
|
4087
2516
|
*/
|
|
4088
2517
|
readonly project: string;
|
|
4089
2518
|
/**
|
|
4090
2519
|
* Product\'s unique identifier
|
|
4091
|
-
* @type {string}
|
|
4092
|
-
* @memberof ProductsApiGetProduct
|
|
4093
2520
|
*/
|
|
4094
2521
|
readonly productId: string;
|
|
4095
2522
|
/**
|
|
4096
2523
|
* Filter response fields to only include a subset of the resource.
|
|
4097
|
-
* @type {string}
|
|
4098
|
-
* @memberof ProductsApiGetProduct
|
|
4099
2524
|
*/
|
|
4100
2525
|
readonly fields?: string;
|
|
4101
2526
|
}
|
|
4102
2527
|
/**
|
|
4103
2528
|
* Request parameters for importProducts operation in ProductsApi.
|
|
4104
|
-
* @export
|
|
4105
|
-
* @interface ProductsApiImportProductsRequest
|
|
4106
2529
|
*/
|
|
4107
2530
|
export interface ProductsApiImportProductsRequest {
|
|
4108
2531
|
/**
|
|
4109
2532
|
* What project it is
|
|
4110
|
-
* @type {string}
|
|
4111
|
-
* @memberof ProductsApiImportProducts
|
|
4112
2533
|
*/
|
|
4113
2534
|
readonly project: string;
|
|
4114
2535
|
/**
|
|
4115
2536
|
* A base64 data URL of a CSV file containing data for one or more products.
|
|
4116
|
-
* @type {string}
|
|
4117
|
-
* @memberof ProductsApiImportProducts
|
|
4118
2537
|
*/
|
|
4119
2538
|
readonly body?: string;
|
|
4120
2539
|
}
|
|
4121
2540
|
/**
|
|
4122
2541
|
* Request parameters for listProducts operation in ProductsApi.
|
|
4123
|
-
* @export
|
|
4124
|
-
* @interface ProductsApiListProductsRequest
|
|
4125
2542
|
*/
|
|
4126
2543
|
export interface ProductsApiListProductsRequest {
|
|
4127
2544
|
/**
|
|
4128
2545
|
* What project it is
|
|
4129
|
-
* @type {string}
|
|
4130
|
-
* @memberof ProductsApiListProducts
|
|
4131
2546
|
*/
|
|
4132
2547
|
readonly project: string;
|
|
4133
2548
|
/**
|
|
4134
2549
|
* Page reference token
|
|
4135
|
-
* @type {number}
|
|
4136
|
-
* @memberof ProductsApiListProducts
|
|
4137
2550
|
*/
|
|
4138
2551
|
readonly pageToken?: number;
|
|
4139
2552
|
/**
|
|
4140
2553
|
* 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.
|
|
4141
|
-
* @type {string}
|
|
4142
|
-
* @memberof ProductsApiListProducts
|
|
4143
2554
|
*/
|
|
4144
2555
|
readonly search?: string;
|
|
4145
2556
|
/**
|
|
4146
2557
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4147
|
-
* @type {Array<string>}
|
|
4148
|
-
* @memberof ProductsApiListProducts
|
|
4149
2558
|
*/
|
|
4150
2559
|
readonly sortBy?: Array<string>;
|
|
4151
2560
|
/**
|
|
4152
2561
|
* Start of date range to filter
|
|
4153
|
-
* @type {string}
|
|
4154
|
-
* @memberof ProductsApiListProducts
|
|
4155
2562
|
*/
|
|
4156
2563
|
readonly start?: string;
|
|
4157
2564
|
/**
|
|
4158
2565
|
* End of date range to filter
|
|
4159
|
-
* @type {string}
|
|
4160
|
-
* @memberof ProductsApiListProducts
|
|
4161
2566
|
*/
|
|
4162
2567
|
readonly end?: string;
|
|
4163
2568
|
/**
|
|
4164
2569
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4165
|
-
* @type {'createdAt' | 'updatedAt'}
|
|
4166
|
-
* @memberof ProductsApiListProducts
|
|
4167
2570
|
*/
|
|
4168
2571
|
readonly dateFilterType?: ListProductsDateFilterTypeEnum;
|
|
4169
2572
|
/**
|
|
4170
2573
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4171
|
-
* @type {number}
|
|
4172
|
-
* @memberof ProductsApiListProducts
|
|
4173
2574
|
*/
|
|
4174
2575
|
readonly pageSize?: number;
|
|
4175
2576
|
/**
|
|
4176
2577
|
* Filter response fields to only include a subset of the resource.
|
|
4177
|
-
* @type {string}
|
|
4178
|
-
* @memberof ProductsApiListProducts
|
|
4179
2578
|
*/
|
|
4180
2579
|
readonly fields?: string;
|
|
4181
2580
|
}
|
|
4182
2581
|
/**
|
|
4183
2582
|
* Request parameters for seoOptimiseProducts operation in ProductsApi.
|
|
4184
|
-
* @export
|
|
4185
|
-
* @interface ProductsApiSeoOptimiseProductsRequest
|
|
4186
2583
|
*/
|
|
4187
2584
|
export interface ProductsApiSeoOptimiseProductsRequest {
|
|
4188
2585
|
/**
|
|
4189
2586
|
* What project it is
|
|
4190
|
-
* @type {string}
|
|
4191
|
-
* @memberof ProductsApiSeoOptimiseProducts
|
|
4192
2587
|
*/
|
|
4193
2588
|
readonly project: string;
|
|
4194
2589
|
/**
|
|
4195
2590
|
* A set of product IDs to AI SEO optimise.
|
|
4196
|
-
* @type {SeoOptimiseProductsRequest}
|
|
4197
|
-
* @memberof ProductsApiSeoOptimiseProducts
|
|
4198
2591
|
*/
|
|
4199
2592
|
readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest;
|
|
4200
2593
|
}
|
|
4201
2594
|
/**
|
|
4202
2595
|
* Request parameters for updateProduct operation in ProductsApi.
|
|
4203
|
-
* @export
|
|
4204
|
-
* @interface ProductsApiUpdateProductRequest
|
|
4205
2596
|
*/
|
|
4206
2597
|
export interface ProductsApiUpdateProductRequest {
|
|
4207
2598
|
/**
|
|
4208
2599
|
* What project it is
|
|
4209
|
-
* @type {string}
|
|
4210
|
-
* @memberof ProductsApiUpdateProduct
|
|
4211
2600
|
*/
|
|
4212
2601
|
readonly project: string;
|
|
4213
2602
|
/**
|
|
4214
2603
|
* Product\'s unique identifier
|
|
4215
|
-
* @type {string}
|
|
4216
|
-
* @memberof ProductsApiUpdateProduct
|
|
4217
2604
|
*/
|
|
4218
2605
|
readonly productId: string;
|
|
4219
|
-
/**
|
|
4220
|
-
*
|
|
4221
|
-
* @type {UpdateProductRequest}
|
|
4222
|
-
* @memberof ProductsApiUpdateProduct
|
|
4223
|
-
*/
|
|
4224
2606
|
readonly updateProductRequest?: UpdateProductRequest;
|
|
4225
2607
|
}
|
|
4226
2608
|
/**
|
|
4227
2609
|
* Request parameters for updateProducts operation in ProductsApi.
|
|
4228
|
-
* @export
|
|
4229
|
-
* @interface ProductsApiUpdateProductsRequest
|
|
4230
2610
|
*/
|
|
4231
2611
|
export interface ProductsApiUpdateProductsRequest {
|
|
4232
2612
|
/**
|
|
4233
2613
|
* What project it is
|
|
4234
|
-
* @type {string}
|
|
4235
|
-
* @memberof ProductsApiUpdateProducts
|
|
4236
2614
|
*/
|
|
4237
2615
|
readonly project: string;
|
|
4238
2616
|
/**
|
|
4239
2617
|
* Update products in bulk.
|
|
4240
|
-
* @type {UpdateProductsRequest}
|
|
4241
|
-
* @memberof ProductsApiUpdateProducts
|
|
4242
2618
|
*/
|
|
4243
2619
|
readonly updateProductsRequest: UpdateProductsRequest;
|
|
4244
2620
|
}
|
|
4245
2621
|
/**
|
|
4246
2622
|
* ProductsApi - object-oriented interface
|
|
4247
|
-
* @export
|
|
4248
|
-
* @class ProductsApi
|
|
4249
|
-
* @extends {BaseAPI}
|
|
4250
2623
|
*/
|
|
4251
2624
|
export declare class ProductsApi extends BaseAPI {
|
|
4252
2625
|
/**
|
|
@@ -4255,7 +2628,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4255
2628
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
4256
2629
|
* @param {*} [options] Override http request option.
|
|
4257
2630
|
* @throws {RequiredError}
|
|
4258
|
-
* @memberof ProductsApi
|
|
4259
2631
|
*/
|
|
4260
2632
|
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4261
2633
|
/**
|
|
@@ -4264,7 +2636,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4264
2636
|
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
4265
2637
|
* @param {*} [options] Override http request option.
|
|
4266
2638
|
* @throws {RequiredError}
|
|
4267
|
-
* @memberof ProductsApi
|
|
4268
2639
|
*/
|
|
4269
2640
|
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4270
2641
|
/**
|
|
@@ -4273,7 +2644,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4273
2644
|
* @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
|
|
4274
2645
|
* @param {*} [options] Override http request option.
|
|
4275
2646
|
* @throws {RequiredError}
|
|
4276
|
-
* @memberof ProductsApi
|
|
4277
2647
|
*/
|
|
4278
2648
|
deleteProducts(requestParameters: ProductsApiDeleteProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4279
2649
|
/**
|
|
@@ -4282,7 +2652,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4282
2652
|
* @param {ProductsApiDuplicateProductsRequest} requestParameters Request parameters.
|
|
4283
2653
|
* @param {*} [options] Override http request option.
|
|
4284
2654
|
* @throws {RequiredError}
|
|
4285
|
-
* @memberof ProductsApi
|
|
4286
2655
|
*/
|
|
4287
2656
|
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateProducts202Response, any>>;
|
|
4288
2657
|
/**
|
|
@@ -4291,7 +2660,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4291
2660
|
* @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
|
|
4292
2661
|
* @param {*} [options] Override http request option.
|
|
4293
2662
|
* @throws {RequiredError}
|
|
4294
|
-
* @memberof ProductsApi
|
|
4295
2663
|
*/
|
|
4296
2664
|
exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4297
2665
|
/**
|
|
@@ -4300,7 +2668,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4300
2668
|
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
4301
2669
|
* @param {*} [options] Override http request option.
|
|
4302
2670
|
* @throws {RequiredError}
|
|
4303
|
-
* @memberof ProductsApi
|
|
4304
2671
|
*/
|
|
4305
2672
|
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4306
2673
|
/**
|
|
@@ -4309,16 +2676,14 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4309
2676
|
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
4310
2677
|
* @param {*} [options] Override http request option.
|
|
4311
2678
|
* @throws {RequiredError}
|
|
4312
|
-
* @memberof ProductsApi
|
|
4313
2679
|
*/
|
|
4314
|
-
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2680
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
4315
2681
|
/**
|
|
4316
2682
|
* Lists all store listing products attached to the given project.
|
|
4317
2683
|
* @summary List products
|
|
4318
2684
|
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
4319
2685
|
* @param {*} [options] Override http request option.
|
|
4320
2686
|
* @throws {RequiredError}
|
|
4321
|
-
* @memberof ProductsApi
|
|
4322
2687
|
*/
|
|
4323
2688
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
4324
2689
|
/**
|
|
@@ -4327,7 +2692,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4327
2692
|
* @param {ProductsApiSeoOptimiseProductsRequest} requestParameters Request parameters.
|
|
4328
2693
|
* @param {*} [options] Override http request option.
|
|
4329
2694
|
* @throws {RequiredError}
|
|
4330
|
-
* @memberof ProductsApi
|
|
4331
2695
|
*/
|
|
4332
2696
|
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimiseProducts202Response, any>>;
|
|
4333
2697
|
/**
|
|
@@ -4336,7 +2700,6 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4336
2700
|
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
4337
2701
|
* @param {*} [options] Override http request option.
|
|
4338
2702
|
* @throws {RequiredError}
|
|
4339
|
-
* @memberof ProductsApi
|
|
4340
2703
|
*/
|
|
4341
2704
|
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
4342
2705
|
/**
|
|
@@ -4345,13 +2708,9 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4345
2708
|
* @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
|
|
4346
2709
|
* @param {*} [options] Override http request option.
|
|
4347
2710
|
* @throws {RequiredError}
|
|
4348
|
-
* @memberof ProductsApi
|
|
4349
2711
|
*/
|
|
4350
2712
|
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
4351
2713
|
}
|
|
4352
|
-
/**
|
|
4353
|
-
* @export
|
|
4354
|
-
*/
|
|
4355
2714
|
export declare const ListProductsDateFilterTypeEnum: {
|
|
4356
2715
|
readonly CreatedAt: "createdAt";
|
|
4357
2716
|
readonly UpdatedAt: "updatedAt";
|
|
@@ -4359,7 +2718,6 @@ export declare const ListProductsDateFilterTypeEnum: {
|
|
|
4359
2718
|
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
4360
2719
|
/**
|
|
4361
2720
|
* VariantsApi - axios parameter creator
|
|
4362
|
-
* @export
|
|
4363
2721
|
*/
|
|
4364
2722
|
export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4365
2723
|
/**
|
|
@@ -4387,7 +2745,6 @@ export declare const VariantsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4387
2745
|
};
|
|
4388
2746
|
/**
|
|
4389
2747
|
* VariantsApi - functional programming interface
|
|
4390
|
-
* @export
|
|
4391
2748
|
*/
|
|
4392
2749
|
export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
4393
2750
|
/**
|
|
@@ -4415,7 +2772,6 @@ export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
|
4415
2772
|
};
|
|
4416
2773
|
/**
|
|
4417
2774
|
* VariantsApi - factory interface
|
|
4418
|
-
* @export
|
|
4419
2775
|
*/
|
|
4420
2776
|
export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4421
2777
|
/**
|
|
@@ -4437,71 +2793,48 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
|
|
|
4437
2793
|
};
|
|
4438
2794
|
/**
|
|
4439
2795
|
* Request parameters for getVariant operation in VariantsApi.
|
|
4440
|
-
* @export
|
|
4441
|
-
* @interface VariantsApiGetVariantRequest
|
|
4442
2796
|
*/
|
|
4443
2797
|
export interface VariantsApiGetVariantRequest {
|
|
4444
2798
|
/**
|
|
4445
2799
|
* What project it is
|
|
4446
|
-
* @type {string}
|
|
4447
|
-
* @memberof VariantsApiGetVariant
|
|
4448
2800
|
*/
|
|
4449
2801
|
readonly project: string;
|
|
4450
2802
|
/**
|
|
4451
2803
|
* Variants unique identifier
|
|
4452
|
-
* @type {string}
|
|
4453
|
-
* @memberof VariantsApiGetVariant
|
|
4454
2804
|
*/
|
|
4455
2805
|
readonly variantId: string;
|
|
4456
2806
|
/**
|
|
4457
2807
|
* Filter response fields to only include a subset of the resource.
|
|
4458
|
-
* @type {string}
|
|
4459
|
-
* @memberof VariantsApiGetVariant
|
|
4460
2808
|
*/
|
|
4461
2809
|
readonly fields?: string;
|
|
4462
2810
|
}
|
|
4463
2811
|
/**
|
|
4464
2812
|
* Request parameters for listVariants operation in VariantsApi.
|
|
4465
|
-
* @export
|
|
4466
|
-
* @interface VariantsApiListVariantsRequest
|
|
4467
2813
|
*/
|
|
4468
2814
|
export interface VariantsApiListVariantsRequest {
|
|
4469
2815
|
/**
|
|
4470
2816
|
* What project it is
|
|
4471
|
-
* @type {string}
|
|
4472
|
-
* @memberof VariantsApiListVariants
|
|
4473
2817
|
*/
|
|
4474
2818
|
readonly project: string;
|
|
4475
2819
|
/**
|
|
4476
2820
|
* 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.
|
|
4477
|
-
* @type {string}
|
|
4478
|
-
* @memberof VariantsApiListVariants
|
|
4479
2821
|
*/
|
|
4480
2822
|
readonly search?: string;
|
|
4481
2823
|
/**
|
|
4482
2824
|
* Page reference token
|
|
4483
|
-
* @type {number}
|
|
4484
|
-
* @memberof VariantsApiListVariants
|
|
4485
2825
|
*/
|
|
4486
2826
|
readonly pageToken?: number;
|
|
4487
2827
|
/**
|
|
4488
2828
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4489
|
-
* @type {number}
|
|
4490
|
-
* @memberof VariantsApiListVariants
|
|
4491
2829
|
*/
|
|
4492
2830
|
readonly pageSize?: number;
|
|
4493
2831
|
/**
|
|
4494
2832
|
* Filter response fields to only include a subset of the resource.
|
|
4495
|
-
* @type {string}
|
|
4496
|
-
* @memberof VariantsApiListVariants
|
|
4497
2833
|
*/
|
|
4498
2834
|
readonly fields?: string;
|
|
4499
2835
|
}
|
|
4500
2836
|
/**
|
|
4501
2837
|
* VariantsApi - object-oriented interface
|
|
4502
|
-
* @export
|
|
4503
|
-
* @class VariantsApi
|
|
4504
|
-
* @extends {BaseAPI}
|
|
4505
2838
|
*/
|
|
4506
2839
|
export declare class VariantsApi extends BaseAPI {
|
|
4507
2840
|
/**
|
|
@@ -4510,7 +2843,6 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
4510
2843
|
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
4511
2844
|
* @param {*} [options] Override http request option.
|
|
4512
2845
|
* @throws {RequiredError}
|
|
4513
|
-
* @memberof VariantsApi
|
|
4514
2846
|
*/
|
|
4515
2847
|
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
4516
2848
|
/**
|
|
@@ -4519,7 +2851,6 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
4519
2851
|
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
4520
2852
|
* @param {*} [options] Override http request option.
|
|
4521
2853
|
* @throws {RequiredError}
|
|
4522
|
-
* @memberof VariantsApi
|
|
4523
2854
|
*/
|
|
4524
2855
|
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
|
|
4525
2856
|
}
|