@teemill/website 0.22.2 → 0.23.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.
Files changed (53) hide show
  1. package/README.md +25 -2
  2. package/api.ts +874 -52
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +722 -17
  7. package/dist/api.js +175 -5
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +722 -17
  15. package/dist/esm/api.js +175 -5
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/Banner.md +23 -0
  27. package/docs/BannerImage.md +22 -0
  28. package/docs/Collection.md +10 -6
  29. package/docs/CollectionProduct.md +24 -0
  30. package/docs/CollectionProductImage.md +22 -0
  31. package/docs/CollectionsApi.md +128 -0
  32. package/docs/CreateCollectionRequest.md +38 -0
  33. package/docs/CreateCollectionRequestBanner.md +22 -0
  34. package/docs/CreateCollectionRequestBannerImage.md +22 -0
  35. package/docs/CreateCollectionRequestBannerOverlay.md +26 -0
  36. package/docs/CreateCollectionRequestProductsInner.md +24 -0
  37. package/docs/CreateCollectionRequestSeoMetadata.md +24 -0
  38. package/docs/MetaImage.md +1 -1
  39. package/docs/NavigationTag.md +24 -0
  40. package/docs/NullableMetaImage.md +23 -0
  41. package/docs/Overlay.md +27 -0
  42. package/docs/UpdateCollectionRequest.md +7 -1
  43. package/docs/UpdateCollectionRequestBanner.md +22 -0
  44. package/docs/UpdateCollectionRequestBannerImage.md +22 -0
  45. package/docs/UpdateCollectionRequestProductsInner.md +24 -0
  46. package/docs/UpdateCollectionRequestSeoMetadata.md +24 -0
  47. package/docs/UpdateCollectionsRequestCollectionsInner.md +6 -0
  48. package/docs/UpdateCollectionsRequestCollectionsInnerBanner.md +22 -0
  49. package/docs/UpdateCollectionsRequestCollectionsInnerBannerImage.md +22 -0
  50. package/docs/UpdateCollectionsRequestCollectionsInnerBannerOverlay.md +26 -0
  51. package/docs/UpdateCollectionsRequestCollectionsInnerProductsInner.md +24 -0
  52. package/index.ts +1 -1
  53. 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.22.2
5
+ * The version of the OpenAPI document: 0.23.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'?: string;
335
+ 'title': string;
298
336
  /**
299
337
  *
300
338
  * @type {string}
301
339
  * @memberof Collection
302
340
  */
303
- 'description'?: string;
341
+ 'description': string;
304
342
  /**
305
343
  *
306
344
  * @type {string}
307
345
  * @memberof Collection
308
346
  */
309
- 'slug'?: string;
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'?: 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 {MetaImage}
379
+ * Tags that are used to link to other collections, pages and products.
380
+ * @type {Array<NavigationTag>}
337
381
  * @memberof Collection
338
382
  */
