@seamapi/types 1.534.0 → 1.536.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 +274 -98
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +397 -49
- package/dist/index.cjs +274 -98
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/instant-keys/index.d.ts +1 -0
- package/lib/seam/connect/models/instant-keys/index.js +1 -0
- package/lib/seam/connect/models/instant-keys/index.js.map +1 -1
- package/lib/seam/connect/models/instant-keys/instant-key-preview.d.ts +240 -0
- package/lib/seam/connect/models/instant-keys/instant-key-preview.js +48 -0
- package/lib/seam/connect/models/instant-keys/instant-key-preview.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +346 -35
- package/lib/seam/connect/openapi.js +274 -98
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +51 -14
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/instant-keys/index.ts +1 -0
- package/src/lib/seam/connect/models/instant-keys/instant-key-preview.ts +58 -0
- package/src/lib/seam/connect/openapi.ts +278 -112
- package/src/lib/seam/connect/route-types.ts +51 -14
|
@@ -30331,24 +30331,6 @@ export default {
|
|
|
30331
30331
|
type: 'string',
|
|
30332
30332
|
},
|
|
30333
30333
|
},
|
|
30334
|
-
{
|
|
30335
|
-
in: 'query',
|
|
30336
|
-
name: 'access_grant_id',
|
|
30337
|
-
schema: {
|
|
30338
|
-
description: 'ID of the access grant for which you want to retrieve all entrances.',
|
|
30339
|
-
format: 'uuid',
|
|
30340
|
-
type: 'string',
|
|
30341
|
-
},
|
|
30342
|
-
},
|
|
30343
|
-
{
|
|
30344
|
-
in: 'query',
|
|
30345
|
-
name: 'access_method_id',
|
|
30346
|
-
schema: {
|
|
30347
|
-
description: 'ID of the access method for which you want to retrieve all entrances.',
|
|
30348
|
-
format: 'uuid',
|
|
30349
|
-
type: 'string',
|
|
30350
|
-
},
|
|
30351
|
-
},
|
|
30352
30334
|
{
|
|
30353
30335
|
in: 'query',
|
|
30354
30336
|
name: 'connected_account_id',
|
|
@@ -30443,16 +30425,6 @@ export default {
|
|
|
30443
30425
|
'application/json': {
|
|
30444
30426
|
schema: {
|
|
30445
30427
|
properties: {
|
|
30446
|
-
access_grant_id: {
|
|
30447
|
-
description: 'ID of the access grant for which you want to retrieve all entrances.',
|
|
30448
|
-
format: 'uuid',
|
|
30449
|
-
type: 'string',
|
|
30450
|
-
},
|
|
30451
|
-
access_method_id: {
|
|
30452
|
-
description: 'ID of the access method for which you want to retrieve all entrances.',
|
|
30453
|
-
format: 'uuid',
|
|
30454
|
-
type: 'string',
|
|
30455
|
-
},
|
|
30456
30428
|
acs_credential_id: {
|
|
30457
30429
|
description: 'ID of the credential for which you want to retrieve all entrances.',
|
|
30458
30430
|
format: 'uuid',
|
|
@@ -37223,15 +37195,6 @@ export default {
|
|
|
37223
37195
|
type: 'string',
|
|
37224
37196
|
},
|
|
37225
37197
|
},
|
|
37226
|
-
{
|
|
37227
|
-
in: 'query',
|
|
37228
|
-
name: 'access_method_id',
|
|
37229
|
-
schema: {
|
|
37230
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
37231
|
-
format: 'uuid',
|
|
37232
|
-
type: 'string',
|
|
37233
|
-
},
|
|
37234
|
-
},
|
|
37235
37198
|
],
|
|
37236
37199
|
responses: {
|
|
37237
37200
|
200: {
|
|
@@ -37279,11 +37242,6 @@ export default {
|
|
|
37279
37242
|
'application/json': {
|
|
37280
37243
|
schema: {
|
|
37281
37244
|
properties: {
|
|
37282
|
-
access_method_id: {
|
|
37283
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
37284
|
-
format: 'uuid',
|
|
37285
|
-
type: 'string',
|
|
37286
|
-
},
|
|
37287
37245
|
connect_webview_id: {
|
|
37288
37246
|
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
37289
37247
|
format: 'uuid',
|
|
@@ -38515,15 +38473,6 @@ export default {
|
|
|
38515
38473
|
type: 'string',
|
|
38516
38474
|
},
|
|
38517
38475
|
},
|
|
38518
|
-
{
|
|
38519
|
-
in: 'query',
|
|
38520
|
-
name: 'access_method_id',
|
|
38521
|
-
schema: {
|
|
38522
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
38523
|
-
format: 'uuid',
|
|
38524
|
-
type: 'string',
|
|
38525
|
-
},
|
|
38526
|
-
},
|
|
38527
38476
|
],
|
|
38528
38477
|
responses: {
|
|
38529
38478
|
200: {
|
|
@@ -38568,11 +38517,6 @@ export default {
|
|
|
38568
38517
|
'application/json': {
|
|
38569
38518
|
schema: {
|
|
38570
38519
|
properties: {
|
|
38571
|
-
access_method_id: {
|
|
38572
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
38573
|
-
format: 'uuid',
|
|
38574
|
-
type: 'string',
|
|
38575
|
-
},
|
|
38576
38520
|
connect_webview_id: {
|
|
38577
38521
|
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
38578
38522
|
format: 'uuid',
|
|
@@ -40755,15 +40699,6 @@ export default {
|
|
|
40755
40699
|
type: 'string',
|
|
40756
40700
|
},
|
|
40757
40701
|
},
|
|
40758
|
-
{
|
|
40759
|
-
in: 'query',
|
|
40760
|
-
name: 'access_method_id',
|
|
40761
|
-
schema: {
|
|
40762
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
40763
|
-
format: 'uuid',
|
|
40764
|
-
type: 'string',
|
|
40765
|
-
},
|
|
40766
|
-
},
|
|
40767
40702
|
],
|
|
40768
40703
|
responses: {
|
|
40769
40704
|
200: {
|
|
@@ -40813,11 +40748,6 @@ export default {
|
|
|
40813
40748
|
'application/json': {
|
|
40814
40749
|
schema: {
|
|
40815
40750
|
properties: {
|
|
40816
|
-
access_method_id: {
|
|
40817
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
40818
|
-
format: 'uuid',
|
|
40819
|
-
type: 'string',
|
|
40820
|
-
},
|
|
40821
40751
|
connect_webview_id: {
|
|
40822
40752
|
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
40823
40753
|
format: 'uuid',
|
|
@@ -41547,15 +41477,6 @@ export default {
|
|
|
41547
41477
|
type: 'string',
|
|
41548
41478
|
},
|
|
41549
41479
|
},
|
|
41550
|
-
{
|
|
41551
|
-
in: 'query',
|
|
41552
|
-
name: 'access_method_id',
|
|
41553
|
-
schema: {
|
|
41554
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
41555
|
-
format: 'uuid',
|
|
41556
|
-
type: 'string',
|
|
41557
|
-
},
|
|
41558
|
-
},
|
|
41559
41480
|
],
|
|
41560
41481
|
responses: {
|
|
41561
41482
|
200: {
|
|
@@ -41605,11 +41526,6 @@ export default {
|
|
|
41605
41526
|
'application/json': {
|
|
41606
41527
|
schema: {
|
|
41607
41528
|
properties: {
|
|
41608
|
-
access_method_id: {
|
|
41609
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
41610
|
-
format: 'uuid',
|
|
41611
|
-
type: 'string',
|
|
41612
|
-
},
|
|
41613
41529
|
connect_webview_id: {
|
|
41614
41530
|
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
41615
41531
|
format: 'uuid',
|
|
@@ -45763,6 +45679,280 @@ export default {
|
|
|
45763
45679
|
'x-undocumented': 'Seam Instant Key only.',
|
|
45764
45680
|
},
|
|
45765
45681
|
},
|
|
45682
|
+
'/seam/instant_key/v1/preview/get': {
|
|
45683
|
+
get: {
|
|
45684
|
+
operationId: 'seamInstantKeyV1PreviewGetGet',
|
|
45685
|
+
requestBody: {
|
|
45686
|
+
content: {
|
|
45687
|
+
'application/json': {
|
|
45688
|
+
schema: {
|
|
45689
|
+
properties: {
|
|
45690
|
+
instant_key_url: {
|
|
45691
|
+
description: 'The short code of the instant key to preview.',
|
|
45692
|
+
type: 'string',
|
|
45693
|
+
},
|
|
45694
|
+
},
|
|
45695
|
+
required: ['instant_key_url'],
|
|
45696
|
+
type: 'object',
|
|
45697
|
+
},
|
|
45698
|
+
},
|
|
45699
|
+
},
|
|
45700
|
+
},
|
|
45701
|
+
responses: {
|
|
45702
|
+
200: {
|
|
45703
|
+
content: {
|
|
45704
|
+
'application/json': {
|
|
45705
|
+
schema: {
|
|
45706
|
+
properties: {
|
|
45707
|
+
instant_key_preview: {
|
|
45708
|
+
description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
|
|
45709
|
+
properties: {
|
|
45710
|
+
access: {
|
|
45711
|
+
items: {
|
|
45712
|
+
properties: {
|
|
45713
|
+
available: { type: 'boolean' },
|
|
45714
|
+
hours: { type: 'string' },
|
|
45715
|
+
icon: { type: 'string' },
|
|
45716
|
+
location: { type: 'string' },
|
|
45717
|
+
name: { type: 'string' },
|
|
45718
|
+
},
|
|
45719
|
+
required: ['name', 'icon', 'available'],
|
|
45720
|
+
type: 'object',
|
|
45721
|
+
},
|
|
45722
|
+
type: 'array',
|
|
45723
|
+
},
|
|
45724
|
+
created_at: { type: 'string' },
|
|
45725
|
+
expires_at: { type: 'string' },
|
|
45726
|
+
guest: {
|
|
45727
|
+
properties: {
|
|
45728
|
+
check_in_date: { type: 'string' },
|
|
45729
|
+
check_out_date: { type: 'string' },
|
|
45730
|
+
email: { type: 'string' },
|
|
45731
|
+
first_name: { type: 'string' },
|
|
45732
|
+
full_name: { type: 'string' },
|
|
45733
|
+
last_name: { type: 'string' },
|
|
45734
|
+
},
|
|
45735
|
+
required: [
|
|
45736
|
+
'first_name',
|
|
45737
|
+
'last_name',
|
|
45738
|
+
'full_name',
|
|
45739
|
+
'email',
|
|
45740
|
+
'check_in_date',
|
|
45741
|
+
'check_out_date',
|
|
45742
|
+
],
|
|
45743
|
+
type: 'object',
|
|
45744
|
+
},
|
|
45745
|
+
hotel: {
|
|
45746
|
+
properties: {
|
|
45747
|
+
accent_color: { type: 'string' },
|
|
45748
|
+
hotel_name: { type: 'string' },
|
|
45749
|
+
logo_url: { type: 'string' },
|
|
45750
|
+
primary_color: { type: 'string' },
|
|
45751
|
+
secondary_color: { type: 'string' },
|
|
45752
|
+
verified: { type: 'boolean' },
|
|
45753
|
+
},
|
|
45754
|
+
required: [
|
|
45755
|
+
'hotel_name',
|
|
45756
|
+
'primary_color',
|
|
45757
|
+
'accent_color',
|
|
45758
|
+
'secondary_color',
|
|
45759
|
+
'verified',
|
|
45760
|
+
],
|
|
45761
|
+
type: 'object',
|
|
45762
|
+
},
|
|
45763
|
+
key_status: {
|
|
45764
|
+
enum: ['ready', 'expired', 'used'],
|
|
45765
|
+
type: 'string',
|
|
45766
|
+
},
|
|
45767
|
+
room: {
|
|
45768
|
+
properties: {
|
|
45769
|
+
floor: { format: 'float', type: 'number' },
|
|
45770
|
+
room_number: { type: 'string' },
|
|
45771
|
+
room_type: { type: 'string' },
|
|
45772
|
+
},
|
|
45773
|
+
required: ['room_number', 'room_type', 'floor'],
|
|
45774
|
+
type: 'object',
|
|
45775
|
+
},
|
|
45776
|
+
shortcode: { type: 'string' },
|
|
45777
|
+
support_email: { type: 'string' },
|
|
45778
|
+
support_phone: { type: 'string' },
|
|
45779
|
+
updated_at: { type: 'string' },
|
|
45780
|
+
},
|
|
45781
|
+
required: [
|
|
45782
|
+
'shortcode',
|
|
45783
|
+
'hotel',
|
|
45784
|
+
'guest',
|
|
45785
|
+
'room',
|
|
45786
|
+
'access',
|
|
45787
|
+
'key_status',
|
|
45788
|
+
'support_phone',
|
|
45789
|
+
'support_email',
|
|
45790
|
+
'created_at',
|
|
45791
|
+
'updated_at',
|
|
45792
|
+
'expires_at',
|
|
45793
|
+
],
|
|
45794
|
+
type: 'object',
|
|
45795
|
+
'x-route-path': '/instant_keys/preview',
|
|
45796
|
+
},
|
|
45797
|
+
ok: { type: 'boolean' },
|
|
45798
|
+
},
|
|
45799
|
+
required: ['instant_key_preview', 'ok'],
|
|
45800
|
+
type: 'object',
|
|
45801
|
+
},
|
|
45802
|
+
},
|
|
45803
|
+
},
|
|
45804
|
+
description: 'OK',
|
|
45805
|
+
},
|
|
45806
|
+
400: { description: 'Bad Request' },
|
|
45807
|
+
401: { description: 'Unauthorized' },
|
|
45808
|
+
},
|
|
45809
|
+
security: [{ certified_client: [] }],
|
|
45810
|
+
summary: '/seam/instant_key/v1/preview/get',
|
|
45811
|
+
tags: [],
|
|
45812
|
+
'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
|
|
45813
|
+
'x-fern-sdk-method-name': 'get',
|
|
45814
|
+
'x-fern-sdk-return-value': 'instant_key_preview',
|
|
45815
|
+
'x-response-key': 'instant_key_preview',
|
|
45816
|
+
'x-title': 'Preview Instant Key',
|
|
45817
|
+
'x-undocumented': 'Seam Instant Key only.',
|
|
45818
|
+
},
|
|
45819
|
+
post: {
|
|
45820
|
+
operationId: 'seamInstantKeyV1PreviewGetPost',
|
|
45821
|
+
requestBody: {
|
|
45822
|
+
content: {
|
|
45823
|
+
'application/json': {
|
|
45824
|
+
schema: {
|
|
45825
|
+
properties: {
|
|
45826
|
+
instant_key_url: {
|
|
45827
|
+
description: 'The short code of the instant key to preview.',
|
|
45828
|
+
type: 'string',
|
|
45829
|
+
},
|
|
45830
|
+
},
|
|
45831
|
+
required: ['instant_key_url'],
|
|
45832
|
+
type: 'object',
|
|
45833
|
+
},
|
|
45834
|
+
},
|
|
45835
|
+
},
|
|
45836
|
+
},
|
|
45837
|
+
responses: {
|
|
45838
|
+
200: {
|
|
45839
|
+
content: {
|
|
45840
|
+
'application/json': {
|
|
45841
|
+
schema: {
|
|
45842
|
+
properties: {
|
|
45843
|
+
instant_key_preview: {
|
|
45844
|
+
description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
|
|
45845
|
+
properties: {
|
|
45846
|
+
access: {
|
|
45847
|
+
items: {
|
|
45848
|
+
properties: {
|
|
45849
|
+
available: { type: 'boolean' },
|
|
45850
|
+
hours: { type: 'string' },
|
|
45851
|
+
icon: { type: 'string' },
|
|
45852
|
+
location: { type: 'string' },
|
|
45853
|
+
name: { type: 'string' },
|
|
45854
|
+
},
|
|
45855
|
+
required: ['name', 'icon', 'available'],
|
|
45856
|
+
type: 'object',
|
|
45857
|
+
},
|
|
45858
|
+
type: 'array',
|
|
45859
|
+
},
|
|
45860
|
+
created_at: { type: 'string' },
|
|
45861
|
+
expires_at: { type: 'string' },
|
|
45862
|
+
guest: {
|
|
45863
|
+
properties: {
|
|
45864
|
+
check_in_date: { type: 'string' },
|
|
45865
|
+
check_out_date: { type: 'string' },
|
|
45866
|
+
email: { type: 'string' },
|
|
45867
|
+
first_name: { type: 'string' },
|
|
45868
|
+
full_name: { type: 'string' },
|
|
45869
|
+
last_name: { type: 'string' },
|
|
45870
|
+
},
|
|
45871
|
+
required: [
|
|
45872
|
+
'first_name',
|
|
45873
|
+
'last_name',
|
|
45874
|
+
'full_name',
|
|
45875
|
+
'email',
|
|
45876
|
+
'check_in_date',
|
|
45877
|
+
'check_out_date',
|
|
45878
|
+
],
|
|
45879
|
+
type: 'object',
|
|
45880
|
+
},
|
|
45881
|
+
hotel: {
|
|
45882
|
+
properties: {
|
|
45883
|
+
accent_color: { type: 'string' },
|
|
45884
|
+
hotel_name: { type: 'string' },
|
|
45885
|
+
logo_url: { type: 'string' },
|
|
45886
|
+
primary_color: { type: 'string' },
|
|
45887
|
+
secondary_color: { type: 'string' },
|
|
45888
|
+
verified: { type: 'boolean' },
|
|
45889
|
+
},
|
|
45890
|
+
required: [
|
|
45891
|
+
'hotel_name',
|
|
45892
|
+
'primary_color',
|
|
45893
|
+
'accent_color',
|
|
45894
|
+
'secondary_color',
|
|
45895
|
+
'verified',
|
|
45896
|
+
],
|
|
45897
|
+
type: 'object',
|
|
45898
|
+
},
|
|
45899
|
+
key_status: {
|
|
45900
|
+
enum: ['ready', 'expired', 'used'],
|
|
45901
|
+
type: 'string',
|
|
45902
|
+
},
|
|
45903
|
+
room: {
|
|
45904
|
+
properties: {
|
|
45905
|
+
floor: { format: 'float', type: 'number' },
|
|
45906
|
+
room_number: { type: 'string' },
|
|
45907
|
+
room_type: { type: 'string' },
|
|
45908
|
+
},
|
|
45909
|
+
required: ['room_number', 'room_type', 'floor'],
|
|
45910
|
+
type: 'object',
|
|
45911
|
+
},
|
|
45912
|
+
shortcode: { type: 'string' },
|
|
45913
|
+
support_email: { type: 'string' },
|
|
45914
|
+
support_phone: { type: 'string' },
|
|
45915
|
+
updated_at: { type: 'string' },
|
|
45916
|
+
},
|
|
45917
|
+
required: [
|
|
45918
|
+
'shortcode',
|
|
45919
|
+
'hotel',
|
|
45920
|
+
'guest',
|
|
45921
|
+
'room',
|
|
45922
|
+
'access',
|
|
45923
|
+
'key_status',
|
|
45924
|
+
'support_phone',
|
|
45925
|
+
'support_email',
|
|
45926
|
+
'created_at',
|
|
45927
|
+
'updated_at',
|
|
45928
|
+
'expires_at',
|
|
45929
|
+
],
|
|
45930
|
+
type: 'object',
|
|
45931
|
+
'x-route-path': '/instant_keys/preview',
|
|
45932
|
+
},
|
|
45933
|
+
ok: { type: 'boolean' },
|
|
45934
|
+
},
|
|
45935
|
+
required: ['instant_key_preview', 'ok'],
|
|
45936
|
+
type: 'object',
|
|
45937
|
+
},
|
|
45938
|
+
},
|
|
45939
|
+
},
|
|
45940
|
+
description: 'OK',
|
|
45941
|
+
},
|
|
45942
|
+
400: { description: 'Bad Request' },
|
|
45943
|
+
401: { description: 'Unauthorized' },
|
|
45944
|
+
},
|
|
45945
|
+
security: [{ certified_client: [] }],
|
|
45946
|
+
summary: '/seam/instant_key/v1/preview/get',
|
|
45947
|
+
tags: [],
|
|
45948
|
+
'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
|
|
45949
|
+
'x-fern-sdk-method-name': 'get',
|
|
45950
|
+
'x-fern-sdk-return-value': 'instant_key_preview',
|
|
45951
|
+
'x-response-key': 'instant_key_preview',
|
|
45952
|
+
'x-title': 'Preview Instant Key',
|
|
45953
|
+
'x-undocumented': 'Seam Instant Key only.',
|
|
45954
|
+
},
|
|
45955
|
+
},
|
|
45766
45956
|
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
45767
45957
|
get: {
|
|
45768
45958
|
description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -48581,15 +48771,6 @@ export default {
|
|
|
48581
48771
|
type: 'string',
|
|
48582
48772
|
},
|
|
48583
48773
|
},
|
|
48584
|
-
{
|
|
48585
|
-
in: 'query',
|
|
48586
|
-
name: 'access_method_id',
|
|
48587
|
-
schema: {
|
|
48588
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
48589
|
-
format: 'uuid',
|
|
48590
|
-
type: 'string',
|
|
48591
|
-
},
|
|
48592
|
-
},
|
|
48593
48774
|
],
|
|
48594
48775
|
responses: {
|
|
48595
48776
|
200: {
|
|
@@ -48639,11 +48820,6 @@ export default {
|
|
|
48639
48820
|
'application/json': {
|
|
48640
48821
|
schema: {
|
|
48641
48822
|
properties: {
|
|
48642
|
-
access_method_id: {
|
|
48643
|
-
description: 'ID of the access method for which you want to retrieve all devices.',
|
|
48644
|
-
format: 'uuid',
|
|
48645
|
-
type: 'string',
|
|
48646
|
-
},
|
|
48647
48823
|
connect_webview_id: {
|
|
48648
48824
|
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
48649
48825
|
format: 'uuid',
|