@seamapi/types 1.708.0 → 1.710.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 +933 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1477 -111
- package/dist/index.cjs +933 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +1044 -0
- package/lib/seam/connect/openapi.js +933 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +322 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +1036 -0
- package/src/lib/seam/connect/route-types.ts +362 -0
|
@@ -50111,6 +50111,189 @@ export default {
|
|
|
50111
50111
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
50112
50112
|
},
|
|
50113
50113
|
},
|
|
50114
|
+
'/seam/customer/v1/connector_customers/list': {
|
|
50115
|
+
get: {
|
|
50116
|
+
description: 'Lists connector customers for a given connector.',
|
|
50117
|
+
operationId: 'seamCustomerV1ConnectorCustomersListGet',
|
|
50118
|
+
parameters: [
|
|
50119
|
+
{
|
|
50120
|
+
in: 'query',
|
|
50121
|
+
name: 'connector_id',
|
|
50122
|
+
schema: {
|
|
50123
|
+
description: 'ID of the connector.',
|
|
50124
|
+
format: 'uuid',
|
|
50125
|
+
type: 'string',
|
|
50126
|
+
},
|
|
50127
|
+
},
|
|
50128
|
+
],
|
|
50129
|
+
responses: {
|
|
50130
|
+
200: {
|
|
50131
|
+
content: {
|
|
50132
|
+
'application/json': {
|
|
50133
|
+
schema: {
|
|
50134
|
+
properties: {
|
|
50135
|
+
connector_customers: {
|
|
50136
|
+
items: {
|
|
50137
|
+
properties: {
|
|
50138
|
+
connector_customer_id: { type: 'string' },
|
|
50139
|
+
connector_id: { type: 'string' },
|
|
50140
|
+
created_at: { type: 'string' },
|
|
50141
|
+
customer_key: { type: 'string' },
|
|
50142
|
+
initial_sync_completed: { type: 'boolean' },
|
|
50143
|
+
initial_sync_status: {
|
|
50144
|
+
nullable: true,
|
|
50145
|
+
type: 'string',
|
|
50146
|
+
},
|
|
50147
|
+
instance_config: {
|
|
50148
|
+
additionalProperties: {
|
|
50149
|
+
$ref: '#/components/schemas/access_code',
|
|
50150
|
+
},
|
|
50151
|
+
nullable: true,
|
|
50152
|
+
type: 'object',
|
|
50153
|
+
},
|
|
50154
|
+
status: { nullable: true, type: 'string' },
|
|
50155
|
+
updated_at: { type: 'string' },
|
|
50156
|
+
},
|
|
50157
|
+
required: [
|
|
50158
|
+
'connector_customer_id',
|
|
50159
|
+
'connector_id',
|
|
50160
|
+
'customer_key',
|
|
50161
|
+
'instance_config',
|
|
50162
|
+
'initial_sync_completed',
|
|
50163
|
+
'initial_sync_status',
|
|
50164
|
+
'status',
|
|
50165
|
+
'created_at',
|
|
50166
|
+
'updated_at',
|
|
50167
|
+
],
|
|
50168
|
+
type: 'object',
|
|
50169
|
+
},
|
|
50170
|
+
type: 'array',
|
|
50171
|
+
},
|
|
50172
|
+
ok: { type: 'boolean' },
|
|
50173
|
+
},
|
|
50174
|
+
required: ['connector_customers', 'ok'],
|
|
50175
|
+
type: 'object',
|
|
50176
|
+
},
|
|
50177
|
+
},
|
|
50178
|
+
},
|
|
50179
|
+
description: 'OK',
|
|
50180
|
+
},
|
|
50181
|
+
400: { description: 'Bad Request' },
|
|
50182
|
+
401: { description: 'Unauthorized' },
|
|
50183
|
+
},
|
|
50184
|
+
security: [
|
|
50185
|
+
{ api_key: [] },
|
|
50186
|
+
{ client_session_with_customer: [] },
|
|
50187
|
+
{ console_session_with_workspace: [] },
|
|
50188
|
+
],
|
|
50189
|
+
summary: '/seam/customer/v1/connector_customers/list',
|
|
50190
|
+
tags: [],
|
|
50191
|
+
'x-fern-sdk-group-name': [
|
|
50192
|
+
'seam',
|
|
50193
|
+
'customer',
|
|
50194
|
+
'v1',
|
|
50195
|
+
'connector_customers',
|
|
50196
|
+
],
|
|
50197
|
+
'x-fern-sdk-method-name': 'list',
|
|
50198
|
+
'x-fern-sdk-return-value': 'connector_customers',
|
|
50199
|
+
'x-response-key': 'connector_customers',
|
|
50200
|
+
'x-title': 'List Connector Customers',
|
|
50201
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
50202
|
+
},
|
|
50203
|
+
post: {
|
|
50204
|
+
description: 'Lists connector customers for a given connector.',
|
|
50205
|
+
operationId: 'seamCustomerV1ConnectorCustomersListPost',
|
|
50206
|
+
requestBody: {
|
|
50207
|
+
content: {
|
|
50208
|
+
'application/json': {
|
|
50209
|
+
schema: {
|
|
50210
|
+
properties: {
|
|
50211
|
+
connector_id: {
|
|
50212
|
+
description: 'ID of the connector.',
|
|
50213
|
+
format: 'uuid',
|
|
50214
|
+
type: 'string',
|
|
50215
|
+
},
|
|
50216
|
+
},
|
|
50217
|
+
type: 'object',
|
|
50218
|
+
},
|
|
50219
|
+
},
|
|
50220
|
+
},
|
|
50221
|
+
},
|
|
50222
|
+
responses: {
|
|
50223
|
+
200: {
|
|
50224
|
+
content: {
|
|
50225
|
+
'application/json': {
|
|
50226
|
+
schema: {
|
|
50227
|
+
properties: {
|
|
50228
|
+
connector_customers: {
|
|
50229
|
+
items: {
|
|
50230
|
+
properties: {
|
|
50231
|
+
connector_customer_id: { type: 'string' },
|
|
50232
|
+
connector_id: { type: 'string' },
|
|
50233
|
+
created_at: { type: 'string' },
|
|
50234
|
+
customer_key: { type: 'string' },
|
|
50235
|
+
initial_sync_completed: { type: 'boolean' },
|
|
50236
|
+
initial_sync_status: {
|
|
50237
|
+
nullable: true,
|
|
50238
|
+
type: 'string',
|
|
50239
|
+
},
|
|
50240
|
+
instance_config: {
|
|
50241
|
+
additionalProperties: {
|
|
50242
|
+
$ref: '#/components/schemas/access_code',
|
|
50243
|
+
},
|
|
50244
|
+
nullable: true,
|
|
50245
|
+
type: 'object',
|
|
50246
|
+
},
|
|
50247
|
+
status: { nullable: true, type: 'string' },
|
|
50248
|
+
updated_at: { type: 'string' },
|
|
50249
|
+
},
|
|
50250
|
+
required: [
|
|
50251
|
+
'connector_customer_id',
|
|
50252
|
+
'connector_id',
|
|
50253
|
+
'customer_key',
|
|
50254
|
+
'instance_config',
|
|
50255
|
+
'initial_sync_completed',
|
|
50256
|
+
'initial_sync_status',
|
|
50257
|
+
'status',
|
|
50258
|
+
'created_at',
|
|
50259
|
+
'updated_at',
|
|
50260
|
+
],
|
|
50261
|
+
type: 'object',
|
|
50262
|
+
},
|
|
50263
|
+
type: 'array',
|
|
50264
|
+
},
|
|
50265
|
+
ok: { type: 'boolean' },
|
|
50266
|
+
},
|
|
50267
|
+
required: ['connector_customers', 'ok'],
|
|
50268
|
+
type: 'object',
|
|
50269
|
+
},
|
|
50270
|
+
},
|
|
50271
|
+
},
|
|
50272
|
+
description: 'OK',
|
|
50273
|
+
},
|
|
50274
|
+
400: { description: 'Bad Request' },
|
|
50275
|
+
401: { description: 'Unauthorized' },
|
|
50276
|
+
},
|
|
50277
|
+
security: [
|
|
50278
|
+
{ api_key: [] },
|
|
50279
|
+
{ client_session_with_customer: [] },
|
|
50280
|
+
{ console_session_with_workspace: [] },
|
|
50281
|
+
],
|
|
50282
|
+
summary: '/seam/customer/v1/connector_customers/list',
|
|
50283
|
+
tags: [],
|
|
50284
|
+
'x-fern-sdk-group-name': [
|
|
50285
|
+
'seam',
|
|
50286
|
+
'customer',
|
|
50287
|
+
'v1',
|
|
50288
|
+
'connector_customers',
|
|
50289
|
+
],
|
|
50290
|
+
'x-fern-sdk-method-name': 'list',
|
|
50291
|
+
'x-fern-sdk-return-value': 'connector_customers',
|
|
50292
|
+
'x-response-key': 'connector_customers',
|
|
50293
|
+
'x-title': 'List Connector Customers',
|
|
50294
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
50295
|
+
},
|
|
50296
|
+
},
|
|
50114
50297
|
'/seam/customer/v1/connectors/authorize': {
|
|
50115
50298
|
get: {
|
|
50116
50299
|
description: 'Returns the OAuth authorization URL for a global connector.\nThis endpoint only works for global connectors (connectors that support multiple customers).',
|
|
@@ -54441,6 +54624,7 @@ export default {
|
|
|
54441
54624
|
},
|
|
54442
54625
|
type: 'array',
|
|
54443
54626
|
},
|
|
54627
|
+
is_common_area: { type: 'boolean' },
|
|
54444
54628
|
is_draft: { type: 'boolean' },
|
|
54445
54629
|
name: { type: 'string' },
|
|
54446
54630
|
needs_review: { type: 'boolean' },
|
|
@@ -54538,6 +54722,7 @@ export default {
|
|
|
54538
54722
|
},
|
|
54539
54723
|
type: 'array',
|
|
54540
54724
|
},
|
|
54725
|
+
is_common_area: { type: 'boolean' },
|
|
54541
54726
|
is_draft: { type: 'boolean' },
|
|
54542
54727
|
name: { type: 'string' },
|
|
54543
54728
|
needs_review: { type: 'boolean' },
|
|
@@ -54582,6 +54767,754 @@ export default {
|
|
|
54582
54767
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
54583
54768
|
},
|
|
54584
54769
|
},
|
|
54770
|
+
'/seam/v1/customers/push_data': {
|
|
54771
|
+
post: {
|
|
54772
|
+
description: 'Pushes customer data including resources like spaces, properties, rooms, users, etc.\nThe customer_key is taken from the authenticated client session.',
|
|
54773
|
+
operationId: 'seamV1CustomersPushDataPost',
|
|
54774
|
+
requestBody: {
|
|
54775
|
+
content: {
|
|
54776
|
+
'application/json': {
|
|
54777
|
+
schema: {
|
|
54778
|
+
properties: {
|
|
54779
|
+
access_grants: {
|
|
54780
|
+
description: 'List of access grants.',
|
|
54781
|
+
items: {
|
|
54782
|
+
properties: {
|
|
54783
|
+
access_grant_key: {
|
|
54784
|
+
description: 'Your unique identifier for the access grant.',
|
|
54785
|
+
minLength: 1,
|
|
54786
|
+
type: 'string',
|
|
54787
|
+
},
|
|
54788
|
+
building_keys: {
|
|
54789
|
+
description: 'Building keys associated with the access grant.',
|
|
54790
|
+
items: { type: 'string' },
|
|
54791
|
+
type: 'array',
|
|
54792
|
+
},
|
|
54793
|
+
common_area_keys: {
|
|
54794
|
+
description: 'Common area keys associated with the access grant.',
|
|
54795
|
+
items: { type: 'string' },
|
|
54796
|
+
type: 'array',
|
|
54797
|
+
},
|
|
54798
|
+
ends_at: {
|
|
54799
|
+
description: 'Ending date and time for the access grant.',
|
|
54800
|
+
format: 'date-time',
|
|
54801
|
+
type: 'string',
|
|
54802
|
+
},
|
|
54803
|
+
facility_keys: {
|
|
54804
|
+
description: 'Facility keys associated with the access grant.',
|
|
54805
|
+
items: { type: 'string' },
|
|
54806
|
+
type: 'array',
|
|
54807
|
+
},
|
|
54808
|
+
guest_key: {
|
|
54809
|
+
description: 'Guest key associated with the access grant.',
|
|
54810
|
+
type: 'string',
|
|
54811
|
+
},
|
|
54812
|
+
listing_keys: {
|
|
54813
|
+
description: 'Listing keys associated with the access grant.',
|
|
54814
|
+
items: { type: 'string' },
|
|
54815
|
+
type: 'array',
|
|
54816
|
+
},
|
|
54817
|
+
name: {
|
|
54818
|
+
description: 'Your name for this access grant resource.',
|
|
54819
|
+
type: 'string',
|
|
54820
|
+
},
|
|
54821
|
+
preferred_code: {
|
|
54822
|
+
description: 'Preferred PIN code to use when creating access for this reservation.',
|
|
54823
|
+
type: 'string',
|
|
54824
|
+
},
|
|
54825
|
+
property_keys: {
|
|
54826
|
+
description: 'Property keys associated with the access grant.',
|
|
54827
|
+
items: { type: 'string' },
|
|
54828
|
+
type: 'array',
|
|
54829
|
+
},
|
|
54830
|
+
resident_key: {
|
|
54831
|
+
description: 'Resident key associated with the access grant.',
|
|
54832
|
+
type: 'string',
|
|
54833
|
+
},
|
|
54834
|
+
room_keys: {
|
|
54835
|
+
description: 'Room keys associated with the access grant.',
|
|
54836
|
+
items: { type: 'string' },
|
|
54837
|
+
type: 'array',
|
|
54838
|
+
},
|
|
54839
|
+
space_keys: {
|
|
54840
|
+
description: 'Space keys associated with the access grant.',
|
|
54841
|
+
items: { type: 'string' },
|
|
54842
|
+
type: 'array',
|
|
54843
|
+
},
|
|
54844
|
+
starts_at: {
|
|
54845
|
+
description: 'Starting date and time for the access grant.',
|
|
54846
|
+
format: 'date-time',
|
|
54847
|
+
type: 'string',
|
|
54848
|
+
},
|
|
54849
|
+
tenant_key: {
|
|
54850
|
+
description: 'Tenant key associated with the access grant.',
|
|
54851
|
+
type: 'string',
|
|
54852
|
+
},
|
|
54853
|
+
unit_keys: {
|
|
54854
|
+
description: 'Unit keys associated with the access grant.',
|
|
54855
|
+
items: { type: 'string' },
|
|
54856
|
+
type: 'array',
|
|
54857
|
+
},
|
|
54858
|
+
user_identity_key: {
|
|
54859
|
+
description: 'User identity key associated with the access grant.',
|
|
54860
|
+
type: 'string',
|
|
54861
|
+
},
|
|
54862
|
+
user_key: {
|
|
54863
|
+
description: 'User key associated with the access grant.',
|
|
54864
|
+
type: 'string',
|
|
54865
|
+
},
|
|
54866
|
+
},
|
|
54867
|
+
required: ['access_grant_key'],
|
|
54868
|
+
type: 'object',
|
|
54869
|
+
},
|
|
54870
|
+
type: 'array',
|
|
54871
|
+
},
|
|
54872
|
+
bookings: {
|
|
54873
|
+
description: 'List of bookings.',
|
|
54874
|
+
items: {
|
|
54875
|
+
properties: {
|
|
54876
|
+
booking_key: {
|
|
54877
|
+
description: 'Your unique identifier for the booking.',
|
|
54878
|
+
minLength: 1,
|
|
54879
|
+
type: 'string',
|
|
54880
|
+
},
|
|
54881
|
+
building_keys: {
|
|
54882
|
+
description: 'Building keys associated with the access grant.',
|
|
54883
|
+
items: { type: 'string' },
|
|
54884
|
+
type: 'array',
|
|
54885
|
+
},
|
|
54886
|
+
common_area_keys: {
|
|
54887
|
+
description: 'Common area keys associated with the access grant.',
|
|
54888
|
+
items: { type: 'string' },
|
|
54889
|
+
type: 'array',
|
|
54890
|
+
},
|
|
54891
|
+
ends_at: {
|
|
54892
|
+
description: 'Ending date and time for the access grant.',
|
|
54893
|
+
format: 'date-time',
|
|
54894
|
+
type: 'string',
|
|
54895
|
+
},
|
|
54896
|
+
facility_keys: {
|
|
54897
|
+
description: 'Facility keys associated with the access grant.',
|
|
54898
|
+
items: { type: 'string' },
|
|
54899
|
+
type: 'array',
|
|
54900
|
+
},
|
|
54901
|
+
guest_key: {
|
|
54902
|
+
description: 'Guest key associated with the access grant.',
|
|
54903
|
+
type: 'string',
|
|
54904
|
+
},
|
|
54905
|
+
listing_keys: {
|
|
54906
|
+
description: 'Listing keys associated with the access grant.',
|
|
54907
|
+
items: { type: 'string' },
|
|
54908
|
+
type: 'array',
|
|
54909
|
+
},
|
|
54910
|
+
name: {
|
|
54911
|
+
description: 'Your name for this access grant resource.',
|
|
54912
|
+
type: 'string',
|
|
54913
|
+
},
|
|
54914
|
+
preferred_code: {
|
|
54915
|
+
description: 'Preferred PIN code to use when creating access for this reservation.',
|
|
54916
|
+
type: 'string',
|
|
54917
|
+
},
|
|
54918
|
+
property_keys: {
|
|
54919
|
+
description: 'Property keys associated with the access grant.',
|
|
54920
|
+
items: { type: 'string' },
|
|
54921
|
+
type: 'array',
|
|
54922
|
+
},
|
|
54923
|
+
resident_key: {
|
|
54924
|
+
description: 'Resident key associated with the access grant.',
|
|
54925
|
+
type: 'string',
|
|
54926
|
+
},
|
|
54927
|
+
room_keys: {
|
|
54928
|
+
description: 'Room keys associated with the access grant.',
|
|
54929
|
+
items: { type: 'string' },
|
|
54930
|
+
type: 'array',
|
|
54931
|
+
},
|
|
54932
|
+
space_keys: {
|
|
54933
|
+
description: 'Space keys associated with the access grant.',
|
|
54934
|
+
items: { type: 'string' },
|
|
54935
|
+
type: 'array',
|
|
54936
|
+
},
|
|
54937
|
+
starts_at: {
|
|
54938
|
+
description: 'Starting date and time for the access grant.',
|
|
54939
|
+
format: 'date-time',
|
|
54940
|
+
type: 'string',
|
|
54941
|
+
},
|
|
54942
|
+
tenant_key: {
|
|
54943
|
+
description: 'Tenant key associated with the access grant.',
|
|
54944
|
+
type: 'string',
|
|
54945
|
+
},
|
|
54946
|
+
unit_keys: {
|
|
54947
|
+
description: 'Unit keys associated with the access grant.',
|
|
54948
|
+
items: { type: 'string' },
|
|
54949
|
+
type: 'array',
|
|
54950
|
+
},
|
|
54951
|
+
user_identity_key: {
|
|
54952
|
+
description: 'User identity key associated with the access grant.',
|
|
54953
|
+
type: 'string',
|
|
54954
|
+
},
|
|
54955
|
+
user_key: {
|
|
54956
|
+
description: 'User key associated with the access grant.',
|
|
54957
|
+
type: 'string',
|
|
54958
|
+
},
|
|
54959
|
+
},
|
|
54960
|
+
required: ['booking_key'],
|
|
54961
|
+
type: 'object',
|
|
54962
|
+
},
|
|
54963
|
+
type: 'array',
|
|
54964
|
+
},
|
|
54965
|
+
buildings: {
|
|
54966
|
+
description: 'List of buildings.',
|
|
54967
|
+
items: {
|
|
54968
|
+
properties: {
|
|
54969
|
+
building_key: {
|
|
54970
|
+
description: 'Your unique identifier for the building.',
|
|
54971
|
+
minLength: 1,
|
|
54972
|
+
type: 'string',
|
|
54973
|
+
},
|
|
54974
|
+
name: {
|
|
54975
|
+
description: 'Your display name for this location resource.',
|
|
54976
|
+
type: 'string',
|
|
54977
|
+
},
|
|
54978
|
+
},
|
|
54979
|
+
required: ['name', 'building_key'],
|
|
54980
|
+
type: 'object',
|
|
54981
|
+
},
|
|
54982
|
+
type: 'array',
|
|
54983
|
+
},
|
|
54984
|
+
common_areas: {
|
|
54985
|
+
description: 'List of shared common areas.',
|
|
54986
|
+
items: {
|
|
54987
|
+
properties: {
|
|
54988
|
+
common_area_key: {
|
|
54989
|
+
description: 'Your unique identifier for the common area.',
|
|
54990
|
+
minLength: 1,
|
|
54991
|
+
type: 'string',
|
|
54992
|
+
},
|
|
54993
|
+
name: {
|
|
54994
|
+
description: 'Your display name for this location resource.',
|
|
54995
|
+
type: 'string',
|
|
54996
|
+
},
|
|
54997
|
+
parent_site_key: {
|
|
54998
|
+
description: 'Your unique identifier for the site.',
|
|
54999
|
+
minLength: 1,
|
|
55000
|
+
type: 'string',
|
|
55001
|
+
},
|
|
55002
|
+
},
|
|
55003
|
+
required: ['name', 'common_area_key'],
|
|
55004
|
+
type: 'object',
|
|
55005
|
+
},
|
|
55006
|
+
type: 'array',
|
|
55007
|
+
},
|
|
55008
|
+
facilities: {
|
|
55009
|
+
description: 'List of gym or fitness facilities.',
|
|
55010
|
+
items: {
|
|
55011
|
+
properties: {
|
|
55012
|
+
facility_key: {
|
|
55013
|
+
description: 'Your unique identifier for the facility.',
|
|
55014
|
+
minLength: 1,
|
|
55015
|
+
type: 'string',
|
|
55016
|
+
},
|
|
55017
|
+
name: {
|
|
55018
|
+
description: 'Your display name for this location resource.',
|
|
55019
|
+
type: 'string',
|
|
55020
|
+
},
|
|
55021
|
+
},
|
|
55022
|
+
required: ['name', 'facility_key'],
|
|
55023
|
+
type: 'object',
|
|
55024
|
+
},
|
|
55025
|
+
type: 'array',
|
|
55026
|
+
},
|
|
55027
|
+
guests: {
|
|
55028
|
+
description: 'List of guests.',
|
|
55029
|
+
items: {
|
|
55030
|
+
properties: {
|
|
55031
|
+
email_address: {
|
|
55032
|
+
description: 'Email address associated with the user identity.',
|
|
55033
|
+
type: 'string',
|
|
55034
|
+
},
|
|
55035
|
+
guest_key: {
|
|
55036
|
+
description: 'Your unique identifier for the guest.',
|
|
55037
|
+
minLength: 1,
|
|
55038
|
+
type: 'string',
|
|
55039
|
+
},
|
|
55040
|
+
name: {
|
|
55041
|
+
description: 'Your display name for this user identity resource.',
|
|
55042
|
+
type: 'string',
|
|
55043
|
+
},
|
|
55044
|
+
phone_number: {
|
|
55045
|
+
description: 'Phone number associated with the user identity.',
|
|
55046
|
+
type: 'string',
|
|
55047
|
+
},
|
|
55048
|
+
},
|
|
55049
|
+
required: ['name', 'guest_key'],
|
|
55050
|
+
type: 'object',
|
|
55051
|
+
},
|
|
55052
|
+
type: 'array',
|
|
55053
|
+
},
|
|
55054
|
+
listings: {
|
|
55055
|
+
description: 'List of property listings.',
|
|
55056
|
+
items: {
|
|
55057
|
+
properties: {
|
|
55058
|
+
listing_key: {
|
|
55059
|
+
description: 'Your unique identifier for the listing.',
|
|
55060
|
+
minLength: 1,
|
|
55061
|
+
type: 'string',
|
|
55062
|
+
},
|
|
55063
|
+
name: {
|
|
55064
|
+
description: 'Your display name for this location resource.',
|
|
55065
|
+
type: 'string',
|
|
55066
|
+
},
|
|
55067
|
+
},
|
|
55068
|
+
required: ['name', 'listing_key'],
|
|
55069
|
+
type: 'object',
|
|
55070
|
+
},
|
|
55071
|
+
type: 'array',
|
|
55072
|
+
},
|
|
55073
|
+
properties: {
|
|
55074
|
+
description: 'List of short-term rental properties.',
|
|
55075
|
+
items: {
|
|
55076
|
+
properties: {
|
|
55077
|
+
name: {
|
|
55078
|
+
description: 'Your display name for this location resource.',
|
|
55079
|
+
type: 'string',
|
|
55080
|
+
},
|
|
55081
|
+
property_key: {
|
|
55082
|
+
description: 'Your unique identifier for the property.',
|
|
55083
|
+
minLength: 1,
|
|
55084
|
+
type: 'string',
|
|
55085
|
+
},
|
|
55086
|
+
},
|
|
55087
|
+
required: ['name', 'property_key'],
|
|
55088
|
+
type: 'object',
|
|
55089
|
+
},
|
|
55090
|
+
type: 'array',
|
|
55091
|
+
},
|
|
55092
|
+
property_listings: {
|
|
55093
|
+
description: 'List of property listings.',
|
|
55094
|
+
items: {
|
|
55095
|
+
properties: {
|
|
55096
|
+
custom_metadata: {
|
|
55097
|
+
additionalProperties: {
|
|
55098
|
+
nullable: true,
|
|
55099
|
+
oneOf: [
|
|
55100
|
+
{ maxLength: 500, type: 'string' },
|
|
55101
|
+
{ type: 'boolean' },
|
|
55102
|
+
],
|
|
55103
|
+
},
|
|
55104
|
+
description: 'Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.',
|
|
55105
|
+
type: 'object',
|
|
55106
|
+
},
|
|
55107
|
+
name: {
|
|
55108
|
+
description: 'Your display name for this location resource.',
|
|
55109
|
+
type: 'string',
|
|
55110
|
+
},
|
|
55111
|
+
property_listing_key: {
|
|
55112
|
+
description: 'Your unique identifier for the property listing.',
|
|
55113
|
+
minLength: 1,
|
|
55114
|
+
type: 'string',
|
|
55115
|
+
},
|
|
55116
|
+
},
|
|
55117
|
+
required: ['name', 'property_listing_key'],
|
|
55118
|
+
type: 'object',
|
|
55119
|
+
},
|
|
55120
|
+
type: 'array',
|
|
55121
|
+
},
|
|
55122
|
+
reservations: {
|
|
55123
|
+
description: 'List of reservations.',
|
|
55124
|
+
items: {
|
|
55125
|
+
properties: {
|
|
55126
|
+
building_keys: {
|
|
55127
|
+
description: 'Building keys associated with the access grant.',
|
|
55128
|
+
items: { type: 'string' },
|
|
55129
|
+
type: 'array',
|
|
55130
|
+
},
|
|
55131
|
+
common_area_keys: {
|
|
55132
|
+
description: 'Common area keys associated with the access grant.',
|
|
55133
|
+
items: { type: 'string' },
|
|
55134
|
+
type: 'array',
|
|
55135
|
+
},
|
|
55136
|
+
ends_at: {
|
|
55137
|
+
description: 'Ending date and time for the access grant.',
|
|
55138
|
+
format: 'date-time',
|
|
55139
|
+
type: 'string',
|
|
55140
|
+
},
|
|
55141
|
+
facility_keys: {
|
|
55142
|
+
description: 'Facility keys associated with the access grant.',
|
|
55143
|
+
items: { type: 'string' },
|
|
55144
|
+
type: 'array',
|
|
55145
|
+
},
|
|
55146
|
+
guest_key: {
|
|
55147
|
+
description: 'Guest key associated with the access grant.',
|
|
55148
|
+
type: 'string',
|
|
55149
|
+
},
|
|
55150
|
+
listing_keys: {
|
|
55151
|
+
description: 'Listing keys associated with the access grant.',
|
|
55152
|
+
items: { type: 'string' },
|
|
55153
|
+
type: 'array',
|
|
55154
|
+
},
|
|
55155
|
+
name: {
|
|
55156
|
+
description: 'Your name for this access grant resource.',
|
|
55157
|
+
type: 'string',
|
|
55158
|
+
},
|
|
55159
|
+
preferred_code: {
|
|
55160
|
+
description: 'Preferred PIN code to use when creating access for this reservation.',
|
|
55161
|
+
type: 'string',
|
|
55162
|
+
},
|
|
55163
|
+
property_keys: {
|
|
55164
|
+
description: 'Property keys associated with the access grant.',
|
|
55165
|
+
items: { type: 'string' },
|
|
55166
|
+
type: 'array',
|
|
55167
|
+
},
|
|
55168
|
+
reservation_key: {
|
|
55169
|
+
description: 'Your unique identifier for the reservation.',
|
|
55170
|
+
minLength: 1,
|
|
55171
|
+
type: 'string',
|
|
55172
|
+
},
|
|
55173
|
+
resident_key: {
|
|
55174
|
+
description: 'Resident key associated with the access grant.',
|
|
55175
|
+
type: 'string',
|
|
55176
|
+
},
|
|
55177
|
+
room_keys: {
|
|
55178
|
+
description: 'Room keys associated with the access grant.',
|
|
55179
|
+
items: { type: 'string' },
|
|
55180
|
+
type: 'array',
|
|
55181
|
+
},
|
|
55182
|
+
space_keys: {
|
|
55183
|
+
description: 'Space keys associated with the access grant.',
|
|
55184
|
+
items: { type: 'string' },
|
|
55185
|
+
type: 'array',
|
|
55186
|
+
},
|
|
55187
|
+
starts_at: {
|
|
55188
|
+
description: 'Starting date and time for the access grant.',
|
|
55189
|
+
format: 'date-time',
|
|
55190
|
+
type: 'string',
|
|
55191
|
+
},
|
|
55192
|
+
tenant_key: {
|
|
55193
|
+
description: 'Tenant key associated with the access grant.',
|
|
55194
|
+
type: 'string',
|
|
55195
|
+
},
|
|
55196
|
+
unit_keys: {
|
|
55197
|
+
description: 'Unit keys associated with the access grant.',
|
|
55198
|
+
items: { type: 'string' },
|
|
55199
|
+
type: 'array',
|
|
55200
|
+
},
|
|
55201
|
+
user_identity_key: {
|
|
55202
|
+
description: 'User identity key associated with the access grant.',
|
|
55203
|
+
type: 'string',
|
|
55204
|
+
},
|
|
55205
|
+
user_key: {
|
|
55206
|
+
description: 'User key associated with the access grant.',
|
|
55207
|
+
type: 'string',
|
|
55208
|
+
},
|
|
55209
|
+
},
|
|
55210
|
+
required: ['reservation_key'],
|
|
55211
|
+
type: 'object',
|
|
55212
|
+
},
|
|
55213
|
+
type: 'array',
|
|
55214
|
+
},
|
|
55215
|
+
residents: {
|
|
55216
|
+
description: 'List of residents.',
|
|
55217
|
+
items: {
|
|
55218
|
+
properties: {
|
|
55219
|
+
email_address: {
|
|
55220
|
+
description: 'Email address associated with the user identity.',
|
|
55221
|
+
type: 'string',
|
|
55222
|
+
},
|
|
55223
|
+
name: {
|
|
55224
|
+
description: 'Your display name for this user identity resource.',
|
|
55225
|
+
type: 'string',
|
|
55226
|
+
},
|
|
55227
|
+
phone_number: {
|
|
55228
|
+
description: 'Phone number associated with the user identity.',
|
|
55229
|
+
type: 'string',
|
|
55230
|
+
},
|
|
55231
|
+
resident_key: {
|
|
55232
|
+
description: 'Your unique identifier for the resident.',
|
|
55233
|
+
minLength: 1,
|
|
55234
|
+
type: 'string',
|
|
55235
|
+
},
|
|
55236
|
+
},
|
|
55237
|
+
required: ['name', 'resident_key'],
|
|
55238
|
+
type: 'object',
|
|
55239
|
+
},
|
|
55240
|
+
type: 'array',
|
|
55241
|
+
},
|
|
55242
|
+
rooms: {
|
|
55243
|
+
description: 'List of hotel or hospitality rooms.',
|
|
55244
|
+
items: {
|
|
55245
|
+
properties: {
|
|
55246
|
+
name: {
|
|
55247
|
+
description: 'Your display name for this location resource.',
|
|
55248
|
+
type: 'string',
|
|
55249
|
+
},
|
|
55250
|
+
parent_site_key: {
|
|
55251
|
+
description: 'Your unique identifier for the site.',
|
|
55252
|
+
minLength: 1,
|
|
55253
|
+
type: 'string',
|
|
55254
|
+
},
|
|
55255
|
+
room_key: {
|
|
55256
|
+
description: 'Your unique identifier for the room.',
|
|
55257
|
+
minLength: 1,
|
|
55258
|
+
type: 'string',
|
|
55259
|
+
},
|
|
55260
|
+
},
|
|
55261
|
+
required: ['name', 'room_key'],
|
|
55262
|
+
type: 'object',
|
|
55263
|
+
},
|
|
55264
|
+
type: 'array',
|
|
55265
|
+
},
|
|
55266
|
+
sites: {
|
|
55267
|
+
description: 'List of general sites or areas.',
|
|
55268
|
+
items: {
|
|
55269
|
+
properties: {
|
|
55270
|
+
name: {
|
|
55271
|
+
description: 'Your display name for this location resource.',
|
|
55272
|
+
type: 'string',
|
|
55273
|
+
},
|
|
55274
|
+
site_key: {
|
|
55275
|
+
description: 'Your unique identifier for the site.',
|
|
55276
|
+
minLength: 1,
|
|
55277
|
+
type: 'string',
|
|
55278
|
+
},
|
|
55279
|
+
},
|
|
55280
|
+
required: ['name', 'site_key'],
|
|
55281
|
+
type: 'object',
|
|
55282
|
+
},
|
|
55283
|
+
type: 'array',
|
|
55284
|
+
},
|
|
55285
|
+
spaces: {
|
|
55286
|
+
description: 'List of general spaces or areas.',
|
|
55287
|
+
items: {
|
|
55288
|
+
properties: {
|
|
55289
|
+
name: {
|
|
55290
|
+
description: 'Your display name for this location resource.',
|
|
55291
|
+
type: 'string',
|
|
55292
|
+
},
|
|
55293
|
+
space_key: {
|
|
55294
|
+
description: 'Your unique identifier for the space.',
|
|
55295
|
+
minLength: 1,
|
|
55296
|
+
type: 'string',
|
|
55297
|
+
},
|
|
55298
|
+
},
|
|
55299
|
+
required: ['name', 'space_key'],
|
|
55300
|
+
type: 'object',
|
|
55301
|
+
},
|
|
55302
|
+
type: 'array',
|
|
55303
|
+
},
|
|
55304
|
+
staff_members: {
|
|
55305
|
+
description: 'List of staff members.',
|
|
55306
|
+
items: {
|
|
55307
|
+
description: 'Represents a staff member for a specific customer.',
|
|
55308
|
+
properties: {
|
|
55309
|
+
building_keys: {
|
|
55310
|
+
description: 'List of unique identifiers for the buildings the staff member is associated with.',
|
|
55311
|
+
items: { type: 'string' },
|
|
55312
|
+
type: 'array',
|
|
55313
|
+
},
|
|
55314
|
+
common_area_keys: {
|
|
55315
|
+
description: 'List of unique identifiers for the common areas the staff member is associated with.',
|
|
55316
|
+
items: { type: 'string' },
|
|
55317
|
+
type: 'array',
|
|
55318
|
+
},
|
|
55319
|
+
email_address: {
|
|
55320
|
+
description: 'Email address associated with the user identity.',
|
|
55321
|
+
type: 'string',
|
|
55322
|
+
},
|
|
55323
|
+
facility_keys: {
|
|
55324
|
+
description: 'List of unique identifiers for the facilities the staff member is associated with.',
|
|
55325
|
+
items: { type: 'string' },
|
|
55326
|
+
type: 'array',
|
|
55327
|
+
},
|
|
55328
|
+
listing_keys: {
|
|
55329
|
+
description: 'List of unique identifiers for the listings the staff member is associated with.',
|
|
55330
|
+
items: { type: 'string' },
|
|
55331
|
+
type: 'array',
|
|
55332
|
+
},
|
|
55333
|
+
name: {
|
|
55334
|
+
description: 'Your display name for this user identity resource.',
|
|
55335
|
+
type: 'string',
|
|
55336
|
+
},
|
|
55337
|
+
phone_number: {
|
|
55338
|
+
description: 'Phone number associated with the user identity.',
|
|
55339
|
+
type: 'string',
|
|
55340
|
+
},
|
|
55341
|
+
property_keys: {
|
|
55342
|
+
description: 'List of unique identifiers for the properties the staff member is associated with.',
|
|
55343
|
+
items: { type: 'string' },
|
|
55344
|
+
type: 'array',
|
|
55345
|
+
},
|
|
55346
|
+
property_listing_keys: {
|
|
55347
|
+
description: 'List of unique identifiers for the property listings the staff member is associated with.',
|
|
55348
|
+
items: { type: 'string' },
|
|
55349
|
+
type: 'array',
|
|
55350
|
+
},
|
|
55351
|
+
room_keys: {
|
|
55352
|
+
description: 'List of unique identifiers for the rooms the staff member is associated with.',
|
|
55353
|
+
items: { type: 'string' },
|
|
55354
|
+
type: 'array',
|
|
55355
|
+
},
|
|
55356
|
+
site_keys: {
|
|
55357
|
+
description: 'List of unique identifiers for the sites the staff member is associated with.',
|
|
55358
|
+
items: { type: 'string' },
|
|
55359
|
+
type: 'array',
|
|
55360
|
+
},
|
|
55361
|
+
space_keys: {
|
|
55362
|
+
description: 'List of unique identifiers for the spaces the staff member is associated with.',
|
|
55363
|
+
items: { type: 'string' },
|
|
55364
|
+
type: 'array',
|
|
55365
|
+
},
|
|
55366
|
+
staff_member_key: {
|
|
55367
|
+
description: 'Your unique identifier for the staff.',
|
|
55368
|
+
type: 'string',
|
|
55369
|
+
},
|
|
55370
|
+
unit_keys: {
|
|
55371
|
+
description: 'List of unique identifiers for the units the staff member is associated with.',
|
|
55372
|
+
items: { type: 'string' },
|
|
55373
|
+
type: 'array',
|
|
55374
|
+
},
|
|
55375
|
+
},
|
|
55376
|
+
required: ['name', 'staff_member_key'],
|
|
55377
|
+
type: 'object',
|
|
55378
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
55379
|
+
},
|
|
55380
|
+
type: 'array',
|
|
55381
|
+
},
|
|
55382
|
+
tenants: {
|
|
55383
|
+
description: 'List of tenants.',
|
|
55384
|
+
items: {
|
|
55385
|
+
properties: {
|
|
55386
|
+
email_address: {
|
|
55387
|
+
description: 'Email address associated with the user identity.',
|
|
55388
|
+
type: 'string',
|
|
55389
|
+
},
|
|
55390
|
+
name: {
|
|
55391
|
+
description: 'Your display name for this user identity resource.',
|
|
55392
|
+
type: 'string',
|
|
55393
|
+
},
|
|
55394
|
+
phone_number: {
|
|
55395
|
+
description: 'Phone number associated with the user identity.',
|
|
55396
|
+
type: 'string',
|
|
55397
|
+
},
|
|
55398
|
+
tenant_key: {
|
|
55399
|
+
description: 'Your unique identifier for the tenant.',
|
|
55400
|
+
minLength: 1,
|
|
55401
|
+
type: 'string',
|
|
55402
|
+
},
|
|
55403
|
+
},
|
|
55404
|
+
required: ['name', 'tenant_key'],
|
|
55405
|
+
type: 'object',
|
|
55406
|
+
},
|
|
55407
|
+
type: 'array',
|
|
55408
|
+
},
|
|
55409
|
+
units: {
|
|
55410
|
+
description: 'List of multi-family residential units.',
|
|
55411
|
+
items: {
|
|
55412
|
+
properties: {
|
|
55413
|
+
name: {
|
|
55414
|
+
description: 'Your display name for this location resource.',
|
|
55415
|
+
type: 'string',
|
|
55416
|
+
},
|
|
55417
|
+
parent_site_key: {
|
|
55418
|
+
description: 'Your unique identifier for the site.',
|
|
55419
|
+
minLength: 1,
|
|
55420
|
+
type: 'string',
|
|
55421
|
+
},
|
|
55422
|
+
unit_key: {
|
|
55423
|
+
description: 'Your unique identifier for the unit.',
|
|
55424
|
+
minLength: 1,
|
|
55425
|
+
type: 'string',
|
|
55426
|
+
},
|
|
55427
|
+
},
|
|
55428
|
+
required: ['name', 'unit_key'],
|
|
55429
|
+
type: 'object',
|
|
55430
|
+
},
|
|
55431
|
+
type: 'array',
|
|
55432
|
+
},
|
|
55433
|
+
user_identities: {
|
|
55434
|
+
description: 'List of user identities.',
|
|
55435
|
+
items: {
|
|
55436
|
+
properties: {
|
|
55437
|
+
email_address: {
|
|
55438
|
+
description: 'Email address associated with the user identity.',
|
|
55439
|
+
type: 'string',
|
|
55440
|
+
},
|
|
55441
|
+
name: {
|
|
55442
|
+
description: 'Your display name for this user identity resource.',
|
|
55443
|
+
type: 'string',
|
|
55444
|
+
},
|
|
55445
|
+
phone_number: {
|
|
55446
|
+
description: 'Phone number associated with the user identity.',
|
|
55447
|
+
type: 'string',
|
|
55448
|
+
},
|
|
55449
|
+
user_identity_key: {
|
|
55450
|
+
description: 'Your unique identifier for the user identity.',
|
|
55451
|
+
minLength: 1,
|
|
55452
|
+
type: 'string',
|
|
55453
|
+
},
|
|
55454
|
+
},
|
|
55455
|
+
required: ['name', 'user_identity_key'],
|
|
55456
|
+
type: 'object',
|
|
55457
|
+
},
|
|
55458
|
+
type: 'array',
|
|
55459
|
+
},
|
|
55460
|
+
users: {
|
|
55461
|
+
description: 'List of users.',
|
|
55462
|
+
items: {
|
|
55463
|
+
properties: {
|
|
55464
|
+
email_address: {
|
|
55465
|
+
description: 'Email address associated with the user identity.',
|
|
55466
|
+
type: 'string',
|
|
55467
|
+
},
|
|
55468
|
+
name: {
|
|
55469
|
+
description: 'Your display name for this user identity resource.',
|
|
55470
|
+
type: 'string',
|
|
55471
|
+
},
|
|
55472
|
+
phone_number: {
|
|
55473
|
+
description: 'Phone number associated with the user identity.',
|
|
55474
|
+
type: 'string',
|
|
55475
|
+
},
|
|
55476
|
+
user_key: {
|
|
55477
|
+
description: 'Your unique identifier for the user.',
|
|
55478
|
+
minLength: 1,
|
|
55479
|
+
type: 'string',
|
|
55480
|
+
},
|
|
55481
|
+
},
|
|
55482
|
+
required: ['name', 'user_key'],
|
|
55483
|
+
type: 'object',
|
|
55484
|
+
},
|
|
55485
|
+
type: 'array',
|
|
55486
|
+
},
|
|
55487
|
+
},
|
|
55488
|
+
type: 'object',
|
|
55489
|
+
},
|
|
55490
|
+
},
|
|
55491
|
+
},
|
|
55492
|
+
},
|
|
55493
|
+
responses: {
|
|
55494
|
+
200: {
|
|
55495
|
+
content: {
|
|
55496
|
+
'application/json': {
|
|
55497
|
+
schema: {
|
|
55498
|
+
properties: { ok: { type: 'boolean' } },
|
|
55499
|
+
required: ['ok'],
|
|
55500
|
+
type: 'object',
|
|
55501
|
+
},
|
|
55502
|
+
},
|
|
55503
|
+
},
|
|
55504
|
+
description: 'OK',
|
|
55505
|
+
},
|
|
55506
|
+
400: { description: 'Bad Request' },
|
|
55507
|
+
401: { description: 'Unauthorized' },
|
|
55508
|
+
},
|
|
55509
|
+
security: [{ client_session_with_customer: [] }],
|
|
55510
|
+
summary: '/seam/v1/customers/push_data',
|
|
55511
|
+
tags: [],
|
|
55512
|
+
'x-fern-sdk-group-name': ['seam', 'v1', 'customers'],
|
|
55513
|
+
'x-fern-sdk-method-name': 'push_data',
|
|
55514
|
+
'x-response-key': null,
|
|
55515
|
+
'x-title': 'Push Customer Data',
|
|
55516
|
+
},
|
|
55517
|
+
},
|
|
54585
55518
|
'/spaces/add_acs_entrances': {
|
|
54586
55519
|
post: {
|
|
54587
55520
|
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
|