@seamapi/types 1.535.0 → 1.537.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.
@@ -38450,6 +38450,72 @@ export default {
38450
38450
  'Whether the portal is embedded in another application.',
38451
38451
  type: 'boolean',
38452
38452
  },
38453
+ landing_page: {
38454
+ description:
38455
+ 'Configuration for the landing page when the portal loads.',
38456
+ properties: {
38457
+ manage: {
38458
+ oneOf: [
38459
+ {
38460
+ properties: { space_key: { type: 'string' } },
38461
+ required: ['space_key'],
38462
+ type: 'object',
38463
+ },
38464
+ {
38465
+ properties: {
38466
+ property_key: { type: 'string' },
38467
+ },
38468
+ required: ['property_key'],
38469
+ type: 'object',
38470
+ },
38471
+ {
38472
+ properties: { room_key: { type: 'string' } },
38473
+ required: ['room_key'],
38474
+ type: 'object',
38475
+ },
38476
+ {
38477
+ properties: {
38478
+ common_area_key: { type: 'string' },
38479
+ },
38480
+ required: ['common_area_key'],
38481
+ type: 'object',
38482
+ },
38483
+ {
38484
+ properties: { unit_key: { type: 'string' } },
38485
+ required: ['unit_key'],
38486
+ type: 'object',
38487
+ },
38488
+ {
38489
+ properties: {
38490
+ facility_key: { type: 'string' },
38491
+ },
38492
+ required: ['facility_key'],
38493
+ type: 'object',
38494
+ },
38495
+ {
38496
+ properties: {
38497
+ building_key: { type: 'string' },
38498
+ },
38499
+ required: ['building_key'],
38500
+ type: 'object',
38501
+ },
38502
+ {
38503
+ properties: { listing_key: { type: 'string' } },
38504
+ required: ['listing_key'],
38505
+ type: 'object',
38506
+ },
38507
+ {
38508
+ properties: {
38509
+ property_listing_key: { type: 'string' },
38510
+ },
38511
+ required: ['property_listing_key'],
38512
+ type: 'object',
38513
+ },
38514
+ ],
38515
+ },
38516
+ },
38517
+ type: 'object',
38518
+ },
38453
38519
  },
38454
38520
  type: 'object',
38455
38521
  },
@@ -49232,6 +49298,72 @@ export default {
49232
49298
  type: 'object',
49233
49299
  },
49234
49300
  is_embedded: { type: 'boolean' },
49301
+ landing_page: {
49302
+ properties: {
49303
+ manage: {
49304
+ oneOf: [
49305
+ {
49306
+ properties: { space_key: { type: 'string' } },
49307
+ required: ['space_key'],
49308
+ type: 'object',
49309
+ },
49310
+ {
49311
+ properties: {
49312
+ property_key: { type: 'string' },
49313
+ },
49314
+ required: ['property_key'],
49315
+ type: 'object',
49316
+ },
49317
+ {
49318
+ properties: { room_key: { type: 'string' } },
49319
+ required: ['room_key'],
49320
+ type: 'object',
49321
+ },
49322
+ {
49323
+ properties: {
49324
+ common_area_key: { type: 'string' },
49325
+ },
49326
+ required: ['common_area_key'],
49327
+ type: 'object',
49328
+ },
49329
+ {
49330
+ properties: { unit_key: { type: 'string' } },
49331
+ required: ['unit_key'],
49332
+ type: 'object',
49333
+ },
49334
+ {
49335
+ properties: {
49336
+ facility_key: { type: 'string' },
49337
+ },
49338
+ required: ['facility_key'],
49339
+ type: 'object',
49340
+ },
49341
+ {
49342
+ properties: {
49343
+ building_key: { type: 'string' },
49344
+ },
49345
+ required: ['building_key'],
49346
+ type: 'object',
49347
+ },
49348
+ {
49349
+ properties: {
49350
+ listing_key: { type: 'string' },
49351
+ },
49352
+ required: ['listing_key'],
49353
+ type: 'object',
49354
+ },
49355
+ {
49356
+ properties: {
49357
+ property_listing_key: { type: 'string' },
49358
+ },
49359
+ required: ['property_listing_key'],
49360
+ type: 'object',
49361
+ },
49362
+ ],
49363
+ },
49364
+ },
49365
+ type: 'object',
49366
+ },
49235
49367
  },
