@embark-black-book/api-contract 0.11.0 → 0.13.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.
@@ -83,6 +83,8 @@ export interface ApiAccordion extends ApiBaseEntity {
83
83
  DestinationEpic?: ApiDestinationEpicDestinationEpicDocument;
84
84
  }
85
85
 
86
+ export type ApiAccordionAccordionDocument = ApiAccordion;
87
+
86
88
  export interface ApiAccordionCategory extends ApiBaseEntity {
87
89
  Name: string;
88
90
  Type: "currency-converter" | "ground-partners" | "luxury-experiences" | "query-built" | "text" | "weather";
@@ -95,6 +97,8 @@ export interface ApiAccordionCategory extends ApiBaseEntity {
95
97
  publishedAt: string;
96
98
  }
97
99
 
100
+ export type ApiAccordionCategoryAccordionCategoryDocument = ApiAccordionCategory;
101
+
98
102
  export interface ApiAccordionItem extends ApiBaseEntity {
99
103
  Rank: number;
100
104
  Text?: string;
@@ -105,6 +109,8 @@ export interface ApiAccordionItem extends ApiBaseEntity {
105
109
  QueryBlock?: QueryQueryBlockEntry;
106
110
  }
107
111
 
112
+ export type ApiAccordionItemAccordionItemDocument = ApiAccordionItem;
113
+
108
114
  export interface ApiAddress extends ApiBaseEntity {
109
115
  Line1?: string;
110
116
  Line2?: string;
@@ -120,6 +126,8 @@ export interface ApiAddress extends ApiBaseEntity {
120
126
  PersonAtCompany?: ApiPersonAtCompanyPersonAtCompanyDocument;
121
127
  }
122
128
 
129
+ export type ApiAddressAddressDocument = ApiAddress;
130
+
123
131
  export interface ApiAddressType extends ApiBaseEntity {
124
132
  Name: string;
125
133
  Rank: number;
@@ -130,6 +138,8 @@ export interface ApiAddressType extends ApiBaseEntity {
130
138
  publishedAt: string;
131
139
  }
132
140
 
141
+ export type ApiAddressTypeAddressTypeDocument = ApiAddressType;
142
+
133
143
  export interface ApiAiConversation extends ApiBaseEntity {
134
144
  ConversationId?: string;
135
145
  Title?: string;
@@ -141,6 +151,8 @@ export interface ApiAiConversation extends ApiBaseEntity {
141
151
  Messages?: Array<ApiAiMessageAiMessageDocument>;
142
152
  }
143
153
 
154
+ export type ApiAiConversationAiConversationDocument = ApiAiConversation;
155
+
144
156
  export interface ApiAiMessage extends ApiBaseEntity {
145
157
  Query: string;
146
158
  Role: "user" | "assistant";
@@ -148,6 +160,8 @@ export interface ApiAiMessage extends ApiBaseEntity {
148
160
  Conversation?: ApiAiConversationAiConversationDocument;
149
161
  }
150
162
 
163
+ export type ApiAiMessageAiMessageDocument = ApiAiMessage;
164
+
151
165
  export interface ApiAlbum extends ApiBaseEntity {
152
166
  Name: string;
153
167
  Description?: string;
@@ -163,6 +177,8 @@ export interface ApiAlbum extends ApiBaseEntity {
163
177
  MediaCategory?: ApiMediaCategoryMediaCategoryDocument;
164
178
  }
165
179
 
180
+ export type ApiAlbumAlbumDocument = ApiAlbum;
181
+
166
182
  export interface ApiAlbumEmbeddedVideoItem extends ApiBaseEntity {
167
183
  VideoHost: "Mux" | "YouTube" | "Vimeo";
168
184
  HostVideoId: string;
@@ -172,6 +188,8 @@ export interface ApiAlbumEmbeddedVideoItem extends ApiBaseEntity {
172
188
  MediaCategory?: ApiMediaCategoryMediaCategoryDocument;
173
189
  }
174
190
 
191
+ export type ApiAlbumEmbeddedVideoItemAlbumEmbeddedVideoItemDocument = ApiAlbumEmbeddedVideoItem;
192
+
175
193
  export interface ApiAlbumItem extends ApiBaseEntity {
176
194
  ImageCredit?: string;
177
195
  publishedAt: string;
@@ -180,6 +198,8 @@ export interface ApiAlbumItem extends ApiBaseEntity {
180
198
  ThumbnailFor?: ApiAlbumAlbumDocument;
181
199
  }
182
200
 
201
+ export type ApiAlbumItemAlbumItemDocument = ApiAlbumItem;
202
+
183
203
  export interface ApiAlbumPdfItem extends ApiBaseEntity {
184
204
  Name: string;
185
205
  publishedAt: string;
@@ -188,6 +208,8 @@ export interface ApiAlbumPdfItem extends ApiBaseEntity {
188
208
  PDF?: PluginUploadFileDocument;
189
209
  }
190
210
 
211
+ export type ApiAlbumPdfItemAlbumPdfItemDocument = ApiAlbumPdfItem;
212
+
191
213
  export interface ApiAliasedDestination extends ApiBaseEntity {
192
214
  publishedAt: string;
193
215
  ParentDestinationMajor?: ApiDestinationMajorDestinationMajorDocument;
@@ -196,6 +218,8 @@ export interface ApiAliasedDestination extends ApiBaseEntity {
196
218
  ChildDestinationMinor?: ApiDestinationMinorDestinationMinorDocument;
197
219
  }
198
220
 
221
+ export type ApiAliasedDestinationAliasedDestinationDocument = ApiAliasedDestination;
222
+
199
223
  export interface ApiAnnouncement extends ApiBaseEntity {
200
224
  IsActive: boolean | null;
201
225
  Message?: string;
@@ -216,12 +240,16 @@ export interface ApiAnswerOption extends ApiBaseEntity {
216
240
  question?: ApiQuestionQuestionDocument;
217
241
  }
218
242
 
243
+ export type ApiAnswerOptionAnswerOptionDocument = ApiAnswerOption;
244
+
219
245
  export interface ApiAuthorizationType extends ApiBaseEntity {
220
246
  Name?: string;
221
247
  Key?: string;
222
248
  publishedAt: string;
223
249
  }
224
250
 
251
+ export type ApiAuthorizationTypeAuthorizationTypeDocument = ApiAuthorizationType;
252
+
225
253
  export interface ApiBlackbookGuideline extends ApiBaseEntity {
226
254
  Title: string;
227
255
  Description?: string;
@@ -341,6 +369,10 @@ export interface ApiCompanyAlternateName extends ApiBaseEntity {
341
369
  Company?: ApiCompanyCompanyDocument;
342
370
  }
343
371
 
372
+ export type ApiCompanyAlternateNameCompanyAlternateNameDocument = ApiCompanyAlternateName;
373
+
374
+ export type ApiCompanyCompanyDocument = ApiCompany;
375
+
344
376
  export interface ApiCompanyDisruption extends ApiBaseEntity {
345
377
  ApproximateStart?: string;
346
378
  ApproximateEnd?: string;
@@ -351,6 +383,8 @@ export interface ApiCompanyDisruption extends ApiBaseEntity {
351
383
  Company?: ApiCompanyCompanyDocument;
352
384
  }
353
385
 
386
+ export type ApiCompanyDisruptionCompanyDisruptionDocument = ApiCompanyDisruption;
387
+
354
388
  export interface ApiCompanyEnhancedCommission extends ApiBaseEntity {
355
389
  Title?: string;
356
390
  TermsAndDetails?: string;
@@ -363,6 +397,8 @@ export interface ApiCompanyEnhancedCommission extends ApiBaseEntity {
363
397
  Files?: Array<PluginUploadFileDocument>;
364
398
  }
365
399
 
400
+ export type ApiCompanyEnhancedCommissionCompanyEnhancedCommissionDocument = ApiCompanyEnhancedCommission;
401
+
366
402
  export interface ApiCompanyGdsId extends ApiBaseEntity {
367
403
  ExternalId?: string;
368
404
  publishedAt: string;
@@ -370,6 +406,8 @@ export interface ApiCompanyGdsId extends ApiBaseEntity {
370
406
  Company?: ApiCompanyCompanyDocument;
371
407
  }
372
408
 
409
+ export type ApiCompanyGdsIdCompanyGdsIdDocument = ApiCompanyGdsId;
410
+
373
411
  export interface ApiCompanyHistory extends ApiBaseEntity {
374
412
  Action?: "profile_verified" | "verification_date_expired" | "first_email_sent" | "second_email_sent" | "subsequent_email_sent" | "provider_request_submitted" | "provider_request_approved" | "provider_request_declined" | "field_updated" | "company_created";
375
413
  Name?: string;
@@ -381,6 +419,8 @@ export interface ApiCompanyHistory extends ApiBaseEntity {
381
419
  ActionByUser?: PluginUsersPermissionsUserDocument;
382
420
  }
383
421
 
422
+ export type ApiCompanyHistoryCompanyHistoryDocument = ApiCompanyHistory;
423
+
384
424
  export interface ApiCompanyQuestionAnswer extends ApiBaseEntity {
385
425
  AnswerText?: string;
386
426
  QualifierAnswerText?: string;
@@ -391,6 +431,8 @@ export interface ApiCompanyQuestionAnswer extends ApiBaseEntity {
391
431
  EventSpace?: ApiEventSpaceEventSpaceDocument;
392
432
  }
393
433
 
434
+ export type ApiCompanyQuestionAnswerCompanyQuestionAnswerDocument = ApiCompanyQuestionAnswer;
435
+
394
436
  export interface ApiCompanyRelationship extends ApiBaseEntity {
395
437
  Type: "family" | "representation" | "management";
396
438
  publishedAt: string;
@@ -398,7 +440,7 @@ export interface ApiCompanyRelationship extends ApiBaseEntity {
398
440
  Child?: ApiCompanyCompanyDocument;
399
441
  }
400
442
 
401
- export interface ApiCompanyStatuse extends ApiBaseEntity {
443
+ export interface ApiCompanyStatus extends ApiBaseEntity {
402
444
  DisplayName: string;
403
445
  IsActive: boolean | null;
404
446
  Key?: string;
@@ -406,6 +448,8 @@ export interface ApiCompanyStatuse extends ApiBaseEntity {
406
448
  publishedAt: string;
407
449
  }
408
450
 
451
+ export type ApiCompanyStatusCompanyStatusDocument = ApiCompanyStatus;
452
+
409
453
  export interface ApiCompanySubType extends ApiBaseEntity {
410
454
  Name: string;
411
455
  IsActive: boolean | null;
@@ -419,6 +463,8 @@ export interface ApiCompanySubType extends ApiBaseEntity {
419
463
  company_types?: Array<ApiCompanyTypeCompanyTypeDocument>;
420
464
  }
421
465
 
466
+ export type ApiCompanySubTypeCompanySubTypeDocument = ApiCompanySubType;
467
+
422
468
  export interface ApiCompanyType extends ApiBaseEntity {
423
469
  Name?: string;
424
470
  IsActive: boolean | null;
@@ -430,6 +476,8 @@ export interface ApiCompanyType extends ApiBaseEntity {
430
476
  companies?: Array<ApiCompanyCompanyDocument>;
431
477
  }
432
478
 
479
+ export type ApiCompanyTypeCompanyTypeDocument = ApiCompanyType;
480
+
433
481
  export interface ApiCompanyTypeQuestionXref extends ApiBaseEntity {
434
482
  IsOnApplication: boolean | null;
435
483
  IsRequiredOnApplication: boolean | null;
@@ -463,6 +511,8 @@ export interface ApiCountry extends ApiBaseEntity {
463
511
  publishedAt: string;
464
512
  }
465
513
 
514
+ export type ApiCountryCountryDocument = ApiCountry;
515
+
466
516
  export interface ApiCountrysubdivision extends ApiBaseEntity {
467
517
  Name: string;
468
518
  Code: string;
@@ -471,6 +521,8 @@ export interface ApiCountrysubdivision extends ApiBaseEntity {
471
521
  publishedAt: string;
472
522
  }
473
523
 
524
+ export type ApiCountrysubdivisionCountrysubdivisionDocument = ApiCountrysubdivision;
525
+
474
526
  export interface ApiCreditCardDefaultPercentage extends ApiBaseEntity {
475
527
  Name?: string;
476
528
  Rank?: number;
@@ -512,6 +564,8 @@ export interface ApiDestinationEpic extends ApiBaseEntity {
512
564
  DestinationVideos?: Array<ApiDestinationVideoDestinationVideoDocument>;
513
565
  }
514
566
 
567
+ export type ApiDestinationEpicDestinationEpicDocument = ApiDestinationEpic;
568
+
515
569
  export interface ApiDestinationLink extends ApiBaseEntity {
516
570
  Rank: number;
517
571
  LinkURL?: string;
@@ -522,6 +576,8 @@ export interface ApiDestinationLink extends ApiBaseEntity {
522
576
  DestinationMinor?: ApiDestinationMinorDestinationMinorDocument;
523
577
  }
524
578
 
579
+ export type ApiDestinationLinkDestinationLinkDocument = ApiDestinationLink;
580
+
525
581
  export interface ApiDestinationMajor extends ApiBaseEntity {
526
582
  Name: string;
527
583
  Slug?: string;
@@ -552,6 +608,8 @@ export interface ApiDestinationMajor extends ApiBaseEntity {
552
608
  DestinationVideos?: Array<ApiDestinationVideoDestinationVideoDocument>;
553
609
  }
554
610
 
611
+ export type ApiDestinationMajorDestinationMajorDocument = ApiDestinationMajor;
612
+
555
613
  export interface ApiDestinationMinor extends ApiBaseEntity {
556
614
  Name: string;
557
615
  Slug?: string;
@@ -581,6 +639,8 @@ export interface ApiDestinationMinor extends ApiBaseEntity {
581
639
  DestinationVideos?: Array<ApiDestinationVideoDestinationVideoDocument>;
582
640
  }
583
641
 
642
+ export type ApiDestinationMinorDestinationMinorDocument = ApiDestinationMinor;
643
+
584
644
  export interface ApiDestinationVideo extends ApiBaseEntity {
585
645
  Rank: number;
586
646
  ShareURL?: string;
@@ -591,6 +651,8 @@ export interface ApiDestinationVideo extends ApiBaseEntity {
591
651
  DestinationMinor?: ApiDestinationMinorDestinationMinorDocument;
592
652
  }
593
653
 
654
+ export type ApiDestinationVideoDestinationVideoDocument = ApiDestinationVideo;
655
+
594
656
  export interface ApiEmailAddress extends ApiBaseEntity {
595
657
  IsValidated: boolean | null;
596
658
  EmailAddress: string;
@@ -603,6 +665,8 @@ export interface ApiEmailAddress extends ApiBaseEntity {
603
665
  PersonAtCompany?: ApiPersonAtCompanyPersonAtCompanyDocument;
604
666
  }
605
667
 
668
+ export type ApiEmailAddressEmailAddressDocument = ApiEmailAddress;
669
+
606
670
  export interface ApiEmailAddressType extends ApiBaseEntity {
607
671
  Name: string;
608
672
  Rank: number;
@@ -613,6 +677,8 @@ export interface ApiEmailAddressType extends ApiBaseEntity {
613
677
  publishedAt: string;
614
678
  }
615
679
 
680
+ export type ApiEmailAddressTypeEmailAddressTypeDocument = ApiEmailAddressType;
681
+
616
682
  export interface ApiEventSpace extends ApiBaseEntity {
617
683
  Name?: string;
618
684
  TotalSquareMeters?: number;
@@ -622,6 +688,8 @@ export interface ApiEventSpace extends ApiBaseEntity {
622
688
  EventSpaceLayouts?: Array<ApiEventSpaceLayoutEventSpaceLayoutDocument>;
623
689
  }
624
690
 
691
+ export type ApiEventSpaceEventSpaceDocument = ApiEventSpace;
692
+
625
693
  export interface ApiEventSpaceLayout extends ApiBaseEntity {
626
694
  MaxCapacity?: number;
627
695
  publishedAt: string;
@@ -629,6 +697,8 @@ export interface ApiEventSpaceLayout extends ApiBaseEntity {
629
697
  LayoutType?: ApiLayoutTypeLayoutTypeDocument;
630
698
  }
631
699
 
700
+ export type ApiEventSpaceLayoutEventSpaceLayoutDocument = ApiEventSpaceLayout;
701
+
632
702
  export interface ApiEventType extends ApiBaseEntity {
633
703
  Name?: string;
634
704
  Key?: string;
@@ -637,6 +707,8 @@ export interface ApiEventType extends ApiBaseEntity {
637
707
  publishedAt: string;
638
708
  }
639
709
 
710
+ export type ApiEventTypeEventTypeDocument = ApiEventType;
711
+
640
712
  export interface ApiExternalEmailTemplate extends ApiBaseEntity {
641
713
  Name: string;
642
714
  Description?: string;
@@ -661,6 +733,8 @@ export interface ApiFeedbackType extends ApiBaseEntity {
661
733
  publishedAt: string;
662
734
  }
663
735
 
736
+ export type ApiFeedbackTypeFeedbackTypeDocument = ApiFeedbackType;
737
+
664
738
  export interface ApiFooterContent extends ApiBaseEntity {
665
739
  EmailSubject?: string;
666
740
  CopyrightEntityName?: string;
@@ -690,6 +764,8 @@ export interface ApiGdsType extends ApiBaseEntity {
690
764
  publishedAt: string;
691
765
  }
692
766
 
767
+ export type ApiGdsTypeGdsTypeDocument = ApiGdsType;
768
+
693
769
  export interface ApiGeographySearchItem extends ApiBaseEntity {
694
770
  Name: string;
695
771
  SearchableName?: string;
@@ -701,6 +777,8 @@ export interface ApiGeographySearchItem extends ApiBaseEntity {
701
777
  Children?: Array<ApiGeographySearchItemGeographySearchItemDocument>;
702
778
  }
703
779
 
780
+ export type ApiGeographySearchItemGeographySearchItemDocument = ApiGeographySearchItem;
781
+
704
782
  export interface ApiHawkSearchErrorLog extends ApiBaseEntity {
705
783
  IndexName?: string;
706
784
  Summary?: string;
@@ -709,7 +787,7 @@ export interface ApiHawkSearchErrorLog extends ApiBaseEntity {
709
787
  publishedAt: string;
710
788
  }
711
789
 
712
- export interface ApiHawkSearchReindice extends ApiBaseEntity {
790
+ export interface ApiHawkSearchReindex extends ApiBaseEntity {
713
791
  StartTime?: string;
714
792
  EndTime?: string;
715
793
  CompletionStatus: "Success" | "Fail";
@@ -740,6 +818,8 @@ export interface ApiHelpPage extends ApiBaseEntity {
740
818
  Children?: Array<ApiHelpPageHelpPageDocument>;
741
819
  }
742
820
 
821
+ export type ApiHelpPageHelpPageDocument = ApiHelpPage;
822
+
743
823
  export interface ApiHeroImage extends ApiBaseEntity {
744
824
  Title?: string;
745
825
  Key?: "destination" | "home" | "interest" | "landing-page" | "loyalty" | "news" | "news-article-group" | "news-article-group-category" | "random" | "special" | "travel-product" | "training-course";
@@ -757,6 +837,8 @@ export interface ApiHeroImage extends ApiBaseEntity {
757
837
  TrainingCourse?: ApiTrainingCourseTrainingCourseDocument;
758
838
  }
759
839
 
840
+ export type ApiHeroImageHeroImageDocument = ApiHeroImage;
841
+
760
842
  export interface ApiHomePageButton extends ApiBaseEntity {
761
843
  Label?: string;
762
844
  Slug?: string;
@@ -770,6 +852,8 @@ export interface ApiHomePageButton extends ApiBaseEntity {
770
852
  LandingPage?: ApiLandingPageLandingPageDocument;
771
853
  }
772
854
 
855
+ export type ApiHomePageButtonHomePageButtonDocument = ApiHomePageButton;
856
+
773
857
  export interface ApiLandingPage extends ApiBaseEntity {
774
858
  Title?: string;
775
859
  Key?: "home" | "loyalty-programs" | "destinations" | "interests" | "travel-products" | "calendar" | "specials" | "commissions" | "financial" | "company-resources" | "training" | "credit-card-merchant-tool";
@@ -783,6 +867,8 @@ export interface ApiLandingPage extends ApiBaseEntity {
783
867
  LandingPageVideos?: Array<ApiLandingPageVideoLandingPageVideoDocument>;
784
868
  }
785
869
 
870
+ export type ApiLandingPageLandingPageDocument = ApiLandingPage;
871
+
786
872
  export interface ApiLandingPageLink extends ApiBaseEntity {
787
873
  Rank: number;
788
874
  LinkURL?: string;
@@ -791,6 +877,8 @@ export interface ApiLandingPageLink extends ApiBaseEntity {
791
877
  LandingPage?: ApiLandingPageLandingPageDocument;
792
878
  }
793
879
 
880
+ export type ApiLandingPageLinkLandingPageLinkDocument = ApiLandingPageLink;
881
+
794
882
  export interface ApiLandingPageVideo extends ApiBaseEntity {
795
883
  Rank: number;
796
884
  ShareURL?: string;
@@ -799,6 +887,8 @@ export interface ApiLandingPageVideo extends ApiBaseEntity {
799
887
  LandingPage?: ApiLandingPageLandingPageDocument;
800
888
  }
801
889
 
890
+ export type ApiLandingPageVideoLandingPageVideoDocument = ApiLandingPageVideo;
891
+
802
892
  export interface ApiLanguage extends ApiBaseEntity {
803
893
  EnglishName: string;
804
894
  NativeName?: string;
@@ -810,6 +900,8 @@ export interface ApiLanguage extends ApiBaseEntity {
810
900
  publishedAt: string;
811
901
  }
812
902
 
903
+ export type ApiLanguageLanguageDocument = ApiLanguage;
904
+
813
905
  export interface ApiLayoutType extends ApiBaseEntity {
814
906
  Name: string;
815
907
  Description?: string;
@@ -817,6 +909,8 @@ export interface ApiLayoutType extends ApiBaseEntity {
817
909
  publishedAt: string;
818
910
  }
819
911
 
912
+ export type ApiLayoutTypeLayoutTypeDocument = ApiLayoutType;
913
+
820
914
  export interface ApiLoyaltyProgram extends ApiBaseEntity {
821
915
  Name: string;
822
916
  Slug?: string;
@@ -841,6 +935,8 @@ export interface ApiLoyaltyProgramCompany extends ApiBaseEntity {
841
935
  Company?: ApiCompanyCompanyDocument;
842
936
  }
843
937
 
938
+ export type ApiLoyaltyProgramCompanyLoyaltyProgramCompanyDocument = ApiLoyaltyProgramCompany;
939
+
844
940
  export interface ApiLoyaltyProgramContact extends ApiBaseEntity {
845
941
  Rank: number;
846
942
  publishedAt: string;
@@ -848,6 +944,8 @@ export interface ApiLoyaltyProgramContact extends ApiBaseEntity {
848
944
  PersonAtCompany?: ApiPersonAtCompanyPersonAtCompanyDocument;
849
945
  }
850
946
 
947
+ export type ApiLoyaltyProgramContactLoyaltyProgramContactDocument = ApiLoyaltyProgramContact;
948
+
851
949
  export interface ApiLoyaltyProgramLink extends ApiBaseEntity {
852
950
  Rank: number;
853
951
  LinkURL?: string;
@@ -856,6 +954,10 @@ export interface ApiLoyaltyProgramLink extends ApiBaseEntity {
856
954
  LoyaltyProgram?: ApiLoyaltyProgramLoyaltyProgramDocument;
857
955
  }
858
956
 
957
+ export type ApiLoyaltyProgramLinkLoyaltyProgramLinkDocument = ApiLoyaltyProgramLink;
958
+
959
+ export type ApiLoyaltyProgramLoyaltyProgramDocument = ApiLoyaltyProgram;
960
+
859
961
  export interface ApiLoyaltyProgramVideo extends ApiBaseEntity {
860
962
  Rank: number;
861
963
  ShareURL?: string;
@@ -864,6 +966,8 @@ export interface ApiLoyaltyProgramVideo extends ApiBaseEntity {
864
966
  LoyaltyProgram?: ApiLoyaltyProgramLoyaltyProgramDocument;
865
967
  }
866
968
 
969
+ export type ApiLoyaltyProgramVideoLoyaltyProgramVideoDocument = ApiLoyaltyProgramVideo;
970
+
867
971
  export interface ApiMediaCategory extends ApiBaseEntity {
868
972
  Name: string;
869
973
  Description?: string;
@@ -872,6 +976,8 @@ export interface ApiMediaCategory extends ApiBaseEntity {
872
976
  publishedAt: string;
873
977
  }
874
978
 
979
+ export type ApiMediaCategoryMediaCategoryDocument = ApiMediaCategory;
980
+
875
981
  export interface ApiMenuItem extends ApiBaseEntity {
876
982
  DisplayName: string;
877
983
  Link: string;
@@ -885,6 +991,8 @@ export interface ApiMenuItem extends ApiBaseEntity {
885
991
  MenuItems?: Array<ApiMenuItemMenuItemDocument>;
886
992
  }
887
993
 
994
+ export type ApiMenuItemMenuItemDocument = ApiMenuItem;
995
+
888
996
  export interface ApiMuxFolder extends ApiBaseEntity {
889
997
  Name?: string;
890
998
  publishedAt: string;
@@ -893,6 +1001,8 @@ export interface ApiMuxFolder extends ApiBaseEntity {
893
1001
  MuxVideos?: Array<ApiMuxVideoMuxVideoDocument>;
894
1002
  }
895
1003
 
1004
+ export type ApiMuxFolderMuxFolderDocument = ApiMuxFolder;
1005
+
896
1006
  export interface ApiMuxVideo extends ApiBaseEntity {
897
1007
  UploadId?: string;
898
1008
  AssetId?: string;
@@ -903,6 +1013,8 @@ export interface ApiMuxVideo extends ApiBaseEntity {
903
1013
  MuxFolder?: ApiMuxFolderMuxFolderDocument;
904
1014
  }
905
1015
 
1016
+ export type ApiMuxVideoMuxVideoDocument = ApiMuxVideo;
1017
+
906
1018
  export interface ApiNavigation extends ApiBaseEntity {
907
1019
  publishedAt: string;
908
1020
  MenuItems?: Array<ApiMenuItemMenuItemDocument>;
@@ -974,6 +1086,8 @@ export interface ApiNewsArticleGroupCategory extends ApiBaseEntity {
974
1086
  Articles?: Array<ApiNewsArticleNewsArticleDocument>;
975
1087
  }
976
1088
 
1089
+ export type ApiNewsArticleGroupCategoryNewsArticleGroupCategoryDocument = ApiNewsArticleGroupCategory;
1090
+
977
1091
  export interface ApiNewsArticleGroupCategoryTopic extends ApiBaseEntity {
978
1092
  Name: string;
979
1093
  Rank: number;
@@ -983,6 +1097,10 @@ export interface ApiNewsArticleGroupCategoryTopic extends ApiBaseEntity {
983
1097
  NewsArticles?: Array<ApiNewsArticleNewsArticleDocument>;
984
1098
  }
985
1099
 
1100
+ export type ApiNewsArticleGroupCategoryTopicNewsArticleGroupCategoryTopicDocument = ApiNewsArticleGroupCategoryTopic;
1101
+
1102
+ export type ApiNewsArticleGroupNewsArticleGroupDocument = ApiNewsArticleGroup;
1103
+
986
1104
  export interface ApiNewsArticleLink extends ApiBaseEntity {
987
1105
  Rank: number;
988
1106
  LinkURL?: string;
@@ -991,6 +1109,10 @@ export interface ApiNewsArticleLink extends ApiBaseEntity {
991
1109
  NewsArticle?: ApiNewsArticleNewsArticleDocument;
992
1110
  }
993
1111
 
1112
+ export type ApiNewsArticleLinkNewsArticleLinkDocument = ApiNewsArticleLink;
1113
+
1114
+ export type ApiNewsArticleNewsArticleDocument = ApiNewsArticle;
1115
+
994
1116
  export interface ApiNewsArticleVideo extends ApiBaseEntity {
995
1117
  Rank: number;
996
1118
  ShareURL?: string;
@@ -999,7 +1121,9 @@ export interface ApiNewsArticleVideo extends ApiBaseEntity {
999
1121
  NewsArticle?: ApiNewsArticleNewsArticleDocument;
1000
1122
  }
1001
1123
 
1002
- export interface ApiPeople extends ApiBaseEntity {
1124
+ export type ApiNewsArticleVideoNewsArticleVideoDocument = ApiNewsArticleVideo;
1125
+
1126
+ export interface ApiPerson extends ApiBaseEntity {
1003
1127
  FirstName?: string;
1004
1128
  MiddleName?: string;
1005
1129
  LastName?: string;
@@ -1025,7 +1149,7 @@ export interface ApiPeople extends ApiBaseEntity {
1025
1149
  AuthorizationTypes?: Array<ApiAuthorizationTypeAuthorizationTypeDocument>;
1026
1150
  }
1027
1151
 
1028
- export interface ApiPeopleAtCompany extends ApiBaseEntity {
1152
+ export interface ApiPersonAtCompany extends ApiBaseEntity {
1029
1153
  JobTitle?: string;
1030
1154
  Bio?: string;
1031
1155
  IsActive: boolean | null;
@@ -1057,6 +1181,8 @@ export interface ApiPersonAtCompanyHistory extends ApiBaseEntity {
1057
1181
  ActionByUser?: PluginUsersPermissionsUserDocument;
1058
1182
  }
1059
1183
 
1184
+ export type ApiPersonAtCompanyPersonAtCompanyDocument = ApiPersonAtCompany;
1185
+
1060
1186
  export interface ApiPersonHistory extends ApiBaseEntity {
1061
1187
  Action?: "field_updated" | "person_created" | "welcome_email_sent";
1062
1188
  Type?: "create" | "update" | "email";
@@ -1067,6 +1193,8 @@ export interface ApiPersonHistory extends ApiBaseEntity {
1067
1193
  ActionByUser?: PluginUsersPermissionsUserDocument;
1068
1194
  }
1069
1195
 
1196
+ export type ApiPersonPersonDocument = ApiPerson;
1197
+
1070
1198
  export interface ApiPhoneNumber extends ApiBaseEntity {
1071
1199
  RawFormat: string;
1072
1200
  IsValidated: boolean | null;
@@ -1084,6 +1212,8 @@ export interface ApiPhoneNumber extends ApiBaseEntity {
1084
1212
  PersonAtCompany?: ApiPersonAtCompanyPersonAtCompanyDocument;
1085
1213
  }
1086
1214
 
1215
+ export type ApiPhoneNumberPhoneNumberDocument = ApiPhoneNumber;
1216
+
1087
1217
  export interface ApiPhoneNumberType extends ApiBaseEntity {
1088
1218
  Name: string;
1089
1219
  IsActive: boolean | null;
@@ -1094,6 +1224,8 @@ export interface ApiPhoneNumberType extends ApiBaseEntity {
1094
1224
  publishedAt: string;
1095
1225
  }
1096
1226
 
1227
+ export type ApiPhoneNumberTypePhoneNumberTypeDocument = ApiPhoneNumberType;
1228
+
1097
1229
  export interface ApiPolicy extends ApiBaseEntity {
1098
1230
  PolicyType: "cookie" | "privacy" | "termsofservice";
1099
1231
  Version: number;
@@ -1103,13 +1235,15 @@ export interface ApiPolicy extends ApiBaseEntity {
1103
1235
  publishedAt: string;
1104
1236
  }
1105
1237
 
1106
- export interface ApiPrefixe extends ApiBaseEntity {
1238
+ export interface ApiPrefix extends ApiBaseEntity {
1107
1239
  Name: string;
1108
1240
  Rank: number;
1109
1241
  IsActive: boolean | null;
1110
1242
  publishedAt: string;
1111
1243
  }
1112
1244
 
1245
+ export type ApiPrefixPrefixDocument = ApiPrefix;
1246
+
1113
1247
  export interface ApiPrimaryContactType extends ApiBaseEntity {
1114
1248
  Name: string;
1115
1249
  IsActive: boolean | null;
@@ -1120,6 +1254,8 @@ export interface ApiPrimaryContactType extends ApiBaseEntity {
1120
1254
  RequiredOnCompanySubTypes?: Array<ApiCompanySubTypeCompanySubTypeDocument>;
1121
1255
  }
1122
1256
 
1257
+ export type ApiPrimaryContactTypePrimaryContactTypeDocument = ApiPrimaryContactType;
1258
+
1123
1259
  export interface ApiProductRoadmap extends ApiBaseEntity {
1124
1260
  Title?: string;
1125
1261
  Description?: string;
@@ -1133,6 +1269,8 @@ export interface ApiPronoun extends ApiBaseEntity {
1133
1269
  publishedAt: string;
1134
1270
  }
1135
1271
 
1272
+ export type ApiPronounPronounDocument = ApiPronoun;
1273
+
1136
1274
  export interface ApiProviderRequest extends ApiBaseEntity {
1137
1275
  Request?: unknown;
1138
1276
  RequestStatus?: "in-progress" | "completed" | "removed";
@@ -1148,6 +1286,8 @@ export interface ApiProviderRequestPage extends ApiBaseEntity {
1148
1286
  publishedAt: string;
1149
1287
  }
1150
1288
 
1289
+ export type ApiProviderRequestProviderRequestDocument = ApiProviderRequest;
1290
+
1151
1291
  export interface ApiPublicationNote extends ApiBaseEntity {
1152
1292
  Name?: string;
1153
1293
  Note?: string;
@@ -1155,6 +1295,8 @@ export interface ApiPublicationNote extends ApiBaseEntity {
1155
1295
  Company?: ApiCompanyCompanyDocument;
1156
1296
  }
1157
1297
 
1298
+ export type ApiPublicationNotePublicationNoteDocument = ApiPublicationNote;
1299
+
1158
1300
  export interface ApiQuestion extends ApiBaseEntity {
1159
1301
  Text?: string;
1160
1302
  Description?: string;
@@ -1172,12 +1314,16 @@ export interface ApiQuestion extends ApiBaseEntity {
1172
1314
  company_question_answers?: Array<ApiCompanyQuestionAnswerCompanyQuestionAnswerDocument>;
1173
1315
  }
1174
1316
 
1317
+ export type ApiQuestionQuestionDocument = ApiQuestion;
1318
+
1175
1319
  export interface ApiQuestionType extends ApiBaseEntity {
1176
1320
  Name: string;
1177
1321
  Description?: string;
1178
1322
  publishedAt: string;
1179
1323
  }
1180
1324
 
1325
+ export type ApiQuestionTypeQuestionTypeDocument = ApiQuestionType;
1326
+
1181
1327
  export interface ApiReleaseNote extends ApiBaseEntity {
1182
1328
  Version?: string;
1183
1329
  ReleaseDate?: string;
@@ -1214,6 +1360,10 @@ export interface ApiSavedFavoriteListCompany extends ApiBaseEntity {
1214
1360
  List?: ApiSavedFavoriteListSavedFavoriteListDocument;
1215
1361
  }
1216
1362
 
1363
+ export type ApiSavedFavoriteListCompanySavedFavoriteListCompanyDocument = ApiSavedFavoriteListCompany;
1364
+
1365
+ export type ApiSavedFavoriteListSavedFavoriteListDocument = ApiSavedFavoriteList;
1366
+
1217
1367
  export interface ApiShortcut extends ApiBaseEntity {
1218
1368
  Text?: string;
1219
1369
  Path?: string;
@@ -1230,6 +1380,8 @@ export interface ApiSocialMedia extends ApiBaseEntity {
1230
1380
  person?: ApiPersonPersonDocument;
1231
1381
  }
1232
1382
 
1383
+ export type ApiSocialMediaSocialMediaDocument = ApiSocialMedia;
1384
+
1233
1385
  export interface ApiSocialMediaType extends ApiBaseEntity {
1234
1386
  Name: string;
1235
1387
  Rank: number;
@@ -1241,6 +1393,8 @@ export interface ApiSocialMediaType extends ApiBaseEntity {
1241
1393
  publishedAt: string;
1242
1394
  }
1243
1395
 
1396
+ export type ApiSocialMediaTypeSocialMediaTypeDocument = ApiSocialMediaType;
1397
+
1244
1398
  export interface ApiSpecial extends ApiBaseEntity {
1245
1399
  Title?: string;
1246
1400
  Body?: string;
@@ -1267,6 +1421,8 @@ export interface ApiSpecial extends ApiBaseEntity {
1267
1421
  Tags?: Array<ApiTagTagDocument>;
1268
1422
  }
1269
1423
 
1424
+ export type ApiSpecialSpecialDocument = ApiSpecial;
1425
+
1270
1426
  export interface ApiSponsorship extends ApiBaseEntity {
1271
1427
  Name: string;
1272
1428
  PublicationStatus: "New" | "Published" | "Archived";
@@ -1299,19 +1455,27 @@ export interface ApiSponsorshipLocation extends ApiBaseEntity {
1299
1455
  publishedAt: string;
1300
1456
  }
1301
1457
 
1302
- export interface ApiSuffixe extends ApiBaseEntity {
1458
+ export type ApiSponsorshipLocationSponsorshipLocationDocument = ApiSponsorshipLocation;
1459
+
1460
+ export type ApiSponsorshipSponsorshipDocument = ApiSponsorship;
1461
+
1462
+ export interface ApiSuffix extends ApiBaseEntity {
1303
1463
  Name: string;
1304
1464
  Rank: number;
1305
1465
  IsActive: boolean | null;
1306
1466
  publishedAt: string;
1307
1467
  }
1308
1468
 
1469
+ export type ApiSuffixSuffixDocument = ApiSuffix;
1470
+
1309
1471
  export interface ApiTag extends ApiBaseEntity {
1310
1472
  Name: string;
1311
1473
  publishedAt: string;
1312
1474
  Companies?: Array<ApiCompanyCompanyDocument>;
1313
1475
  }
1314
1476
 
1477
+ export type ApiTagTagDocument = ApiTag;
1478
+
1315
1479
  export interface ApiTrainingCourse extends ApiBaseEntity {
1316
1480
  Title?: string;
1317
1481
  Slug?: string;
@@ -1327,6 +1491,8 @@ export interface ApiTrainingCourse extends ApiBaseEntity {
1327
1491
  Videos?: Array<ApiTrainingVideoItemTrainingVideoItemDocument>;
1328
1492
  }
1329
1493
 
1494
+ export type ApiTrainingCourseTrainingCourseDocument = ApiTrainingCourse;
1495
+
1330
1496
  export interface ApiTrainingLink extends ApiBaseEntity {
1331
1497
  Rank: number;
1332
1498
  LinkURL?: string;
@@ -1335,6 +1501,8 @@ export interface ApiTrainingLink extends ApiBaseEntity {
1335
1501
  Course?: ApiTrainingCourseTrainingCourseDocument;
1336
1502
  }
1337
1503
 
1504
+ export type ApiTrainingLinkTrainingLinkDocument = ApiTrainingLink;
1505
+
1338
1506
  export interface ApiTrainingModule extends ApiBaseEntity {
1339
1507
  Title?: string;
1340
1508
  Slug?: string;
@@ -1347,6 +1515,8 @@ export interface ApiTrainingModule extends ApiBaseEntity {
1347
1515
  ChildModules?: Array<ApiTrainingModuleTrainingModuleDocument>;
1348
1516
  }
1349
1517
 
1518
+ export type ApiTrainingModuleTrainingModuleDocument = ApiTrainingModule;
1519
+
1350
1520
  export interface ApiTrainingVideoItem extends ApiBaseEntity {
1351
1521
  VideoHost?: "Mux" | "YouTube" | "Vimeo";
1352
1522
  HostVideoId?: string;
@@ -1356,6 +1526,8 @@ export interface ApiTrainingVideoItem extends ApiBaseEntity {
1356
1526
  Course?: ApiTrainingCourseTrainingCourseDocument;
1357
1527
  }
1358
1528
 
1529
+ export type ApiTrainingVideoItemTrainingVideoItemDocument = ApiTrainingVideoItem;
1530
+
1359
1531
  export interface ApiUpload extends ApiBaseEntity {
1360
1532
  name: string;
1361
1533
  alternativeText?: string | null;
@@ -1386,6 +1558,8 @@ export interface ApiUsefulLink extends ApiBaseEntity {
1386
1558
  MediaCategory?: ApiMediaCategoryMediaCategoryDocument;
1387
1559
  }
1388
1560
 
1561
+ export type ApiUsefulLinkUsefulLinkDocument = ApiUsefulLink;
1562
+
1389
1563
  export interface ApiUserAcceptedPolicy extends ApiBaseEntity {
1390
1564
  PolicyType: "cookie" | "privacy" | "termsofservice";
1391
1565
  Version: number;
@@ -1402,4 +1576,24 @@ export interface ApiVrLink extends ApiBaseEntity {
1402
1576
  MediaCategory?: ApiMediaCategoryMediaCategoryDocument;
1403
1577
  }
1404
1578
 
1405
- export type ApiEntity = ApiMedia | ApiUsersPermissionsRole | ApiUsersPermissionsUser | ApiAccordion | ApiAccordionCategory | ApiAccordionItem | ApiAddress | ApiAddressType | ApiAiConversation | ApiAiMessage | ApiAlbum | ApiAlbumEmbeddedVideoItem | ApiAlbumItem | ApiAlbumPdfItem | ApiAliasedDestination | ApiAnnouncement | ApiAnswerOption | ApiAuthorizationType | ApiBlackbookGuideline | ApiCalendarItem | ApiChartbrewReport | ApiCompany | ApiCompanyAlternateName | ApiCompanyDisruption | ApiCompanyEnhancedCommission | ApiCompanyGdsId | ApiCompanyHistory | ApiCompanyQuestionAnswer | ApiCompanyRelationship | ApiCompanyStatuse | ApiCompanySubType | ApiCompanyType | ApiCompanyTypeQuestionXref | ApiCompanyVerification | ApiContentTypeBuilder | ApiCountry | ApiCountrysubdivision | ApiCreditCardDefaultPercentage | ApiCreditCardMerchantToolSideNote | ApiDefaultDirectorySearch | ApiDestinationEpic | ApiDestinationLink | ApiDestinationMajor | ApiDestinationMinor | ApiDestinationVideo | ApiEmailAddress | ApiEmailAddressType | ApiEventSpace | ApiEventSpaceLayout | ApiEventType | ApiExternalEmailTemplate | ApiFeedback | ApiFeedbackType | ApiFooterContent | ApiFooterLegalMenu | ApiFooterMenu | ApiGdsType | ApiGeographySearchItem | ApiHawkSearchErrorLog | ApiHawkSearchReindice | ApiHelpPage | ApiHeroImage | ApiHomePageButton | ApiLandingPage | ApiLandingPageLink | ApiLandingPageVideo | ApiLanguage | ApiLayoutType | ApiLoyaltyProgram | ApiLoyaltyProgramCompany | ApiLoyaltyProgramContact | ApiLoyaltyProgramLink | ApiLoyaltyProgramVideo | ApiMediaCategory | ApiMenuItem | ApiMuxFolder | ApiMuxVideo | ApiNavigation | ApiNewsArticle | ApiNewsArticleGroup | ApiNewsArticleGroupCategory | ApiNewsArticleGroupCategoryTopic | ApiNewsArticleLink | ApiNewsArticleVideo | ApiPeople | ApiPeopleAtCompany | ApiPersonAtCompanyHistory | ApiPersonHistory | ApiPhoneNumber | ApiPhoneNumberType | ApiPolicy | ApiPrefixe | ApiPrimaryContactType | ApiProductRoadmap | ApiPronoun | ApiProviderRequest | ApiProviderRequestPage | ApiPublicationNote | ApiQuestion | ApiQuestionType | ApiReleaseNote | ApiRssFeed | ApiSavedFavoriteList | ApiSavedFavoriteListCompany | ApiShortcut | ApiSocialMedia | ApiSocialMediaType | ApiSpecial | ApiSponsorship | ApiSponsorshipLocation | ApiSuffixe | ApiTag | ApiTrainingCourse | ApiTrainingLink | ApiTrainingModule | ApiTrainingVideoItem | ApiUpload | ApiUsefulLink | ApiUserAcceptedPolicy | ApiVrLink;
1579
+ export type ApiVrLinkVrLinkDocument = ApiVrLink;
1580
+
1581
+ export interface MenuMenuLinkEntry {
1582
+ DisplayName: string;
1583
+ Link?: string;
1584
+ LinkType: "Normal" | "HeadingLink" | "HeadingNoLink";
1585
+ IsVisibleAnonymous: boolean | null;
1586
+ }
1587
+
1588
+ export type PluginUploadFileDocument = ApiMedia;
1589
+
1590
+ export type PluginUsersPermissionsUserDocument = ApiUsersPermissionsUser;
1591
+
1592
+ export interface QueryQueryBlockEntry {
1593
+ Columns?: unknown;
1594
+ GroupBy?: string;
1595
+ MaxResults: number;
1596
+ EmptyMessage?: string;
1597
+ }
1598
+
1599
+ export type ApiEntity = ApiMedia | ApiUsersPermissionsRole | ApiUsersPermissionsUser | ApiAccordion | ApiAccordionCategory | ApiAccordionItem | ApiAddress | ApiAddressType | ApiAiConversation | ApiAiMessage | ApiAlbum | ApiAlbumEmbeddedVideoItem | ApiAlbumItem | ApiAlbumPdfItem | ApiAliasedDestination | ApiAnnouncement | ApiAnswerOption | ApiAuthorizationType | ApiBlackbookGuideline | ApiCalendarItem | ApiChartbrewReport | ApiCompany | ApiCompanyAlternateName | ApiCompanyDisruption | ApiCompanyEnhancedCommission | ApiCompanyGdsId | ApiCompanyHistory | ApiCompanyQuestionAnswer | ApiCompanyRelationship | ApiCompanyStatus | ApiCompanySubType | ApiCompanyType | ApiCompanyTypeQuestionXref | ApiCompanyVerification | ApiContentTypeBuilder | ApiCountry | ApiCountrysubdivision | ApiCreditCardDefaultPercentage | ApiCreditCardMerchantToolSideNote | ApiDefaultDirectorySearch | ApiDestinationEpic | ApiDestinationLink | ApiDestinationMajor | ApiDestinationMinor | ApiDestinationVideo | ApiEmailAddress | ApiEmailAddressType | ApiEventSpace | ApiEventSpaceLayout | ApiEventType | ApiExternalEmailTemplate | ApiFeedback | ApiFeedbackType | ApiFooterContent | ApiFooterLegalMenu | ApiFooterMenu | ApiGdsType | ApiGeographySearchItem | ApiHawkSearchErrorLog | ApiHawkSearchReindex | ApiHelpPage | ApiHeroImage | ApiHomePageButton | ApiLandingPage | ApiLandingPageLink | ApiLandingPageVideo | ApiLanguage | ApiLayoutType | ApiLoyaltyProgram | ApiLoyaltyProgramCompany | ApiLoyaltyProgramContact | ApiLoyaltyProgramLink | ApiLoyaltyProgramVideo | ApiMediaCategory | ApiMenuItem | ApiMuxFolder | ApiMuxVideo | ApiNavigation | ApiNewsArticle | ApiNewsArticleGroup | ApiNewsArticleGroupCategory | ApiNewsArticleGroupCategoryTopic | ApiNewsArticleLink | ApiNewsArticleVideo | ApiPerson | ApiPersonAtCompany | ApiPersonAtCompanyHistory | ApiPersonHistory | ApiPhoneNumber | ApiPhoneNumberType | ApiPolicy | ApiPrefix | ApiPrimaryContactType | ApiProductRoadmap | ApiPronoun | ApiProviderRequest | ApiProviderRequestPage | ApiPublicationNote | ApiQuestion | ApiQuestionType | ApiReleaseNote | ApiRssFeed | ApiSavedFavoriteList | ApiSavedFavoriteListCompany | ApiShortcut | ApiSocialMedia | ApiSocialMediaType | ApiSpecial | ApiSponsorship | ApiSponsorshipLocation | ApiSuffix | ApiTag | ApiTrainingCourse | ApiTrainingLink | ApiTrainingModule | ApiTrainingVideoItem | ApiUpload | ApiUsefulLink | ApiUserAcceptedPolicy | ApiVrLink;