@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.
package/dist/connect.cjs CHANGED
@@ -40630,6 +40630,71 @@ var openapi_default = {
40630
40630
  default: false,
40631
40631
  description: "Whether the portal is embedded in another application.",
40632
40632
  type: "boolean"
40633
+ },
40634
+ landing_page: {
40635
+ description: "Configuration for the landing page when the portal loads.",
40636
+ properties: {
40637
+ manage: {
40638
+ oneOf: [
40639
+ {
40640
+ properties: { space_key: { type: "string" } },
40641
+ required: ["space_key"],
40642
+ type: "object"
40643
+ },
40644
+ {
40645
+ properties: {
40646
+ property_key: { type: "string" }
40647
+ },
40648
+ required: ["property_key"],
40649
+ type: "object"
40650
+ },
40651
+ {
40652
+ properties: { room_key: { type: "string" } },
40653
+ required: ["room_key"],
40654
+ type: "object"
40655
+ },
40656
+ {
40657
+ properties: {
40658
+ common_area_key: { type: "string" }
40659
+ },
40660
+ required: ["common_area_key"],
40661
+ type: "object"
40662
+ },
40663
+ {
40664
+ properties: { unit_key: { type: "string" } },
40665
+ required: ["unit_key"],
40666
+ type: "object"
40667
+ },
40668
+ {
40669
+ properties: {
40670
+ facility_key: { type: "string" }
40671
+ },
40672
+ required: ["facility_key"],
40673
+ type: "object"
40674
+ },
40675
+ {
40676
+ properties: {
40677
+ building_key: { type: "string" }
40678
+ },
40679
+ required: ["building_key"],
40680
+ type: "object"
40681
+ },
40682
+ {
40683
+ properties: { listing_key: { type: "string" } },
40684
+ required: ["listing_key"],
40685
+ type: "object"
40686
+ },
40687
+ {
40688
+ properties: {
40689
+ property_listing_key: { type: "string" }
40690
+ },
40691
+ required: ["property_listing_key"],
40692
+ type: "object"
40693
+ }
40694
+ ]
40695
+ }
40696
+ },
40697
+ type: "object"
40633
40698
  }
40634
40699
  },
40635
40700
  type: "object"
@@ -50883,7 +50948,73 @@ var openapi_default = {
50883
50948
  },
50884
50949
  type: "object"
50885
50950
  },
50886
- is_embedded: { type: "boolean" }
50951
+ is_embedded: { type: "boolean" },
50952
+ landing_page: {
50953
+ properties: {
50954
+ manage: {
50955
+ oneOf: [
50956
+ {
50957
+ properties: { space_key: { type: "string" } },
50958
+ required: ["space_key"],
50959
+ type: "object"
50960
+ },
50961
+ {
50962
+ properties: {
50963
+ property_key: { type: "string" }
50964
+ },
50965
+ required: ["property_key"],
50966
+ type: "object"
50967
+ },
50968
+ {
50969
+ properties: { room_key: { type: "string" } },
50970
+ required: ["room_key"],
50971
+ type: "object"
50972
+ },
50973
+ {
50974
+ properties: {
50975
+ common_area_key: { type: "string" }
50976
+ },
50977
+ required: ["common_area_key"],
50978
+ type: "object"
50979
+ },
50980
+ {
50981
+ properties: { unit_key: { type: "string" } },
50982
+ required: ["unit_key"],
50983
+ type: "object"
50984
+ },
50985
+ {
50986
+ properties: {
50987
+ facility_key: { type: "string" }
50988
+ },
50989
+ required: ["facility_key"],
50990
+ type: "object"
50991
+ },
50992
+ {
50993
+ properties: {
50994
+ building_key: { type: "string" }
50995
+ },
50996
+ required: ["building_key"],
50997
+ type: "object"
50998
+ },
50999
+ {
51000
+ properties: {
51001
+ listing_key: { type: "string" }
51002
+ },
51003
+ required: ["listing_key"],
51004
+ type: "object"
51005
+ },
51006
+ {
51007
+ properties: {
51008
+ property_listing_key: { type: "string" }
51009
+ },
51010
+ required: ["property_listing_key"],
51011
+ type: "object"
51012
+ }
51013
+ ]
51014
+ }
51015
+ },
51016
+ type: "object"
51017
+ }
50887
51018
  },