49236
49368
  type: 'object',
49237
49369
  },
@@ -49328,6 +49460,72 @@ export default {
49328
49460
  type: 'object',
49329
49461
  },
49330
49462
  is_embedded: { type: 'boolean' },
49463
+ landing_page: {
49464
+ properties: {
49465
+ manage: {
49466
+ oneOf: [
49467
+ {
49468
+ properties: { space_key: { type: 'string' } },
49469
+ required: ['space_key'],
49470
+ type: 'object',
49471
+ },
49472
+ {
49473
+ properties: {
49474
+ property_key: { type: 'string' },
49475
+ },
49476
+ required: ['property_key'],
49477
+ type: 'object',
49478
+ },
49479
+ {
49480
+ properties: { room_key: { type: 'string' } },
49481
+ required: ['room_key'],
49482
+ type: 'object',
49483
+ },
49484
+ {
49485
+ properties: {
49486
+ common_area_key: { type: 'string' },
49487
+ },
49488
+ required: ['common_area_key'],
49489
+ type: 'object',
49490
+ },
49491
+ {
49492
+ properties: { unit_key: { type: 'string' } },
49493
+ required: ['unit_key'],
49494
+ type: 'object',
49495
+ },
49496
+ {
49497
+ properties: {
49498
+ facility_key: { type: 'string' },
49499
+ },
49500
+ required: ['facility_key'],
49501
+ type: 'object',
49502
+ },
49503
+ {
49504
+ properties: {
49505
+ building_key: { type: 'string' },
49506
+ },
49507
+ required: ['building_key'],
49508
+ type: 'object',
49509
+ },
49510
+ {
49511
+ properties: {
49512
+ listing_key: { type: 'string' },
49513
+ },
49514
+ required: ['listing_key'],
49515
+ type: 'object',
49516
+ },
49517
+ {
49518
+ properties: {
49519
+ property_listing_key: { type: 'string' },
49520
+ },
49521
+ required: ['property_listing_key'],
49522
+ type: 'object',
49523
+ },
49524
+ ],
49525
+ },
49526
+ },
49527
+ type: 'object',
49528
+ },
49331
49529
  },
49332
49530
  type: 'object',
49333
49531
  },
@@ -49601,6 +49799,284 @@ export default {
49601
49799
  'x-undocumented': 'Seam Instant Key only.',
49602
49800
  },
49603
49801
  },
