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