50888
51019
  type: "object"
50889
51020
  },
@@ -50977,7 +51108,73 @@ var openapi_default = {
50977
51108
  },
50978
51109
  type: "object"
50979
51110
  },
50980
- is_embedded: { type: "boolean" }
51111
+ is_embedded: { type: "boolean" },
51112
+ landing_page: {
51113
+ properties: {
51114
+ manage: {
51115
+ oneOf: [
51116
+ {
51117
+ properties: { space_key: { type: "string" } },
51118
+ required: ["space_key"],
51119
+ type: "object"
51120
+ },
51121
+ {
51122
+ properties: {
51123
+ property_key: { type: "string" }
51124
+ },
51125
+ required: ["property_key"],
51126
+ type: "object"
51127
+ },
51128
+ {
51129
+ properties: { room_key: { type: "string" } },
51130
+ required: ["room_key"],
51131
+ type: "object"
51132
+ },
51133
+ {
51134
+ properties: {
51135
+ common_area_key: { type: "string" }
51136
+ },
51137
+ required: ["common_area_key"],
51138
+ type: "object"
51139
+ },
51140
+ {
51141
+ properties: { unit_key: { type: "string" } },
51142
+ required: ["unit_key"],
51143
+ type: "object"
51144
+ },
51145
+ {
51146
+ properties: {
51147
+ facility_key: { type: "string" }
51148
+ },
51149
+ required: ["facility_key"],
51150
+ type: "object"
51151
+ },
51152
+ {
51153
+ properties: {
51154
+ building_key: { type: "string" }
51155
+ },
51156
+ required: ["building_key"],
51157
+ type: "object"
51158
+ },
51159
+ {
51160
+ properties: {
51161
+ listing_key: { type: "string" }
51162
+ },
51163
+ required: ["listing_key"],
51164
+ type: "object"
51165
+ },
51166
+ {
51167
+ properties: {
51168
+ property_listing_key: { type: "string" }
51169
+ },
51170
+ required: ["property_listing_key"],
51171
+ type: "object"
51172
+ }
51173
+ ]
51174
+ }
51175
+ },
51176
+ type: "object"
51177
+ }
50981
51178
  },
50982
51179
  type: "object"
50983
51180
  },
@@ -51249,6 +51446,280 @@ var openapi_default = {
51249
51446
  "x-undocumented": "Seam Instant Key only."
51250
51447
  }
51251
51448
  },