49802
+ '/seam/instant_key/v1/preview/get': {
49803
+ get: {
49804
+ operationId: 'seamInstantKeyV1PreviewGetGet',
49805
+ requestBody: {
49806
+ content: {
49807
+ 'application/json': {
49808
+ schema: {
49809
+ properties: {
49810
+ instant_key_url: {
49811
+ description:
49812
+ 'The short code of the instant key to preview.',
49813
+ type: 'string',
49814
+ },
49815
+ },
49816
+ required: ['instant_key_url'],
49817
+ type: 'object',
49818
+ },
49819
+ },
49820
+ },
49821
+ },
49822
+ responses: {
49823
+ 200: {
49824
+ content: {
49825
+ 'application/json': {
49826
+ schema: {
49827
+ properties: {
49828
+ instant_key_preview: {
49829
+ description:
49830
+ 'Represents a preview of an Instant Key with hotel, guest, and access information.',
49831
+ properties: {
49832
+ access: {
49833
+ items: {
49834
+ properties: {
49835
+ available: { type: 'boolean' },
49836
+ hours: { type: 'string' },
49837
+ icon: { type: 'string' },
49838
+ location: { type: 'string' },
49839
+ name: { type: 'string' },
49840
+ },
49841
+ required: ['name', 'icon', 'available'],
49842
+ type: 'object',
49843
+ },
49844
+ type: 'array',
49845
+ },
49846
+ created_at: { type: 'string' },
49847
+ expires_at: { type: 'string' },
49848
+ guest: {
49849
+ properties: {
49850
+ check_in_date: { type: 'string' },
49851
+ check_out_date: { type: 'string' },
49852
+ email: { type: 'string' },
49853
+ first_name: { type: 'string' },
49854
+ full_name: { type: 'string' },
49855
+ last_name: { type: 'string' },
49856
+ },
49857
+ required: [
49858
+ 'first_name',
49859
+ 'last_name',
49860
+ 'full_name',
49861
+ 'email',
49862
+ 'check_in_date',
49863
+ 'check_out_date',
49864
+ ],
49865
+ type: 'object',
49866
+ },
49867
+ hotel: {
49868
+ properties: {
49869
+ accent_color: { type: 'string' },
49870
+ hotel_name: { type: 'string' },
49871
+ logo_url: { type: 'string' },
49872
+ primary_color: { type: 'string' },
49873
+ secondary_color: { type: 'string' },
49874
+ verified: { type: 'boolean' },
49875
+ },
49876
+ required: [
49877
+ 'hotel_name',
49878
+ 'primary_color',
49879
+ 'accent_color',
49880
+ 'secondary_color',
49881
+ 'verified',
49882
+ ],
49883
+ type: 'object',
49884
+ },
49885
+ key_status: {
49886
+ enum: ['ready', 'expired', 'used'],
49887
+ type: 'string',
49888
+ },
49889
+ room: {
49890
+ properties: {
49891
+ floor: { format: 'float', type: 'number' },
49892
+ room_number: { type: 'string' },
49893
+ room_type: { type: 'string' },
49894
+ },
49895
+ required: ['room_number', 'room_type', 'floor'],
49896
+ type: 'object',
49897
+ },
49898
+ shortcode: { type: 'string' },
49899
+ support_email: { type: 'string' },
49900
+ support_phone: { type: 'string' },
49901
+ updated_at: { type: 'string' },
49902
+ },
49903
+ required: [
49904
+ 'shortcode',
49905
+ 'hotel',
49906
+ 'guest',
49907
+ 'room',
49908
+ 'access',
49909
+ 'key_status',
49910
+ 'support_phone',
49911
+ 'support_email',
49912
+ 'created_at',
49913
+ 'updated_at',
49914
+ 'expires_at',
49915
+ ],
49916
+ type: 'object',
49917
+ 'x-route-path': '/instant_keys/preview',
49918
+ },
49919
+ ok: { type: 'boolean' },
49920
+ },
49921
+ required: ['instant_key_preview', 'ok'],
49922
+ type: 'object',
49923
+ },
49924
+ },
49925
+ },
49926
+ description: 'OK',
49927
+ },
49928
+ 400: { description: 'Bad Request' },
49929
+ 401: { description: 'Unauthorized' },
49930
+ },
49931
+ security: [{ certified_client: [] }],
49932
+ summary: '/seam/instant_key/v1/preview/get',
49933
+ tags: [],
49934
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
49935
+ 'x-fern-sdk-method-name': 'get',
49936
+ 'x-fern-sdk-return-value': 'instant_key_preview',
49937
+ 'x-response-key': 'instant_key_preview',
49938
+ 'x-title': 'Preview Instant Key',
49939
+ 'x-undocumented': 'Seam Instant Key only.',
49940
+ },
49941
+ post: {
49942
+ operationId: 'seamInstantKeyV1PreviewGetPost',
49943
+ requestBody: {
49944
+ content: {
49945
+ 'application/json': {
49946
+ schema: {
49947
+ properties: {
49948
+ instant_key_url: {
49949
+ description:
49950
+ 'The short code of the instant key to preview.',
49951
+ type: 'string',
49952
+ },
49953
+ },
49954
+ required: ['instant_key_url'],
49955
+ type: 'object',
49956
+ },
49957
+ },
49958
+ },
49959
+ },
49960
+ responses: {
49961
+ 200: {
49962
+ content: {
49963
+ 'application/json': {
49964
+ schema: {
49965
+ properties: {
49966
+ instant_key_preview: {
49967
+ description:
49968
+ 'Represents a preview of an Instant Key with hotel, guest, and access information.',
49969
+ properties: {
49970
+ access: {
49971
+ items: {
49972
+ properties: {
49973
+ available: { type: 'boolean' },
49974
+ hours: { type: 'string' },
49975
+ icon: { type: 'string' },
49976
+ location: { type: 'string' },
49977
+ name: { type: 'string' },
49978
+ },
49979
+ required: ['name', 'icon', 'available'],
49980
+ type: 'object',
49981
+ },
49982
+ type: 'array',
49983
+ },
49984
+ created_at: { type: 'string' },
49985
+ expires_at: { type: 'string' },
49986
+ guest: {
49987
+ properties: {
49988
+ check_in_date: { type: 'string' },
49989
+ check_out_date: { type: 'string' },
49990
+ email: { type: 'string' },
49991
+ first_name: { type: 'string' },
49992
+ full_name: { type: 'string' },
49993
+ last_name: { type: 'string' },
49994
+ },
49995
+ required: [
49996
+ 'first_name',
49997
+ 'last_name',
49998
+ 'full_name',
49999
+ 'email',
50000
+ 'check_in_date',
50001
+ 'check_out_date',
50002
+ ],
50003
+ type: 'object',
50004
+ },
50005
+ hotel: {
50006
+ properties: {
50007
+ accent_color: { type: 'string' },
50008
+ hotel_name: { type: 'string' },
50009
+ logo_url: { type: 'string' },
50010
+ primary_color: { type: 'string' },
50011
+ secondary_color: { type: 'string' },
50012
+ verified: { type: 'boolean' },
50013
+ },
50014
+ required: [
50015
+ 'hotel_name',
50016
+ 'primary_color',
50017
+ 'accent_color',
50018
+ 'secondary_color',
50019
+ 'verified',
50020
+ ],
50021
+ type: 'object',
50022
+ },
50023
+ key_status: {
50024
+ enum: ['ready', 'expired', 'used'],
50025
+ type: 'string',
50026
+ },
50027
+ room: {
50028
+ properties: {
50029
+ floor: { format: 'float', type: 'number' },
50030
+ room_number: { type: 'string' },
50031
+ room_type: { type: 'string' },
50032
+ },
50033
+ required: ['room_number', 'room_type', 'floor'],
50034
+ type: 'object',
50035
+ },
50036
+ shortcode: { type: 'string' },
50037
+ support_email: { type: 'string' },
50038
+ support_phone: { type: 'string' },
50039
+ updated_at: { type: 'string' },
50040
+ },
50041
+ required: [
50042
+ 'shortcode',
50043
+ 'hotel',
50044
+ 'guest',
50045
+ 'room',
50046
+ 'access',
50047
+ 'key_status',
50048
+ 'support_phone',
50049
+ 'support_email',
50050
+ 'created_at',
50051
+ 'updated_at',
50052
+ 'expires_at',
50053
+ ],
50054
+ type: 'object',
50055
+ 'x-route-path': '/instant_keys/preview',
50056
+ },
50057
+ ok: { type: 'boolean' },
50058
+ },
50059
+ required: ['instant_key_preview', 'ok'],
50060
+ type: 'object',
50061
+ },
50062
+ },
50063
+ },
50064
+ description: 'OK',
50065
+ },
50066
+ 400: { description: 'Bad Request' },
50067
+ 401: { description: 'Unauthorized' },
50068
+ },
50069
+ security: [{ certified_client: [] }],
50070
+ summary: '/seam/instant_key/v1/preview/get',
50071
+ tags: [],
50072
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
50073
+ 'x-fern-sdk-method-name': 'get',
50074
+ 'x-fern-sdk-return-value': 'instant_key_preview',
50075
+ 'x-response-key': 'instant_key_preview',
50076
+ 'x-title': 'Preview Instant Key',
50077
+ 'x-undocumented': 'Seam Instant Key only.',
50078
+ },
50079
+ },
49604
50080
  '/seam/mobile_sdk/v1/acs/credentials/list': {
49605
50081
  get: {
49606
50082
  description:
@@ -36031,6 +36031,42 @@ export type Routes = {
36031
36031
  }
36032
36032
  /** Whether the portal is embedded in another application. */
36033
36033
  is_embedded?: boolean
36034
+ /** Configuration for the landing page when the portal loads. */
36035
+ landing_page?:
36036
+ | {
36037
+ manage?:
36038
+ | (
36039
+ | {
36040
+ space_key: string
36041
+ }
36042
+ | {
36043
+ property_key: string
36044
+ }
36045
+ | {
36046
+ room_key: string
36047
+ }
36048
+ | {
36049
+ common_area_key: string
36050
+ }
36051
+ | {
36052
+ unit_key: string
36053
+ }
36054
+ | {
36055
+ facility_key: string
36056
+ }
36057
+ | {
36058
+ building_key: string
36059
+ }
36060
+ | {
36061
+ listing_key: string
36062
+ }
36063
+ | {
36064
+ property_listing_key: string
36065
+ }
36066
+ )
36067
+ | undefined
36068
+ }
36069
+ | undefined
36034
36070
  } & {
36035
36071
  customer_data?:
36036
36072
  | {
@@ -68618,6 +68654,41 @@ export type Routes = {
68618
68654
  }
68619
68655
  | undefined
68620
68656
  is_embedded?: boolean | undefined
68657
+ landing_page?:
68658
+ | {
68659
+ manage?:
68660
+ | (
68661
+ | {
68662
+ space_key: string
68663
+ }
68664
+ | {
68665
+ property_key: string
68666
+ }
68667
+ | {
68668
+ room_key: string
68669
+ }
68670
+ | {
68671
+ common_area_key: string
68672
+ }
68673
+ | {
68674
+ unit_key: string
68675
+ }
68676
+ | {
68677
+ facility_key: string
68678
+ }
68679
+ | {
68680
+ building_key: string
68681
+ }
68682
+ | {
68683
+ listing_key: string
68684
+ }
68685
+ | {
68686
+ property_listing_key: string
68687
+ }
68688
+ )
68689
+ | undefined
68690
+ }
68691
+ | undefined
68621
68692
  /** Business vertical of the customer portal. */
68622
68693
  business_vertical?:
68623
68694
  | (
@@ -68720,6 +68791,57 @@ export type Routes = {
68720
68791
  }
68721
68792
  }
68722
68793
  }
68794
+ '/seam/instant_key/v1/preview/get': {
68795
+ route: '/seam/instant_key/v1/preview/get'
68796
+ method: 'GET' | 'POST'
68797
+ queryParams: {}
68798
+ jsonBody: {
68799
+ /** The short code of the instant key to preview. */
68800
+ instant_key_url: string
68801
+ }
68802
+ commonParams: {}
68803
+ formData: {}
68804
+ jsonResponse: {
68805
+ /** Represents a preview of an Instant Key with hotel, guest, and access information. */
68806
+ instant_key_preview: {
68807
+ shortcode: string
68808
+ hotel: {
68809
+ hotel_name: string
68810
+ primary_color: string
68811
+ accent_color: string
68812
+ secondary_color: string
68813
+ logo_url?: string | undefined
68814
+ verified: boolean
68815
+ }
68816
+ guest: {
68817
+ first_name: string
68818
+ last_name: string
68819
+ full_name: string
68820
+ email: string
68821
+ check_in_date: string
68822
+ check_out_date: string
68823
+ }
68824
+ room: {
68825
+ room_number: string
68826
+ room_type: string
68827
+ floor: number
68828
+ }
68829
+ access: {
68830
+ name: string
68831
+ icon: string
68832
+ hours?: string | undefined
68833
+ location?: string | undefined
68834
+ available: boolean
68835
+ }[]
68836
+ key_status: 'ready' | 'expired' | 'used'
68837
+ support_phone: string
68838
+ support_email: string
68839
+ created_at: string
68840
+ updated_at: string
68841
+ expires_at: string
68842
+ }
68843
+ }
68844
+ }
68723
68845
  '/seam/mobile_sdk/v1/acs/credentials/list': {
68724
68846
  route: '/seam/mobile_sdk/v1/acs/credentials/list'
68725
68847
  method: 'GET' | 'POST'