@glidevvr/storage-payload-types-pkg 1.0.18 → 1.0.20

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 (2) hide show
  1. package/package.json +1 -1
  2. package/payload-types.ts +239 -209
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@glidevvr/storage-payload-types-pkg",
3
- "version": "1.0.18",
3
+ "version": "1.0.20",
4
4
  "description": "Package for Payload CMS types.",
5
5
  "main": "payload-types.ts",
6
6
  "scripts": {
package/payload-types.ts CHANGED
@@ -298,7 +298,7 @@ export interface Tenant {
298
298
  /**
299
299
  * The page for the All Locations page content. Routing will use this page's slug.
300
300
  */
301
- facilitySlug?: (string | null) | Page;
301
+ allFacilitiesPage?: (string | null) | Market;
302
302
  seApiKey?: string | null;
303
303
  seApiPrivateKey?: string | null;
304
304
  /**
@@ -484,91 +484,42 @@ export interface Media {
484
484
  };
485
485
  }
486
486
  /**
487
- * This interface was referenced by `Config`'s JSON-Schema
488
- * via the `definition` "ArchiveBlock".
489
- */
490
- export interface ArchiveBlock {
491
- introContent?: {
492
- root: {
493
- type: string;
494
- children: {
495
- type: string;
496
- version: number;
497
- [k: string]: unknown;
498
- }[];
499
- direction: ('ltr' | 'rtl') | null;
500
- format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
501
- indent: number;
502
- version: number;
503
- };
504
- [k: string]: unknown;
505
- } | null;
506
- populateBy?: ('collection' | 'selection') | null;
507
- relationTo?: 'posts' | null;
508
- categories?: (string | Category)[] | null;
509
- limit?: number | null;
510
- selectedDocs?:
511
- | {
512
- relationTo: 'posts';
513
- value: string | Post;
514
- }[]
515
- | null;
516
- id?: string | null;
517
- blockName?: string | null;
518
- blockType: 'archive';
519
- }
520
- /**
521
- * This interface was referenced by `Config`'s JSON-Schema
522
- * via the `definition` "categories".
523
- */
524
- export interface Category {
525
- id: string;
526
- tenant?: (string | null) | Tenant;
527
- title: string;
528
- description?: string | null;
529
- meta?: {
530
- title?: string | null;
531
- description?: string | null;
532
- /**
533
- * Determines noindex/index status for this page. If the website setting is set to noindex, it will override this page-specific setting.
534
- */
535
- indexable?: boolean | null;
536
- };
537
- slug: string;
538
- slugLock?: boolean | null;
539
- featuredImage?: (string | null) | Media;
540
- createdBy?: string | null;
541
- updatedBy?: string | null;
542
- updatedAt: string;
543
- createdAt: string;
544
- }
545
- /**
546
- * This collection is for static blog articles.
487
+ * This collection represents different markets.
547
488
  *
548
489
  * This interface was referenced by `Config`'s JSON-Schema
549
- * via the `definition` "posts".
490
+ * via the `definition` "markets".
550
491
  */
551
- export interface Post {
492
+ export interface Market {
552
493
  id: string;
553
494
  tenant?: (string | null) | Tenant;
554
495
  title: string;
555
- content: {
556
- root: {
557
- type: string;
558
- children: {
559
- type: string;
560
- version: number;
561
- [k: string]: unknown;
562
- }[];
563
- direction: ('ltr' | 'rtl') | null;
564
- format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
565
- indent: number;
566
- version: number;
567
- };
568
- [k: string]: unknown;
569
- };
570
- relatedPosts?: (string | Post)[] | null;
571
- categories?: (string | Category)[] | null;
496
+ marketType: 'state' | 'city' | 'amenity' | 'allFacilities';
497
+ country: 'USA' | 'Canada';
498
+ state?: string | null;
499
+ city?: string | null;
500
+ sort: 'facility_title' | 'state' | 'city' | 'starting_price';
501
+ customOrGeo: 'geo' | 'custom';
502
+ customFacilities?: (string | Facility)[] | null;
503
+ layout?:
504
+ | (
505
+ | ArchiveBlock
506
+ | BreadcrumbsBlock
507
+ | CallToActionBlock
508
+ | ContentBlock
509
+ | FaqBlock
510
+ | FeaturedLocationsBlock
511
+ | FeaturesGridBlock
512
+ | FormBlock
513
+ | HomeHero
514
+ | HorizontalRuleBlock
515
+ | SingleTestimonialBlock
516
+ | MediaBlock
517
+ | RentalStepsBlock
518
+ | SearchCalloutBlock
519
+ | StoragResourcesBlock
520
+ | GalleryBlock
521
+ )[]
522
+ | null;
572
523
  meta?: {
573
524
  title?: string | null;
574
525
  description?: string | null;
@@ -579,112 +530,21 @@ export interface Post {
579
530
  };
580
531
  slug: string;
581
532
  slugLock?: boolean | null;
582
- author?: (string | null) | User;
583
- publishedAt?: string | null;
584
- featuredImage?: (string | null) | Media;
585
- /**
586
- * Defaults to the beginning of your post content if not entered.
587
- */
588
- excerpt?: string | null;
533
+ parent?: (string | null) | Market;
589
534
  createdBy?: string | null;
590
535
  updatedBy?: string | null;
591
536
  breadcrumbs?:
592
537
  | {
593
- doc?: (string | null) | Post;
538
+ doc?: (string | null) | Market;
594
539
  url?: string | null;
595
540
  label?: string | null;
596
541
  id?: string | null;
597
542
  }[]
598
543
  | null;
599
- parent?: (string | null) | Post;
600
544
  updatedAt: string;
601
545
  createdAt: string;
602
546
  _status?: ('draft' | 'published') | null;
603
547
  }
604
- /**
605
- * This interface was referenced by `Config`'s JSON-Schema
606
- * via the `definition` "BreadcrumbsBlock".
607
- */
608
- export interface BreadcrumbsBlock {
609
- id?: string | null;
610
- blockName?: string | null;
611
- blockType: 'breadcrumbs';
612
- }
613
- /**
614
- * This interface was referenced by `Config`'s JSON-Schema
615
- * via the `definition` "CallToActionBlock".
616
- */
617
- export interface CallToActionBlock {
618
- richText?: {
619
- root: {
620
- type: string;
621
- children: {
622
- type: string;
623
- version: number;
624
- [k: string]: unknown;
625
- }[];
626
- direction: ('ltr' | 'rtl') | null;
627
- format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
628
- indent: number;
629
- version: number;
630
- };
631
- [k: string]: unknown;
632
- } | null;
633
- links?:
634
- | {
635
- link: {
636
- type?: ('reference' | 'custom') | null;
637
- newTab?: boolean | null;
638
- reference?:
639
- | ({
640
- relationTo: 'pages';
641
- value: string | Page;
642
- } | null)
643
- | ({
644
- relationTo: 'posts';
645
- value: string | Post;
646
- } | null)
647
- | ({
648
- relationTo: 'facilities';
649
- value: string | Facility;
650
- } | null)
651
- | ({
652
- relationTo: 'markets';
653
- value: string | Market;
654
- } | null)
655
- | ({
656
- relationTo: 'categories';
657
- value: string | Category;
658
- } | null);
659
- url?: string | null;
660
- label: string;
661
- /**
662
- * Choose how the link should be rendered.
663
- */
664
- appearance?:
665
- | (
666
- | 'default'
667
- | 'primary'
668
- | 'primary-light'
669
- | 'outline-primary'
670
- | 'secondary'
671
- | 'secondary-light'
672
- | 'outline-secondary'
673
- | 'destructive'
674
- | 'link'
675
- | 'white'
676
- | 'ghost'
677
- | 'gray'
678
- )
679
- | null;
680
- };
681
- id?: string | null;
682
- }[]
683
- | null;
684
- id?: string | null;
685
- blockName?: string | null;
686
- blockType: 'cta';
687
- }
688
548
  /**
689
549
  * This collection represents different facilities.
690
550
  *
@@ -694,9 +554,15 @@ export interface CallToActionBlock {
694
554
  export interface Facility {
695
555
  id: string;
696
556
  tenant?: (string | null) | Tenant;
557
+ /**
558
+ * This is the facility name displayed on the front-end of the website.
559
+ */
697
560
  title: string;
698
561
  seFacilityId?: number | null;
699
562
  comingSoon?: boolean | null;
563
+ /**
564
+ * Please enter the Google Place ID for the valid business listing.
565
+ */
700
566
  googlePlaceId?: string | null;
701
567
  /**
702
568
  * If unset, the branding will default to the company's default brand.
@@ -745,18 +611,36 @@ export interface Facility {
745
611
  tableLayout?: 'row' | null;
746
612
  buttonLayout?: ('separate' | 'combined') | null;
747
613
  vacancyNotice?: boolean | null;
614
+ /**
615
+ * At how many units left to show the urgency notice.
616
+ */
748
617
  vacancyThreshold?: number | null;
749
618
  showAppliedPromoPrice?: boolean | null;
750
619
  unavailableUnits?: boolean | null;
620
+ /**
621
+ * If a unit is unavailable, show nearby options.
622
+ */
751
623
  showNearbyUnits?: boolean | null;
752
624
  disableRental?: boolean | null;
753
625
  disableReservation?: boolean | null;
626
+ /**
627
+ * A soft reservation does not remove a unit from inventory.
628
+ */
754
629
  disableSoftReservation?: boolean | null;
755
- rentalAppLocation?: ('drawer' | 'external' | 'dialog' | 'Accordion') | null;
630
+ rentalAppLocation?: ('drawer' | 'dialog' | 'accordion' | 'external') | null;
631
+ /**
632
+ * If you need values mapped to the url, pass them in using the dot notation and the app will "translate".
633
+ */
756
634
  rentalAppExternalUrl?: string | null;
757
- reservationAppLocation?: ('drawer' | 'external' | 'dialog' | 'Accordion') | null;
635
+ reservationAppLocation?: ('drawer' | 'dialog' | 'accordion' | 'external') | null;
636
+ /**
637
+ * If you need values mapped to the url, pass them in using the dot notation and the app will "translate".
638
+ */
758
639
  reservationAppExternalUrl?: string | null;
759
- softReservationAppLocation?: ('drawer' | 'external' | 'dialog' | 'Accordion') | null;
640
+ softReservationAppLocation?: ('drawer' | 'dialog' | 'accordion' | 'external') | null;
641
+ /**
642
+ * If you need values mapped to the url, pass them in using the dot notation and the app will "translate".
643
+ */
760
644
  softReservationAppExternalUrl?: string | null;
761
645
  /**
762
646
  * Category names should be comma separated.
@@ -766,6 +650,9 @@ export interface Facility {
766
650
  * Feature names should be comma separated.
767
651
  */
768
652
  allowedFeatures?: string | null;
653
+ /**
654
+ * Drag to prioritize - the first listed will have the highest priority. The default sorting is Available (desc), Area (asc), Width (asc), Display Rate (asc).
655
+ */
769
656
  sort?:
770
657
  | (
771
658
  | 'area'
@@ -782,6 +669,9 @@ export interface Facility {
782
669
  | 'display_rate:desc'
783
670
  )[]
784
671
  | null;
672
+ /**
673
+ * Drag to prioritize - the first listed will have the highest priority. The default grouping is Width, Length, Unit Type ID, Display Rate.
674
+ */
785
675
  groupBy?: ('width' | 'length' | 'unit_type_id' | 'display_Rate' | 'floor')[] | null;
786
676
  };
787
677
  faq?:
@@ -848,42 +738,91 @@ export interface FacilityFeature {
848
738
  createdAt: string;
849
739
  }
850
740
  /**
851
- * This collection represents different markets.
741
+ * This interface was referenced by `Config`'s JSON-Schema
742
+ * via the `definition` "ArchiveBlock".
743
+ */
744
+ export interface ArchiveBlock {
745
+ introContent?: {
746
+ root: {
747
+ type: string;
748
+ children: {
749
+ type: string;
750
+ version: number;
751
+ [k: string]: unknown;
752
+ }[];
753
+ direction: ('ltr' | 'rtl') | null;
754
+ format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
755
+ indent: number;
756
+ version: number;
757
+ };
758
+ [k: string]: unknown;
759
+ } | null;
760
+ populateBy?: ('collection' | 'selection') | null;
761
+ relationTo?: 'posts' | null;
762
+ categories?: (string | Category)[] | null;
763
+ limit?: number | null;
764
+ selectedDocs?:
765
+ | {
766
+ relationTo: 'posts';
767
+ value: string | Post;
768
+ }[]
769
+ | null;
770
+ id?: string | null;
771
+ blockName?: string | null;
772
+ blockType: 'archive';
773
+ }
774
+ /**
775
+ * This interface was referenced by `Config`'s JSON-Schema
776
+ * via the `definition` "categories".
777
+ */
778
+ export interface Category {
779
+ id: string;
780
+ tenant?: (string | null) | Tenant;
781
+ title: string;
782
+ description?: string | null;
783
+ meta?: {
784
+ title?: string | null;
785
+ description?: string | null;
786
+ /**
787
+ * Determines noindex/index status for this page. If the website setting is set to noindex, it will override this page-specific setting.
788
+ */
789
+ indexable?: boolean | null;
790
+ };
791
+ slug: string;
792
+ slugLock?: boolean | null;
793
+ featuredImage?: (string | null) | Media;
794
+ createdBy?: string | null;
795
+ updatedBy?: string | null;
796
+ updatedAt: string;
797
+ createdAt: string;
798
+ }
799
+ /**
800
+ * This collection is for static blog articles.
852
801
  *
853
802
  * This interface was referenced by `Config`'s JSON-Schema
854
- * via the `definition` "markets".
803
+ * via the `definition` "posts".
855
804
  */
856
- export interface Market {
805
+ export interface Post {
857
806
  id: string;
858
807
  tenant?: (string | null) | Tenant;
859
808
  title: string;
860
- marketType: 'state' | 'city' | 'amenity';
861
- country: 'USA' | 'Canada';
862
- state: string;
863
- city?: string | null;
864
- sort: 'facility_title' | 'state' | 'city' | 'starting_price';
865
- customOrGeo: 'geo' | 'custom';
866
- customFacilities?: (string | Facility)[] | null;
867
- layout?:
868
- | (
869
- | ArchiveBlock
870
- | BreadcrumbsBlock
871
- | CallToActionBlock
872
- | ContentBlock
873
- | FaqBlock
874
- | FeaturedLocationsBlock
875
- | FeaturesGridBlock
876
- | FormBlock
877
- | HomeHero
878
- | HorizontalRuleBlock
879
- | SingleTestimonialBlock
880
- | MediaBlock
881
- | RentalStepsBlock
882
- | SearchCalloutBlock
883
- | StoragResourcesBlock
884
- | GalleryBlock
885
- )[]
886
- | null;
809
+ content: {
810
+ root: {
811
+ type: string;
812
+ children: {
813
+ type: string;
814
+ version: number;
815
+ [k: string]: unknown;
816
+ }[];
817
+ direction: ('ltr' | 'rtl') | null;
818
+ format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
819
+ indent: number;
820
+ version: number;
821
+ };
822
+ [k: string]: unknown;
823
+ };
824
+ relatedPosts?: (string | Post)[] | null;
825
+ categories?: (string | Category)[] | null;
887
826
  meta?: {
888
827
  title?: string | null;
889
828
  description?: string | null;
@@ -894,21 +833,112 @@ export interface Market {
894
833
  };
895
834
  slug: string;
896
835
  slugLock?: boolean | null;
897
- parent?: (string | null) | Market;
836
+ author?: (string | null) | User;
837
+ publishedAt?: string | null;
838
+ featuredImage?: (string | null) | Media;
839
+ /**
840
+ * Defaults to the beginning of your post content if not entered.
841
+ */
842
+ excerpt?: string | null;
898
843
  createdBy?: string | null;
899
844
  updatedBy?: string | null;
900
845
  breadcrumbs?:
901
846
  | {
902
- doc?: (string | null) | Market;
847
+ doc?: (string | null) | Post;
903
848
  url?: string | null;
904
849
  label?: string | null;
905
850
  id?: string | null;
906
851
  }[]
907
852
  | null;
853
+ parent?: (string | null) | Post;
908
854
  updatedAt: string;
909
855
  createdAt: string;
910
856
  _status?: ('draft' | 'published') | null;
911
857
  }
858
+ /**
859
+ * This interface was referenced by `Config`'s JSON-Schema
860
+ * via the `definition` "BreadcrumbsBlock".
861
+ */
862
+ export interface BreadcrumbsBlock {
863
+ id?: string | null;
864
+ blockName?: string | null;
865
+ blockType: 'breadcrumbs';
866
+ }
867
+ /**
868
+ * This interface was referenced by `Config`'s JSON-Schema
869
+ * via the `definition` "CallToActionBlock".
870
+ */
871
+ export interface CallToActionBlock {
872
+ richText?: {
873
+ root: {
874
+ type: string;
875
+ children: {
876
+ type: string;
877
+ version: number;
878
+ [k: string]: unknown;
879
+ }[];
880
+ direction: ('ltr' | 'rtl') | null;
881
+ format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
882
+ indent: number;
883
+ version: number;
884
+ };
885
+ [k: string]: unknown;
886
+ } | null;
887
+ links?:
888
+ | {
889
+ link: {
890
+ type?: ('reference' | 'custom') | null;
891
+ newTab?: boolean | null;
892
+ reference?:
893
+ | ({
894
+ relationTo: 'pages';
895
+ value: string | Page;
896
+ } | null)
897
+ | ({
898
+ relationTo: 'posts';
899
+ value: string | Post;
900
+ } | null)
901
+ | ({
902
+ relationTo: 'facilities';
903
+ value: string | Facility;
904
+ } | null)
905
+ | ({
906
+ relationTo: 'markets';
907
+ value: string | Market;
908
+ } | null)
909
+ | ({
910
+ relationTo: 'categories';
911
+ value: string | Category;
912
+ } | null);
913
+ url?: string | null;
914
+ label: string;
915
+ /**
916
+ * Choose how the link should be rendered.
917
+ */
918
+ appearance?:
919
+ | (
920
+ | 'default'
921
+ | 'primary'
922
+ | 'primary-light'
923
+ | 'outline-primary'
924
+ | 'secondary'
925
+ | 'secondary-light'
926
+ | 'outline-secondary'
927
+ | 'destructive'
928
+ | 'link'
929
+ | 'white'
930
+ | 'ghost'
931
+ | 'gray'
932
+ )
933
+ | null;
934
+ };
935
+ id?: string | null;
936
+ }[]
937
+ | null;
938
+ id?: string | null;
939
+ blockName?: string | null;
940
+ blockType: 'cta';
941
+ }
912
942
  /**
913
943
  * This interface was referenced by `Config`'s JSON-Schema
914
944
  * via the `definition` "ContentBlock".
@@ -2102,7 +2132,7 @@ export interface TenantsSelect<T extends boolean = true> {
2102
2132
  name?: T;
2103
2133
  users?: T;
2104
2134
  defaultBrand?: T;
2105
- facilitySlug?: T;
2135
+ allFacilitiesPage?: T;
2106
2136
  seApiKey?: T;
2107
2137
  seApiPrivateKey?: T;
2108
2138
  googleApiBrowserKey?: T;