51449
+ "/seam/instant_key/v1/preview/get": {
51450
+ get: {
51451
+ operationId: "seamInstantKeyV1PreviewGetGet",
51452
+ requestBody: {
51453
+ content: {
51454
+ "application/json": {
51455
+ schema: {
51456
+ properties: {
51457
+ instant_key_url: {
51458
+ description: "The short code of the instant key to preview.",
51459
+ type: "string"
51460
+ }
51461
+ },
51462
+ required: ["instant_key_url"],
51463
+ type: "object"
51464
+ }
51465
+ }
51466
+ }
51467
+ },
51468
+ responses: {
51469
+ 200: {
51470
+ content: {
51471
+ "application/json": {
51472
+ schema: {
51473
+ properties: {
51474
+ instant_key_preview: {
51475
+ description: "Represents a preview of an Instant Key with hotel, guest, and access information.",
51476
+ properties: {
51477
+ access: {
51478
+ items: {
51479
+ properties: {
51480
+ available: { type: "boolean" },
51481
+ hours: { type: "string" },
51482
+ icon: { type: "string" },
51483
+ location: { type: "string" },
51484
+ name: { type: "string" }
51485
+ },
51486
+ required: ["name", "icon", "available"],
51487
+ type: "object"
51488
+ },
51489
+ type: "array"
51490
+ },
51491
+ created_at: { type: "string" },
51492
+ expires_at: { type: "string" },
51493
+ guest: {
51494
+ properties: {
51495
+ check_in_date: { type: "string" },
51496
+ check_out_date: { type: "string" },
51497
+ email: { type: "string" },
51498
+ first_name: { type: "string" },
51499
+ full_name: { type: "string" },
51500
+ last_name: { type: "string" }
51501
+ },
51502
+ required: [
51503
+ "first_name",
51504
+ "last_name",
51505
+ "full_name",
51506
+ "email",
51507
+ "check_in_date",
51508
+ "check_out_date"
51509
+ ],
51510
+ type: "object"
51511
+ },
51512
+ hotel: {
51513
+ properties: {
51514
+ accent_color: { type: "string" },
51515
+ hotel_name: { type: "string" },
51516
+ logo_url: { type: "string" },
51517
+ primary_color: { type: "string" },
51518
+ secondary_color: { type: "string" },
51519
+ verified: { type: "boolean" }
51520
+ },
51521
+ required: [
51522
+ "hotel_name",
51523
+ "primary_color",
51524
+ "accent_color",
51525
+ "secondary_color",
51526
+ "verified"
51527
+ ],
51528
+ type: "object"
51529
+ },
51530
+ key_status: {
51531
+ enum: ["ready", "expired", "used"],
51532
+ type: "string"
51533
+ },
51534
+ room: {
51535
+ properties: {
51536
+ floor: { format: "float", type: "number" },
51537
+ room_number: { type: "string" },
51538
+ room_type: { type: "string" }
51539
+ },
51540
+ required: ["room_number", "room_type", "floor"],
51541
+ type: "object"
51542
+ },
51543
+ shortcode: { type: "string" },
51544
+ support_email: { type: "string" },
51545
+ support_phone: { type: "string" },
51546
+ updated_at: { type: "string" }
51547
+ },
51548
+ required: [
51549
+ "shortcode",
51550
+ "hotel",
51551
+ "guest",
51552
+ "room",
51553
+ "access",
51554
+ "key_status",
51555
+ "support_phone",
51556
+ "support_email",
51557
+ "created_at",
51558
+ "updated_at",
51559
+ "expires_at"
51560
+ ],
51561
+ type: "object",
51562
+ "x-route-path": "/instant_keys/preview"
51563
+ },
51564
+ ok: { type: "boolean" }
51565
+ },
51566
+ required: ["instant_key_preview", "ok"],
51567
+ type: "object"
51568
+ }
51569
+ }
51570
+ },
51571
+ description: "OK"
51572
+ },
51573
+ 400: { description: "Bad Request" },
51574
+ 401: { description: "Unauthorized" }
51575
+ },
51576
+ security: [{ certified_client: [] }],
51577
+ summary: "/seam/instant_key/v1/preview/get",
51578
+ tags: [],
51579
+ "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"],
51580
+ "x-fern-sdk-method-name": "get",
51581
+ "x-fern-sdk-return-value": "instant_key_preview",
51582
+ "x-response-key": "instant_key_preview",
51583
+ "x-title": "Preview Instant Key",
51584
+ "x-undocumented": "Seam Instant Key only."
51585
+ },
51586
+ post: {
51587
+ operationId: "seamInstantKeyV1PreviewGetPost",
51588
+ requestBody: {
51589
+ content: {
51590
+ "application/json": {
51591
+ schema: {
51592
+ properties: {
51593
+ instant_key_url: {
51594
+ description: "The short code of the instant key to preview.",
51595
+ type: "string"
51596
+ }
51597
+ },
51598
+ required: ["instant_key_url"],
51599
+ type: "object"
51600
+ }
51601
+ }
51602
+ }
51603
+ },
51604
+ responses: {
51605
+ 200: {
51606
+ content: {
51607
+ "application/json": {
51608
+ schema: {
51609
+ properties: {
51610
+ instant_key_preview: {
51611
+ description: "Represents a preview of an Instant Key with hotel, guest, and access information.",
51612
+ properties: {
51613
+ access: {
51614
+ items: {
51615
+ properties: {
51616
+ available: { type: "boolean" },
51617
+ hours: { type: "string" },
51618
+ icon: { type: "string" },
51619
+ location: { type: "string" },
51620
+ name: { type: "string" }
51621
+ },
51622
+ required: ["name", "icon", "available"],
51623
+ type: "object"
51624
+ },
51625
+ type: "array"
51626
+ },
51627
+ created_at: { type: "string" },
51628
+ expires_at: { type: "string" },
51629
+ guest: {
51630
+ properties: {
51631
+ check_in_date: { type: "string" },
51632
+ check_out_date: { type: "string" },
51633
+ email: { type: "string" },
51634
+ first_name: { type: "string" },
51635
+ full_name: { type: "string" },
51636
+ last_name: { type: "string" }
51637
+ },
51638
+ required: [
51639
+ "first_name",
51640
+ "last_name",
51641
+ "full_name",
51642
+ "email",
51643
+ "check_in_date",
51644
+ "check_out_date"
51645
+ ],
51646
+ type: "object"
51647
+ },
51648
+ hotel: {
51649
+ properties: {
51650
+ accent_color: { type: "string" },
51651
+ hotel_name: { type: "string" },
51652
+ logo_url: { type: "string" },
51653
+ primary_color: { type: "string" },
51654
+ secondary_color: { type: "string" },
51655
+ verified: { type: "boolean" }
51656
+ },
51657
+ required: [
51658
+ "hotel_name",
51659
+ "primary_color",
51660
+ "accent_color",
51661
+ "secondary_color",
51662
+ "verified"
51663
+ ],
51664
+ type: "object"
51665
+ },
51666
+ key_status: {
51667
+ enum: ["ready", "expired", "used"],
51668
+ type: "string"
51669
+ },
51670
+ room: {
51671
+ properties: {
51672
+ floor: { format: "float", type: "number" },
51673
+ room_number: { type: "string" },
51674
+ room_type: { type: "string" }
51675
+ },
51676
+ required: ["room_number", "room_type", "floor"],
51677
+ type: "object"
51678
+ },
51679
+ shortcode: { type: "string" },
51680
+ support_email: { type: "string" },
51681
+ support_phone: { type: "string" },
51682
+ updated_at: { type: "string" }
51683
+ },
51684
+ required: [
51685
+ "shortcode",
51686
+ "hotel",
51687
+ "guest",
51688
+ "room",
51689
+ "access",
51690
+ "key_status",
51691
+ "support_phone",
51692
+ "support_email",
51693
+ "created_at",
51694
+ "updated_at",
51695
+ "expires_at"
51696
+ ],
51697
+ type: "object",
51698
+ "x-route-path": "/instant_keys/preview"
51699
+ },
51700
+ ok: { type: "boolean" }
51701
+ },
51702
+ required: ["instant_key_preview", "ok"],
51703
+ type: "object"
51704
+ }
51705
+ }
51706
+ },
51707
+ description: "OK"
51708
+ },
51709
+ 400: { description: "Bad Request" },
51710
+ 401: { description: "Unauthorized" }
51711
+ },
51712
+ security: [{ certified_client: [] }],
51713
+ summary: "/seam/instant_key/v1/preview/get",
51714
+ tags: [],
51715
+ "x-fern-sdk-group-name": ["seam", "instant_key", "v1", "preview"],
51716
+ "x-fern-sdk-method-name": "get",
51717
+ "x-fern-sdk-return-value": "instant_key_preview",
51718
+ "x-response-key": "instant_key_preview",
51719
+ "x-title": "Preview Instant Key",
51720
+ "x-undocumented": "Seam Instant Key only."
51721
+ }
51722
+ },
51252
51723
  "/seam/mobile_sdk/v1/acs/credentials/list": {
51253
51724
  get: {
51254
51725
  description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",