339
- 'metaImage'?: MetaImage;
383
+ 'navigationTags'?: Array<NavigationTag>;
384
+ /**
385
+ * A set of products to include in the collection.
386
+ * @type {Array<CollectionProduct>}
387
+ * @memberof Collection
388
+ */
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}
@@ -1773,6 +2128,12 @@ export interface UpdateBrandRequest {
1773
2128
  * @interface UpdateCollectionRequest
1774
2129
  */
1775
2130
  export interface UpdateCollectionRequest {
2131
+ /**
2132
+ *
2133
+ * @type {UpdateCollectionRequestBanner}
2134
+ * @memberof UpdateCollectionRequest
2135
+ */
2136
+ 'banner'?: UpdateCollectionRequestBanner;
1776
2137
  /**
1777
2138
  * Collection title
1778
2139
  * @type {string}
@@ -1799,10 +2160,10 @@ export interface UpdateCollectionRequest {
1799
2160
  'longDescription'?: string;
1800
2161
  /**
1801
2162
  *
1802
- * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
2163
+ * @type {UpdateCollectionRequestSeoMetadata}
1803
2164
  * @memberof UpdateCollectionRequest
1804
2165
  */
1805
- 'seoMetadata'?: UpdateCollectionsRequestCollectionsInnerSeoMetadata;
2166
+ 'seoMetadata'?: UpdateCollectionRequestSeoMetadata;
1806
2167
  /**
1807
2168
  * The primary target search phrase for the collection that you wish to rank for in search engine results.
1808
2169
  * @type {string}
@@ -1815,6 +2176,106 @@ export interface UpdateCollectionRequest {
1815
2176
  * @memberof UpdateCollectionRequest
1816
2177
  */
1817
2178
  'targetSearchPhraseSynonyms'?: Array<string>;
2179
+ /**
2180
+ * A set of products to include in the collection.
2181
+ * @type {Array<UpdateCollectionRequestProductsInner>}
2182
+ * @memberof UpdateCollectionRequest
2183
+ */
2184
+ 'products'?: Array<UpdateCollectionRequestProductsInner>;
2185
+ /**
2186
+ * Tags that are used to link to other collections, pages and products.
2187
+ * @type {Array<NavigationTag>}
2188
+ * @memberof UpdateCollectionRequest
2189
+ */
2190
+ 'navigationTags'?: Array<NavigationTag>;
2191
+ }
2192
+ /**
2193
+ *
2194
+ * @export
2195
+ * @interface UpdateCollectionRequestBanner
2196
+ */
2197
+ export interface UpdateCollectionRequestBanner {
2198
+ /**
2199
+ *
2200
+ * @type {UpdateCollectionRequestBannerImage}
2201
+ * @memberof UpdateCollectionRequestBanner
2202
+ */
2203
+ 'image'?: UpdateCollectionRequestBannerImage;
2204
+ /**
2205
+ *
2206
+ * @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
2207
+ * @memberof UpdateCollectionRequestBanner
2208
+ */
2209
+ 'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
2210
+ }
2211
+ /**
2212
+ *
2213
+ * @export
2214
+ * @interface UpdateCollectionRequestBannerImage
2215
+ */
2216
+ export interface UpdateCollectionRequestBannerImage {
2217
+ /**
2218
+ * Banner image source
2219
+ * @type {string}
2220
+ * @memberof UpdateCollectionRequestBannerImage
2221
+ */
2222
+ 'src'?: string;
2223
+ /**
2224
+ * Banner image alt text
2225
+ * @type {string}
2226
+ * @memberof UpdateCollectionRequestBannerImage
2227
+ */
2228
+ 'alt'?: string;
2229
+ }
2230
+ /**
2231
+ *
2232
+ * @export
2233
+ * @interface UpdateCollectionRequestProductsInner
2234
+ */
2235
+ export interface UpdateCollectionRequestProductsInner {
2236
+ /**
2237
+ * A reference to the catalog product
2238
+ * @type {string}
2239
+ * @memberof UpdateCollectionRequestProductsInner
2240
+ */
2241
+ 'ref'?: string;
2242
+ /**
2243
+ * The sort order of the product in the collection
2244
+ * @type {number}
2245
+ * @memberof UpdateCollectionRequestProductsInner
2246
+ */
2247
+ 'order'?: number;
2248
+ /**
2249
+ * An image for the product to be used in the collection
2250
+ * @type {string}
2251
+ * @memberof UpdateCollectionRequestProductsInner
2252
+ */
2253
+ 'src'?: string;
2254
+ }
2255
+ /**
2256
+ *
2257
+ * @export
2258
+ * @interface UpdateCollectionRequestSeoMetadata
2259
+ */
2260
+ export interface UpdateCollectionRequestSeoMetadata {
2261
+ /**
2262
+ * Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used.
2263
+ * @type {string}
2264
+ * @memberof UpdateCollectionRequestSeoMetadata
2265
+ */
2266
+ 'title'?: string | null;
2267
+ /**
2268
+ * Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used.
2269
+ * @type {string}
2270
+ * @memberof UpdateCollectionRequestSeoMetadata
2271
+ */
2272
+ 'description'?: string | null;
2273
+ /**
2274
+ *
2275
+ * @type {MetaImage}
2276
+ * @memberof UpdateCollectionRequestSeoMetadata
2277
+ */
2278
+ 'image'?: MetaImage | null;
1818
2279
  }
1819
2280
  /**
1820
2281
  *
@@ -1841,6 +2302,12 @@ export interface UpdateCollectionsRequestCollectionsInner {
1841
2302
  * @memberof UpdateCollectionsRequestCollectionsInner
1842
2303
  */
1843
2304
  'id': string;
2305
+ /**
2306
+ *
2307
+ * @type {UpdateCollectionsRequestCollectionsInnerBanner}
2308
+ * @memberof UpdateCollectionsRequestCollectionsInner
2309
+ */
2310
+ 'banner'?: UpdateCollectionsRequestCollectionsInnerBanner;
1844
2311
  /**
1845
2312
  * Collection title
1846
2313
  * @type {string}
@@ -1883,6 +2350,112 @@ export interface UpdateCollectionsRequestCollectionsInner {
1883
2350
  * @memberof UpdateCollectionsRequestCollectionsInner
1884
2351
  */
1885
2352
  'targetSearchPhraseSynonyms'?: Array<string>;
2353
+ /**
2354
+ * A set of products to include in the collection.
2355
+ * @type {Array<UpdateCollectionsRequestCollectionsInnerProductsInner>}
2356
+ * @memberof UpdateCollectionsRequestCollectionsInner
2357
+ */
2358
+ 'products'?: Array<UpdateCollectionsRequestCollectionsInnerProductsInner>;
2359
+ /**
2360
+ * Tags that are used to link to other collections, pages and products.
2361
+ * @type {Array<NavigationTag>}
2362
+ * @memberof UpdateCollectionsRequestCollectionsInner
2363
+ */
2364
+ 'navigationTags'?: Array<NavigationTag>;
2365
+ }
2366
+ /**
2367
+ *
2368
+ * @export
2369
+ * @interface UpdateCollectionsRequestCollectionsInnerBanner
2370
+ */
2371
+ export interface UpdateCollectionsRequestCollectionsInnerBanner {
2372
+ /**
2373
+ *
2374
+ * @type {UpdateCollectionsRequestCollectionsInnerBannerImage}
2375
+ * @memberof UpdateCollectionsRequestCollectionsInnerBanner
2376
+ */
2377
+ 'image'?: UpdateCollectionsRequestCollectionsInnerBannerImage;
2378
+ /**
2379
+ *
2380
+ * @type {UpdateCollectionsRequestCollectionsInnerBannerOverlay}
2381
+ * @memberof UpdateCollectionsRequestCollectionsInnerBanner
2382
+ */
2383
+ 'overlay'?: UpdateCollectionsRequestCollectionsInnerBannerOverlay | null;
2384
+ }
2385
+ /**
2386
+ *
2387
+ * @export
2388
+ * @interface UpdateCollectionsRequestCollectionsInnerBannerImage
2389
+ */
2390
+ export interface UpdateCollectionsRequestCollectionsInnerBannerImage {
2391
+ /**
2392
+ * Banner image source
2393
+ * @type {string}
2394
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
2395
+ */
2396
+ 'src'?: string;
2397
+ /**
2398
+ * Alternative text for the image
2399
+ * @type {string}
2400
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerImage
2401
+ */
2402
+ 'alt'?: string;
2403
+ }
2404
+ /**
2405
+ *
2406
+ * @export
2407
+ * @interface UpdateCollectionsRequestCollectionsInnerBannerOverlay
2408
+ */
2409
+ export interface UpdateCollectionsRequestCollectionsInnerBannerOverlay {
2410
+ /**
2411
+ * The start color of the gradient
2412
+ * @type {string}
2413
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
2414
+ */
2415
+ 'from'?: string;
2416
+ /**
2417
+ * The end color of the gradient
2418
+ * @type {string}
2419
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
2420
+ */
2421
+ 'to'?: string;
2422
+ /**
2423
+ * The angle of the gradient
2424
+ * @type {number}
2425
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
2426
+ */
2427
+ 'angle'?: number;
2428
+ /**
2429
+ * The opacity of the gradient
2430
+ * @type {number}
2431
+ * @memberof UpdateCollectionsRequestCollectionsInnerBannerOverlay
2432
+ */
2433
+ 'opacity'?: number;
2434
+ }
2435
+ /**
2436
+ *
2437
+ * @export
2438
+ * @interface UpdateCollectionsRequestCollectionsInnerProductsInner
2439
+ */
2440
+ export interface UpdateCollectionsRequestCollectionsInnerProductsInner {
2441
+ /**
2442
+ *
2443
+ * @type {CollectionProduct}
2444
+ * @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
2445
+ */
2446
+ 'ref'?: CollectionProduct;
2447
+ /**
2448
+ * The sort order of the product in the collection
2449
+ * @type {number}
2450
+ * @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
2451
+ */
2452
+ 'order'?: number;
2453
+ /**
2454
+ *
2455
+ * @type {NullableMetaImage}
2456
+ * @memberof UpdateCollectionsRequestCollectionsInnerProductsInner
2457
+ */
2458
+ 'image'?: NullableMetaImage | null;
1886
2459
  }
