@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 +473 -2
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +898 -0
- package/dist/index.cjs +473 -2
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +139 -0
- package/lib/seam/connect/models/customer/customer-portal.js +7 -0
- package/lib/seam/connect/models/customer/customer-portal.js.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 +804 -0
- package/lib/seam/connect/openapi.js +471 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +94 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/customer/customer-portal.ts +8 -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 +476 -0
- package/src/lib/seam/connect/route-types.ts +122 -0
|
@@ -35061,6 +35061,71 @@ export default {
|
|
|
35061
35061
|
description: 'Whether the portal is embedded in another application.',
|
|
35062
35062
|
type: 'boolean',
|
|
35063
35063
|
},
|
|
35064
|
+
landing_page: {
|
|
35065
|
+
description: 'Configuration for the landing page when the portal loads.',
|
|
35066
|
+
properties: {
|
|
35067
|
+
manage: {
|
|
35068
|
+
oneOf: [
|
|
35069
|
+
{
|
|
35070
|
+
properties: { space_key: { type: 'string' } },
|
|
35071
|
+
required: ['space_key'],
|
|
35072
|
+
type: 'object',
|
|
35073
|
+
},
|
|
35074
|
+
{
|
|
35075
|
+
properties: {
|
|
35076
|
+
property_key: { type: 'string' },
|
|
35077
|
+
},
|
|
35078
|
+
required: ['property_key'],
|
|
35079
|
+
type: 'object',
|
|
35080
|
+
},
|
|
35081
|
+
{
|
|
35082
|
+
properties: { room_key: { type: 'string' } },
|
|
35083
|
+
required: ['room_key'],
|
|
35084
|
+
type: 'object',
|
|
35085
|
+
},
|
|
35086
|
+
{
|
|
35087
|
+
properties: {
|
|
35088
|
+
common_area_key: { type: 'string' },
|
|
35089
|
+
},
|
|
35090
|
+
required: ['common_area_key'],
|
|
35091
|
+
type: 'object',
|
|
35092
|
+
},
|
|
35093
|
+
{
|
|
35094
|
+
properties: { unit_key: { type: 'string' } },
|
|
35095
|
+
required: ['unit_key'],
|
|
35096
|
+
type: 'object',
|
|
35097
|
+
},
|
|
35098
|
+
{
|
|
35099
|
+
properties: {
|
|
35100
|
+
facility_key: { type: 'string' },
|
|
35101
|
+
},
|
|
35102
|
+
required: ['facility_key'],
|
|
35103
|
+
type: 'object',
|
|
35104
|
+
},
|
|
35105
|
+
{
|
|
35106
|
+
properties: {
|
|
35107
|
+
building_key: { type: 'string' },
|
|
35108
|
+
},
|
|
35109
|
+
required: ['building_key'],
|
|
35110
|
+
type: 'object',
|
|
35111
|
+
},
|
|
35112
|
+
{
|
|
35113
|
+
properties: { listing_key: { type: 'string' } },
|
|
35114
|
+
required: ['listing_key'],
|
|
35115
|
+
type: 'object',
|
|
35116
|
+
},
|
|
35117
|
+
{
|
|
35118
|
+
properties: {
|
|
35119
|
+
property_listing_key: { type: 'string' },
|
|
35120
|
+
},
|
|
35121
|
+
required: ['property_listing_key'],
|
|
35122
|
+
type: 'object',
|
|
35123
|
+
},
|
|
35124
|
+
],
|
|
35125
|
+
},
|
|
35126
|
+
},
|
|
35127
|
+
type: 'object',
|
|
35128
|
+
},
|
|
35064
35129
|
},
|
|
35065
35130
|
type: 'object',
|
|
35066
35131
|
},
|
|
@@ -45314,6 +45379,72 @@ export default {
|
|
|
45314
45379
|
type: 'object',
|
|
45315
45380
|
},
|
|
45316
45381
|
is_embedded: { type: 'boolean' },
|
|
45382
|
+
landing_page: {
|
|
45383
|
+
properties: {
|
|
45384
|
+
manage: {
|
|
45385
|
+
oneOf: [
|
|
45386
|
+
{
|
|
45387
|
+
properties: { space_key: { type: 'string' } },
|
|
45388
|
+
required: ['space_key'],
|
|
45389
|
+
type: 'object',
|
|
45390
|
+
},
|
|
45391
|
+
{
|
|
45392
|
+
properties: {
|
|
45393
|
+
property_key: { type: 'string' },
|
|
45394
|
+
},
|
|
45395
|
+
required: ['property_key'],
|
|
45396
|
+
type: 'object',
|
|
45397
|
+
},
|
|
45398
|
+
{
|
|
45399
|
+
properties: { room_key: { type: 'string' } },
|
|
45400
|
+
required: ['room_key'],
|
|
45401
|
+
type: 'object',
|
|
45402
|
+
},
|
|
45403
|
+
{
|
|
45404
|
+
properties: {
|
|
45405
|
+
common_area_key: { type: 'string' },
|
|
45406
|
+
},
|
|
45407
|
+
required: ['common_area_key'],
|
|
45408
|
+
type: 'object',
|
|
45409
|
+
},
|
|
45410
|
+
{
|
|
45411
|
+
properties: { unit_key: { type: 'string' } },
|
|
45412
|
+
required: ['unit_key'],
|
|
45413
|
+
type: 'object',
|
|
45414
|
+
},
|
|
45415
|
+
{
|
|
45416
|
+
properties: {
|
|
45417
|
+
facility_key: { type: 'string' },
|
|
45418
|
+
},
|
|
45419
|
+
required: ['facility_key'],
|
|
45420
|
+
type: 'object',
|
|
45421
|
+
},
|
|
45422
|
+
{
|
|
45423
|
+
properties: {
|
|
45424
|
+
building_key: { type: 'string' },
|
|
45425
|
+
},
|
|
45426
|
+
required: ['building_key'],
|
|
45427
|
+
type: 'object',
|
|
45428
|
+
},
|
|
45429
|
+
{
|
|
45430
|
+
properties: {
|
|
45431
|
+
listing_key: { type: 'string' },
|
|
45432
|
+
},
|
|
45433
|
+
required: ['listing_key'],
|
|
45434
|
+
type: 'object',
|
|
45435
|
+
},
|
|
45436
|
+
{
|
|
45437
|
+
properties: {
|
|
45438
|
+
property_listing_key: { type: 'string' },
|
|
45439
|
+
},
|
|
45440
|
+
required: ['property_listing_key'],
|
|
45441
|
+
type: 'object',
|
|
45442
|
+
},
|
|
45443
|
+
],
|
|
45444
|
+
},
|
|
45445
|
+
},
|
|
45446
|
+
type: 'object',
|
|
45447
|
+
},
|
|
45317
45448
|
},
|
|
45318
45449
|
type: 'object',
|
|
45319
45450
|
},
|
|
@@ -45408,6 +45539,72 @@ export default {
|
|
|
45408
45539
|
type: 'object',
|
|
45409
45540
|
},
|
|
45410
45541
|
is_embedded: { type: 'boolean' },
|
|
45542
|
+
landing_page: {
|
|
45543
|
+
properties: {
|
|
45544
|
+
manage: {
|
|
45545
|
+
oneOf: [
|
|
45546
|
+
{
|
|
45547
|
+
properties: { space_key: { type: 'string' } },
|
|
45548
|
+
required: ['space_key'],
|
|
45549
|
+
type: 'object',
|
|
45550
|
+
},
|
|
45551
|
+
{
|
|
45552
|
+
properties: {
|
|
45553
|
+
property_key: { type: 'string' },
|
|
45554
|
+
},
|
|
45555
|
+
required: ['property_key'],
|
|
45556
|
+
type: 'object',
|
|
45557
|
+
},
|
|
45558
|
+
{
|
|
45559
|
+
properties: { room_key: { type: 'string' } },
|
|
45560
|
+
required: ['room_key'],
|
|
45561
|
+
type: 'object',
|
|
45562
|
+
},
|
|
45563
|
+
{
|
|
45564
|
+
properties: {
|
|
45565
|
+
common_area_key: { type: 'string' },
|
|
45566
|
+
},
|
|
45567
|
+
required: ['common_area_key'],
|
|
45568
|
+
type: 'object',
|
|
45569
|
+
},
|
|
45570
|
+
{
|
|
45571
|
+
properties: { unit_key: { type: 'string' } },
|
|
45572
|
+
required: ['unit_key'],
|
|
45573
|
+
type: 'object',
|
|
45574
|
+
},
|
|
45575
|
+
{
|
|
45576
|
+
properties: {
|
|
45577
|
+
facility_key: { type: 'string' },
|
|
45578
|
+
},
|
|
45579
|
+
required: ['facility_key'],
|
|
45580
|
+
type: 'object',
|
|
45581
|
+
},
|
|
45582
|
+
{
|
|
45583
|
+
properties: {
|
|
45584
|
+
building_key: { type: 'string' },
|
|
45585
|
+
},
|
|
45586
|
+
required: ['building_key'],
|
|
45587
|
+
type: 'object',
|
|
45588
|
+
},
|
|
45589
|
+
{
|
|
45590
|
+
properties: {
|
|
45591
|
+
listing_key: { type: 'string' },
|
|
45592
|
+
},
|
|
45593
|
+
required: ['listing_key'],
|
|
45594
|
+
type: 'object',
|
|
45595
|
+
},
|
|
45596
|
+
{
|
|
45597
|
+
properties: {
|
|
45598
|
+
property_listing_key: { type: 'string' },
|
|
45599
|
+
},
|
|
45600
|
+
required: ['property_listing_key'],
|
|
45601
|
+
type: 'object',
|
|
45602
|
+
},
|
|
45603
|
+
],
|
|
45604
|
+
},
|
|
45605
|
+
},
|
|
45606
|
+
type: 'object',
|
|
45607
|
+
},
|
|
45411
45608
|
},
|
|
45412
45609
|
type: 'object',
|
|
45413
45610
|
},
|
|
@@ -45679,6 +45876,280 @@ export default {
|
|
|
45679
45876
|
'x-undocumented': 'Seam Instant Key only.',
|
|
45680
45877
|
},
|
|
45681
45878
|
},
|
|
45879
|
+
'/seam/instant_key/v1/preview/get': {
|
|
45880
|
+
get: {
|
|
45881
|
+
operationId: 'seamInstantKeyV1PreviewGetGet',
|
|
45882
|
+
requestBody: {
|
|
45883
|
+
content: {
|
|
45884
|
+
'application/json': {
|
|
45885
|
+
schema: {
|
|
45886
|
+
properties: {
|
|
45887
|
+
instant_key_url: {
|
|
45888
|
+
description: 'The short code of the instant key to preview.',
|
|
45889
|
+
type: 'string',
|
|
45890
|
+
},
|
|
45891
|
+
},
|
|
45892
|
+
required: ['instant_key_url'],
|
|
45893
|
+
type: 'object',
|
|
45894
|
+
},
|
|
45895
|
+
},
|
|
45896
|
+
},
|
|
45897
|
+
},
|
|
45898
|
+
responses: {
|
|
45899
|
+
200: {
|
|
45900
|
+
content: {
|
|
45901
|
+
'application/json': {
|
|
45902
|
+
schema: {
|
|
45903
|
+
properties: {
|
|
45904
|
+
instant_key_preview: {
|
|
45905
|
+
description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
|
|
45906
|
+
properties: {
|
|
45907
|
+
access: {
|
|
45908
|
+
items: {
|
|
45909
|
+
properties: {
|
|
45910
|
+
available: { type: 'boolean' },
|
|
45911
|
+
hours: { type: 'string' },
|
|
45912
|
+
icon: { type: 'string' },
|
|
45913
|
+
location: { type: 'string' },
|
|
45914
|
+
name: { type: 'string' },
|
|
45915
|
+
},
|
|
45916
|
+
required: ['name', 'icon', 'available'],
|
|
45917
|
+
type: 'object',
|
|
45918
|
+
},
|
|
45919
|
+
type: 'array',
|
|
45920
|
+
},
|
|
45921
|
+
created_at: { type: 'string' },
|
|
45922
|
+
expires_at: { type: 'string' },
|
|
45923
|
+
guest: {
|
|
45924
|
+
properties: {
|
|
45925
|
+
check_in_date: { type: 'string' },
|
|
45926
|
+
check_out_date: { type: 'string' },
|
|
45927
|
+
email: { type: 'string' },
|
|
45928
|
+
first_name: { type: 'string' },
|
|
45929
|
+
full_name: { type: 'string' },
|
|
45930
|
+
last_name: { type: 'string' },
|
|
45931
|
+
},
|
|
45932
|
+
required: [
|
|
45933
|
+
'first_name',
|
|
45934
|
+
'last_name',
|
|
45935
|
+
'full_name',
|
|
45936
|
+
'email',
|
|
45937
|
+
'check_in_date',
|
|
45938
|
+
'check_out_date',
|
|
45939
|
+
],
|
|
45940
|
+
type: 'object',
|
|
45941
|
+
},
|
|
45942
|
+
hotel: {
|
|
45943
|
+
properties: {
|
|
45944
|
+
accent_color: { type: 'string' },
|
|
45945
|
+
hotel_name: { type: 'string' },
|
|
45946
|
+
logo_url: { type: 'string' },
|
|
45947
|
+
primary_color: { type: 'string' },
|
|
45948
|
+
secondary_color: { type: 'string' },
|
|
45949
|
+
verified: { type: 'boolean' },
|
|
45950
|
+
},
|
|
45951
|
+
required: [
|
|
45952
|
+
'hotel_name',
|
|
45953
|
+
'primary_color',
|
|
45954
|
+
'accent_color',
|
|
45955
|
+
'secondary_color',
|
|
45956
|
+
'verified',
|
|
45957
|
+
],
|
|
45958
|
+
type: 'object',
|
|
45959
|
+
},
|
|
45960
|
+
key_status: {
|
|
45961
|
+
enum: ['ready', 'expired', 'used'],
|
|
45962
|
+
type: 'string',
|
|
45963
|
+
},
|
|
45964
|
+
room: {
|
|
45965
|
+
properties: {
|
|
45966
|
+
floor: { format: 'float', type: 'number' },
|
|
45967
|
+
room_number: { type: 'string' },
|
|
45968
|
+
room_type: { type: 'string' },
|
|
45969
|
+
},
|
|
45970
|
+
required: ['room_number', 'room_type', 'floor'],
|
|
45971
|
+
type: 'object',
|
|
45972
|
+
},
|
|
45973
|
+
shortcode: { type: 'string' },
|
|
45974
|
+
support_email: { type: 'string' },
|
|
45975
|
+
support_phone: { type: 'string' },
|
|
45976
|
+
updated_at: { type: 'string' },
|
|
45977
|
+
},
|
|
45978
|
+
required: [
|
|
45979
|
+
'shortcode',
|
|
45980
|
+
'hotel',
|
|
45981
|
+
'guest',
|
|
45982
|
+
'room',
|
|
45983
|
+
'access',
|
|
45984
|
+
'key_status',
|
|
45985
|
+
'support_phone',
|
|
45986
|
+
'support_email',
|
|
45987
|
+
'created_at',
|
|
45988
|
+
'updated_at',
|
|
45989
|
+
'expires_at',
|
|
45990
|
+
],
|
|
45991
|
+
type: 'object',
|
|
45992
|
+
'x-route-path': '/instant_keys/preview',
|
|
45993
|
+
},
|
|
45994
|
+
ok: { type: 'boolean' },
|
|
45995
|
+
},
|
|
45996
|
+
required: ['instant_key_preview', 'ok'],
|
|
45997
|
+
type: 'object',
|
|
45998
|
+
},
|
|
45999
|
+
},
|
|
46000
|
+
},
|
|
46001
|
+
description: 'OK',
|
|
46002
|
+
},
|
|
46003
|
+
400: { description: 'Bad Request' },
|
|
46004
|
+
401: { description: 'Unauthorized' },
|
|
46005
|
+
},
|
|
46006
|
+
security: [{ certified_client: [] }],
|
|
46007
|
+
summary: '/seam/instant_key/v1/preview/get',
|
|
46008
|
+
tags: [],
|
|
46009
|
+
'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
|
|
46010
|
+
'x-fern-sdk-method-name': 'get',
|
|
46011
|
+
'x-fern-sdk-return-value': 'instant_key_preview',
|
|
46012
|
+
'x-response-key': 'instant_key_preview',
|
|
46013
|
+
'x-title': 'Preview Instant Key',
|
|
46014
|
+
'x-undocumented': 'Seam Instant Key only.',
|
|
46015
|
+
},
|
|
46016
|
+
post: {
|
|
46017
|
+
operationId: 'seamInstantKeyV1PreviewGetPost',
|
|
46018
|
+
requestBody: {
|
|
46019
|
+
content: {
|
|
46020
|
+
'application/json': {
|
|
46021
|
+
schema: {
|
|
46022
|
+
properties: {
|
|
46023
|
+
instant_key_url: {
|
|
46024
|
+
description: 'The short code of the instant key to preview.',
|
|
46025
|
+
type: 'string',
|
|
46026
|
+
},
|
|
46027
|
+
},
|
|
46028
|
+
required: ['instant_key_url'],
|
|
46029
|
+
type: 'object',
|
|
46030
|
+
},
|
|
46031
|
+
},
|
|
46032
|
+
},
|
|
46033
|
+
},
|
|
46034
|
+
responses: {
|
|
46035
|
+
200: {
|
|
46036
|
+
content: {
|
|
46037
|
+
'application/json': {
|
|
46038
|
+
schema: {
|
|
46039
|
+
properties: {
|
|
46040
|
+
instant_key_preview: {
|
|
46041
|
+
description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
|
|
46042
|
+
properties: {
|
|
46043
|
+
access: {
|
|
46044
|
+
items: {
|
|
46045
|
+
properties: {
|
|
46046
|
+
available: { type: 'boolean' },
|
|
46047
|
+
hours: { type: 'string' },
|
|
46048
|
+
icon: { type: 'string' },
|
|
46049
|
+
location: { type: 'string' },
|
|
46050
|
+
name: { type: 'string' },
|
|
46051
|
+
},
|
|
46052
|
+
required: ['name', 'icon', 'available'],
|
|
46053
|
+
type: 'object',
|
|
46054
|
+
},
|
|
46055
|
+
type: 'array',
|
|
46056
|
+
},
|
|
46057
|
+
created_at: { type: 'string' },
|
|
46058
|
+
expires_at: { type: 'string' },
|
|
46059
|
+
guest: {
|
|
46060
|
+
properties: {
|
|
46061
|
+
check_in_date: { type: 'string' },
|
|
46062
|
+
check_out_date: { type: 'string' },
|
|
46063
|
+
email: { type: 'string' },
|
|
46064
|
+
first_name: { type: 'string' },
|
|
46065
|
+
full_name: { type: 'string' },
|
|
46066
|
+
last_name: { type: 'string' },
|
|
46067
|
+
},
|
|
46068
|
+
required: [
|
|
46069
|
+
'first_name',
|
|
46070
|
+
'last_name',
|
|
46071
|
+
'full_name',
|
|
46072
|
+
'email',
|
|
46073
|
+
'check_in_date',
|
|
46074
|
+
'check_out_date',
|
|
46075
|
+
],
|
|
46076
|
+
type: 'object',
|
|
46077
|
+
},
|
|
46078
|
+
hotel: {
|
|
46079
|
+
properties: {
|
|
46080
|
+
accent_color: { type: 'string' },
|
|
46081
|
+
hotel_name: { type: 'string' },
|
|
46082
|
+
logo_url: { type: 'string' },
|
|
46083
|
+
primary_color: { type: 'string' },
|
|
46084
|
+
secondary_color: { type: 'string' },
|
|
46085
|
+
verified: { type: 'boolean' },
|
|
46086
|
+
},
|
|
46087
|
+
required: [
|
|
46088
|
+
'hotel_name',
|
|
46089
|
+
'primary_color',
|
|
46090
|
+
'accent_color',
|
|
46091
|
+
'secondary_color',
|
|
46092
|
+
'verified',
|
|
46093
|
+
],
|
|
46094
|
+
type: 'object',
|
|
46095
|
+
},
|
|
46096
|
+
key_status: {
|
|
46097
|
+
enum: ['ready', 'expired', 'used'],
|
|
46098
|
+
type: 'string',
|
|
46099
|
+
},
|
|
46100
|
+
room: {
|
|
46101
|
+
properties: {
|
|
46102
|
+
floor: { format: 'float', type: 'number' },
|
|
46103
|
+
room_number: { type: 'string' },
|
|
46104
|
+
room_type: { type: 'string' },
|
|
46105
|
+
},
|
|
46106
|
+
required: ['room_number', 'room_type', 'floor'],
|
|
46107
|
+
type: 'object',
|
|
46108
|
+
},
|
|
46109
|
+
shortcode: { type: 'string' },
|
|
46110
|
+
support_email: { type: 'string' },
|
|
46111
|
+
support_phone: { type: 'string' },
|
|
46112
|
+
updated_at: { type: 'string' },
|
|
46113
|
+
},
|
|
46114
|
+
required: [
|
|
46115
|
+
'shortcode',
|
|
46116
|
+
'hotel',
|
|
46117
|
+
'guest',
|
|
46118
|
+
'room',
|
|
46119
|
+
'access',
|
|
46120
|
+
'key_status',
|
|
46121
|
+
'support_phone',
|
|
46122
|
+
'support_email',
|
|
46123
|
+
'created_at',
|
|
46124
|
+
'updated_at',
|
|
46125
|
+
'expires_at',
|
|
46126
|
+
],
|
|
46127
|
+
type: 'object',
|
|
46128
|
+
'x-route-path': '/instant_keys/preview',
|
|
46129
|
+
},
|
|
46130
|
+
ok: { type: 'boolean' },
|
|
46131
|
+
},
|
|
46132
|
+
required: ['instant_key_preview', 'ok'],
|
|
46133
|
+
type: 'object',
|
|
46134
|
+
},
|
|
46135
|
+
},
|
|
46136
|
+
},
|
|
46137
|
+
description: 'OK',
|
|
46138
|
+
},
|
|
46139
|
+
400: { description: 'Bad Request' },
|
|
46140
|
+
401: { description: 'Unauthorized' },
|
|
46141
|
+
},
|
|
46142
|
+
security: [{ certified_client: [] }],
|
|
46143
|
+
summary: '/seam/instant_key/v1/preview/get',
|
|
46144
|
+
tags: [],
|
|
46145
|
+
'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
|
|
46146
|
+
'x-fern-sdk-method-name': 'get',
|
|
46147
|
+
'x-fern-sdk-return-value': 'instant_key_preview',
|
|
46148
|
+
'x-response-key': 'instant_key_preview',
|
|
46149
|
+
'x-title': 'Preview Instant Key',
|
|
46150
|
+
'x-undocumented': 'Seam Instant Key only.',
|
|
46151
|
+
},
|
|
46152
|
+
},
|
|
45682
46153
|
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
45683
46154
|
get: {
|
|
45684
46155
|
description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|