@teemill/website 0.22.2 → 0.24.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 +26 -2
- package/api.ts +901 -53
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +747 -19
- package/dist/api.js +180 -7
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +747 -19
- package/dist/esm/api.js +178 -5
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- 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/Banner.md +23 -0
- package/docs/BannerImage.md +22 -0
- package/docs/Collection.md +10 -6
- package/docs/CollectionProduct.md +24 -0
- package/docs/CollectionProductImage.md +22 -0
- package/docs/CollectionsApi.md +128 -0
- package/docs/CreateCollectionRequest.md +38 -0
- package/docs/CreateCollectionRequestBanner.md +22 -0
- package/docs/CreateCollectionRequestBannerImage.md +22 -0
- package/docs/CreateCollectionRequestBannerOverlay.md +26 -0
- package/docs/CreateCollectionRequestProductsInner.md +24 -0
- package/docs/CreateCollectionRequestSeoMetadata.md +24 -0
- package/docs/MetaImage.md +1 -1
- package/docs/NavigationTag.md +24 -0
- package/docs/NullableMetaImage.md +23 -0
- package/docs/Overlay.md +27 -0
- package/docs/SalePrice.md +23 -0
- package/docs/UpdateCollectionRequest.md +7 -1
- package/docs/UpdateCollectionRequestBanner.md +22 -0
- package/docs/UpdateCollectionRequestBannerImage.md +22 -0
- package/docs/UpdateCollectionRequestProductsInner.md +24 -0
- package/docs/UpdateCollectionRequestSeoMetadata.md +24 -0
- package/docs/UpdateCollectionsRequestCollectionsInner.md +6 -0
- package/docs/UpdateCollectionsRequestCollectionsInnerBanner.md +22 -0
- package/docs/UpdateCollectionsRequestCollectionsInnerBannerImage.md +22 -0
- package/docs/UpdateCollectionsRequestCollectionsInnerBannerOverlay.md +26 -0
- package/docs/UpdateCollectionsRequestCollectionsInnerProductsInner.md +24 -0
- package/docs/Variant.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Website API
|
|
3
3
|
* Manage your PodOS Website
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.24.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -190,6 +190,44 @@ export interface AuthorizeStripe200Response {
|
|
|
190
190
|
*/
|
|
191
191
|
'redirect_url': string;
|
|
192
192
|
}
|
|
193
|
+
/**
|
|
194
|
+
* The banner image that is used to display the collection
|
|
195
|
+
* @export
|
|
196
|
+
* @interface Banner
|
|
197
|
+
*/
|
|
198
|
+
export interface Banner {
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @type {Overlay}
|
|
202
|
+
* @memberof Banner
|
|
203
|
+
*/
|
|
204
|
+
'overlay'?: Overlay | null;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @type {BannerImage}
|
|
208
|
+
* @memberof Banner
|
|
209
|
+
*/
|
|
210
|
+
'image': BannerImage;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
*
|
|
214
|
+
* @export
|
|
215
|
+
* @interface BannerImage
|
|
216
|
+
*/
|
|
217
|
+
export interface BannerImage {
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @type {string}
|
|
221
|
+
* @memberof BannerImage
|
|
222
|
+
*/
|
|
223
|
+
'src': string;
|
|
224
|
+
/**
|
|
225
|
+
*
|
|
226
|
+
* @type {string}
|
|
227
|
+
* @memberof BannerImage
|
|
228
|
+
*/
|
|
229
|
+
'alt': string;
|
|
230
|
+
}
|
|
193
231
|
/**
|
|
194
232
|
*
|
|
195
233
|
* @export
|
|
@@ -237,7 +275,7 @@ export interface Blog {
|
|
|
237
275
|
* @type {MetaImage}
|
|
238
276
|
* @memberof Blog
|
|
239
277
|
*/
|
|
240
|
-
'metaImage'?: MetaImage;
|
|
278
|
+
'metaImage'?: MetaImage | null;
|
|
241
279
|
/**
|
|
242
280
|
*
|
|
243
281
|
* @type {string}
|
|
@@ -294,25 +332,31 @@ export interface Collection {
|
|
|
294
332
|
* @type {string}
|
|
295
333
|
* @memberof Collection
|
|
296
334
|
*/
|
|
297
|
-
'title'
|
|
335
|
+
'title': string;
|
|
298
336
|
/**
|
|
299
337
|
*
|
|
300
338
|
* @type {string}
|
|
301
339
|
* @memberof Collection
|
|
302
340
|
*/
|
|
303
|
-
'description'
|
|
341
|
+
'description': string;
|
|
304
342
|
/**
|
|
305
343
|
*
|
|
306
344
|
* @type {string}
|
|
307
345
|
* @memberof Collection
|
|
308
346
|
*/
|
|
309
|
-
'slug'
|
|
347
|
+
'slug': string;
|
|
310
348
|
/**
|
|
311
349
|
*
|
|
312
350
|
* @type {string}
|
|
313
351
|
* @memberof Collection
|
|
314
352
|
*/
|
|
315
353
|
'longDescription'?: string;
|
|
354
|
+
/**
|
|
355
|
+
*
|
|
356
|
+
* @type {Banner}
|
|
357
|
+
* @memberof Collection
|
|
358
|
+
*/
|
|
359
|
+
'banner': Banner;
|
|
316
360
|
/**
|
|
317
361
|
*
|
|
318
362
|
* @type {SeoMetadata}
|
|
@@ -324,7 +368,7 @@ export interface Collection {
|
|
|
324
368
|
* @type {TargetSearchPhraseData}
|
|
325
369
|
* @memberof Collection
|
|
326
370
|
*/
|
|
327
|
-
'targetSearchPhraseData'
|
|
371
|
+
'targetSearchPhraseData': TargetSearchPhraseData;
|
|
328
372
|
/**
|
|
329
373
|
* History of AI optimisations performed on the collection
|
|
330
374
|
* @type {Array<OptimisationHistoryItem>}
|
|
@@ -332,11 +376,61 @@ export interface Collection {
|
|
|
332
376
|
*/
|
|
333
377
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
334
378
|
/**
|
|
335
|
-
*
|
|
336
|
-
* @type {
|
|
379
|
+
* Tags that are used to link to other collections, pages and products.
|
|
380
|
+
* @type {Array<NavigationTag>}
|
|
381
|
+
* @memberof Collection
|
|
382
|
+
*/
|
|
383
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
384
|
+
/**
|
|
385
|
+
* A set of products to include in the collection.
|
|
386
|
+
* @type {Array<CollectionProduct>}
|
|
337
387
|
* @memberof Collection
|
|
338
388
|
*/
|
|
339
|
-
'
|
|
389
|
+
'products': Array<CollectionProduct>;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
*
|
|
393
|
+
* @export
|
|
394
|
+
* @interface CollectionProduct
|
|
395
|
+
*/
|
|
396
|
+
export interface CollectionProduct {
|
|
397
|
+
/**
|
|
398
|
+
* A reference to the catalog product
|
|
399
|
+
* @type {string}
|
|
400
|
+
* @memberof CollectionProduct
|
|
401
|
+
*/
|
|
402
|
+
'ref': string;
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @type {CollectionProductImage}
|
|
406
|
+
* @memberof CollectionProduct
|
|
407
|
+
*/
|
|
408
|
+
'image': CollectionProductImage;
|
|
409
|
+
/**
|
|
410
|
+
* The sort order of the product in the collection
|
|
411
|
+
* @type {number}
|
|
412
|
+
* @memberof CollectionProduct
|
|
413
|
+
*/
|
|
414
|
+
'order': number;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @export
|
|
419
|
+
* @interface CollectionProductImage
|
|
420
|
+
*/
|
|
421
|
+
export interface CollectionProductImage {
|
|
422
|
+
/**
|
|
423
|
+
* An image for the product to be used in the collection
|
|
424
|
+
* @type {string}
|
|
425
|
+
* @memberof CollectionProductImage
|
|
426
|
+
*/
|
|
427
|
+
'src': string;
|
|
428
|
+
/**
|
|
429
|
+
* Alternative text for the image
|
|
430
|
+
* @type {string}
|
|
431
|
+
* @memberof CollectionProductImage
|
|
432
|
+
*/
|
|
433
|
+
'alt': string;
|
|
340
434
|
}
|
|
341
435
|
/**
|
|
342
436
|
*
|
|
@@ -357,6 +451,192 @@ export interface CollectionsResponse {
|
|
|
357
451
|
*/
|
|
358
452
|
'nextPageToken'?: number | null;
|
|
359
453
|
}
|
|
454
|
+
/**
|
|
455
|
+
*
|
|
456
|
+
* @export
|
|
457
|
+
* @interface CreateCollectionRequest
|
|
458
|
+
*/
|
|
459
|
+
export interface CreateCollectionRequest {
|
|
460
|
+
/**
|
|
461
|
+
*
|
|
462
|
+
* @type {CreateCollectionRequestBanner}
|
|
463
|
+
* @memberof CreateCollectionRequest
|
|
464
|
+
*/
|
|
465
|
+
'banner': CreateCollectionRequestBanner;
|
|
466
|
+
/**
|
|
467
|
+
* Collection title
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof CreateCollectionRequest
|
|
470
|
+
*/
|
|
471
|
+
'title': string;
|
|
472
|
+
/**
|
|
473
|
+
* Collection description
|
|
474
|
+
* @type {string}
|
|
475
|
+
* @memberof CreateCollectionRequest
|
|
476
|
+
*/
|
|
477
|
+
'description': string;
|
|
478
|
+
/**
|
|
479
|
+
* URL slug. This must be unique for each collection on the website.
|
|
480
|
+
* @type {string}
|
|
481
|
+
* @memberof CreateCollectionRequest
|
|
482
|
+
*/
|
|
483
|
+
'slug': string;
|
|
484
|
+
/**
|
|
485
|
+
* Long-form description for the collection used for SEO.
|
|
486
|
+
* @type {string}
|
|
487
|
+
* @memberof CreateCollectionRequest
|
|
488
|
+
*/
|
|
489
|
+
'longDescription'?: string;
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @type {CreateCollectionRequestSeoMetadata}
|
|
493
|
+
* @memberof CreateCollectionRequest
|
|
494
|
+
*/
|
|
495
|
+
'seoMetadata'?: CreateCollectionRequestSeoMetadata;
|
|
496
|
+
/**
|
|
497
|
+
* The primary target search phrase for the collection that you wish to rank for in search engine results.
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof CreateCollectionRequest
|
|
500
|
+
*/
|
|
501
|
+
'targetSearchPhrase'?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Synonyms for the target search phrase.
|
|
504
|
+
* @type {Array<string>}
|
|
505
|
+
* @memberof CreateCollectionRequest
|
|
506
|
+
*/
|
|
507
|
+
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
508
|
+
/**
|
|
509
|
+
* A set of products to include in the collection.
|
|
510
|
+
* @type {Array<CreateCollectionRequestProductsInner>}
|
|
511
|
+
* @memberof CreateCollectionRequest
|
|
512
|
+
*/
|
|
513
|
+
'products': Array<CreateCollectionRequestProductsInner>;
|
|
514
|
+
/**
|
|
515
|
+
* Tags that are used to link to other collections, pages and products.
|
|
516
|
+
* @type {Array<NavigationTag>}
|
|
517
|
+
* @memberof CreateCollectionRequest
|
|
518
|
+
*/
|
|
519
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @export
|
|
524
|
+
* @interface CreateCollectionRequestBanner
|
|
525
|
+
*/
|
|
526
|
+
export interface CreateCollectionRequestBanner {
|
|
527
|
+
/**
|
|
528
|
+
*
|
|
529
|
+
* @type {CreateCollectionRequestBannerImage}
|
|
530
|
+
* @memberof CreateCollectionRequestBanner
|
|
531
|
+
*/
|
|
532
|
+
'image': CreateCollectionRequestBannerImage;
|
|
533
|
+
/**
|
|
534
|
+
*
|
|
535
|
+
* @type {CreateCollectionRequestBannerOverlay}
|
|
536
|
+
* @memberof CreateCollectionRequestBanner
|
|
537
|
+
*/
|
|
538
|
+
'overlay'?: CreateCollectionRequestBannerOverlay;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
*
|
|
542
|
+
* @export
|
|
543
|
+
* @interface CreateCollectionRequestBannerImage
|
|
544
|
+
*/
|
|
545
|
+
export interface CreateCollectionRequestBannerImage {
|
|
546
|
+
/**
|
|
547
|
+
* The source of the image
|
|
548
|
+
* @type {string}
|
|
549
|
+
* @memberof CreateCollectionRequestBannerImage
|
|
550
|
+
*/
|
|
551
|
+
'src': string;
|
|
552
|
+
/**
|
|
553
|
+
* Alternative text for the image
|
|
554
|
+
* @type {string}
|
|
555
|
+
* @memberof CreateCollectionRequestBannerImage
|
|
556
|
+
*/
|
|
557
|
+
'alt': string;
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
*
|
|
561
|
+
* @export
|
|
562
|
+
* @interface CreateCollectionRequestBannerOverlay
|
|
563
|
+
*/
|
|
564
|
+
export interface CreateCollectionRequestBannerOverlay {
|
|
565
|
+
/**
|
|
566
|
+
* The start color of the gradient
|
|
567
|
+
* @type {string}
|
|
568
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
569
|
+
*/
|
|
570
|
+
'from'?: string;
|
|
571
|
+
/**
|
|
572
|
+
* The end color of the gradient
|
|
573
|
+
* @type {string}
|
|
574
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
575
|
+
*/
|
|
576
|
+
'to'?: string;
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @type {number}
|
|
580
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
581
|
+
*/
|
|
582
|
+
'angle'?: number;
|
|
583
|
+
/**
|
|
584
|
+
* The opacity of the gradient
|
|
585
|
+
* @type {number}
|
|
586
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
587
|
+
*/
|
|
588
|
+
'opacity'?: number;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
*
|
|
592
|
+
* @export
|
|
593
|
+
* @interface CreateCollectionRequestProductsInner
|
|
594
|
+
*/
|
|
595
|
+
export interface CreateCollectionRequestProductsInner {
|
|
596
|
+
/**
|
|
597
|
+
* A reference to the catalog product
|
|
598
|
+
* @type {string}
|
|
599
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
600
|
+
*/
|
|
601
|
+
'ref': string;
|
|
602
|
+
/**
|
|
603
|
+
* The sort order of the product in the collection
|
|
604
|
+
* @type {number}
|
|
605
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
606
|
+
*/
|
|
607
|
+
'order': number;
|
|
608
|
+
/**
|
|
609
|
+
* An image for the product to be used in the collection
|
|
610
|
+
* @type {string}
|
|
611
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
612
|
+
*/
|
|
613
|
+
'src': string;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
*
|
|
617
|
+
* @export
|
|
618
|
+
* @interface CreateCollectionRequestSeoMetadata
|
|
619
|
+
*/
|
|
620
|
+
export interface CreateCollectionRequestSeoMetadata {
|
|
621
|
+
/**
|
|
622
|
+
* Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used.
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
625
|
+
*/
|
|
626
|
+
'title'?: string;
|
|
627
|
+
/**
|
|
628
|
+
* Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used.
|
|
629
|
+
* @type {string}
|
|
630
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
631
|
+
*/
|
|
632
|
+
'description'?: string;
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
* @type {MetaImage}
|
|
636
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
637
|
+
*/
|
|
638
|
+
'image'?: MetaImage | null;
|
|
639
|
+
}
|
|
360
640
|
/**
|
|
361
641
|
*
|
|
362
642
|
* @export
|
|
@@ -589,7 +869,7 @@ export interface MetaField {
|
|
|
589
869
|
'value': string;
|
|
590
870
|
}
|
|
591
871
|
/**
|
|
592
|
-
* The image that will in links shared on social media platforms
|
|
872
|
+
* The image that will be used in links shared on social media platforms
|
|
593
873
|
* @export
|
|
594
874
|
* @interface MetaImage
|
|
595
875
|
*/
|
|
@@ -620,6 +900,50 @@ export interface ModerateReviewRequest {
|
|
|
620
900
|
*/
|
|
621
901
|
'enabled'?: boolean;
|
|
622
902
|
}
|
|
903
|
+
/**
|
|
904
|
+
*
|
|
905
|
+
* @export
|
|
906
|
+
* @interface NavigationTag
|
|
907
|
+
*/
|
|
908
|
+
export interface NavigationTag {
|
|
909
|
+
/**
|
|
910
|
+
*
|
|
911
|
+
* @type {string}
|
|
912
|
+
* @memberof NavigationTag
|
|
913
|
+
*/
|
|
914
|
+
'text': string;
|
|
915
|
+
/**
|
|
916
|
+
*
|
|
917
|
+
* @type {string}
|
|
918
|
+
* @memberof NavigationTag
|
|
919
|
+
*/
|
|
920
|
+
'link': string;
|
|
921
|
+
/**
|
|
922
|
+
*
|
|
923
|
+
* @type {number}
|
|
924
|
+
* @memberof NavigationTag
|
|
925
|
+
*/
|
|
926
|
+
'order': number;
|
|
927
|
+
}
|
|
928
|
+
/**
|
|
929
|
+
* The image that will be used in links shared on social media platforms
|
|
930
|
+
* @export
|
|
931
|
+
* @interface NullableMetaImage
|
|
932
|
+
*/
|
|
933
|
+
export interface NullableMetaImage {
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @type {string}
|
|
937
|
+
* @memberof NullableMetaImage
|
|
938
|
+
*/
|
|
939
|
+
'src'?: string;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof NullableMetaImage
|
|
944
|
+
*/
|
|
945
|
+
'alt'?: string;
|
|
946
|
+
}
|
|
623
947
|
/**
|
|
624
948
|
*
|
|
625
949
|
* @export
|
|
@@ -639,6 +963,37 @@ export interface OptimisationHistoryItem {
|
|
|
639
963
|
*/
|
|
640
964
|
'createdAt'?: string;
|
|
641
965
|
}
|
|
966
|
+
/**
|
|
967
|
+
* The overlay that is used to display the collection
|
|
968
|
+
* @export
|
|
969
|
+
* @interface Overlay
|
|
970
|
+
*/
|
|
971
|
+
export interface Overlay {
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {string}
|
|
975
|
+
* @memberof Overlay
|
|
976
|
+
*/
|
|
977
|
+
'from': string;
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
* @type {string}
|
|
981
|
+
* @memberof Overlay
|
|
982
|
+
*/
|
|
983
|
+
'to': string;
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {number}
|
|
987
|
+
* @memberof Overlay
|
|
988
|
+
*/
|
|
989
|
+
'angle': number;
|
|
990
|
+
/**
|
|
991
|
+
*
|
|
992
|
+
* @type {number}
|
|
993
|
+
* @memberof Overlay
|
|
994
|
+
*/
|
|
995
|
+
'opacity': number;
|
|
996
|
+
}
|
|
642
997
|
/**
|
|
643
998
|
*
|
|
644
999
|
* @export
|
|
@@ -700,7 +1055,7 @@ export interface Page {
|
|
|
700
1055
|
* @type {MetaImage}
|
|
701
1056
|
* @memberof Page
|
|
702
1057
|
*/
|
|
703
|
-
'metaImage'?: MetaImage;
|
|
1058
|
+
'metaImage'?: MetaImage | null;
|
|
704
1059
|
/**
|
|
705
1060
|
*
|
|
706
1061
|
* @type {string}
|
|
@@ -1220,6 +1575,29 @@ export interface Route {
|
|
|
1220
1575
|
*/
|
|
1221
1576
|
'published': boolean;
|
|
1222
1577
|
}
|
|
1578
|
+
/**
|
|
1579
|
+
* Discounted price including tax.
|
|
1580
|
+
* @export
|
|
1581
|
+
* @interface SalePrice
|
|
1582
|
+
*/
|
|
1583
|
+
export interface SalePrice {
|
|
1584
|
+
/**
|
|
1585
|
+
* Discounted price including tax in the specified currency.
|
|
1586
|
+
* @type {number}
|
|
1587
|
+
* @memberof SalePrice
|
|
1588
|
+
*/
|
|
1589
|
+
'amount': number;
|
|
1590
|
+
/**
|
|
1591
|
+
* Currency code for the currency the sale price is valued in.
|
|
1592
|
+
* @type {string}
|
|
1593
|
+
* @memberof SalePrice
|
|
1594
|
+
*/
|
|
1595
|
+
'currencyCode': SalePriceCurrencyCodeEnum;
|
|
1596
|
+
}
|
|
1597
|
+
export declare const SalePriceCurrencyCodeEnum: {
|
|
1598
|
+
readonly Gbp: "GBP";
|
|
1599
|
+
};
|
|
1600
|
+
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1223
1601
|
/**
|
|
1224
1602
|
*
|
|
1225
1603
|
* @export
|
|
@@ -1773,6 +2151,12 @@ export interface UpdateBrandRequest {
|
|
|
1773
2151
|
* @interface UpdateCollectionRequest
|
|
1774
2152
|
*/
|
|
1775
2153
|
export interface UpdateCollectionRequest {
|
|
2154
|
+
/**
|
|
2155
|
+
*
|
|
2156
|
+
* @type {UpdateCollectionRequestBanner}
|
|
2157
|
+
* @memberof UpdateCollectionRequest
|
|
2158
|
+
*/
|
|
2159
|
+
'banner'?: UpdateCollectionRequestBanner;
|
|
1776
2160
|
/**
|
|
1777
2161
|
* Collection title
|
|
1778
2162
|
* @type {string}
|
|
@@ -1799,10 +2183,10 @@ export interface UpdateCollectionRequest {
|
|
|
1799
2183
|
'longDescription'?: string;
|
|
1800
2184
|
/**
|
|
1801
2185
|
*
|
|
1802
|
-
* @type {
|
|
2186
|
+
* @type {UpdateCollectionRequestSeoMetadata}
|
|
1803
2187
|
* @memberof UpdateCollectionRequest
|
|
1804
2188
|
*/
|
|
1805
|
-
'seoMetadata'?:
|
|
2189
|
+
'seoMetadata'?: UpdateCollectionRequestSeoMetadata;
|
|
1806
2190
|
/**
|
|
1807
2191
|
* The primary target search phrase for the collection that you wish to rank for in search engine results.
|
|
1808
2192
|
* @type {string}
|
|
@@ -1815,6 +2199,106 @@ export interface UpdateCollectionRequest {
|
|
|
1815
2199
|
* @memberof UpdateCollectionRequest
|
|
1816
2200
|
*/
|
|
1817
2201
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2202
|
+
/**
|
|
2203
|
+
* A set of products to include in the collection.
|
|
2204
|
+
* @type {Array<UpdateCollectionRequestProductsInner>}
|
|
2205
|
+
* @memberof UpdateCollectionRequest
|
|
2206
|
+
*/
|
|
2207
|
+
'products'?: Array<UpdateCollectionRequestProductsInner>;
|
|
2208
|
+
/**
|
|
2209
|
+
* Tags that are used to link to other collections, pages and products.
|
|
2210
|
+
* @type {Array<NavigationTag>}
|
|
2211
|
+
* @memberof UpdateCollectionRequest
|
|
2212
|
+
*/
|
|
2213
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
2214
|
+
}
|
|
2215
|
+
/**
|
|
2216
|
+
*
|
|
2217
|
+
* @export
|
|
2218
|
+
* @interface UpdateCollectionRequestBanner
|
|
2219
|
+
*/
|
|
2220
|
+
export interface UpdateCollectionRequestBanner {
|
|
2221
|
+
/**
|
|
2222
|
+
*
|
|
2223
|
+
* @type {UpdateCollectionRequestBannerImage}
|
|
2224
|
+
* @memberof UpdateCollectionRequestBanner
|
|
2225
|
+
*/
|
|
2226
|
+
'image'?: UpdateCollectionRequestBannerImage;
|
|
2227
|
+
/**
|
|
2228
|
+
*
|
|
2229
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
|
|
2230
|
+
* @memberof UpdateCollectionRequestBanner
|
|
2231
|
+
*/
|
|
2232
|
+
'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
|
|
2233
|
+
}
|
|
2234
|
+
/**
|
|
2235
|
+
*
|
|
2236
|
+
* @export
|
|
2237
|
+
* @interface UpdateCollectionRequestBannerImage
|
|
2238
|
+
*/
|
|
2239
|
+
export interface UpdateCollectionRequestBannerImage {
|
|
2240
|
+
/**
|
|
2241
|
+
* Banner image source
|
|
2242
|
+
* @type {string}
|
|
2243
|
+
* @memberof UpdateCollectionRequestBannerImage
|
|
2244
|
+
*/
|
|
2245
|
+
'src'?: string;
|
|
2246
|
+
/**
|
|
2247
|
+
* Banner image alt text
|
|
2248
|
+
* @type {string}
|
|
2249
|
+
* @memberof UpdateCollectionRequestBannerImage
|
|
2250
|
+
*/
|
|
2251
|
+
'alt'?: string;
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
*
|
|
2255
|
+
* @export
|
|
2256
|
+
* @interface UpdateCollectionRequestProductsInner
|
|
2257
|
+
*/
|
|
2258
|
+
export interface UpdateCollectionRequestProductsInner {
|
|
2259
|
+
/**
|
|
2260
|
+
* A reference to the catalog product
|
|
2261
|
+
* @type {string}
|
|
2262
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2263
|
+
*/
|
|
2264
|
+
'ref'?: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* The sort order of the product in the collection
|
|
2267
|
+
* @type {number}
|
|
2268
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2269
|
+
*/
|
|
2270
|
+
'order'?: number;
|
|
2271
|
+
/**
|
|
2272
|
+
* An image for the product to be used in the collection
|
|
2273
|
+
* @type {string}
|
|
2274
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2275
|
+
*/
|
|
2276
|
+
'src'?: string;
|
|
2277
|
+
}
|
|
2278
|
+
/**
|
|
2279
|
+
*
|
|
2280
|
+
* @export
|
|
2281
|
+
* @interface UpdateCollectionRequestSeoMetadata
|
|
2282
|
+
*/
|
|
2283
|
+
export interface UpdateCollectionRequestSeoMetadata {
|
|
2284
|
+
/**
|
|
2285
|
+
* Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used.
|
|
2286
|
+
* @type {string}
|
|
2287
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2288
|
+
*/
|
|
2289
|
+
'title'?: string | null;
|
|
2290
|
+
/**
|
|
2291
|
+
* Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used.
|
|
2292
|
+
* @type {string}
|
|
2293
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2294
|
+
*/
|
|
2295
|
+
'description'?: string | null;
|
|
2296
|
+
/**
|
|
2297
|
+
*
|
|
2298
|
+
* @type {MetaImage}
|
|
2299
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2300
|
+
*/
|
|
2301
|
+
'image'?: MetaImage | null;
|
|
1818
2302
|
}
|
|
1819
2303
|
/**
|
|
1820
2304
|
*
|
|
@@ -1841,6 +2325,12 @@ export interface UpdateCollectionsRequestCollectionsInner {
|
|
|
1841
2325
|
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
1842
2326
|
*/
|
|
1843
2327
|
'id': string;
|
|
2328
|
+
/**
|
|
2329
|
+
*
|
|
2330
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBanner}
|
|
2331
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2332
|
+
*/
|
|
2333
|
+
'banner'?: UpdateCollectionsRequestCollectionsInnerBanner;
|
|
1844
2334
|
/**
|
|
1845
2335
|
* Collection title
|
|
1846
2336
|
* @type {string}
|
|
@@ -1883,6 +2373,112 @@ export interface UpdateCollectionsRequestCollectionsInner {
|
|
|
1883
2373
|
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
1884
2374
|
*/
|
|
1885
2375
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2376
|
+
/**
|
|
2377
|
+
* A set of products to include in the collection.
|
|
2378
|
+
* @type {Array<UpdateCollectionsRequestCollectionsInnerProductsInner>}
|
|
2379
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2380
|
+
*/
|
|
2381
|
+
'products'?: Array<UpdateCollectionsRequestCollectionsInnerProductsInner>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Tags that are used to link to other collections, pages and products.
|
|
2384
|
+
* @type {Array<NavigationTag>}
|
|
2385
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2386
|
+
*/
|
|
2387
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
2388
|
+
}
|
|
2389
|
+
/**
|
|
2390
|
+
*
|
|
2391
|
+
* @export
|
|
2392
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBanner
|
|
2393
|
+
*/
|
|
2394
|
+
export interface UpdateCollectionsRequestCollectionsInnerBanner {
|
|
2395
|
+
/**
|
|
2396
|
+
*
|
|
2397
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerImage}
|
|
2398
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBanner
|
|
2399
|
+
*/
|
|
2400
|
+
'image'?: UpdateCollectionsRequestCollectionsInnerBannerImage;
|
|
2401
|
+
/**
|
|
2402
|
+
*
|
|
2403
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
|
|
2404
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBanner
|
|
2405
|
+
*/
|
|
2406
|
+
'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
|
|
2407
|
+
}
|
|
2408
|
+
/**
|
|
2409
|
+
*
|
|
2410
|
+
* @export
|
|
2411
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
2412
|
+
*/
|
|
2413
|
+
export interface UpdateCollectionsRequestCollectionsInnerBannerImage {
|
|
2414
|
+
/**
|
|
2415
|
+
* Banner image source
|
|
2416
|
+
* @type {string}
|
|
2417
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
2418
|
+
*/
|
|
2419
|
+
'src'?: string;
|
|
2420
|
+
/**
|
|
2421
|
+
* Alternative text for the image
|
|
2422
|
+
* @type {string}
|
|
2423
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
2424
|
+
*/
|
|
2425
|
+
'alt'?: string;
|
|
2426
|
+
}
|
|
2427
|
+
/**
|
|
2428
|
+
*
|
|
2429
|
+
* @export
|
|
2430
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2431
|
+
*/
|
|
2432
|
+
export interface UpdateCollectionsRequestCollectionsInnerBannerOverlay {
|
|
2433
|
+
/**
|
|
2434
|
+
* The start color of the gradient
|
|
2435
|
+
* @type {string}
|
|
2436
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2437
|
+
*/
|
|
2438
|
+
'from'?: string;
|
|
2439
|
+
/**
|
|
2440
|
+
* The end color of the gradient
|
|
2441
|
+
* @type {string}
|
|
2442
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2443
|
+
*/
|
|
2444
|
+
'to'?: string;
|
|
2445
|
+
/**
|
|
2446
|
+
* The angle of the gradient
|
|
2447
|
+
* @type {number}
|
|
2448
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2449
|
+
*/
|
|
2450
|
+
'angle'?: number;
|
|
2451
|
+
/**
|
|
2452
|
+
* The opacity of the gradient
|
|
2453
|
+
* @type {number}
|
|
2454
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2455
|
+
*/
|
|
2456
|
+
'opacity'?: number;
|
|
2457
|
+
}
|
|
2458
|
+
/**
|
|
2459
|
+
*
|
|
2460
|
+
* @export
|
|
2461
|
+
* @interface UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
2462
|
+
*/
|
|
2463
|
+
export interface UpdateCollectionsRequestCollectionsInnerProductsInner {
|
|
2464
|
+
/**
|
|
2465
|
+
*
|
|
2466
|
+
* @type {CollectionProduct}
|
|
2467
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
2468
|
+
*/
|
|
2469
|
+
'ref'?: CollectionProduct;
|
|
2470
|
+
/**
|
|
2471
|
+
* The sort order of the product in the collection
|
|
2472
|
+
* @type {number}
|
|
2473
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
2474
|
+
*/
|
|
2475
|
+
'order'?: number;
|
|
2476
|
+
/**
|
|
2477
|
+
*
|
|
2478
|
+
* @type {NullableMetaImage}
|
|
2479
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
2480
|
+
*/
|
|
2481
|
+
'image'?: NullableMetaImage | null;
|
|
1886
2482
|
}
|
|
1887
2483
|
/**
|
|
1888
2484
|
*
|
|
@@ -2416,10 +3012,10 @@ export interface Variant {
|
|
|
2416
3012
|
'retailPrice'?: Price;
|
|
2417
3013
|
/**
|
|
2418
3014
|
*
|
|
2419
|
-
* @type {
|
|
3015
|
+
* @type {SalePrice}
|
|
2420
3016
|
* @memberof Variant
|
|
2421
3017
|
*/
|
|
2422
|
-
'salePrice'?:
|
|
3018
|
+
'salePrice'?: SalePrice | null;
|
|
2423
3019
|
/**
|
|
2424
3020
|
*
|
|
2425
3021
|
* @type {Price}
|
|
@@ -2878,6 +3474,27 @@ export declare class BlogsApi extends BaseAPI {
|
|
|
2878
3474
|
* @export
|
|
2879
3475
|
*/
|
|
2880
3476
|
export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3477
|
+
/**
|
|
3478
|
+
* Create a new website collection.
|
|
3479
|
+
* @summary Create website collection
|
|
3480
|
+
* @param {string} project What project it is
|
|
3481
|
+
* @param {number} [pageToken] Page reference token
|
|
3482
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3483
|
+
* @param {string} [search] Search term to filter results
|
|
3484
|
+
* @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
|
|
3485
|
+
* @param {*} [options] Override http request option.
|
|
3486
|
+
* @throws {RequiredError}
|
|
3487
|
+
*/
|
|
3488
|
+
createCollection: (project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3489
|
+
/**
|
|
3490
|
+
*
|
|
3491
|
+
* @summary Delete website collection
|
|
3492
|
+
* @param {string} project What project it is
|
|
3493
|
+
* @param {string} collectionId Collection\'s unique identifier
|
|
3494
|
+
* @param {*} [options] Override http request option.
|
|
3495
|
+
* @throws {RequiredError}
|
|
3496
|
+
*/
|
|
3497
|
+
deleteCollection: (project: string, collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2881
3498
|
/**
|
|
2882
3499
|
* Export collections as a CSV file.
|
|
2883
3500
|
* @summary Export collections
|
|
@@ -2926,7 +3543,7 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2926
3543
|
*/
|
|
2927
3544
|
updateCollection: (project: string, collectionId: string, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2928
3545
|
/**
|
|
2929
|
-
*
|
|
3546
|
+
* Update a website collection.
|
|
2930
3547
|
* @summary Update website collections
|
|
2931
3548
|
* @param {string} project What project it is
|
|
2932
3549
|
* @param {number} [pageToken] Page reference token
|
|
@@ -2943,6 +3560,27 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
2943
3560
|
* @export
|
|
2944
3561
|
*/
|
|
2945
3562
|
export declare const CollectionsApiFp: (configuration?: Configuration) => {
|
|
3563
|
+
/**
|
|
3564
|
+
* Create a new website collection.
|
|
3565
|
+
* @summary Create website collection
|
|
3566
|
+
* @param {string} project What project it is
|
|
3567
|
+
* @param {number} [pageToken] Page reference token
|
|
3568
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3569
|
+
* @param {string} [search] Search term to filter results
|
|
3570
|
+
* @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
|
|
3571
|
+
* @param {*} [options] Override http request option.
|
|
3572
|
+
* @throws {RequiredError}
|
|
3573
|
+
*/
|
|
3574
|
+
createCollection(project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>>;
|
|
3575
|
+
/**
|
|
3576
|
+
*
|
|
3577
|
+
* @summary Delete website collection
|
|
3578
|
+
* @param {string} project What project it is
|
|
3579
|
+
* @param {string} collectionId Collection\'s unique identifier
|
|
3580
|
+
* @param {*} [options] Override http request option.
|
|
3581
|
+
* @throws {RequiredError}
|
|
3582
|
+
*/
|
|
3583
|
+
deleteCollection(project: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2946
3584
|
/**
|
|
2947
3585
|
* Export collections as a CSV file.
|
|
2948
3586
|
* @summary Export collections
|
|
@@ -2991,7 +3629,7 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
|
|
|
2991
3629
|
*/
|
|
2992
3630
|
updateCollection(project: string, collectionId: string, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>>;
|
|
2993
3631
|
/**
|
|
2994
|
-
*
|
|
3632
|
+
* Update a website collection.
|
|
2995
3633
|
* @summary Update website collections
|
|
2996
3634
|
* @param {string} project What project it is
|
|
2997
3635
|
* @param {number} [pageToken] Page reference token
|
|
@@ -3008,6 +3646,22 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
|
|
|
3008
3646
|
* @export
|
|
3009
3647
|
*/
|
|
3010
3648
|
export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3649
|
+
/**
|
|
3650
|
+
* Create a new website collection.
|
|
3651
|
+
* @summary Create website collection
|
|
3652
|
+
* @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
|
|
3653
|
+
* @param {*} [options] Override http request option.
|
|
3654
|
+
* @throws {RequiredError}
|
|
3655
|
+
*/
|
|
3656
|
+
createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection>;
|
|
3657
|
+
/**
|
|
3658
|
+
*
|
|
3659
|
+
* @summary Delete website collection
|
|
3660
|
+
* @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
|
|
3661
|
+
* @param {*} [options] Override http request option.
|
|
3662
|
+
* @throws {RequiredError}
|
|
3663
|
+
*/
|
|
3664
|
+
deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3011
3665
|
/**
|
|
3012
3666
|
* Export collections as a CSV file.
|
|
3013
3667
|
* @summary Export collections
|
|
@@ -3049,7 +3703,7 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
|
|
|
3049
3703
|
*/
|
|
3050
3704
|
updateCollection(requestParameters: CollectionsApiUpdateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection>;
|
|
3051
3705
|
/**
|
|
3052
|
-
*
|
|
3706
|
+
* Update a website collection.
|
|
3053
3707
|
* @summary Update website collections
|
|
3054
3708
|
* @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
|
|
3055
3709
|
* @param {*} [options] Override http request option.
|
|
@@ -3057,6 +3711,62 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
|
|
|
3057
3711
|
*/
|
|
3058
3712
|
updateCollections(requestParameters: CollectionsApiUpdateCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CollectionsResponse>;
|
|
3059
3713
|
};
|
|
3714
|
+
/**
|
|
3715
|
+
* Request parameters for createCollection operation in CollectionsApi.
|
|
3716
|
+
* @export
|
|
3717
|
+
* @interface CollectionsApiCreateCollectionRequest
|
|
3718
|
+
*/
|
|
3719
|
+
export interface CollectionsApiCreateCollectionRequest {
|
|
3720
|
+
/**
|
|
3721
|
+
* What project it is
|
|
3722
|
+
* @type {string}
|
|
3723
|
+
* @memberof CollectionsApiCreateCollection
|
|
3724
|
+
*/
|
|
3725
|
+
readonly project: string;
|
|
3726
|
+
/**
|
|
3727
|
+
* Page reference token
|
|
3728
|
+
* @type {number}
|
|
3729
|
+
* @memberof CollectionsApiCreateCollection
|
|
3730
|
+
*/
|
|
3731
|
+
readonly pageToken?: number;
|
|
3732
|
+
/**
|
|
3733
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3734
|
+
* @type {number}
|
|
3735
|
+
* @memberof CollectionsApiCreateCollection
|
|
3736
|
+
*/
|
|
3737
|
+
readonly pageSize?: number;
|
|
3738
|
+
/**
|
|
3739
|
+
* Search term to filter results
|
|
3740
|
+
* @type {string}
|
|
3741
|
+
* @memberof CollectionsApiCreateCollection
|
|
3742
|
+
*/
|
|
3743
|
+
readonly search?: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* Create a new collection
|
|
3746
|
+
* @type {CreateCollectionRequest}
|
|
3747
|
+
* @memberof CollectionsApiCreateCollection
|
|
3748
|
+
*/
|
|
3749
|
+
readonly createCollectionRequest?: CreateCollectionRequest;
|
|
3750
|
+
}
|
|
3751
|
+
/**
|
|
3752
|
+
* Request parameters for deleteCollection operation in CollectionsApi.
|
|
3753
|
+
* @export
|
|
3754
|
+
* @interface CollectionsApiDeleteCollectionRequest
|
|
3755
|
+
*/
|
|
3756
|
+
export interface CollectionsApiDeleteCollectionRequest {
|
|
3757
|
+
/**
|
|
3758
|
+
* What project it is
|
|
3759
|
+
* @type {string}
|
|
3760
|
+
* @memberof CollectionsApiDeleteCollection
|
|
3761
|
+
*/
|
|
3762
|
+
readonly project: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* Collection\'s unique identifier
|
|
3765
|
+
* @type {string}
|
|
3766
|
+
* @memberof CollectionsApiDeleteCollection
|
|
3767
|
+
*/
|
|
3768
|
+
readonly collectionId: string;
|
|
3769
|
+
}
|
|
3060
3770
|
/**
|
|
3061
3771
|
* Request parameters for exportCollections operation in CollectionsApi.
|
|
3062
3772
|
* @export
|
|
@@ -3208,6 +3918,24 @@ export interface CollectionsApiUpdateCollectionsRequest {
|
|
|
3208
3918
|
* @extends {BaseAPI}
|
|
3209
3919
|
*/
|
|
3210
3920
|
export declare class CollectionsApi extends BaseAPI {
|
|
3921
|
+
/**
|
|
3922
|
+
* Create a new website collection.
|
|
3923
|
+
* @summary Create website collection
|
|
3924
|
+
* @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
|
|
3925
|
+
* @param {*} [options] Override http request option.
|
|
3926
|
+
* @throws {RequiredError}
|
|
3927
|
+
* @memberof CollectionsApi
|
|
3928
|
+
*/
|
|
3929
|
+
createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Collection, any>>;
|
|
3930
|
+
/**
|
|
3931
|
+
*
|
|
3932
|
+
* @summary Delete website collection
|
|
3933
|
+
* @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
|
|
3934
|
+
* @param {*} [options] Override http request option.
|
|
3935
|
+
* @throws {RequiredError}
|
|
3936
|
+
* @memberof CollectionsApi
|
|
3937
|
+
*/
|
|
3938
|
+
deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3211
3939
|
/**
|
|
3212
3940
|
* Export collections as a CSV file.
|
|
3213
3941
|
* @summary Export collections
|
|
@@ -3254,7 +3982,7 @@ export declare class CollectionsApi extends BaseAPI {
|
|
|
3254
3982
|
*/
|
|
3255
3983
|
updateCollection(requestParameters: CollectionsApiUpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Collection, any>>;
|
|
3256
3984
|
/**
|
|
3257
|
-
*
|
|
3985
|
+
* Update a website collection.
|
|
3258
3986
|
* @summary Update website collections
|
|
3259
3987
|
* @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
|
|
3260
3988
|
* @param {*} [options] Override http request option.
|