@embark-black-book/api-contract 0.1.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.
@@ -0,0 +1,1231 @@
1
+ /* eslint-disable */
2
+ // Auto-generated from specification.json
3
+
4
+ export interface ApiBaseEntity<TId = number> {
5
+ id: TId;
6
+ documentId: string;
7
+ createdAt: string;
8
+ updatedAt: string;
9
+ isDirty: boolean;
10
+ }
11
+
12
+ export interface ApiMedia extends ApiBaseEntity<string | number> {
13
+ name: string;
14
+ alternativeText?: string;
15
+ caption?: string;
16
+ focalPoint?: unknown;
17
+ width?: number;
18
+ height?: number;
19
+ formats?: unknown;
20
+ hash: string;
21
+ ext?: string;
22
+ mime: string;
23
+ size: number;
24
+ url: string;
25
+ previewUrl?: string;
26
+ provider: string;
27
+ provider_metadata?: unknown;
28
+ related: unknown;
29
+ }
30
+
31
+ export interface ApiUsersPermissionsRole extends ApiBaseEntity<string | number> {
32
+ name: string;
33
+ description?: string;
34
+ type?: string;
35
+ publishedAt: string;
36
+ permissions?: Array<unknown>;
37
+ users?: Array<unknown>;
38
+ }
39
+
40
+ export interface ApiUsersPermissionsUser extends ApiBaseEntity<string | number> {
41
+ username: string;
42
+ email: string;
43
+ provider?: string;
44
+ confirmed: boolean | null;
45
+ blocked: boolean | null;
46
+ publishedAt: string;
47
+ role?: ApiUsersPermissionsRole;
48
+ person?: unknown;
49
+ }
50
+
51
+ export interface ApiAccordion extends ApiBaseEntity {
52
+ publishedAt: string;
53
+ AccordionItems?: Array<ApiAccordionItem>;
54
+ DestinationMinor?: ApiDestinationMinor;
55
+ DestinationMajor?: ApiDestinationMajor;
56
+ DestinationEpic?: ApiDestinationEpic;
57
+ }
58
+
59
+ export interface ApiAccordionCategory extends ApiBaseEntity {
60
+ Name: string;
61
+ Type: "currency-converter" | "ground-partners" | "text" | "weather";
62
+ IsDefaultOnDestinationMinor: boolean | null;
63
+ IsDefaultOnDestinationMajor: boolean | null;
64
+ DefaultRankMajor: number;
65
+ DefaultRankMinor: number;
66
+ IsDefaultOnDestinationEpic: boolean | null;
67
+ DefaultRankEpic: number;
68
+ publishedAt: string;
69
+ }
70
+
71
+ export interface ApiAccordionItem extends ApiBaseEntity {
72
+ Rank: number;
73
+ Text?: string;
74
+ EmbedCode?: string;
75
+ publishedAt: string;
76
+ AccordionCategory?: ApiAccordionCategory;
77
+ Accordion?: ApiAccordion;
78
+ }
79
+
80
+ export interface ApiAddress extends ApiBaseEntity {
81
+ Line1?: string;
82
+ Line2?: string;
83
+ City?: string;
84
+ PostalCode?: string;
85
+ IsPrimary: boolean | null;
86
+ publishedAt: string;
87
+ country?: ApiCountry;
88
+ country_subdivision?: ApiCountrysubdivision;
89
+ address_type?: ApiAddressType;
90
+ }
91
+
92
+ export interface ApiAddressType extends ApiBaseEntity {
93
+ Name: string;
94
+ Rank: number;
95
+ IsActive: boolean | null;
96
+ AppliesToPerson: boolean | null;
97
+ AppliesToPersonCompany: boolean | null;
98
+ AppliesToCompany: boolean | null;
99
+ publishedAt: string;
100
+ }
101
+
102
+ export interface ApiAlbum extends ApiBaseEntity {
103
+ Name: string;
104
+ Description?: string;
105
+ ImageCredits?: string;
106
+ Location?: string;
107
+ IsDirectoryGallery: boolean | null;
108
+ publishedAt: string;
109
+ Company?: ApiCompany;
110
+ AlbumItems?: Array<ApiAlbumItem>;
111
+ Thumbnail?: ApiAlbumItem;
112
+ EmbeddedVideoItems?: Array<ApiAlbumEmbeddedVideoItem>;
113
+ PDFItems?: Array<ApiAlbumPdfItem>;
114
+ MediaCategory?: ApiMediaCategory;
115
+ }
116
+
117
+ export interface ApiAlbumEmbeddedVideoItem extends ApiBaseEntity {
118
+ VideoHost: "Mux" | "YouTube" | "Vimeo";
119
+ HostVideoId: string;
120
+ Name?: string;
121
+ publishedAt: string;
122
+ album?: ApiAlbum;
123
+ MediaCategory?: ApiMediaCategory;
124
+ }
125
+
126
+ export interface ApiAlbumItem extends ApiBaseEntity {
127
+ ImageCredit?: string;
128
+ publishedAt: string;
129
+ Album?: ApiAlbum;
130
+ Media?: ApiMedia;
131
+ ThumbnailFor?: ApiAlbum;
132
+ }
133
+
134
+ export interface ApiAlbumPdfItem extends ApiBaseEntity {
135
+ Name: string;
136
+ publishedAt: string;
137
+ MediaCategory?: ApiMediaCategory;
138
+ Album?: ApiAlbum;
139
+ PDF?: ApiMedia;
140
+ }
141
+
142
+ export interface ApiAliasedDestination extends ApiBaseEntity {
143
+ publishedAt: string;
144
+ ParentDestinationMajor?: ApiDestinationMajor;
145
+ ParentDestinationMinor?: ApiDestinationMinor;
146
+ ChildDestinationMajor?: ApiDestinationMajor;
147
+ ChildDestinationMinor?: ApiDestinationMinor;
148
+ }
149
+
150
+ export interface ApiAnnouncement extends ApiBaseEntity {
151
+ IsActive: boolean | null;
152
+ Message?: string;
153
+ URL?: string;
154
+ Start?: string;
155
+ End?: string;
156
+ publishedAt: string;
157
+ }
158
+
159
+ export interface ApiAnswerOption extends ApiBaseEntity {
160
+ Text: string;
161
+ Rank: number;
162
+ HasQualifier: boolean | null;
163
+ QualifierLabel?: string;
164
+ IsQualifierRequired: boolean | null;
165
+ DoNotSendToIndex: boolean | null;
166
+ publishedAt: string;
167
+ question?: ApiQuestion;
168
+ }
169
+
170
+ export interface ApiAuthorizationType extends ApiBaseEntity {
171
+ Name?: string;
172
+ Key?: string;
173
+ publishedAt: string;
174
+ }
175
+
176
+ export interface ApiBlackbookGuideline extends ApiBaseEntity {
177
+ Title: string;
178
+ Description?: string;
179
+ publishedAt: string;
180
+ }
181
+
182
+ export interface ApiCalendarItem extends ApiBaseEntity {
183
+ Category?: "Training" | "Office visits - New York" | "Office visits - Brazil" | "Local vendor visits" | "Billionaire calendar";
184
+ Title: string;
185
+ Body?: string;
186
+ StartTime?: string;
187
+ StartTimeZone?: string;
188
+ EndTime?: string;
189
+ EndTimeZone?: string;
190
+ MeetingType?: "In-person" | "Virtual" | "Hybrid";
191
+ Location?: string;
192
+ LearnMoreURL?: string;
193
+ VirtualMeetingURL?: string;
194
+ PublicationStatus?: "New" | "Published" | "Archived";
195
+ IsActive: boolean | null;
196
+ ViewableByAdvisors: boolean | null;
197
+ ViewableByEmbark: boolean | null;
198
+ ViewableByPlanners: boolean | null;
199
+ ViewableByProviders?: boolean | null;
200
+ LocationOnBlackbook?: string;
201
+ publishedAt: string;
202
+ Tags?: Array<ApiTag>;
203
+ Files?: Array<ApiMedia>;
204
+ }
205
+
206
+ export interface ApiChartbrewReport extends ApiBaseEntity {
207
+ Name: string;
208
+ Description?: string;
209
+ Rank: number;
210
+ UID: string;
211
+ Height: number;
212
+ publishedAt: string;
213
+ }
214
+
215
+ export interface ApiCompany extends ApiBaseEntity {
216
+ Name: string;
217
+ SearchableName?: string;
218
+ InvoiceCompanyName?: string;
219
+ IsHidden: boolean | null;
220
+ Tagline?: string;
221
+ Description?: string;
222
+ Website?: string;
223
+ IsActive: boolean | null;
224
+ IsArchived: boolean | null;
225
+ InternalNotes?: string;
226
+ IsEmbarkPreferred: boolean | null;
227
+ SearchResultsLocation?: string;
228
+ EventSpaceMaximum?: number;
229
+ NumberOfUnits?: number;
230
+ NumberOfBedrooms?: number;
231
+ InternalOverview?: string;
232
+ InternalPositioning?: string;
233
+ InternalWhy?: string;
234
+ InternalPersonality?: string;
235
+ InternalDrawbacks?: string;
236
+ InternalPerspective?: string;
237
+ InternalBestFor?: string;
238
+ InsiderReviews?: string;
239
+ EventSpaceMaximumSeated?: number;
240
+ IsVerified: boolean | null;
241
+ VerificationExpirationDate?: string;
242
+ FirstReminderDate?: string;
243
+ SecondReminderDate?: string;
244
+ SubsequentReminderDate?: string;
245
+ IsBlacklisted: boolean | null;
246
+ IsSlowToPay: boolean | null;
247
+ IsEmbarkHero: boolean | null;
248
+ BlacklistedNotes?: string;
249
+ SlowToPayNotes?: string;
250
+ EmbarkHeroNotes?: string;
251
+ TimeZone?: string;
252
+ EmbarkCategory: "luxury" | "lifestyle" | "value";
253
+ ShowEventTabs: boolean | null;
254
+ publishedAt: string;
255
+ CompanyStatus?: ApiCompanyStatuse;
256
+ company_types?: Array<ApiCompanyType>;
257
+ company_sub_types?: Array<ApiCompanySubType>;
258
+ SocialMediaAccounts?: Array<ApiSocialMedia>;
259
+ Addresses?: Array<ApiAddress>;
260
+ PhoneNumbers?: Array<ApiPhoneNumber>;
261
+ EmailAddresses?: Array<ApiEmailAddress>;
262
+ Media?: Array<ApiMedia>;
263
+ LogoImage?: ApiMedia;
264
+ Albums?: Array<ApiAlbum>;
265
+ Tags?: Array<ApiTag>;
266
+ SearchResultsThumbnail?: ApiMedia;
267
+ BannerImage?: ApiMedia;
268
+ EventSpaces?: Array<ApiEventSpace>;
269
+ Ingredients?: Array<ApiIngredient>;
270
+ HighlightedIngredients?: Array<ApiIngredient>;
271
+ GeographySearchItems?: Array<ApiGeographySearchItem>;
272
+ LanguagesSpoken?: Array<ApiLanguage>;
273
+ UsefulLinks?: Array<ApiUsefulLink>;
274
+ CompanyQuestionAnswers?: Array<ApiCompanyQuestionAnswer>;
275
+ AccountManagers?: Array<ApiPeopleAtCompany>;
276
+ PublicationNotes?: Array<ApiPublicationNote>;
277
+ CompanyHistories?: Array<ApiCompanyHistory>;
278
+ VRLinks?: Array<ApiVrLink>;
279
+ CompanyGDSIds?: Array<ApiCompanyGdsId>;
280
+ AlternateNames?: Array<ApiCompanyAlternateName>;
281
+ Sponsorships?: Array<ApiSponsorship>;
282
+ LoyaltyProgramCompanies?: Array<ApiLoyaltyProgramCompany>;
283
+ NewsArticles?: Array<ApiNewsArticle>;
284
+ }
285
+
286
+ export interface ApiCompanyAlternateName extends ApiBaseEntity {
287
+ AlternateName?: string;
288
+ SearchableAlternateName?: string;
289
+ IsDirectoryDefault: boolean | null;
290
+ publishedAt: string;
291
+ Company?: ApiCompany;
292
+ }
293
+
294
+ export interface ApiCompanyGdsId extends ApiBaseEntity {
295
+ ExternalId?: string;
296
+ publishedAt: string;
297
+ GDSType?: ApiGdsType;
298
+ Company?: ApiCompany;
299
+ }
300
+
301
+ export interface ApiCompanyHistory extends ApiBaseEntity {
302
+ Action?: "profile_verified" | "verification_date_expired" | "first_email_sent" | "second_email_sent" | "subsequent_email_sent";
303
+ Name?: string;
304
+ Type?: "verification";
305
+ Note?: string;
306
+ publishedAt: string;
307
+ Company?: ApiCompany;
308
+ }
309
+
310
+ export interface ApiCompanyQuestionAnswer extends ApiBaseEntity {
311
+ AnswerText?: string;
312
+ QualifierAnswerText?: string;
313
+ publishedAt: string;
314
+ company?: ApiCompany;
315
+ question?: ApiQuestion;
316
+ answer_option?: ApiAnswerOption;
317
+ EventSpace?: ApiEventSpace;
318
+ }
319
+
320
+ export interface ApiCompanyRelationship extends ApiBaseEntity {
321
+ Type: "family" | "representation" | "management";
322
+ publishedAt: string;
323
+ Parent?: ApiCompany;
324
+ Child?: ApiCompany;
325
+ }
326
+
327
+ export interface ApiCompanyStatuse extends ApiBaseEntity {
328
+ DisplayName: string;
329
+ IsActive: boolean | null;
330
+ Key?: string;
331
+ ProfileHeaderInfo?: string;
332
+ publishedAt: string;
333
+ }
334
+
335
+ export interface ApiCompanySubType extends ApiBaseEntity {
336
+ Name: string;
337
+ IsActive: boolean | null;
338
+ Description?: string;
339
+ IconName?: string;
340
+ Key?: string;
341
+ VerificationInstructions?: string;
342
+ IsGroundPartner: boolean | null;
343
+ publishedAt: string;
344
+ companies?: Array<ApiCompany>;
345
+ company_types?: Array<ApiCompanyType>;
346
+ }
347
+
348
+ export interface ApiCompanyType extends ApiBaseEntity {
349
+ Name?: string;
350
+ IsActive: boolean | null;
351
+ Description?: string;
352
+ VerificationInstructions?: string;
353
+ Key?: string;
354
+ publishedAt: string;
355
+ company_sub_types?: Array<ApiCompanySubType>;
356
+ companies?: Array<ApiCompany>;
357
+ }
358
+
359
+ export interface ApiCompanyTypeQuestionXref extends ApiBaseEntity {
360
+ IsOnApplication: boolean | null;
361
+ IsRequiredOnApplication: boolean | null;
362
+ IsOnCompanyProfile: boolean | null;
363
+ IsRequiredOnCompanyProfile: boolean | null;
364
+ publishedAt: string;
365
+ company_type?: ApiCompanyType;
366
+ company_sub_type?: ApiCompanySubType;
367
+ question?: ApiQuestion;
368
+ }
369
+
370
+ export interface ApiCompanyVerification extends ApiBaseEntity {
371
+ VerificationInstructions?: string;
372
+ publishedAt: string;
373
+ }
374
+
375
+ export interface ApiContentTypeBuilder extends ApiBaseEntity {
376
+ uid: string;
377
+ plugin?: string;
378
+ apiID: string;
379
+ schema: { displayName: string; singularName: string; pluralName: string; description: string; draftAndPublish: boolean; kind: "collectionType" | "singleType"; collectionName?: string; attributes: Record<string, unknown>; visible: boolean; restrictRelationsTo: Array<unknown> | null; pluginOptions?: Record<string, unknown>; options?: Record<string, unknown>; reviewWorkflows?: boolean; populateCreatorFields?: boolean; comment?: string; version?: string; };
380
+ }
381
+
382
+ export interface ApiCountry extends ApiBaseEntity {
383
+ Name: string;
384
+ A2: string;
385
+ A3: string;
386
+ IsActive: boolean | null;
387
+ Number?: number;
388
+ SearchableName?: string;
389
+ publishedAt: string;
390
+ }
391
+
392
+ export interface ApiCountrysubdivision extends ApiBaseEntity {
393
+ Name: string;
394
+ Code: string;
395
+ IsActive: boolean | null;
396
+ SearchableName?: string;
397
+ publishedAt: string;
398
+ }
399
+
400
+ export interface ApiDefaultDirectorySearch extends ApiBaseEntity {
401
+ SearchText?: string;
402
+ publishedAt: string;
403
+ }
404
+
405
+ export interface ApiDestinationEpic extends ApiBaseEntity {
406
+ Name: string;
407
+ Slug?: string;
408
+ IsActive: boolean | null;
409
+ PublicationStatus: "New" | "Published" | "Archived";
410
+ Key: "destination" | "interest" | "travel-product";
411
+ SearchableName?: string;
412
+ ViewableByAdvisor: boolean | null;
413
+ ViewableByEmbark: boolean | null;
414
+ ViewableByPlanner: boolean | null;
415
+ ViewableByProvider: boolean | null;
416
+ publishedAt: string;
417
+ HeroImage?: ApiHeroImage;
418
+ DestinationMajors?: Array<ApiDestinationMajor>;
419
+ Tags?: Array<ApiTag>;
420
+ GeographySearchItems?: Array<ApiGeographySearchItem>;
421
+ Specials?: Array<ApiSpecial>;
422
+ NewsArticles?: Array<ApiNewsArticle>;
423
+ DestinationLinks?: Array<ApiDestinationLink>;
424
+ Files?: Array<ApiMedia>;
425
+ Accordion?: ApiAccordion;
426
+ }
427
+
428
+ export interface ApiDestinationLink extends ApiBaseEntity {
429
+ Rank: number;
430
+ LinkURL?: string;
431
+ DisplayText?: string;
432
+ publishedAt: string;
433
+ DestinationEpic?: ApiDestinationEpic;
434
+ DestinationMajor?: ApiDestinationMajor;
435
+ DestinationMinor?: ApiDestinationMinor;
436
+ }
437
+
438
+ export interface ApiDestinationMajor extends ApiBaseEntity {
439
+ Name: string;
440
+ Slug?: string;
441
+ TimeZone?: string;
442
+ Highlights?: string;
443
+ IsActive: boolean | null;
444
+ PublicationStatus: "New" | "Published" | "Archived";
445
+ Key: "destination" | "interest" | "travel-product";
446
+ SearchableName?: string;
447
+ ViewableByAdvisor: boolean | null;
448
+ ViewableByEmbark: boolean | null;
449
+ ViewableByPlanner: boolean | null;
450
+ ViewableByProvider: boolean | null;
451
+ publishedAt: string;
452
+ HeroImage?: ApiHeroImage;
453
+ ProposalTemplate?: ApiMedia;
454
+ Tags?: Array<ApiTag>;
455
+ Accordion?: ApiAccordion;
456
+ DestinationMinors?: Array<ApiDestinationMinor>;
457
+ DestinationEpic?: ApiDestinationEpic;
458
+ GeographySearchItems?: Array<ApiGeographySearchItem>;
459
+ Specials?: Array<ApiSpecial>;
460
+ NewsArticles?: Array<ApiNewsArticle>;
461
+ DestinationLinks?: Array<ApiDestinationLink>;
462
+ Files?: Array<ApiMedia>;
463
+ ParentOfAliasedDestinations?: Array<ApiAliasedDestination>;
464
+ ChildOfAliasedDestinations?: Array<ApiAliasedDestination>;
465
+ }
466
+
467
+ export interface ApiDestinationMinor extends ApiBaseEntity {
468
+ Name: string;
469
+ Slug?: string;
470
+ TimeZone?: string;
471
+ Highlights?: string;
472
+ IsActive: boolean | null;
473
+ PublicationStatus: "New" | "Published" | "Archived";
474
+ Key: "destination" | "interest" | "travel-product";
475
+ SearchableName?: string;
476
+ ViewableByAdvisor: boolean | null;
477
+ ViewableByEmbark: boolean | null;
478
+ ViewableByPlanner: boolean | null;
479
+ ViewableByProvider: boolean | null;
480
+ publishedAt: string;
481
+ HeroImage?: ApiHeroImage;
482
+ ProposalTemplate?: ApiMedia;
483
+ Tags?: Array<ApiTag>;
484
+ Accordion?: ApiAccordion;
485
+ DestinationMajor?: ApiDestinationMajor;
486
+ GeographySearchItems?: Array<ApiGeographySearchItem>;
487
+ Specials?: Array<ApiSpecial>;
488
+ DestinationLinks?: Array<ApiDestinationLink>;
489
+ Files?: Array<ApiMedia>;
490
+ NewsArticles?: Array<ApiNewsArticle>;
491
+ ParentOfAliasedDestinations?: Array<ApiAliasedDestination>;
492
+ ChildOfAliasedDestinations?: Array<ApiAliasedDestination>;
493
+ }
494
+
495
+ export interface ApiEmailAddress extends ApiBaseEntity {
496
+ IsValidated: boolean | null;
497
+ EmailAddress: string;
498
+ IsPrimary: boolean | null;
499
+ ValidationMessage?: string;
500
+ publishedAt: string;
501
+ email_address_type?: ApiEmailAddressType;
502
+ }
503
+
504
+ export interface ApiEmailAddressType extends ApiBaseEntity {
505
+ Name: string;
506
+ Rank: number;
507
+ IsActive: boolean | null;
508
+ AppliesToPerson: boolean | null;
509
+ AppliesToPersonCompany: boolean | null;
510
+ AppliesToCompany: boolean | null;
511
+ publishedAt: string;
512
+ }
513
+
514
+ export interface ApiEventSpace extends ApiBaseEntity {
515
+ Name?: string;
516
+ TotalSquareMeters?: number;
517
+ CeilingHeightInMeters?: number;
518
+ publishedAt: string;
519
+ Company?: ApiCompany;
520
+ EventSpaceLayouts?: Array<ApiEventSpaceLayout>;
521
+ }
522
+
523
+ export interface ApiEventSpaceLayout extends ApiBaseEntity {
524
+ MaxCapacity?: number;
525
+ publishedAt: string;
526
+ EventSpace?: ApiEventSpace;
527
+ LayoutType?: ApiLayoutType;
528
+ }
529
+
530
+ export interface ApiEventType extends ApiBaseEntity {
531
+ Name?: string;
532
+ Key?: string;
533
+ Rank: number;
534
+ IsActive: boolean | null;
535
+ publishedAt: string;
536
+ }
537
+
538
+ export interface ApiExternalEmailTemplate extends ApiBaseEntity {
539
+ Name: string;
540
+ Description?: string;
541
+ Key?: string;
542
+ ExternalTemplateId?: string;
543
+ publishedAt: string;
544
+ }
545
+
546
+ export interface ApiFooterContent extends ApiBaseEntity {
547
+ EmailSubject?: string;
548
+ CopyrightEntityName?: string;
549
+ CopyrightYear?: string;
550
+ CopyrightText?: string;
551
+ publishedAt: string;
552
+ Address?: ApiAddress;
553
+ EmailAddress?: ApiEmailAddress;
554
+ PhoneNumber?: ApiPhoneNumber;
555
+ SocialMedia?: Array<ApiSocialMedia>;
556
+ }
557
+
558
+ export interface ApiFooterLegalMenu extends ApiBaseEntity {
559
+ publishedAt: string;
560
+ MenuItems?: Array<ApiMenuItem>;
561
+ }
562
+
563
+ export interface ApiFooterMenu extends ApiBaseEntity {
564
+ publishedAt: string;
565
+ MenuItems?: Array<ApiMenuItem>;
566
+ }
567
+
568
+ export interface ApiGdsType extends ApiBaseEntity {
569
+ Name?: string;
570
+ IsActive: boolean | null;
571
+ Rank: number;
572
+ publishedAt: string;
573
+ }
574
+
575
+ export interface ApiGeographySearchItem extends ApiBaseEntity {
576
+ Name: string;
577
+ SearchableName?: string;
578
+ IsActive: boolean | null;
579
+ Weight: number;
580
+ FilterName?: string;
581
+ publishedAt: string;
582
+ Parents?: Array<ApiGeographySearchItem>;
583
+ Children?: Array<ApiGeographySearchItem>;
584
+ }
585
+
586
+ export interface ApiHawkSearchErrorLog extends ApiBaseEntity {
587
+ IndexName?: string;
588
+ Summary?: string;
589
+ Message?: string;
590
+ Payload?: string;
591
+ publishedAt: string;
592
+ }
593
+
594
+ export interface ApiHawkSearchReindice extends ApiBaseEntity {
595
+ StartTime?: string;
596
+ EndTime?: string;
597
+ CompletionStatus: "Success" | "Fail";
598
+ IndexName?: string;
599
+ CompanyRecords?: number;
600
+ PersonRecords?: number;
601
+ DestinationRecords?: number;
602
+ PassionRecords?: number;
603
+ TravelProductRecords?: number;
604
+ NewsRecords?: number;
605
+ LoyaltyProgramRecords?: number;
606
+ SpecialRecords?: number;
607
+ AllRecords?: number;
608
+ Message?: string;
609
+ publishedAt: string;
610
+ }
611
+
612
+ export interface ApiHelpPage extends ApiBaseEntity {
613
+ Title: string;
614
+ Body?: string;
615
+ IsActive: boolean | null;
616
+ IsEmbarkEditorOnly: boolean | null;
617
+ Rank: number;
618
+ Slug?: string;
619
+ publishedAt: string;
620
+ Attachments?: Array<ApiMedia>;
621
+ Parents?: Array<ApiHelpPage>;
622
+ Children?: Array<ApiHelpPage>;
623
+ }
624
+
625
+ export interface ApiHeroImage extends ApiBaseEntity {
626
+ Title?: string;
627
+ Key?: "destination" | "home" | "interest" | "landing-page" | "loyalty" | "news" | "news-article-group" | "news-article-group-category" | "random" | "special" | "travel-product" | "training-course";
628
+ publishedAt: string;
629
+ Images?: Array<ApiMedia>;
630
+ DestinationMinor?: ApiDestinationMinor;
631
+ DestinationMajor?: ApiDestinationMajor;
632
+ DestinationEpic?: ApiDestinationEpic;
633
+ LoyaltyProgram?: ApiLoyaltyProgram;
634
+ NewsArticle?: ApiNewsArticle;
635
+ Special?: ApiSpecial;
636
+ LandingPage?: ApiLandingPage;
637
+ NewsArticleGroup?: ApiNewsArticleGroup;
638
+ NewsArticleGroupCategory?: ApiNewsArticleGroupCategory;
639
+ TrainingCourse?: ApiTrainingCourse;
640
+ }
641
+
642
+ export interface ApiHomePageButton extends ApiBaseEntity {
643
+ Label?: string;
644
+ Slug?: string;
645
+ Link?: string;
646
+ ViewableByAdvisor: boolean | null;
647
+ ViewableByEmbark: boolean | null;
648
+ ViewableByPlanner: boolean | null;
649
+ ViewableByProvider: boolean | null;
650
+ Rank: number;
651
+ publishedAt: string;
652
+ LandingPage?: ApiLandingPage;
653
+ }
654
+
655
+ export interface ApiIngredient extends ApiBaseEntity {
656
+ Name: string;
657
+ Description?: string;
658
+ IsActive: boolean | null;
659
+ publishedAt: string;
660
+ Companies?: Array<ApiCompany>;
661
+ HighlightedCompanies?: Array<ApiCompany>;
662
+ }
663
+
664
+ export interface ApiLandingPage extends ApiBaseEntity {
665
+ Title?: string;
666
+ Key?: "home" | "loyalty-programs" | "destinations" | "interests" | "travel-products" | "calendar" | "specials" | "commissions" | "financial" | "company-resources" | "training";
667
+ IsActive: boolean | null;
668
+ Notes?: string;
669
+ publishedAt: string;
670
+ HeroImage?: ApiHeroImage;
671
+ HomePageButtons?: Array<ApiHomePageButton>;
672
+ LandingPageLinks?: Array<ApiLandingPageLink>;
673
+ Files?: Array<ApiMedia>;
674
+ LandingPageVideos?: Array<ApiLandingPageVideo>;
675
+ }
676
+
677
+ export interface ApiLandingPageLink extends ApiBaseEntity {
678
+ Rank: number;
679
+ LinkURL?: string;
680
+ DisplayText?: string;
681
+ publishedAt: string;
682
+ LandingPage?: ApiLandingPage;
683
+ }
684
+
685
+ export interface ApiLandingPageVideo extends ApiBaseEntity {
686
+ Rank: number;
687
+ ShareURL?: string;
688
+ DisplayText?: string;
689
+ publishedAt: string;
690
+ LandingPage?: ApiLandingPage;
691
+ }
692
+
693
+ export interface ApiLanguage extends ApiBaseEntity {
694
+ EnglishName: string;
695
+ NativeName?: string;
696
+ SearchableName?: string;
697
+ A2?: string;
698
+ A3?: string;
699
+ Rank: number;
700
+ IsActive: boolean | null;
701
+ publishedAt: string;
702
+ }
703
+
704
+ export interface ApiLayoutType extends ApiBaseEntity {
705
+ Name: string;
706
+ Description?: string;
707
+ IsActive: boolean | null;
708
+ publishedAt: string;
709
+ }
710
+
711
+ export interface ApiLoyaltyProgram extends ApiBaseEntity {
712
+ Name: string;
713
+ Slug?: string;
714
+ PublicationStatus: "New" | "Published" | "Archived";
715
+ IsActive: boolean | null;
716
+ Details?: string;
717
+ ExternalURL?: string;
718
+ publishedAt: string;
719
+ HeroImage?: ApiHeroImage;
720
+ Logo?: ApiMedia;
721
+ LoyaltyProgramCompanies?: Array<ApiLoyaltyProgramCompany>;
722
+ Files?: Array<ApiMedia>;
723
+ LoyaltyProgramLinks?: Array<ApiLoyaltyProgramLink>;
724
+ LoyaltyProgramContacts?: Array<ApiLoyaltyProgramContact>;
725
+ LoyaltyProgramVideos?: Array<ApiLoyaltyProgramVideo>;
726
+ }
727
+
728
+ export interface ApiLoyaltyProgramCompany extends ApiBaseEntity {
729
+ IsPrimary?: boolean | null;
730
+ publishedAt: string;
731
+ LoyaltyProgram?: ApiLoyaltyProgram;
732
+ Company?: ApiCompany;
733
+ }
734
+
735
+ export interface ApiLoyaltyProgramContact extends ApiBaseEntity {
736
+ Rank: number;
737
+ publishedAt: string;
738
+ LoyaltyProgram?: ApiLoyaltyProgram;
739
+ PersonAtCompany?: ApiPeopleAtCompany;
740
+ }
741
+
742
+ export interface ApiLoyaltyProgramLink extends ApiBaseEntity {
743
+ Rank: number;
744
+ LinkURL?: string;
745
+ DisplayText?: string;
746
+ publishedAt: string;
747
+ LoyaltyProgram?: ApiLoyaltyProgram;
748
+ }
749
+
750
+ export interface ApiLoyaltyProgramVideo extends ApiBaseEntity {
751
+ Rank: number;
752
+ ShareURL?: string;
753
+ DisplayText?: string;
754
+ publishedAt: string;
755
+ LoyaltyProgram?: ApiLoyaltyProgram;
756
+ }
757
+
758
+ export interface ApiMediaCategory extends ApiBaseEntity {
759
+ Name: string;
760
+ Description?: string;
761
+ IsActive: boolean | null;
762
+ Key?: string;
763
+ publishedAt: string;
764
+ }
765
+
766
+ export interface ApiMenuItem extends ApiBaseEntity {
767
+ DisplayName: string;
768
+ Link: string;
769
+ IsVisibleAnonymous: boolean | null;
770
+ Rank: number;
771
+ ViewableByAdvisor: boolean | null;
772
+ ViewableByEmbark: boolean | null;
773
+ ViewableByPlanner: boolean | null;
774
+ ViewableByProvider: boolean | null;
775
+ publishedAt: string;
776
+ MenuItems?: Array<ApiMenuItem>;
777
+ }
778
+
779
+ export interface ApiMuxFolder extends ApiBaseEntity {
780
+ Name?: string;
781
+ publishedAt: string;
782
+ Children?: Array<ApiMuxFolder>;
783
+ Parent?: ApiMuxFolder;
784
+ MuxVideos?: Array<ApiMuxVideo>;
785
+ }
786
+
787
+ export interface ApiMuxVideo extends ApiBaseEntity {
788
+ UploadId?: string;
789
+ AssetId?: string;
790
+ PlaybackId?: string;
791
+ Title?: string;
792
+ MuxStatus?: "preparing" | "ready" | "errored";
793
+ publishedAt: string;
794
+ MuxFolder?: ApiMuxFolder;
795
+ }
796
+
797
+ export interface ApiNavigation extends ApiBaseEntity {
798
+ publishedAt: string;
799
+ MenuItems?: Array<ApiMenuItem>;
800
+ }
801
+
802
+ export interface ApiNewsArticle extends ApiBaseEntity {
803
+ Title?: string;
804
+ Body?: string;
805
+ VisibleOnHome: boolean | null;
806
+ ViewableOnDestinationHome: boolean | null;
807
+ ViewableByAdvisors: boolean | null;
808
+ ViewableByPlanners: boolean | null;
809
+ ViewableByProviders: boolean | null;
810
+ PublicationStatus?: "New" | "Published" | "Archived";
811
+ IsActive: boolean | null;
812
+ DatePublished?: string;
813
+ Slug?: string;
814
+ ViewableByEmbark: boolean | null;
815
+ ExternalURL?: string;
816
+ IsExternalLink: boolean | null;
817
+ Rank: number;
818
+ IncludeInNavigation: boolean | null;
819
+ publishedAt: string;
820
+ Tags?: Array<ApiTag>;
821
+ Files?: Array<ApiMedia>;
822
+ HeroImage?: ApiHeroImage;
823
+ DestinationEpics?: Array<ApiDestinationEpic>;
824
+ DestinationMajors?: Array<ApiDestinationMajor>;
825
+ Author?: ApiPeople;
826
+ Links?: Array<ApiNewsArticleLink>;
827
+ DestinationMinors?: Array<ApiDestinationMinor>;
828
+ Companies?: Array<ApiCompany>;
829
+ NewsArticleGroup?: ApiNewsArticleGroup;
830
+ NewsArticleGroupCategory?: ApiNewsArticleGroupCategory;
831
+ GeographySearchItems?: Array<ApiGeographySearchItem>;
832
+ NewsArticleGroupCategoryTopic?: ApiNewsArticleGroupCategoryTopic;
833
+ }
834
+
835
+ export interface ApiNewsArticleGroup extends ApiBaseEntity {
836
+ Name: string;
837
+ Rank: number;
838
+ Slug?: string;
839
+ IsActive: boolean | null;
840
+ Template: "Default" | "Latest" | "ByCategoryAndGeography" | "ThreeColumnList";
841
+ IncludeInNavigation: boolean | null;
842
+ Title?: string;
843
+ Notes?: string;
844
+ publishedAt: string;
845
+ NewsArticles?: Array<ApiNewsArticle>;
846
+ NewsArticleGroupCategories?: Array<ApiNewsArticleGroupCategory>;
847
+ HeroImage?: ApiHeroImage;
848
+ }
849
+
850
+ export interface ApiNewsArticleGroupCategory extends ApiBaseEntity {
851
+ Name: string;
852
+ Rank: number;
853
+ IsActive: boolean | null;
854
+ Slug?: string;
855
+ IncludeInNavigation: boolean | null;
856
+ Title?: string;
857
+ Notes?: string;
858
+ Template: "Default" | "Latest" | "ByCategoryAndGeography" | "ThreeColumnList";
859
+ publishedAt: string;
860
+ NewsArticleGroup?: ApiNewsArticleGroup;
861
+ HeroImage?: ApiHeroImage;
862
+ NewsArticles?: Array<ApiNewsArticle>;
863
+ NewsArticleGroupCategoryTopics?: Array<ApiNewsArticleGroupCategoryTopic>;
864
+ }
865
+
866
+ export interface ApiNewsArticleGroupCategoryTopic extends ApiBaseEntity {
867
+ Name: string;
868
+ Rank: number;
869
+ IsActive: boolean | null;
870
+ publishedAt: string;
871
+ NewsArticleGroupCategory?: ApiNewsArticleGroupCategory;
872
+ NewsArticles?: Array<ApiNewsArticle>;
873
+ }
874
+
875
+ export interface ApiNewsArticleLink extends ApiBaseEntity {
876
+ Rank: number;
877
+ LinkURL?: string;
878
+ DisplayText?: string;
879
+ publishedAt: string;
880
+ NewsArticle?: ApiNewsArticle;
881
+ }
882
+
883
+ export interface ApiPeople extends ApiBaseEntity {
884
+ FirstName?: string;
885
+ MiddleName?: string;
886
+ LastName?: string;
887
+ DirectoryName?: string;
888
+ PreferredName?: string;
889
+ SearchableName?: string;
890
+ IsActive: boolean | null;
891
+ IsArchived: boolean | null;
892
+ publishedAt: string;
893
+ prefix?: { documentId: string; id: string | number; Name: string; Rank: number; IsActive: boolean | null; createdAt?: string; updatedAt?: string; publishedAt: string; };
894
+ Suffix?: { documentId: string; id: string | number; Name: string; Rank: number; IsActive: boolean | null; createdAt?: string; updatedAt?: string; publishedAt: string; };
895
+ Pronoun?: ApiPronoun;
896
+ PreferredLanguage?: ApiLanguage;
897
+ LanguagesSpoken?: Array<ApiLanguage>;
898
+ Addresses?: Array<ApiAddress>;
899
+ EmailAddresses?: Array<ApiEmailAddress>;
900
+ PhoneNumbers?: Array<ApiPhoneNumber>;
901
+ SocialMediaAccounts?: Array<ApiSocialMedia>;
902
+ user?: ApiUsersPermissionsUser;
903
+ ProfileImage?: ApiMedia;
904
+ PersonAtCompanies?: Array<ApiPeopleAtCompany>;
905
+ AuthorizationTypes?: Array<ApiAuthorizationType>;
906
+ }
907
+
908
+ export interface ApiPeopleAtCompany extends ApiBaseEntity {
909
+ JobTitle?: string;
910
+ Bio?: string;
911
+ IsActive: boolean | null;
912
+ IsArchived: boolean | null;
913
+ CanManageCompanyDetails: boolean | null;
914
+ CanManageCompanyStaff: boolean | null;
915
+ IsDefaultProfile: boolean | null;
916
+ IsBlackbookProfileContact: boolean | null;
917
+ DoCopyOnImportantEmails: boolean | null;
918
+ ReceiveRFPNotifications: boolean | null;
919
+ publishedAt: string;
920
+ Person?: ApiPeople;
921
+ Company?: ApiCompany;
922
+ SocialMediaAccounts?: Array<ApiSocialMedia>;
923
+ Addresses?: Array<ApiAddress>;
924
+ PhoneNumbers?: Array<ApiPhoneNumber>;
925
+ EmailAddresses?: Array<ApiEmailAddress>;
926
+ AccountsManaged?: Array<ApiCompany>;
927
+ PrimaryContactTypes?: Array<ApiPrimaryContactType>;
928
+ LoyaltyProgramContacts?: Array<ApiLoyaltyProgramContact>;
929
+ }
930
+
931
+ export interface ApiPhoneNumber extends ApiBaseEntity {
932
+ RawFormat: string;
933
+ IsValidated: boolean | null;
934
+ E164Format?: string;
935
+ InternationalFormat?: string;
936
+ NationalFormat?: string;
937
+ IsPrimary: boolean | null;
938
+ IsWhatsApp: boolean | null;
939
+ ValidationMessage?: string;
940
+ publishedAt: string;
941
+ country?: ApiCountry;
942
+ phone_number_type?: ApiPhoneNumberType;
943
+ }
944
+
945
+ export interface ApiPhoneNumberType extends ApiBaseEntity {
946
+ Name: string;
947
+ IsActive: boolean | null;
948
+ Rank: number;
949
+ AppliesToPerson: boolean | null;
950
+ AppliesToPersonCompany: boolean | null;
951
+ AppliesToCompany: boolean | null;
952
+ publishedAt: string;
953
+ }
954
+
955
+ export interface ApiPolicy extends ApiBaseEntity {
956
+ PolicyType: "cookie" | "privacy" | "termsofservice";
957
+ Version: number;
958
+ Policy?: string;
959
+ IsCurrent: boolean | null;
960
+ Title?: string;
961
+ publishedAt: string;
962
+ }
963
+
964
+ export interface ApiPrefixe extends ApiBaseEntity {
965
+ Name: string;
966
+ Rank: number;
967
+ IsActive: boolean | null;
968
+ publishedAt: string;
969
+ }
970
+
971
+ export interface ApiPrimaryContactType extends ApiBaseEntity {
972
+ Name: string;
973
+ IsActive: boolean | null;
974
+ Key?: string;
975
+ Rank: number;
976
+ publishedAt: string;
977
+ RequiredOnCompanyTypes?: Array<ApiCompanyType>;
978
+ RequiredOnCompanySubTypes?: Array<ApiCompanySubType>;
979
+ }
980
+
981
+ export interface ApiProductRoadmap extends ApiBaseEntity {
982
+ Title?: string;
983
+ Description?: string;
984
+ publishedAt: string;
985
+ }
986
+
987
+ export interface ApiPronoun extends ApiBaseEntity {
988
+ Name: string;
989
+ Rank: number;
990
+ IsActive: boolean | null;
991
+ publishedAt: string;
992
+ }
993
+
994
+ export interface ApiPublicationNote extends ApiBaseEntity {
995
+ Name?: string;
996
+ Note?: string;
997
+ publishedAt: string;
998
+ Company?: ApiCompany;
999
+ }
1000
+
1001
+ export interface ApiQuestion extends ApiBaseEntity {
1002
+ Text?: string;
1003
+ Description?: string;
1004
+ ProfileLabelText?: string;
1005
+ Category: "Accommodations" | "Concessions" | "Essentials" | "Financial" | "General Event Parameters" | "On Site Activities" | "Product Positioning" | "Property Access" | "Property Features & Guidelines" | "Staff & Services" | "Specialty Travel" | "Venue-Specific Details" | "Wellness Overview" | "Wellness Details" | "Working with Groups";
1006
+ Rank: number;
1007
+ Subcategory?: "Accessibility" | "Banquet Catering" | "Beach" | "Blackbook Perks" | "Buyout" | "Curfew" | "Commission" | "Details" | "Food & Beverage" | "General" | "Internal Movement" | "Kosher Events" | "Loading & Teardown" | "Medical" | "Permits" | "Pool" | "Production Parameters" | "Racket Sports" | "Recommendations" | "Restrictions" | "Shipping & Importing" | "Spa/Salon" | "Staff & Vendors Accommodating" | "Staff & Vendors General" | "Staff & Vendors Vehicles and Parking" | "Tenting & Rain Backup" | "Transportation" | "Value & Cost Considerations";
1008
+ IsInGlance: boolean | null;
1009
+ IsInOverview: boolean | null;
1010
+ publishedAt: string;
1011
+ question_type?: ApiQuestionType;
1012
+ answer_options?: Array<ApiAnswerOption>;
1013
+ company_question_answers?: Array<ApiCompanyQuestionAnswer>;
1014
+ }
1015
+
1016
+ export interface ApiQuestionType extends ApiBaseEntity {
1017
+ Name: string;
1018
+ Description?: string;
1019
+ publishedAt: string;
1020
+ }
1021
+
1022
+ export interface ApiReleaseNote extends ApiBaseEntity {
1023
+ Version?: string;
1024
+ ReleaseDate?: string;
1025
+ Notes?: string;
1026
+ publishedAt: string;
1027
+ }
1028
+
1029
+ export interface ApiRssFeed extends ApiBaseEntity {
1030
+ Name?: string;
1031
+ FeedURL?: string;
1032
+ Rank: number;
1033
+ NumberToDisplay: number;
1034
+ publishedAt: string;
1035
+ }
1036
+
1037
+ export interface ApiSavedFavoriteList extends ApiBaseEntity {
1038
+ Name: string;
1039
+ Description?: string;
1040
+ ApproximateDate?: string;
1041
+ IsActive?: boolean | null;
1042
+ Type: "favorite" | "event";
1043
+ OtherEventType?: string;
1044
+ publishedAt: string;
1045
+ Owner?: ApiPeople;
1046
+ ReppingAs?: ApiPeopleAtCompany;
1047
+ EventType?: ApiEventType;
1048
+ Companies?: Array<ApiCompany>;
1049
+ }
1050
+
1051
+ export interface ApiSavedFavoriteListCompany extends ApiBaseEntity {
1052
+ Reason?: string;
1053
+ publishedAt: string;
1054
+ Company?: ApiCompany;
1055
+ List?: ApiSavedFavoriteList;
1056
+ }
1057
+
1058
+ export interface ApiShortcut extends ApiBaseEntity {
1059
+ Text?: string;
1060
+ Path?: string;
1061
+ IsActive?: boolean | null;
1062
+ publishedAt: string;
1063
+ }
1064
+
1065
+ export interface ApiSocialMedia extends ApiBaseEntity {
1066
+ Name?: string;
1067
+ URL?: string;
1068
+ publishedAt: string;
1069
+ social_media_type?: ApiSocialMediaType;
1070
+ }
1071
+
1072
+ export interface ApiSocialMediaType extends ApiBaseEntity {
1073
+ Name: string;
1074
+ Rank: number;
1075
+ IsActive: boolean | null;
1076
+ AppliesToPerson: boolean | null;
1077
+ AppliesToPersonCompany: boolean | null;
1078
+ AppliesToCompany: boolean | null;
1079
+ BaseURL?: string;
1080
+ publishedAt: string;
1081
+ }
1082
+
1083
+ export interface ApiSpecial extends ApiBaseEntity {
1084
+ Title?: string;
1085
+ Body?: string;
1086
+ ExpirationDate?: string;
1087
+ Tagline?: string;
1088
+ PublicationStatus: "New" | "Published" | "Archived";
1089
+ IsActive: boolean | null;
1090
+ ViewableByAdvisor: boolean | null;
1091
+ ViewableByEmbark: boolean | null;
1092
+ ViewableByPlanner: boolean | null;
1093
+ ViewableByProvider: boolean | null;
1094
+ ViewableOnHome: boolean | null;
1095
+ ViewableOnDestinationHome: boolean | null;
1096
+ Slug?: string;
1097
+ Key: "commission" | "special";
1098
+ CommissionRate?: number;
1099
+ publishedAt: string;
1100
+ HeroImage?: ApiHeroImage;
1101
+ ViewableOnDestinationEpics?: Array<ApiDestinationEpic>;
1102
+ ViewableOnDestinationMajors?: Array<ApiDestinationMajor>;
1103
+ ViewableOnDestinationMinor?: Array<ApiDestinationMinor>;
1104
+ ApplicableCompanies?: Array<ApiCompany>;
1105
+ Files?: Array<ApiMedia>;
1106
+ Tags?: Array<ApiTag>;
1107
+ }
1108
+
1109
+ export interface ApiSponsorship extends ApiBaseEntity {
1110
+ Name: string;
1111
+ StartDate?: string;
1112
+ EndDate?: string;
1113
+ IsExclusiveForLocation: boolean | null;
1114
+ GoogleAnalyticsCampaign?: string;
1115
+ Weight: number;
1116
+ IsActive: boolean | null;
1117
+ publishedAt: string;
1118
+ Companies?: Array<ApiCompany>;
1119
+ SponsorshipLocation?: ApiSponsorshipLocation;
1120
+ Image?: ApiMedia;
1121
+ PointOfContact?: Array<ApiPeopleAtCompany>;
1122
+ SponsorshipStatus?: ApiSponsorshipStatuse;
1123
+ AlsoInterestedIns?: Array<ApiSponsorshipAlsoInterestedIn>;
1124
+ }
1125
+
1126
+ export interface ApiSponsorshipAlsoInterestedIn extends ApiBaseEntity {
1127
+ InterestedInWhy?: string;
1128
+ publishedAt: string;
1129
+ Company?: ApiCompany;
1130
+ Sponsorship?: ApiSponsorship;
1131
+ }
1132
+
1133
+ export interface ApiSponsorshipLocation extends ApiBaseEntity {
1134
+ Name: string;
1135
+ Key: string;
1136
+ ImageFileDescription?: string;
1137
+ IsActive: boolean | null;
1138
+ publishedAt: string;
1139
+ }
1140
+
1141
+ export interface ApiSponsorshipStatuse extends ApiBaseEntity {
1142
+ Name: string;
1143
+ Description?: string;
1144
+ IsActive: boolean | null;
1145
+ Rank: number;
1146
+ Key?: string;
1147
+ publishedAt: string;
1148
+ }
1149
+
1150
+ export interface ApiSuffixe extends ApiBaseEntity {
1151
+ Name: string;
1152
+ Rank: number;
1153
+ IsActive: boolean | null;
1154
+ publishedAt: string;
1155
+ }
1156
+
1157
+ export interface ApiTag extends ApiBaseEntity {
1158
+ Name: string;
1159
+ publishedAt: string;
1160
+ Companies?: Array<ApiCompany>;
1161
+ }
1162
+
1163
+ export interface ApiTrainingCourse extends ApiBaseEntity {
1164
+ Title?: string;
1165
+ Slug?: string;
1166
+ Body?: string;
1167
+ IsActive: boolean | null;
1168
+ Rank: number;
1169
+ publishedAt: string;
1170
+ HeroImage?: ApiHeroImage;
1171
+ Files?: Array<ApiMedia>;
1172
+ Links?: Array<ApiTrainingLink>;
1173
+ Modules?: Array<ApiTrainingModule>;
1174
+ Category?: ApiNewsArticleGroupCategory;
1175
+ Videos?: Array<ApiTrainingVideoItem>;
1176
+ }
1177
+
1178
+ export interface ApiTrainingLink extends ApiBaseEntity {
1179
+ Rank: number;
1180
+ LinkURL?: string;
1181
+ DisplayText?: string;
1182
+ publishedAt: string;
1183
+ Course?: ApiTrainingCourse;
1184
+ }
1185
+
1186
+ export interface ApiTrainingModule extends ApiBaseEntity {
1187
+ Title?: string;
1188
+ Slug?: string;
1189
+ Rank: number;
1190
+ IsActive: boolean | null;
1191
+ publishedAt: string;
1192
+ Course?: ApiTrainingCourse;
1193
+ Article?: ApiNewsArticle;
1194
+ ParentModule?: ApiTrainingModule;
1195
+ ChildModules?: Array<ApiTrainingModule>;
1196
+ }
1197
+
1198
+ export interface ApiTrainingVideoItem extends ApiBaseEntity {
1199
+ VideoHost?: "Mux" | "YouTube" | "Vimeo";
1200
+ HostVideoId?: string;
1201
+ Name?: string;
1202
+ publishedAt: string;
1203
+ Course?: ApiTrainingCourse;
1204
+ }
1205
+
1206
+ export interface ApiUsefulLink extends ApiBaseEntity {
1207
+ URL?: string;
1208
+ DisplayText?: string;
1209
+ Rank: number;
1210
+ publishedAt: string;
1211
+ company?: ApiCompany;
1212
+ MediaCategory?: ApiMediaCategory;
1213
+ }
1214
+
1215
+ export interface ApiUserAcceptedPolicy extends ApiBaseEntity {
1216
+ PolicyType: "cookie" | "privacy" | "termsofservice";
1217
+ Version: number;
1218
+ UserDocumentId?: string;
1219
+ publishedAt: string;
1220
+ }
1221
+
1222
+ export interface ApiVrLink extends ApiBaseEntity {
1223
+ Name?: string;
1224
+ URL?: string;
1225
+ Rank: number;
1226
+ publishedAt: string;
1227
+ Company?: ApiCompany;
1228
+ MediaCategory?: ApiMediaCategory;
1229
+ }
1230
+
1231
+ export type ApiEntity = ApiMedia | ApiUsersPermissionsRole | ApiUsersPermissionsUser | ApiAccordion | ApiAccordionCategory | ApiAccordionItem | ApiAddress | ApiAddressType | ApiAlbum | ApiAlbumEmbeddedVideoItem | ApiAlbumItem | ApiAlbumPdfItem | ApiAliasedDestination | ApiAnnouncement | ApiAnswerOption | ApiAuthorizationType | ApiBlackbookGuideline | ApiCalendarItem | ApiChartbrewReport | ApiCompany | ApiCompanyAlternateName | ApiCompanyGdsId | ApiCompanyHistory | ApiCompanyQuestionAnswer | ApiCompanyRelationship | ApiCompanyStatuse | ApiCompanySubType | ApiCompanyType | ApiCompanyTypeQuestionXref | ApiCompanyVerification | ApiContentTypeBuilder | ApiCountry | ApiCountrysubdivision | ApiDefaultDirectorySearch | ApiDestinationEpic | ApiDestinationLink | ApiDestinationMajor | ApiDestinationMinor | ApiEmailAddress | ApiEmailAddressType | ApiEventSpace | ApiEventSpaceLayout | ApiEventType | ApiExternalEmailTemplate | ApiFooterContent | ApiFooterLegalMenu | ApiFooterMenu | ApiGdsType | ApiGeographySearchItem | ApiHawkSearchErrorLog | ApiHawkSearchReindice | ApiHelpPage | ApiHeroImage | ApiHomePageButton | ApiIngredient | ApiLandingPage | ApiLandingPageLink | ApiLandingPageVideo | ApiLanguage | ApiLayoutType | ApiLoyaltyProgram | ApiLoyaltyProgramCompany | ApiLoyaltyProgramContact | ApiLoyaltyProgramLink | ApiLoyaltyProgramVideo | ApiMediaCategory | ApiMenuItem | ApiMuxFolder | ApiMuxVideo | ApiNavigation | ApiNewsArticle | ApiNewsArticleGroup | ApiNewsArticleGroupCategory | ApiNewsArticleGroupCategoryTopic | ApiNewsArticleLink | ApiPeople | ApiPeopleAtCompany | ApiPhoneNumber | ApiPhoneNumberType | ApiPolicy | ApiPrefixe | ApiPrimaryContactType | ApiProductRoadmap | ApiPronoun | ApiPublicationNote | ApiQuestion | ApiQuestionType | ApiReleaseNote | ApiRssFeed | ApiSavedFavoriteList | ApiSavedFavoriteListCompany | ApiShortcut | ApiSocialMedia | ApiSocialMediaType | ApiSpecial | ApiSponsorship | ApiSponsorshipAlsoInterestedIn | ApiSponsorshipLocation | ApiSponsorshipStatuse | ApiSuffixe | ApiTag | ApiTrainingCourse | ApiTrainingLink | ApiTrainingModule | ApiTrainingVideoItem | ApiUsefulLink | ApiUserAcceptedPolicy | ApiVrLink;