1887
2460
  /**
1888
2461
  *
@@ -2878,6 +3451,27 @@ export declare class BlogsApi extends BaseAPI {
2878
3451
  * @export
2879
3452
  */
2880
3453
  export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
3454
+ /**
3455
+ * Create a new website collection.
3456
+ * @summary Create website collection
3457
+ * @param {string} project What project it is
3458
+ * @param {number} [pageToken] Page reference token
3459
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3460
+ * @param {string} [search] Search term to filter results
3461
+ * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
3462
+ * @param {*} [options] Override http request option.
3463
+ * @throws {RequiredError}
3464
+ */
3465
+ createCollection: (project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3466
+ /**
3467
+ *
3468
+ * @summary Delete website collection
3469
+ * @param {string} project What project it is
3470
+ * @param {string} collectionId Collection\&#39;s unique identifier
3471
+ * @param {*} [options] Override http request option.
3472
+ * @throws {RequiredError}
3473
+ */
3474
+ deleteCollection: (project: string, collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2881
3475
  /**
2882
3476
  * Export collections as a CSV file.
2883
3477
  * @summary Export collections
@@ -2926,7 +3520,7 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
2926
3520
  */
2927
3521
  updateCollection: (project: string, collectionId: string, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2928
3522
  /**
2929
- *
3523
+ * Update a website collection.
2930
3524
  * @summary Update website collections
2931
3525
  * @param {string} project What project it is
2932
3526
  * @param {number} [pageToken] Page reference token
@@ -2943,6 +3537,27 @@ export declare const CollectionsApiAxiosParamCreator: (configuration?: Configura
2943
3537
  * @export
2944
3538
  */
2945
3539
  export declare const CollectionsApiFp: (configuration?: Configuration) => {
3540
+ /**
3541
+ * Create a new website collection.
3542
+ * @summary Create website collection
3543
+ * @param {string} project What project it is
3544
+ * @param {number} [pageToken] Page reference token
3545
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3546
+ * @param {string} [search] Search term to filter results
3547
+ * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
3548
+ * @param {*} [options] Override http request option.
3549
+ * @throws {RequiredError}
3550
+ */
3551
+ createCollection(project: string, pageToken?: number, pageSize?: number, search?: string, createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>>;
3552
+ /**
3553
+ *
3554
+ * @summary Delete website collection
3555
+ * @param {string} project What project it is
3556
+ * @param {string} collectionId Collection\&#39;s unique identifier
3557
+ * @param {*} [options] Override http request option.
3558
+ * @throws {RequiredError}
3559
+ */
3560
+ deleteCollection(project: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2946
3561
  /**
2947
3562
  * Export collections as a CSV file.
2948
3563
  * @summary Export collections
@@ -2991,7 +3606,7 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
2991
3606
  */
2992
3607
  updateCollection(project: string, collectionId: string, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collection>>;
2993
3608
  /**
2994
- *
3609
+ * Update a website collection.
2995
3610
  * @summary Update website collections
2996
3611
  * @param {string} project What project it is
2997
3612
  * @param {number} [pageToken] Page reference token
@@ -3008,6 +3623,22 @@ export declare const CollectionsApiFp: (configuration?: Configuration) => {
3008
3623
  * @export
3009
3624
  */
3010
3625
  export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3626
+ /**
3627
+ * Create a new website collection.
3628
+ * @summary Create website collection
3629
+ * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
3630
+ * @param {*} [options] Override http request option.
3631
+ * @throws {RequiredError}
3632
+ */
3633
+ createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection>;
3634
+ /**
3635
+ *
3636
+ * @summary Delete website collection
3637
+ * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
3638
+ * @param {*} [options] Override http request option.
3639
+ * @throws {RequiredError}
3640
+ */
3641
+ deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3011
3642
  /**
3012
3643
  * Export collections as a CSV file.
3013
3644
  * @summary Export collections
@@ -3049,7 +3680,7 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
3049
3680
  */
3050
3681
  updateCollection(requestParameters: CollectionsApiUpdateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Collection>;
3051
3682
  /**
3052
- *
3683
+ * Update a website collection.
3053
3684
  * @summary Update website collections
3054
3685
  * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
3055
3686
  * @param {*} [options] Override http request option.
@@ -3057,6 +3688,62 @@ export declare const CollectionsApiFactory: (configuration?: Configuration, base
3057
3688
  */
3058
3689
  updateCollections(requestParameters: CollectionsApiUpdateCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CollectionsResponse>;
3059
3690
  };
3691
+ /**
3692
+ * Request parameters for createCollection operation in CollectionsApi.
3693
+ * @export
3694
+ * @interface CollectionsApiCreateCollectionRequest
3695
+ */
3696
+ export interface CollectionsApiCreateCollectionRequest {
3697
+ /**
3698
+ * What project it is
3699
+ * @type {string}
3700
+ * @memberof CollectionsApiCreateCollection
3701
+ */
3702
+ readonly project: string;
3703
+ /**
3704
+ * Page reference token
3705
+ * @type {number}
3706
+ * @memberof CollectionsApiCreateCollection
3707
+ */
3708
+ readonly pageToken?: number;
3709
+ /**
3710
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
3711
+ * @type {number}
3712
+ * @memberof CollectionsApiCreateCollection
3713
+ */
3714
+ readonly pageSize?: number;
3715
+ /**
3716
+ * Search term to filter results
3717
+ * @type {string}
3718
+ * @memberof CollectionsApiCreateCollection
3719
+ */
3720
+ readonly search?: string;
3721
+ /**
3722
+ * Create a new collection
3723
+ * @type {CreateCollectionRequest}
3724
+ * @memberof CollectionsApiCreateCollection
3725
+ */
3726
+ readonly createCollectionRequest?: CreateCollectionRequest;
3727
+ }
3728
+ /**
3729
+ * Request parameters for deleteCollection operation in CollectionsApi.
3730
+ * @export
3731
+ * @interface CollectionsApiDeleteCollectionRequest
3732
+ */
3733
+ export interface CollectionsApiDeleteCollectionRequest {
3734
+ /**
3735
+ * What project it is
3736
+ * @type {string}
3737
+ * @memberof CollectionsApiDeleteCollection
3738
+ */
3739
+ readonly project: string;
3740
+ /**
3741
+ * Collection\&#39;s unique identifier
3742
+ * @type {string}
3743
+ * @memberof CollectionsApiDeleteCollection
3744
+ */
3745
+ readonly collectionId: string;
3746
+ }
3060
3747
  /**
3061
3748
  * Request parameters for exportCollections operation in CollectionsApi.
3062
3749
  * @export
@@ -3208,6 +3895,24 @@ export interface CollectionsApiUpdateCollectionsRequest {
3208
3895
  * @extends {BaseAPI}
3209
3896
  */
3210
3897
  export declare class CollectionsApi extends BaseAPI {
3898
+ /**
3899
+ * Create a new website collection.
3900
+ * @summary Create website collection
3901
+ * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
3902
+ * @param {*} [options] Override http request option.
3903
+ * @throws {RequiredError}
3904
+ * @memberof CollectionsApi
3905
+ */
3906
+ createCollection(requestParameters: CollectionsApiCreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Collection, any>>;
3907
+ /**
3908
+ *
3909
+ * @summary Delete website collection
3910
+ * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
3911
+ * @param {*} [options] Override http request option.
3912
+ * @throws {RequiredError}
3913
+ * @memberof CollectionsApi
3914
+ */
3915
+ deleteCollection(requestParameters: CollectionsApiDeleteCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
3211
3916
  /**
3212
3917
  * Export collections as a CSV file.
3213
3918
  * @summary Export collections
@@ -3254,7 +3959,7 @@ export declare class CollectionsApi extends BaseAPI {
3254
3959
  */
3255
3960
  updateCollection(requestParameters: CollectionsApiUpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Collection, any>>;
3256
3961
  /**
3257
- *
3962
+ * Update a website collection.
3258
3963
  * @summary Update website collections
3259
3964
  * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
3260
3965
  * @param {*} [options] Override http request option.