@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/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Website API
|
|
5
5
|
* Manage your PodOS Website
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.24.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -207,6 +207,44 @@ export interface AuthorizeStripe200Response {
|
|
|
207
207
|
*/
|
|
208
208
|
'redirect_url': string;
|
|
209
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* The banner image that is used to display the collection
|
|
212
|
+
* @export
|
|
213
|
+
* @interface Banner
|
|
214
|
+
*/
|
|
215
|
+
export interface Banner {
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @type {Overlay}
|
|
219
|
+
* @memberof Banner
|
|
220
|
+
*/
|
|
221
|
+
'overlay'?: Overlay | null;
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @type {BannerImage}
|
|
225
|
+
* @memberof Banner
|
|
226
|
+
*/
|
|
227
|
+
'image': BannerImage;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @export
|
|
232
|
+
* @interface BannerImage
|
|
233
|
+
*/
|
|
234
|
+
export interface BannerImage {
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof BannerImage
|
|
239
|
+
*/
|
|
240
|
+
'src': string;
|
|
241
|
+
/**
|
|
242
|
+
*
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof BannerImage
|
|
245
|
+
*/
|
|
246
|
+
'alt': string;
|
|
247
|
+
}
|
|
210
248
|
/**
|
|
211
249
|
*
|
|
212
250
|
* @export
|
|
@@ -254,7 +292,7 @@ export interface Blog {
|
|
|
254
292
|
* @type {MetaImage}
|
|
255
293
|
* @memberof Blog
|
|
256
294
|
*/
|
|
257
|
-
'metaImage'?: MetaImage;
|
|
295
|
+
'metaImage'?: MetaImage | null;
|
|
258
296
|
/**
|
|
259
297
|
*
|
|
260
298
|
* @type {string}
|
|
@@ -311,25 +349,31 @@ export interface Collection {
|
|
|
311
349
|
* @type {string}
|
|
312
350
|
* @memberof Collection
|
|
313
351
|
*/
|
|
314
|
-
'title'
|
|
352
|
+
'title': string;
|
|
315
353
|
/**
|
|
316
354
|
*
|
|
317
355
|
* @type {string}
|
|
318
356
|
* @memberof Collection
|
|
319
357
|
*/
|
|
320
|
-
'description'
|
|
358
|
+
'description': string;
|
|
321
359
|
/**
|
|
322
360
|
*
|
|
323
361
|
* @type {string}
|
|
324
362
|
* @memberof Collection
|
|
325
363
|
*/
|
|
326
|
-
'slug'
|
|
364
|
+
'slug': string;
|
|
327
365
|
/**
|
|
328
366
|
*
|
|
329
367
|
* @type {string}
|
|
330
368
|
* @memberof Collection
|
|
331
369
|
*/
|
|
332
370
|
'longDescription'?: string;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {Banner}
|
|
374
|
+
* @memberof Collection
|
|
375
|
+
*/
|
|
376
|
+
'banner': Banner;
|
|
333
377
|
/**
|
|
334
378
|
*
|
|
335
379
|
* @type {SeoMetadata}
|
|
@@ -341,7 +385,7 @@ export interface Collection {
|
|
|
341
385
|
* @type {TargetSearchPhraseData}
|
|
342
386
|
* @memberof Collection
|
|
343
387
|
*/
|
|
344
|
-
'targetSearchPhraseData'
|
|
388
|
+
'targetSearchPhraseData': TargetSearchPhraseData;
|
|
345
389
|
/**
|
|
346
390
|
* History of AI optimisations performed on the collection
|
|
347
391
|
* @type {Array<OptimisationHistoryItem>}
|
|
@@ -349,11 +393,61 @@ export interface Collection {
|
|
|
349
393
|
*/
|
|
350
394
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
351
395
|
/**
|
|
352
|
-
*
|
|
353
|
-
* @type {
|
|
396
|
+
* Tags that are used to link to other collections, pages and products.
|
|
397
|
+
* @type {Array<NavigationTag>}
|
|
398
|
+
* @memberof Collection
|
|
399
|
+
*/
|
|
400
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
401
|
+
/**
|
|
402
|
+
* A set of products to include in the collection.
|
|
403
|
+
* @type {Array<CollectionProduct>}
|
|
354
404
|
* @memberof Collection
|
|
355
405
|
*/
|
|
356
|
-
'
|
|
406
|
+
'products': Array<CollectionProduct>;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @export
|
|
411
|
+
* @interface CollectionProduct
|
|
412
|
+
*/
|
|
413
|
+
export interface CollectionProduct {
|
|
414
|
+
/**
|
|
415
|
+
* A reference to the catalog product
|
|
416
|
+
* @type {string}
|
|
417
|
+
* @memberof CollectionProduct
|
|
418
|
+
*/
|
|
419
|
+
'ref': string;
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @type {CollectionProductImage}
|
|
423
|
+
* @memberof CollectionProduct
|
|
424
|
+
*/
|
|
425
|
+
'image': CollectionProductImage;
|
|
426
|
+
/**
|
|
427
|
+
* The sort order of the product in the collection
|
|
428
|
+
* @type {number}
|
|
429
|
+
* @memberof CollectionProduct
|
|
430
|
+
*/
|
|
431
|
+
'order': number;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @export
|
|
436
|
+
* @interface CollectionProductImage
|
|
437
|
+
*/
|
|
438
|
+
export interface CollectionProductImage {
|
|
439
|
+
/**
|
|
440
|
+
* An image for the product to be used in the collection
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof CollectionProductImage
|
|
443
|
+
*/
|
|
444
|
+
'src': string;
|
|
445
|
+
/**
|
|
446
|
+
* Alternative text for the image
|
|
447
|
+
* @type {string}
|
|
448
|
+
* @memberof CollectionProductImage
|
|
449
|
+
*/
|
|
450
|
+
'alt': string;
|
|
357
451
|
}
|
|
358
452
|
/**
|
|
359
453
|
*
|
|
@@ -374,6 +468,192 @@ export interface CollectionsResponse {
|
|
|
374
468
|
*/
|
|
375
469
|
'nextPageToken'?: number | null;
|
|
376
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
*
|
|
473
|
+
* @export
|
|
474
|
+
* @interface CreateCollectionRequest
|
|
475
|
+
*/
|
|
476
|
+
export interface CreateCollectionRequest {
|
|
477
|
+
/**
|
|
478
|
+
*
|
|
479
|
+
* @type {CreateCollectionRequestBanner}
|
|
480
|
+
* @memberof CreateCollectionRequest
|
|
481
|
+
*/
|
|
482
|
+
'banner': CreateCollectionRequestBanner;
|
|
483
|
+
/**
|
|
484
|
+
* Collection title
|
|
485
|
+
* @type {string}
|
|
486
|
+
* @memberof CreateCollectionRequest
|
|
487
|
+
*/
|
|
488
|
+
'title': string;
|
|
489
|
+
/**
|
|
490
|
+
* Collection description
|
|
491
|
+
* @type {string}
|
|
492
|
+
* @memberof CreateCollectionRequest
|
|
493
|
+
*/
|
|
494
|
+
'description': string;
|
|
495
|
+
/**
|
|
496
|
+
* URL slug. This must be unique for each collection on the website.
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof CreateCollectionRequest
|
|
499
|
+
*/
|
|
500
|
+
'slug': string;
|
|
501
|
+
/**
|
|
502
|
+
* Long-form description for the collection used for SEO.
|
|
503
|
+
* @type {string}
|
|
504
|
+
* @memberof CreateCollectionRequest
|
|
505
|
+
*/
|
|
506
|
+
'longDescription'?: string;
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @type {CreateCollectionRequestSeoMetadata}
|
|
510
|
+
* @memberof CreateCollectionRequest
|
|
511
|
+
*/
|
|
512
|
+
'seoMetadata'?: CreateCollectionRequestSeoMetadata;
|
|
513
|
+
/**
|
|
514
|
+
* The primary target search phrase for the collection that you wish to rank for in search engine results.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof CreateCollectionRequest
|
|
517
|
+
*/
|
|
518
|
+
'targetSearchPhrase'?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Synonyms for the target search phrase.
|
|
521
|
+
* @type {Array<string>}
|
|
522
|
+
* @memberof CreateCollectionRequest
|
|
523
|
+
*/
|
|
524
|
+
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
525
|
+
/**
|
|
526
|
+
* A set of products to include in the collection.
|
|
527
|
+
* @type {Array<CreateCollectionRequestProductsInner>}
|
|
528
|
+
* @memberof CreateCollectionRequest
|
|
529
|
+
*/
|
|
530
|
+
'products': Array<CreateCollectionRequestProductsInner>;
|
|
531
|
+
/**
|
|
532
|
+
* Tags that are used to link to other collections, pages and products.
|
|
533
|
+
* @type {Array<NavigationTag>}
|
|
534
|
+
* @memberof CreateCollectionRequest
|
|
535
|
+
*/
|
|
536
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @export
|
|
541
|
+
* @interface CreateCollectionRequestBanner
|
|
542
|
+
*/
|
|
543
|
+
export interface CreateCollectionRequestBanner {
|
|
544
|
+
/**
|
|
545
|
+
*
|
|
546
|
+
* @type {CreateCollectionRequestBannerImage}
|
|
547
|
+
* @memberof CreateCollectionRequestBanner
|
|
548
|
+
*/
|
|
549
|
+
'image': CreateCollectionRequestBannerImage;
|
|
550
|
+
/**
|
|
551
|
+
*
|
|
552
|
+
* @type {CreateCollectionRequestBannerOverlay}
|
|
553
|
+
* @memberof CreateCollectionRequestBanner
|
|
554
|
+
*/
|
|
555
|
+
'overlay'?: CreateCollectionRequestBannerOverlay;
|
|
556
|
+
}
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
* @export
|
|
560
|
+
* @interface CreateCollectionRequestBannerImage
|
|
561
|
+
*/
|
|
562
|
+
export interface CreateCollectionRequestBannerImage {
|
|
563
|
+
/**
|
|
564
|
+
* The source of the image
|
|
565
|
+
* @type {string}
|
|
566
|
+
* @memberof CreateCollectionRequestBannerImage
|
|
567
|
+
*/
|
|
568
|
+
'src': string;
|
|
569
|
+
/**
|
|
570
|
+
* Alternative text for the image
|
|
571
|
+
* @type {string}
|
|
572
|
+
* @memberof CreateCollectionRequestBannerImage
|
|
573
|
+
*/
|
|
574
|
+
'alt': string;
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @export
|
|
579
|
+
* @interface CreateCollectionRequestBannerOverlay
|
|
580
|
+
*/
|
|
581
|
+
export interface CreateCollectionRequestBannerOverlay {
|
|
582
|
+
/**
|
|
583
|
+
* The start color of the gradient
|
|
584
|
+
* @type {string}
|
|
585
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
586
|
+
*/
|
|
587
|
+
'from'?: string;
|
|
588
|
+
/**
|
|
589
|
+
* The end color of the gradient
|
|
590
|
+
* @type {string}
|
|
591
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
592
|
+
*/
|
|
593
|
+
'to'?: string;
|
|
594
|
+
/**
|
|
595
|
+
*
|
|
596
|
+
* @type {number}
|
|
597
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
598
|
+
*/
|
|
599
|
+
'angle'?: number;
|
|
600
|
+
/**
|
|
601
|
+
* The opacity of the gradient
|
|
602
|
+
* @type {number}
|
|
603
|
+
* @memberof CreateCollectionRequestBannerOverlay
|
|
604
|
+
*/
|
|
605
|
+
'opacity'?: number;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
*
|
|
609
|
+
* @export
|
|
610
|
+
* @interface CreateCollectionRequestProductsInner
|
|
611
|
+
*/
|
|
612
|
+
export interface CreateCollectionRequestProductsInner {
|
|
613
|
+
/**
|
|
614
|
+
* A reference to the catalog product
|
|
615
|
+
* @type {string}
|
|
616
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
617
|
+
*/
|
|
618
|
+
'ref': string;
|
|
619
|
+
/**
|
|
620
|
+
* The sort order of the product in the collection
|
|
621
|
+
* @type {number}
|
|
622
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
623
|
+
*/
|
|
624
|
+
'order': number;
|
|
625
|
+
/**
|
|
626
|
+
* An image for the product to be used in the collection
|
|
627
|
+
* @type {string}
|
|
628
|
+
* @memberof CreateCollectionRequestProductsInner
|
|
629
|
+
*/
|
|
630
|
+
'src': string;
|
|
631
|
+
}
|
|
632
|
+
/**
|
|
633
|
+
*
|
|
634
|
+
* @export
|
|
635
|
+
* @interface CreateCollectionRequestSeoMetadata
|
|
636
|
+
*/
|
|
637
|
+
export interface CreateCollectionRequestSeoMetadata {
|
|
638
|
+
/**
|
|
639
|
+
* Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used.
|
|
640
|
+
* @type {string}
|
|
641
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
642
|
+
*/
|
|
643
|
+
'title'?: string;
|
|
644
|
+
/**
|
|
645
|
+
* Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used.
|
|
646
|
+
* @type {string}
|
|
647
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
648
|
+
*/
|
|
649
|
+
'description'?: string;
|
|
650
|
+
/**
|
|
651
|
+
*
|
|
652
|
+
* @type {MetaImage}
|
|
653
|
+
* @memberof CreateCollectionRequestSeoMetadata
|
|
654
|
+
*/
|
|
655
|
+
'image'?: MetaImage | null;
|
|
656
|
+
}
|
|
377
657
|
/**
|
|
378
658
|
*
|
|
379
659
|
* @export
|
|
@@ -606,7 +886,7 @@ export interface MetaField {
|
|
|
606
886
|
'value': string;
|
|
607
887
|
}
|
|
608
888
|
/**
|
|
609
|
-
* The image that will in links shared on social media platforms
|
|
889
|
+
* The image that will be used in links shared on social media platforms
|
|
610
890
|
* @export
|
|
611
891
|
* @interface MetaImage
|
|
612
892
|
*/
|
|
@@ -637,6 +917,50 @@ export interface ModerateReviewRequest {
|
|
|
637
917
|
*/
|
|
638
918
|
'enabled'?: boolean;
|
|
639
919
|
}
|
|
920
|
+
/**
|
|
921
|
+
*
|
|
922
|
+
* @export
|
|
923
|
+
* @interface NavigationTag
|
|
924
|
+
*/
|
|
925
|
+
export interface NavigationTag {
|
|
926
|
+
/**
|
|
927
|
+
*
|
|
928
|
+
* @type {string}
|
|
929
|
+
* @memberof NavigationTag
|
|
930
|
+
*/
|
|
931
|
+
'text': string;
|
|
932
|
+
/**
|
|
933
|
+
*
|
|
934
|
+
* @type {string}
|
|
935
|
+
* @memberof NavigationTag
|
|
936
|
+
*/
|
|
937
|
+
'link': string;
|
|
938
|
+
/**
|
|
939
|
+
*
|
|
940
|
+
* @type {number}
|
|
941
|
+
* @memberof NavigationTag
|
|
942
|
+
*/
|
|
943
|
+
'order': number;
|
|
944
|
+
}
|
|
945
|
+
/**
|
|
946
|
+
* The image that will be used in links shared on social media platforms
|
|
947
|
+
* @export
|
|
948
|
+
* @interface NullableMetaImage
|
|
949
|
+
*/
|
|
950
|
+
export interface NullableMetaImage {
|
|
951
|
+
/**
|
|
952
|
+
*
|
|
953
|
+
* @type {string}
|
|
954
|
+
* @memberof NullableMetaImage
|
|
955
|
+
*/
|
|
956
|
+
'src'?: string;
|
|
957
|
+
/**
|
|
958
|
+
*
|
|
959
|
+
* @type {string}
|
|
960
|
+
* @memberof NullableMetaImage
|
|
961
|
+
*/
|
|
962
|
+
'alt'?: string;
|
|
963
|
+
}
|
|
640
964
|
/**
|
|
641
965
|
*
|
|
642
966
|
* @export
|
|
@@ -656,6 +980,37 @@ export interface OptimisationHistoryItem {
|
|
|
656
980
|
*/
|
|
657
981
|
'createdAt'?: string;
|
|
658
982
|
}
|
|
983
|
+
/**
|
|
984
|
+
* The overlay that is used to display the collection
|
|
985
|
+
* @export
|
|
986
|
+
* @interface Overlay
|
|
987
|
+
*/
|
|
988
|
+
export interface Overlay {
|
|
989
|
+
/**
|
|
990
|
+
*
|
|
991
|
+
* @type {string}
|
|
992
|
+
* @memberof Overlay
|
|
993
|
+
*/
|
|
994
|
+
'from': string;
|
|
995
|
+
/**
|
|
996
|
+
*
|
|
997
|
+
* @type {string}
|
|
998
|
+
* @memberof Overlay
|
|
999
|
+
*/
|
|
1000
|
+
'to': string;
|
|
1001
|
+
/**
|
|
1002
|
+
*
|
|
1003
|
+
* @type {number}
|
|
1004
|
+
* @memberof Overlay
|
|
1005
|
+
*/
|
|
1006
|
+
'angle': number;
|
|
1007
|
+
/**
|
|
1008
|
+
*
|
|
1009
|
+
* @type {number}
|
|
1010
|
+
* @memberof Overlay
|
|
1011
|
+
*/
|
|
1012
|
+
'opacity': number;
|
|
1013
|
+
}
|
|
659
1014
|
/**
|
|
660
1015
|
*
|
|
661
1016
|
* @export
|
|
@@ -717,7 +1072,7 @@ export interface Page {
|
|
|
717
1072
|
* @type {MetaImage}
|
|
718
1073
|
* @memberof Page
|
|
719
1074
|
*/
|
|
720
|
-
'metaImage'?: MetaImage;
|
|
1075
|
+
'metaImage'?: MetaImage | null;
|
|
721
1076
|
/**
|
|
722
1077
|
*
|
|
723
1078
|
* @type {string}
|
|
@@ -1241,6 +1596,32 @@ export interface Route {
|
|
|
1241
1596
|
*/
|
|
1242
1597
|
'published': boolean;
|
|
1243
1598
|
}
|
|
1599
|
+
/**
|
|
1600
|
+
* Discounted price including tax.
|
|
1601
|
+
* @export
|
|
1602
|
+
* @interface SalePrice
|
|
1603
|
+
*/
|
|
1604
|
+
export interface SalePrice {
|
|
1605
|
+
/**
|
|
1606
|
+
* Discounted price including tax in the specified currency.
|
|
1607
|
+
* @type {number}
|
|
1608
|
+
* @memberof SalePrice
|
|
1609
|
+
*/
|
|
1610
|
+
'amount': number;
|
|
1611
|
+
/**
|
|
1612
|
+
* Currency code for the currency the sale price is valued in.
|
|
1613
|
+
* @type {string}
|
|
1614
|
+
* @memberof SalePrice
|
|
1615
|
+
*/
|
|
1616
|
+
'currencyCode': SalePriceCurrencyCodeEnum;
|
|
1617
|
+
}
|
|
1618
|
+
|
|
1619
|
+
export const SalePriceCurrencyCodeEnum = {
|
|
1620
|
+
Gbp: 'GBP'
|
|
1621
|
+
} as const;
|
|
1622
|
+
|
|
1623
|
+
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1624
|
+
|
|
1244
1625
|
/**
|
|
1245
1626
|
*
|
|
1246
1627
|
* @export
|
|
@@ -1808,6 +2189,12 @@ export interface UpdateBrandRequest {
|
|
|
1808
2189
|
* @interface UpdateCollectionRequest
|
|
1809
2190
|
*/
|
|
1810
2191
|
export interface UpdateCollectionRequest {
|
|
2192
|
+
/**
|
|
2193
|
+
*
|
|
2194
|
+
* @type {UpdateCollectionRequestBanner}
|
|
2195
|
+
* @memberof UpdateCollectionRequest
|
|
2196
|
+
*/
|
|
2197
|
+
'banner'?: UpdateCollectionRequestBanner;
|
|
1811
2198
|
/**
|
|
1812
2199
|
* Collection title
|
|
1813
2200
|
* @type {string}
|
|
@@ -1834,10 +2221,10 @@ export interface UpdateCollectionRequest {
|
|
|
1834
2221
|
'longDescription'?: string;
|
|
1835
2222
|
/**
|
|
1836
2223
|
*
|
|
1837
|
-
* @type {
|
|
2224
|
+
* @type {UpdateCollectionRequestSeoMetadata}
|
|
1838
2225
|
* @memberof UpdateCollectionRequest
|
|
1839
2226
|
*/
|
|
1840
|
-
'seoMetadata'?:
|
|
2227
|
+
'seoMetadata'?: UpdateCollectionRequestSeoMetadata;
|
|
1841
2228
|
/**
|
|
1842
2229
|
* The primary target search phrase for the collection that you wish to rank for in search engine results.
|
|
1843
2230
|
* @type {string}
|
|
@@ -1850,74 +2237,286 @@ export interface UpdateCollectionRequest {
|
|
|
1850
2237
|
* @memberof UpdateCollectionRequest
|
|
1851
2238
|
*/
|
|
1852
2239
|
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2240
|
+
/**
|
|
2241
|
+
* A set of products to include in the collection.
|
|
2242
|
+
* @type {Array<UpdateCollectionRequestProductsInner>}
|
|
2243
|
+
* @memberof UpdateCollectionRequest
|
|
2244
|
+
*/
|
|
2245
|
+
'products'?: Array<UpdateCollectionRequestProductsInner>;
|
|
2246
|
+
/**
|
|
2247
|
+
* Tags that are used to link to other collections, pages and products.
|
|
2248
|
+
* @type {Array<NavigationTag>}
|
|
2249
|
+
* @memberof UpdateCollectionRequest
|
|
2250
|
+
*/
|
|
2251
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
*
|
|
2255
|
+
* @export
|
|
2256
|
+
* @interface UpdateCollectionRequestBanner
|
|
2257
|
+
*/
|
|
2258
|
+
export interface UpdateCollectionRequestBanner {
|
|
2259
|
+
/**
|
|
2260
|
+
*
|
|
2261
|
+
* @type {UpdateCollectionRequestBannerImage}
|
|
2262
|
+
* @memberof UpdateCollectionRequestBanner
|
|
2263
|
+
*/
|
|
2264
|
+
'image'?: UpdateCollectionRequestBannerImage;
|
|
2265
|
+
/**
|
|
2266
|
+
*
|
|
2267
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
|
|
2268
|
+
* @memberof UpdateCollectionRequestBanner
|
|
2269
|
+
*/
|
|
2270
|
+
'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
|
|
2271
|
+
}
|
|
2272
|
+
/**
|
|
2273
|
+
*
|
|
2274
|
+
* @export
|
|
2275
|
+
* @interface UpdateCollectionRequestBannerImage
|
|
2276
|
+
*/
|
|
2277
|
+
export interface UpdateCollectionRequestBannerImage {
|
|
2278
|
+
/**
|
|
2279
|
+
* Banner image source
|
|
2280
|
+
* @type {string}
|
|
2281
|
+
* @memberof UpdateCollectionRequestBannerImage
|
|
2282
|
+
*/
|
|
2283
|
+
'src'?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* Banner image alt text
|
|
2286
|
+
* @type {string}
|
|
2287
|
+
* @memberof UpdateCollectionRequestBannerImage
|
|
2288
|
+
*/
|
|
2289
|
+
'alt'?: string;
|
|
2290
|
+
}
|
|
2291
|
+
/**
|
|
2292
|
+
*
|
|
2293
|
+
* @export
|
|
2294
|
+
* @interface UpdateCollectionRequestProductsInner
|
|
2295
|
+
*/
|
|
2296
|
+
export interface UpdateCollectionRequestProductsInner {
|
|
2297
|
+
/**
|
|
2298
|
+
* A reference to the catalog product
|
|
2299
|
+
* @type {string}
|
|
2300
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2301
|
+
*/
|
|
2302
|
+
'ref'?: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* The sort order of the product in the collection
|
|
2305
|
+
* @type {number}
|
|
2306
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2307
|
+
*/
|
|
2308
|
+
'order'?: number;
|
|
2309
|
+
/**
|
|
2310
|
+
* An image for the product to be used in the collection
|
|
2311
|
+
* @type {string}
|
|
2312
|
+
* @memberof UpdateCollectionRequestProductsInner
|
|
2313
|
+
*/
|
|
2314
|
+
'src'?: string;
|
|
2315
|
+
}
|
|
2316
|
+
/**
|
|
2317
|
+
*
|
|
2318
|
+
* @export
|
|
2319
|
+
* @interface UpdateCollectionRequestSeoMetadata
|
|
2320
|
+
*/
|
|
2321
|
+
export interface UpdateCollectionRequestSeoMetadata {
|
|
2322
|
+
/**
|
|
2323
|
+
* Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used.
|
|
2324
|
+
* @type {string}
|
|
2325
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2326
|
+
*/
|
|
2327
|
+
'title'?: string | null;
|
|
2328
|
+
/**
|
|
2329
|
+
* Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used.
|
|
2330
|
+
* @type {string}
|
|
2331
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2332
|
+
*/
|
|
2333
|
+
'description'?: string | null;
|
|
2334
|
+
/**
|
|
2335
|
+
*
|
|
2336
|
+
* @type {MetaImage}
|
|
2337
|
+
* @memberof UpdateCollectionRequestSeoMetadata
|
|
2338
|
+
*/
|
|
2339
|
+
'image'?: MetaImage | null;
|
|
2340
|
+
}
|
|
2341
|
+
/**
|
|
2342
|
+
*
|
|
2343
|
+
* @export
|
|
2344
|
+
* @interface UpdateCollectionsRequest
|
|
2345
|
+
*/
|
|
2346
|
+
export interface UpdateCollectionsRequest {
|
|
2347
|
+
/**
|
|
2348
|
+
*
|
|
2349
|
+
* @type {Array<UpdateCollectionsRequestCollectionsInner>}
|
|
2350
|
+
* @memberof UpdateCollectionsRequest
|
|
2351
|
+
*/
|
|
2352
|
+
'collections'?: Array<UpdateCollectionsRequestCollectionsInner>;
|
|
2353
|
+
}
|
|
2354
|
+
/**
|
|
2355
|
+
*
|
|
2356
|
+
* @export
|
|
2357
|
+
* @interface UpdateCollectionsRequestCollectionsInner
|
|
2358
|
+
*/
|
|
2359
|
+
export interface UpdateCollectionsRequestCollectionsInner {
|
|
2360
|
+
/**
|
|
2361
|
+
* Unique object identifier
|
|
2362
|
+
* @type {string}
|
|
2363
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2364
|
+
*/
|
|
2365
|
+
'id': string;
|
|
2366
|
+
/**
|
|
2367
|
+
*
|
|
2368
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBanner}
|
|
2369
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2370
|
+
*/
|
|
2371
|
+
'banner'?: UpdateCollectionsRequestCollectionsInnerBanner;
|
|
2372
|
+
/**
|
|
2373
|
+
* Collection title
|
|
2374
|
+
* @type {string}
|
|
2375
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2376
|
+
*/
|
|
2377
|
+
'title'?: string;
|
|
2378
|
+
/**
|
|
2379
|
+
* Collection description
|
|
2380
|
+
* @type {string}
|
|
2381
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2382
|
+
*/
|
|
2383
|
+
'description'?: string;
|
|
2384
|
+
/**
|
|
2385
|
+
* URL slug. This must be unique for each collection on the website. Updating this will also break any existing links to this collection.
|
|
2386
|
+
* @type {string}
|
|
2387
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2388
|
+
*/
|
|
2389
|
+
'slug'?: string;
|
|
2390
|
+
/**
|
|
2391
|
+
* Long-form description for the collection used for SEO.
|
|
2392
|
+
* @type {string}
|
|
2393
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2394
|
+
*/
|
|
2395
|
+
'longDescription'?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
*
|
|
2398
|
+
* @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
|
|
2399
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2400
|
+
*/
|
|
2401
|
+
'seoMetadata'?: UpdateCollectionsRequestCollectionsInnerSeoMetadata;
|
|
2402
|
+
/**
|
|
2403
|
+
* The primary target search phrase for the collection that you wish to rank for in search engine results.
|
|
2404
|
+
* @type {string}
|
|
2405
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2406
|
+
*/
|
|
2407
|
+
'targetSearchPhrase'?: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* Synonyms for the target search phrase.
|
|
2410
|
+
* @type {Array<string>}
|
|
2411
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2412
|
+
*/
|
|
2413
|
+
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
2414
|
+
/**
|
|
2415
|
+
* A set of products to include in the collection.
|
|
2416
|
+
* @type {Array<UpdateCollectionsRequestCollectionsInnerProductsInner>}
|
|
2417
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2418
|
+
*/
|
|
2419
|
+
'products'?: Array<UpdateCollectionsRequestCollectionsInnerProductsInner>;
|
|
2420
|
+
/**
|
|
2421
|
+
* Tags that are used to link to other collections, pages and products.
|
|
2422
|
+
* @type {Array<NavigationTag>}
|
|
2423
|
+
* @memberof UpdateCollectionsRequestCollectionsInner
|
|
2424
|
+
*/
|
|
2425
|
+
'navigationTags'?: Array<NavigationTag>;
|
|
1853
2426
|
}
|
|
1854
2427
|
/**
|
|
1855
2428
|
*
|
|
1856
2429
|
* @export
|
|
1857
|
-
* @interface
|
|
2430
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBanner
|
|
1858
2431
|
*/
|
|
1859
|
-
export interface
|
|
2432
|
+
export interface UpdateCollectionsRequestCollectionsInnerBanner {
|
|
1860
2433
|
/**
|
|
1861
2434
|
*
|
|
1862
|
-
* @type {
|
|
1863
|
-
* @memberof
|
|
2435
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerImage}
|
|
2436
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBanner
|
|
1864
2437
|
*/
|
|
1865
|
-
'
|
|
2438
|
+
'image'?: UpdateCollectionsRequestCollectionsInnerBannerImage;
|
|
2439
|
+
/**
|
|
2440
|
+
*
|
|
2441
|
+
* @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
|
|
2442
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBanner
|
|
2443
|
+
*/
|
|
2444
|
+
'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
|
|
1866
2445
|
}
|
|
1867
2446
|
/**
|
|
1868
2447
|
*
|
|
1869
2448
|
* @export
|
|
1870
|
-
* @interface
|
|
2449
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
1871
2450
|
*/
|
|
1872
|
-
export interface
|
|
2451
|
+
export interface UpdateCollectionsRequestCollectionsInnerBannerImage {
|
|
1873
2452
|
/**
|
|
1874
|
-
*
|
|
2453
|
+
* Banner image source
|
|
1875
2454
|
* @type {string}
|
|
1876
|
-
* @memberof
|
|
2455
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
1877
2456
|
*/
|
|
1878
|
-
'
|
|
2457
|
+
'src'?: string;
|
|
1879
2458
|
/**
|
|
1880
|
-
*
|
|
2459
|
+
* Alternative text for the image
|
|
1881
2460
|
* @type {string}
|
|
1882
|
-
* @memberof
|
|
2461
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
|
|
1883
2462
|
*/
|
|
1884
|
-
'
|
|
2463
|
+
'alt'?: string;
|
|
2464
|
+
}
|
|
2465
|
+
/**
|
|
2466
|
+
*
|
|
2467
|
+
* @export
|
|
2468
|
+
* @interface UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2469
|
+
*/
|
|
2470
|
+
export interface UpdateCollectionsRequestCollectionsInnerBannerOverlay {
|
|
1885
2471
|
/**
|
|
1886
|
-
*
|
|
2472
|
+
* The start color of the gradient
|
|
1887
2473
|
* @type {string}
|
|
1888
|
-
* @memberof
|
|
2474
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
1889
2475
|
*/
|
|
1890
|
-
'
|
|
2476
|
+
'from'?: string;
|
|
1891
2477
|
/**
|
|
1892
|
-
*
|
|
2478
|
+
* The end color of the gradient
|
|
1893
2479
|
* @type {string}
|
|
1894
|
-
* @memberof
|
|
2480
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
1895
2481
|
*/
|
|
1896
|
-
'
|
|
2482
|
+
'to'?: string;
|
|
1897
2483
|
/**
|
|
1898
|
-
*
|
|
1899
|
-
* @type {
|
|
1900
|
-
* @memberof
|
|
2484
|
+
* The angle of the gradient
|
|
2485
|
+
* @type {number}
|
|
2486
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
1901
2487
|
*/
|
|
1902
|
-
'
|
|
2488
|
+
'angle'?: number;
|
|
2489
|
+
/**
|
|
2490
|
+
* The opacity of the gradient
|
|
2491
|
+
* @type {number}
|
|
2492
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
|
|
2493
|
+
*/
|
|
2494
|
+
'opacity'?: number;
|
|
2495
|
+
}
|
|
2496
|
+
/**
|
|
2497
|
+
*
|
|
2498
|
+
* @export
|
|
2499
|
+
* @interface UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
2500
|
+
*/
|
|
2501
|
+
export interface UpdateCollectionsRequestCollectionsInnerProductsInner {
|
|
1903
2502
|
/**
|
|
1904
2503
|
*
|
|
1905
|
-
* @type {
|
|
1906
|
-
* @memberof
|
|
2504
|
+
* @type {CollectionProduct}
|
|
2505
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
1907
2506
|
*/
|
|
1908
|
-
'
|
|
2507
|
+
'ref'?: CollectionProduct;
|
|
1909
2508
|
/**
|
|
1910
|
-
* The
|
|
1911
|
-
* @type {
|
|
1912
|
-
* @memberof
|
|
2509
|
+
* The sort order of the product in the collection
|
|
2510
|
+
* @type {number}
|
|
2511
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
1913
2512
|
*/
|
|
1914
|
-
'
|
|
2513
|
+
'order'?: number;
|
|
1915
2514
|
/**
|
|
1916
|
-
*
|
|
1917
|
-
* @type {
|
|
1918
|
-
* @memberof
|
|
2515
|
+
*
|
|
2516
|
+
* @type {NullableMetaImage}
|
|
2517
|
+
* @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
|
|
1919
2518
|
*/
|
|
1920
|
-
'
|
|
2519
|
+
'image'?: NullableMetaImage | null;
|
|
1921
2520
|
}
|
|
1922
2521
|
/**
|
|
1923
2522
|
*
|
|
@@ -2462,10 +3061,10 @@ export interface Variant {
|
|
|
2462
3061
|
'retailPrice'?: Price;
|
|
2463
3062
|
/**
|
|
2464
3063
|
*
|
|
2465
|
-
* @type {
|
|
3064
|
+
* @type {SalePrice}
|
|
2466
3065
|
* @memberof Variant
|
|
2467
3066
|
*/
|
|
2468
|
-
'salePrice'?:
|
|
3067
|
+
'salePrice'?: SalePrice | null;
|
|
2469
3068
|
/**
|
|
2470
3069
|
*
|
|
2471
3070
|
* @type {Price}
|
|
@@ -3220,6 +3819,117 @@ export class BlogsApi extends BaseAPI {
|
|
|
3220
3819
|
*/
|
|
3221
3820
|
export const CollectionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3222
3821
|
return {
|
|
3822
|
+
/**
|
|
3823
|
+
* Create a new website collection.
|
|
3824
|
+
* @summary Create website collection
|
|
3825
|
+
* @param {string} project What project it is
|
|
3826
|
+
* @param {number} [pageToken] Page reference token
|
|
3827
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3828
|
+
* @param {string} [search] Search term to filter results
|
|
3829
|
+
* @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
|
|
3830
|
+
* @param {*} [options] Override http request option.
|
|
3831
|
+
* @throws {RequiredError}
|
|
3832
|
+
*/
|
|
3833
|
+
createCollection: async (project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3834
|
+
// verify required parameter 'project' is not null or undefined
|
|
3835
|
+
assertParamExists('createCollection', 'project', project)
|
|
3836
|
+
const localVarPath = `/v1/website/collections`;
|
|
3837
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3838
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3839
|
+
let baseOptions;
|
|
3840
|
+
if (configuration) {
|
|
3841
|
+
baseOptions = configuration.baseOptions;
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3845
|
+
const localVarHeaderParameter = {} as any;
|
|
3846
|
+
const localVarQueryParameter = {} as any;
|
|
3847
|
+
|
|
3848
|
+
// authentication session-oauth required
|
|
3849
|
+
// oauth required
|
|
3850
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3851
|
+
|
|
3852
|
+
// authentication api-key required
|
|
3853
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3854
|
+
|
|
3855
|
+
if (project !== undefined) {
|
|
3856
|
+
localVarQueryParameter['project'] = project;
|
|
3857
|
+
}
|
|
3858
|
+
|
|
3859
|
+
if (pageToken !== undefined) {
|
|
3860
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3861
|
+
}
|
|
3862
|
+
|
|
3863
|
+
if (pageSize !== undefined) {
|
|
3864
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3865
|
+
}
|
|
3866
|
+
|
|
3867
|
+
if (search !== undefined) {
|
|
3868
|
+
localVarQueryParameter['search'] = search;
|
|
3869
|
+
}
|
|
3870
|
+
|
|
3871
|
+
|
|
3872
|
+
|
|
3873
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3874
|
+
|
|
3875
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3876
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3877
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3878
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createCollectionRequest, localVarRequestOptions, configuration)
|
|
3879
|
+
|
|
3880
|
+
return {
|
|
3881
|
+
url: toPathString(localVarUrlObj),
|
|
3882
|
+
options: localVarRequestOptions,
|
|
3883
|
+
};
|
|
3884
|
+
},
|
|
3885
|
+
/**
|
|
3886
|
+
*
|
|
3887
|
+
* @summary Delete website collection
|
|
3888
|
+
* @param {string} project What project it is
|
|
3889
|
+
* @param {string} collectionId Collection\'s unique identifier
|
|
3890
|
+
* @param {*} [options] Override http request option.
|
|
3891
|
+
* @throws {RequiredError}
|
|
3892
|
+
*/
|
|
3893
|
+
deleteCollection: async (project: string, collectionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3894
|
+
// verify required parameter 'project' is not null or undefined
|
|
3895
|
+
assertParamExists('deleteCollection', 'project', project)
|
|
3896
|
+
// verify required parameter 'collectionId' is not null or undefined
|
|
3897
|
+
assertParamExists('deleteCollection', 'collectionId', collectionId)
|
|
3898
|
+
const localVarPath = `/v1/website/collections/{collectionId}`
|
|
3899
|
+
.replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
|
|
3900
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3901
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3902
|
+
let baseOptions;
|
|
3903
|
+
if (configuration) {
|
|
3904
|
+
baseOptions = configuration.baseOptions;
|
|
3905
|
+
}
|
|
3906
|
+
|
|
3907
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
3908
|
+
const localVarHeaderParameter = {} as any;
|
|
3909
|
+
const localVarQueryParameter = {} as any;
|
|
3910
|
+
|
|
3911
|
+
// authentication session-oauth required
|
|
3912
|
+
// oauth required
|
|
3913
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3914
|
+
|
|
3915
|
+
// authentication api-key required
|
|
3916
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3917
|
+
|
|
3918
|
+
if (project !== undefined) {
|
|
3919
|
+
localVarQueryParameter['project'] = project;
|
|
3920
|
+
}
|
|
3921
|
+
|
|
3922
|
+
|
|
3923
|
+
|
|
3924
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3925
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3926
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3927
|
+
|
|
3928
|
+
return {
|
|
3929
|
+
url: toPathString(localVarUrlObj),
|
|
3930
|
+
options: localVarRequestOptions,
|
|
3931
|
+
};
|
|
3932
|
+
},
|
|
3223
3933
|
/**
|
|
3224
3934
|
* Export collections as a CSV file.
|
|
3225
3935
|
* @summary Export collections
|
|
@@ -3472,7 +4182,7 @@ export const CollectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
3472
4182
|
};
|
|
3473
4183
|
},
|
|
3474
4184
|
/**
|
|
3475
|
-
*
|
|
4185
|
+
* Update a website collection.
|
|
3476
4186
|
* @summary Update website collections
|
|
3477
4187
|
* @param {string} project What project it is
|
|
3478
4188
|
* @param {number} [pageToken] Page reference token
|
|
@@ -3544,6 +4254,37 @@ export const CollectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
3544
4254
|
export const CollectionsApiFp = function(configuration?: Configuration) {
|
|
3545
4255
|
const localVarAxiosParamCreator = CollectionsApiAxiosParamCreator(configuration)
|
|
3546
4256
|
return {
|
|
4257
|
+
/**
|
|
4258
|
+
* Create a new website collection.
|
|
4259
|
+
* @summary Create website collection
|
|
4260
|
+
* @param {string} project What project it is
|
|
4261
|
+
* @param {number} [pageToken] Page reference token
|
|
4262
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4263
|
+
* @param {string} [search] Search term to filter results
|
|
4264
|
+
* @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
|
|
4265
|
+
* @param {*} [options] Override http request option.
|
|
4266
|
+
* @throws {RequiredError}
|
|
4267
|
+
*/
|
|
4268
|
+
async createCollection(project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>> {
|
|
4269
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCollection(project, pageToken, pageSize, search, createCollectionRequest, options);
|
|
4270
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4271
|
+
const localVarOperationServerBasePath = operationServerMap['CollectionsApi.createCollection']?.[localVarOperationServerIndex]?.url;
|
|
4272
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4273
|
+
},
|
|
4274
|
+
/**
|
|
4275
|
+
*
|
|
4276
|
+
* @summary Delete website collection
|
|
4277
|
+
* @param {string} project What project it is
|
|
4278
|
+
* @param {string} collectionId Collection\'s unique identifier
|
|
4279
|
+
* @param {*} [options] Override http request option.
|
|
4280
|
+
* @throws {RequiredError}
|
|
4281
|
+
*/
|
|
4282
|
+
async deleteCollection(project: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
4283
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCollection(project, collectionId, options);
|
|
4284
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4285
|
+
const localVarOperationServerBasePath = operationServerMap['CollectionsApi.deleteCollection']?.[localVarOperationServerIndex]?.url;
|
|
4286
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4287
|
+
},
|
|
3547
4288
|
/**
|
|
3548
4289
|
* Export collections as a CSV file.
|
|
3549
4290
|
* @summary Export collections
|
|
@@ -3617,7 +4358,7 @@ export const CollectionsApiFp = function(configuration?: Configuration) {
|
|
|
3617
4358
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3618
4359
|
},
|
|
3619
4360
|
/**
|
|
3620
|
-
*
|
|
4361
|
+
* Update a website collection.
|
|
3621
4362
|
* @summary Update website collections
|
|
3622
4363
|
* @param {string} project What project it is
|
|
3623
4364
|
* @param {number} [pageToken] Page reference token
|
|
@@ -3643,6 +4384,26 @@ export const CollectionsApiFp = function(configuration?: Configuration) {
|
|
|
3643
4384
|
export const CollectionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3644
4385
|
const localVarFp = CollectionsApiFp(configuration)
|
|
3645
4386
|
return {
|
|
4387
|
+
/**
|
|
4388
|
+
* Create a new website collection.
|
|
4389
|
+
* @summary Create website collection
|
|
4390
|
+
* @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
|
|
4391
|
+
* @param {*} [options] Override http request option.
|
|
4392
|
+
* @throws {RequiredError}
|
|
4393
|
+
*/
|
|
4394
|
+
createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection> {
|
|
4395
|
+
return localVarFp.createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(axios, basePath));
|
|
4396
|
+
},
|
|
4397
|
+
/**
|
|
4398
|
+
*
|
|
4399
|
+
* @summary Delete website collection
|
|
4400
|
+
* @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
|
|
4401
|
+
* @param {*} [options] Override http request option.
|
|
4402
|
+
* @throws {RequiredError}
|
|
4403
|
+
*/
|
|
4404
|
+
deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
4405
|
+
return localVarFp.deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(axios, basePath));
|
|
4406
|
+
},
|
|
3646
4407
|
/**
|
|
3647
4408
|
* Export collections as a CSV file.
|
|
3648
4409
|
* @summary Export collections
|
|
@@ -3694,7 +4455,7 @@ export const CollectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
3694
4455
|
return localVarFp.updateCollection(requestParameters.project, requestParameters.collectionId, requestParameters.updateCollectionRequest, options).then((request) => request(axios, basePath));
|
|
3695
4456
|
},
|
|
3696
4457
|
/**
|
|
3697
|
-
*
|
|
4458
|
+
* Update a website collection.
|
|
3698
4459
|
* @summary Update website collections
|
|
3699
4460
|
* @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
|
|
3700
4461
|
* @param {*} [options] Override http request option.
|
|
@@ -3706,6 +4467,69 @@ export const CollectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
3706
4467
|
};
|
|
3707
4468
|
};
|
|
3708
4469
|
|
|
4470
|
+
/**
|
|
4471
|
+
* Request parameters for createCollection operation in CollectionsApi.
|
|
4472
|
+
* @export
|
|
4473
|
+
* @interface CollectionsApiCreateCollectionRequest
|
|
4474
|
+
*/
|
|
4475
|
+
export interface CollectionsApiCreateCollectionRequest {
|
|
4476
|
+
/**
|
|
4477
|
+
* What project it is
|
|
4478
|
+
* @type {string}
|
|
4479
|
+
* @memberof CollectionsApiCreateCollection
|
|
4480
|
+
*/
|
|
4481
|
+
readonly project: string
|
|
4482
|
+
|
|
4483
|
+
/**
|
|
4484
|
+
* Page reference token
|
|
4485
|
+
* @type {number}
|
|
4486
|
+
* @memberof CollectionsApiCreateCollection
|
|
4487
|
+
*/
|
|
4488
|
+
readonly pageToken?: number
|
|
4489
|
+
|
|
4490
|
+
/**
|
|
4491
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4492
|
+
* @type {number}
|
|
4493
|
+
* @memberof CollectionsApiCreateCollection
|
|
4494
|
+
*/
|
|
4495
|
+
readonly pageSize?: number
|
|
4496
|
+
|
|
4497
|
+
/**
|
|
4498
|
+
* Search term to filter results
|
|
4499
|
+
* @type {string}
|
|
4500
|
+
* @memberof CollectionsApiCreateCollection
|
|
4501
|
+
*/
|
|
4502
|
+
readonly search?: string
|
|
4503
|
+
|
|
4504
|
+
/**
|
|
4505
|
+
* Create a new collection
|
|
4506
|
+
* @type {CreateCollectionRequest}
|
|
4507
|
+
* @memberof CollectionsApiCreateCollection
|
|
4508
|
+
*/
|
|
4509
|
+
readonly createCollectionRequest?: CreateCollectionRequest
|
|
4510
|
+
}
|
|
4511
|
+
|
|
4512
|
+
/**
|
|
4513
|
+
* Request parameters for deleteCollection operation in CollectionsApi.
|
|
4514
|
+
* @export
|
|
4515
|
+
* @interface CollectionsApiDeleteCollectionRequest
|
|
4516
|
+
*/
|
|
4517
|
+
export interface CollectionsApiDeleteCollectionRequest {
|
|
4518
|
+
/**
|
|
4519
|
+
* What project it is
|
|
4520
|
+
* @type {string}
|
|
4521
|
+
* @memberof CollectionsApiDeleteCollection
|
|
4522
|
+
*/
|
|
4523
|
+
readonly project: string
|
|
4524
|
+
|
|
4525
|
+
/**
|
|
4526
|
+
* Collection\'s unique identifier
|
|
4527
|
+
* @type {string}
|
|
4528
|
+
* @memberof CollectionsApiDeleteCollection
|
|
4529
|
+
*/
|
|
4530
|
+
readonly collectionId: string
|
|
4531
|
+
}
|
|
4532
|
+
|
|
3709
4533
|
/**
|
|
3710
4534
|
* Request parameters for exportCollections operation in CollectionsApi.
|
|
3711
4535
|
* @export
|
|
@@ -3874,6 +4698,30 @@ export interface CollectionsApiUpdateCollectionsRequest {
|
|
|
3874
4698
|
* @extends {BaseAPI}
|
|
3875
4699
|
*/
|
|
3876
4700
|
export class CollectionsApi extends BaseAPI {
|
|
4701
|
+
/**
|
|
4702
|
+
* Create a new website collection.
|
|
4703
|
+
* @summary Create website collection
|
|
4704
|
+
* @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
|
|
4705
|
+
* @param {*} [options] Override http request option.
|
|
4706
|
+
* @throws {RequiredError}
|
|
4707
|
+
* @memberof CollectionsApi
|
|
4708
|
+
*/
|
|
4709
|
+
public createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig) {
|
|
4710
|
+
return CollectionsApiFp(this.configuration).createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4711
|
+
}
|
|
4712
|
+
|
|
4713
|
+
/**
|
|
4714
|
+
*
|
|
4715
|
+
* @summary Delete website collection
|
|
4716
|
+
* @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
|
|
4717
|
+
* @param {*} [options] Override http request option.
|
|
4718
|
+
* @throws {RequiredError}
|
|
4719
|
+
* @memberof CollectionsApi
|
|
4720
|
+
*/
|
|
4721
|
+
public deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig) {
|
|
4722
|
+
return CollectionsApiFp(this.configuration).deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(this.axios, this.basePath));
|
|
4723
|
+
}
|
|
4724
|
+
|
|
3877
4725
|
/**
|
|
3878
4726
|
* Export collections as a CSV file.
|
|
3879
4727
|
* @summary Export collections
|
|
@@ -3935,7 +4783,7 @@ export class CollectionsApi extends BaseAPI {
|
|
|
3935
4783
|
}
|
|
3936
4784
|
|
|
3937
4785
|
/**
|
|
3938
|
-
*
|
|
4786
|
+
* Update a website collection.
|
|
3939
4787
|
* @summary Update website collections
|
|
3940
4788
|
* @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
|
|
3941
4789
|
* @param {*} [options] Override http request option.
|