@seamapi/types 1.421.1 → 1.422.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 +1630 -583
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2627 -1024
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +420 -0
- package/lib/seam/connect/models/customer/access-grant-resources.js +111 -0
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -0
- package/lib/seam/connect/models/customer/business-vertical.d.ts +3 -0
- package/lib/seam/connect/models/customer/business-vertical.js +11 -0
- package/lib/seam/connect/models/customer/business-vertical.js.map +1 -0
- package/lib/seam/connect/models/customer/customer-data.d.ts +597 -0
- package/lib/seam/connect/models/customer/customer-data.js +67 -0
- package/lib/seam/connect/models/customer/customer-data.js.map +1 -0
- package/lib/seam/connect/models/customer/customer-portal.d.ts +71 -0
- package/lib/seam/connect/models/customer/customer-portal.js +34 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -0
- package/lib/seam/connect/models/customer/index.d.ts +3 -0
- package/lib/seam/connect/models/customer/index.js +4 -0
- package/lib/seam/connect/models/customer/index.js.map +1 -0
- package/lib/seam/connect/models/customer/location-resources.d.ts +229 -0
- package/lib/seam/connect/models/customer/location-resources.js +55 -0
- package/lib/seam/connect/models/customer/location-resources.js.map +1 -0
- package/lib/seam/connect/models/customer/user-identity-resources.d.ts +205 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js +50 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -0
- package/lib/seam/connect/models/index.d.ts +4 -0
- package/lib/seam/connect/models/index.js +4 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/partner/index.d.ts +0 -1
- package/lib/seam/connect/models/partner/index.js +0 -1
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +2 -2
- package/lib/seam/connect/openapi.d.ts +1821 -658
- package/lib/seam/connect/openapi.js +1639 -592
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +552 -112
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +21 -3
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +129 -0
- package/src/lib/seam/connect/models/customer/business-vertical.ts +13 -0
- package/src/lib/seam/connect/models/customer/customer-data.ts +93 -0
- package/src/lib/seam/connect/models/customer/customer-portal.ts +39 -0
- package/src/lib/seam/connect/models/customer/index.ts +3 -0
- package/src/lib/seam/connect/models/customer/location-resources.ts +77 -0
- package/src/lib/seam/connect/models/customer/user-identity-resources.ts +68 -0
- package/src/lib/seam/connect/models/index.ts +4 -0
- package/src/lib/seam/connect/models/partner/index.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +1794 -601
- package/src/lib/seam/connect/route-types.ts +642 -114
- package/lib/seam/connect/models/partner/resources.d.ts +0 -76
- package/lib/seam/connect/models/partner/resources.js +0 -87
- package/lib/seam/connect/models/partner/resources.js.map +0 -1
- package/src/lib/seam/connect/models/partner/resources.ts +0 -112
|
@@ -18195,77 +18195,6 @@ export default {
|
|
|
18195
18195
|
required: ['next_page_cursor', 'has_next_page', 'next_page_url'],
|
|
18196
18196
|
type: 'object',
|
|
18197
18197
|
},
|
|
18198
|
-
partner_resource: {
|
|
18199
|
-
description:
|
|
18200
|
-
'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
|
|
18201
|
-
properties: {
|
|
18202
|
-
custom_metadata: {
|
|
18203
|
-
additionalProperties: { type: 'string' },
|
|
18204
|
-
description:
|
|
18205
|
-
'Custom metadata associated with the partner resource.',
|
|
18206
|
-
type: 'object',
|
|
18207
|
-
},
|
|
18208
|
-
customer_key: {
|
|
18209
|
-
description: 'Customer key associated with the partner resource.',
|
|
18210
|
-
type: 'string',
|
|
18211
|
-
},
|
|
18212
|
-
description: {
|
|
18213
|
-
description: 'Description of the partner resource.',
|
|
18214
|
-
type: 'string',
|
|
18215
|
-
},
|
|
18216
|
-
email_address: {
|
|
18217
|
-
description:
|
|
18218
|
-
'Email address associated with the user identity partner resource.',
|
|
18219
|
-
type: 'string',
|
|
18220
|
-
},
|
|
18221
|
-
ends_at: {
|
|
18222
|
-
description:
|
|
18223
|
-
'Ending date and time associated with the access grant partner resource.',
|
|
18224
|
-
type: 'string',
|
|
18225
|
-
},
|
|
18226
|
-
location_keys: {
|
|
18227
|
-
description:
|
|
18228
|
-
'Location keys associated with the access grant partner resource.',
|
|
18229
|
-
items: { type: 'string' },
|
|
18230
|
-
type: 'array',
|
|
18231
|
-
},
|
|
18232
|
-
name: {
|
|
18233
|
-
description: 'Name of the partner resource.',
|
|
18234
|
-
type: 'string',
|
|
18235
|
-
},
|
|
18236
|
-
partner_resource_key: {
|
|
18237
|
-
description: 'Key of the partner resource.',
|
|
18238
|
-
type: 'string',
|
|
18239
|
-
},
|
|
18240
|
-
partner_resource_type: {
|
|
18241
|
-
description: 'Type of the partner resource.',
|
|
18242
|
-
type: 'string',
|
|
18243
|
-
},
|
|
18244
|
-
phone_number: {
|
|
18245
|
-
description:
|
|
18246
|
-
'Phone number associated with the user identity partner resource.',
|
|
18247
|
-
type: 'string',
|
|
18248
|
-
},
|
|
18249
|
-
starts_at: {
|
|
18250
|
-
description:
|
|
18251
|
-
'Starting date and time associated with the access grant partner resource.',
|
|
18252
|
-
type: 'string',
|
|
18253
|
-
},
|
|
18254
|
-
user_identity_key: {
|
|
18255
|
-
description:
|
|
18256
|
-
'User identity key associated with the access grant partner resource.',
|
|
18257
|
-
type: 'string',
|
|
18258
|
-
},
|
|
18259
|
-
},
|
|
18260
|
-
required: [
|
|
18261
|
-
'partner_resource_type',
|
|
18262
|
-
'partner_resource_key',
|
|
18263
|
-
'customer_key',
|
|
18264
|
-
],
|
|
18265
|
-
type: 'object',
|
|
18266
|
-
'x-route-path': '/unstable_partner/resources',
|
|
18267
|
-
'x-undocumented': 'Unreleased.',
|
|
18268
|
-
},
|
|
18269
18198
|
phone: {
|
|
18270
18199
|
description: "Represents an app user's mobile phone.",
|
|
18271
18200
|
properties: {
|
|
@@ -35938,184 +35867,1593 @@ export default {
|
|
|
35938
35867
|
'x-title': 'Update a Connected Account',
|
|
35939
35868
|
},
|
|
35940
35869
|
},
|
|
35941
|
-
'/
|
|
35942
|
-
delete: {
|
|
35943
|
-
description:
|
|
35944
|
-
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
35945
|
-
operationId: 'devicesDeleteDelete',
|
|
35946
|
-
parameters: [
|
|
35947
|
-
{
|
|
35948
|
-
in: 'query',
|
|
35949
|
-
name: 'device_id',
|
|
35950
|
-
required: true,
|
|
35951
|
-
schema: {
|
|
35952
|
-
description: 'ID of the device that you want to delete.',
|
|
35953
|
-
format: 'uuid',
|
|
35954
|
-
type: 'string',
|
|
35955
|
-
},
|
|
35956
|
-
},
|
|
35957
|
-
],
|
|
35958
|
-
responses: {
|
|
35959
|
-
200: {
|
|
35960
|
-
content: {
|
|
35961
|
-
'application/json': {
|
|
35962
|
-
schema: {
|
|
35963
|
-
properties: { ok: { type: 'boolean' } },
|
|
35964
|
-
required: ['ok'],
|
|
35965
|
-
type: 'object',
|
|
35966
|
-
},
|
|
35967
|
-
},
|
|
35968
|
-
},
|
|
35969
|
-
description: 'OK',
|
|
35970
|
-
},
|
|
35971
|
-
400: { description: 'Bad Request' },
|
|
35972
|
-
401: { description: 'Unauthorized' },
|
|
35973
|
-
},
|
|
35974
|
-
security: [
|
|
35975
|
-
{ api_key: [] },
|
|
35976
|
-
{ pat_with_workspace: [] },
|
|
35977
|
-
{ console_session_with_workspace: [] },
|
|
35978
|
-
],
|
|
35979
|
-
summary: '/devices/delete',
|
|
35980
|
-
tags: ['/devices'],
|
|
35981
|
-
'x-deprecated':
|
|
35982
|
-
'Deleting a device is no longer supported and will be removed.',
|
|
35983
|
-
'x-fern-sdk-group-name': ['devices'],
|
|
35984
|
-
'x-fern-sdk-method-name': 'delete',
|
|
35985
|
-
'x-response-key': null,
|
|
35986
|
-
'x-title': 'Delete a Device',
|
|
35987
|
-
'x-undocumented':
|
|
35988
|
-
'Deleting a device is no longer supported and will be removed.',
|
|
35989
|
-
},
|
|
35990
|
-
post: {
|
|
35991
|
-
description:
|
|
35992
|
-
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
35993
|
-
operationId: 'devicesDeletePost',
|
|
35994
|
-
requestBody: {
|
|
35995
|
-
content: {
|
|
35996
|
-
'application/json': {
|
|
35997
|
-
schema: {
|
|
35998
|
-
properties: {
|
|
35999
|
-
device_id: {
|
|
36000
|
-
description: 'ID of the device that you want to delete.',
|
|
36001
|
-
format: 'uuid',
|
|
36002
|
-
type: 'string',
|
|
36003
|
-
},
|
|
36004
|
-
},
|
|
36005
|
-
required: ['device_id'],
|
|
36006
|
-
type: 'object',
|
|
36007
|
-
},
|
|
36008
|
-
},
|
|
36009
|
-
},
|
|
36010
|
-
},
|
|
36011
|
-
responses: {
|
|
36012
|
-
200: {
|
|
36013
|
-
content: {
|
|
36014
|
-
'application/json': {
|
|
36015
|
-
schema: {
|
|
36016
|
-
properties: { ok: { type: 'boolean' } },
|
|
36017
|
-
required: ['ok'],
|
|
36018
|
-
type: 'object',
|
|
36019
|
-
},
|
|
36020
|
-
},
|
|
36021
|
-
},
|
|
36022
|
-
description: 'OK',
|
|
36023
|
-
},
|
|
36024
|
-
400: { description: 'Bad Request' },
|
|
36025
|
-
401: { description: 'Unauthorized' },
|
|
36026
|
-
},
|
|
36027
|
-
security: [
|
|
36028
|
-
{ api_key: [] },
|
|
36029
|
-
{ pat_with_workspace: [] },
|
|
36030
|
-
{ console_session_with_workspace: [] },
|
|
36031
|
-
],
|
|
36032
|
-
summary: '/devices/delete',
|
|
36033
|
-
tags: ['/devices'],
|
|
36034
|
-
'x-deprecated':
|
|
36035
|
-
'Deleting a device is no longer supported and will be removed.',
|
|
36036
|
-
'x-fern-sdk-group-name': ['devices'],
|
|
36037
|
-
'x-fern-sdk-method-name': 'delete',
|
|
36038
|
-
'x-response-key': null,
|
|
36039
|
-
'x-title': 'Delete a Device',
|
|
36040
|
-
'x-undocumented':
|
|
36041
|
-
'Deleting a device is no longer supported and will be removed.',
|
|
36042
|
-
},
|
|
36043
|
-
},
|
|
36044
|
-
'/devices/get': {
|
|
36045
|
-
get: {
|
|
36046
|
-
description:
|
|
36047
|
-
'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
|
|
36048
|
-
operationId: 'devicesGetGet',
|
|
36049
|
-
parameters: [
|
|
36050
|
-
{
|
|
36051
|
-
in: 'query',
|
|
36052
|
-
name: 'device_id',
|
|
36053
|
-
schema: {
|
|
36054
|
-
description: 'ID of the device that you want to get.',
|
|
36055
|
-
format: 'uuid',
|
|
36056
|
-
type: 'string',
|
|
36057
|
-
},
|
|
36058
|
-
},
|
|
36059
|
-
{
|
|
36060
|
-
in: 'query',
|
|
36061
|
-
name: 'name',
|
|
36062
|
-
schema: {
|
|
36063
|
-
description: 'Name of the device that you want to get.',
|
|
36064
|
-
type: 'string',
|
|
36065
|
-
},
|
|
36066
|
-
},
|
|
36067
|
-
],
|
|
36068
|
-
responses: {
|
|
36069
|
-
200: {
|
|
36070
|
-
content: {
|
|
36071
|
-
'application/json': {
|
|
36072
|
-
schema: {
|
|
36073
|
-
properties: {
|
|
36074
|
-
device: { $ref: '#/components/schemas/device' },
|
|
36075
|
-
ok: { type: 'boolean' },
|
|
36076
|
-
},
|
|
36077
|
-
required: ['device', 'ok'],
|
|
36078
|
-
type: 'object',
|
|
36079
|
-
},
|
|
36080
|
-
},
|
|
36081
|
-
},
|
|
36082
|
-
description: 'OK',
|
|
36083
|
-
},
|
|
36084
|
-
400: { description: 'Bad Request' },
|
|
36085
|
-
401: { description: 'Unauthorized' },
|
|
36086
|
-
},
|
|
36087
|
-
security: [
|
|
36088
|
-
{ client_session: [] },
|
|
36089
|
-
{ client_session_with_customer: [] },
|
|
36090
|
-
{ pat_with_workspace: [] },
|
|
36091
|
-
{ console_session_with_workspace: [] },
|
|
36092
|
-
{ api_key: [] },
|
|
36093
|
-
],
|
|
36094
|
-
summary: '/devices/get',
|
|
36095
|
-
tags: ['/devices'],
|
|
36096
|
-
'x-fern-sdk-group-name': ['devices'],
|
|
36097
|
-
'x-fern-sdk-method-name': 'get',
|
|
36098
|
-
'x-fern-sdk-return-value': 'device',
|
|
36099
|
-
'x-response-key': 'device',
|
|
36100
|
-
'x-title': 'Get a Device',
|
|
36101
|
-
},
|
|
35870
|
+
'/customers/create_portal': {
|
|
36102
35871
|
post: {
|
|
36103
35872
|
description:
|
|
36104
|
-
'
|
|
36105
|
-
operationId: '
|
|
35873
|
+
'Creates a new customer portal magic link with configurable features.',
|
|
35874
|
+
operationId: 'customersCreatePortalPost',
|
|
36106
35875
|
requestBody: {
|
|
36107
35876
|
content: {
|
|
36108
35877
|
'application/json': {
|
|
36109
35878
|
schema: {
|
|
36110
|
-
|
|
36111
|
-
|
|
36112
|
-
|
|
36113
|
-
|
|
36114
|
-
|
|
36115
|
-
|
|
36116
|
-
|
|
36117
|
-
|
|
36118
|
-
|
|
35879
|
+
allOf: [
|
|
35880
|
+
{
|
|
35881
|
+
default: {
|
|
35882
|
+
features: {
|
|
35883
|
+
connect: { exclude: false },
|
|
35884
|
+
manage_devices: { exclude: false },
|
|
35885
|
+
organize: { exclude: false },
|
|
35886
|
+
},
|
|
35887
|
+
},
|
|
35888
|
+
description: 'Configuration for a customer portal',
|
|
35889
|
+
properties: {
|
|
35890
|
+
features: {
|
|
35891
|
+
default: {},
|
|
35892
|
+
properties: {
|
|
35893
|
+
connect: {
|
|
35894
|
+
default: {},
|
|
35895
|
+
description:
|
|
35896
|
+
'Configuration for the connect accounts feature.',
|
|
35897
|
+
properties: {
|
|
35898
|
+
exclude: {
|
|
35899
|
+
default: false,
|
|
35900
|
+
description:
|
|
35901
|
+
'Whether to exclude this feature from the portal.',
|
|
35902
|
+
type: 'boolean',
|
|
35903
|
+
},
|
|
35904
|
+
},
|
|
35905
|
+
type: 'object',
|
|
35906
|
+
},
|
|
35907
|
+
manage_devices: {
|
|
35908
|
+
default: {},
|
|
35909
|
+
description:
|
|
35910
|
+
'Configuration for the manage devices feature.',
|
|
35911
|
+
properties: {
|
|
35912
|
+
exclude: {
|
|
35913
|
+
default: false,
|
|
35914
|
+
description:
|
|
35915
|
+
'Whether to exclude this feature from the portal.',
|
|
35916
|
+
type: 'boolean',
|
|
35917
|
+
},
|
|
35918
|
+
},
|
|
35919
|
+
type: 'object',
|
|
35920
|
+
},
|
|
35921
|
+
organize: {
|
|
35922
|
+
default: {},
|
|
35923
|
+
description:
|
|
35924
|
+
'Configuration for the organize feature.',
|
|
35925
|
+
properties: {
|
|
35926
|
+
exclude: {
|
|
35927
|
+
default: false,
|
|
35928
|
+
description:
|
|
35929
|
+
'Whether to exclude this feature from the portal.',
|
|
35930
|
+
type: 'boolean',
|
|
35931
|
+
},
|
|
35932
|
+
},
|
|
35933
|
+
type: 'object',
|
|
35934
|
+
},
|
|
35935
|
+
},
|
|
35936
|
+
type: 'object',
|
|
35937
|
+
},
|
|
35938
|
+
},
|
|
35939
|
+
type: 'object',
|
|
35940
|
+
},
|
|
35941
|
+
{
|
|
35942
|
+
properties: {
|
|
35943
|
+
customer_data: {
|
|
35944
|
+
properties: {
|
|
35945
|
+
access_grants: {
|
|
35946
|
+
description: 'List of access grants.',
|
|
35947
|
+
items: {
|
|
35948
|
+
properties: {
|
|
35949
|
+
access_grant_key: {
|
|
35950
|
+
description:
|
|
35951
|
+
'Your unique identifier for the access grant.',
|
|
35952
|
+
type: 'string',
|
|
35953
|
+
},
|
|
35954
|
+
building_keys: {
|
|
35955
|
+
description:
|
|
35956
|
+
'Building keys associated with the access grant.',
|
|
35957
|
+
items: { type: 'string' },
|
|
35958
|
+
type: 'array',
|
|
35959
|
+
},
|
|
35960
|
+
common_area_keys: {
|
|
35961
|
+
description:
|
|
35962
|
+
'Common area keys associated with the access grant.',
|
|
35963
|
+
items: { type: 'string' },
|
|
35964
|
+
type: 'array',
|
|
35965
|
+
},
|
|
35966
|
+
ends_at: {
|
|
35967
|
+
description:
|
|
35968
|
+
'Ending date and time for the access grant.',
|
|
35969
|
+
type: 'string',
|
|
35970
|
+
},
|
|
35971
|
+
facility_keys: {
|
|
35972
|
+
description:
|
|
35973
|
+
'Facility keys associated with the access grant.',
|
|
35974
|
+
items: { type: 'string' },
|
|
35975
|
+
type: 'array',
|
|
35976
|
+
},
|
|
35977
|
+
guest_key: {
|
|
35978
|
+
description:
|
|
35979
|
+
'Guest key associated with the access grant.',
|
|
35980
|
+
type: 'string',
|
|
35981
|
+
},
|
|
35982
|
+
listing_keys: {
|
|
35983
|
+
description:
|
|
35984
|
+
'Listing keys associated with the access grant.',
|
|
35985
|
+
items: { type: 'string' },
|
|
35986
|
+
type: 'array',
|
|
35987
|
+
},
|
|
35988
|
+
name: {
|
|
35989
|
+
description:
|
|
35990
|
+
'Your display name for this access grant resource.',
|
|
35991
|
+
type: 'string',
|
|
35992
|
+
},
|
|
35993
|
+
property_keys: {
|
|
35994
|
+
description:
|
|
35995
|
+
'Property keys associated with the access grant.',
|
|
35996
|
+
items: { type: 'string' },
|
|
35997
|
+
type: 'array',
|
|
35998
|
+
},
|
|
35999
|
+
resident_key: {
|
|
36000
|
+
description:
|
|
36001
|
+
'Resident key associated with the access grant.',
|
|
36002
|
+
type: 'string',
|
|
36003
|
+
},
|
|
36004
|
+
room_keys: {
|
|
36005
|
+
description:
|
|
36006
|
+
'Room keys associated with the access grant.',
|
|
36007
|
+
items: { type: 'string' },
|
|
36008
|
+
type: 'array',
|
|
36009
|
+
},
|
|
36010
|
+
space_keys: {
|
|
36011
|
+
description:
|
|
36012
|
+
'Space keys associated with the access grant.',
|
|
36013
|
+
items: { type: 'string' },
|
|
36014
|
+
type: 'array',
|
|
36015
|
+
},
|
|
36016
|
+
starts_at: {
|
|
36017
|
+
description:
|
|
36018
|
+
'Starting date and time for the access grant.',
|
|
36019
|
+
type: 'string',
|
|
36020
|
+
},
|
|
36021
|
+
tenant_key: {
|
|
36022
|
+
description:
|
|
36023
|
+
'Tenant key associated with the access grant.',
|
|
36024
|
+
type: 'string',
|
|
36025
|
+
},
|
|
36026
|
+
unit_keys: {
|
|
36027
|
+
description:
|
|
36028
|
+
'Unit keys associated with the access grant.',
|
|
36029
|
+
items: { type: 'string' },
|
|
36030
|
+
type: 'array',
|
|
36031
|
+
},
|
|
36032
|
+
user_identity_key: {
|
|
36033
|
+
description:
|
|
36034
|
+
'User identity key associated with the access grant.',
|
|
36035
|
+
type: 'string',
|
|
36036
|
+
},
|
|
36037
|
+
user_key: {
|
|
36038
|
+
description:
|
|
36039
|
+
'User key associated with the access grant.',
|
|
36040
|
+
type: 'string',
|
|
36041
|
+
},
|
|
36042
|
+
},
|
|
36043
|
+
required: ['name', 'access_grant_key'],
|
|
36044
|
+
type: 'object',
|
|
36045
|
+
},
|
|
36046
|
+
type: 'array',
|
|
36047
|
+
},
|
|
36048
|
+
bookings: {
|
|
36049
|
+
description: 'List of bookings.',
|
|
36050
|
+
items: {
|
|
36051
|
+
properties: {
|
|
36052
|
+
booking_key: {
|
|
36053
|
+
description:
|
|
36054
|
+
'Your unique identifier for the booking.',
|
|
36055
|
+
type: 'string',
|
|
36056
|
+
},
|
|
36057
|
+
building_keys: {
|
|
36058
|
+
description:
|
|
36059
|
+
'Building keys associated with the access grant.',
|
|
36060
|
+
items: { type: 'string' },
|
|
36061
|
+
type: 'array',
|
|
36062
|
+
},
|
|
36063
|
+
common_area_keys: {
|
|
36064
|
+
description:
|
|
36065
|
+
'Common area keys associated with the access grant.',
|
|
36066
|
+
items: { type: 'string' },
|
|
36067
|
+
type: 'array',
|
|
36068
|
+
},
|
|
36069
|
+
ends_at: {
|
|
36070
|
+
description:
|
|
36071
|
+
'Ending date and time for the access grant.',
|
|
36072
|
+
type: 'string',
|
|
36073
|
+
},
|
|
36074
|
+
facility_keys: {
|
|
36075
|
+
description:
|
|
36076
|
+
'Facility keys associated with the access grant.',
|
|
36077
|
+
items: { type: 'string' },
|
|
36078
|
+
type: 'array',
|
|
36079
|
+
},
|
|
36080
|
+
guest_key: {
|
|
36081
|
+
description:
|
|
36082
|
+
'Guest key associated with the access grant.',
|
|
36083
|
+
type: 'string',
|
|
36084
|
+
},
|
|
36085
|
+
listing_keys: {
|
|
36086
|
+
description:
|
|
36087
|
+
'Listing keys associated with the access grant.',
|
|
36088
|
+
items: { type: 'string' },
|
|
36089
|
+
type: 'array',
|
|
36090
|
+
},
|
|
36091
|
+
name: {
|
|
36092
|
+
description:
|
|
36093
|
+
'Your display name for this access grant resource.',
|
|
36094
|
+
type: 'string',
|
|
36095
|
+
},
|
|
36096
|
+
property_keys: {
|
|
36097
|
+
description:
|
|
36098
|
+
'Property keys associated with the access grant.',
|
|
36099
|
+
items: { type: 'string' },
|
|
36100
|
+
type: 'array',
|
|
36101
|
+
},
|
|
36102
|
+
resident_key: {
|
|
36103
|
+
description:
|
|
36104
|
+
'Resident key associated with the access grant.',
|
|
36105
|
+
type: 'string',
|
|
36106
|
+
},
|
|
36107
|
+
room_keys: {
|
|
36108
|
+
description:
|
|
36109
|
+
'Room keys associated with the access grant.',
|
|
36110
|
+
items: { type: 'string' },
|
|
36111
|
+
type: 'array',
|
|
36112
|
+
},
|
|
36113
|
+
space_keys: {
|
|
36114
|
+
description:
|
|
36115
|
+
'Space keys associated with the access grant.',
|
|
36116
|
+
items: { type: 'string' },
|
|
36117
|
+
type: 'array',
|
|
36118
|
+
},
|
|
36119
|
+
starts_at: {
|
|
36120
|
+
description:
|
|
36121
|
+
'Starting date and time for the access grant.',
|
|
36122
|
+
type: 'string',
|
|
36123
|
+
},
|
|
36124
|
+
tenant_key: {
|
|
36125
|
+
description:
|
|
36126
|
+
'Tenant key associated with the access grant.',
|
|
36127
|
+
type: 'string',
|
|
36128
|
+
},
|
|
36129
|
+
unit_keys: {
|
|
36130
|
+
description:
|
|
36131
|
+
'Unit keys associated with the access grant.',
|
|
36132
|
+
items: { type: 'string' },
|
|
36133
|
+
type: 'array',
|
|
36134
|
+
},
|
|
36135
|
+
user_identity_key: {
|
|
36136
|
+
description:
|
|
36137
|
+
'User identity key associated with the access grant.',
|
|
36138
|
+
type: 'string',
|
|
36139
|
+
},
|
|
36140
|
+
user_key: {
|
|
36141
|
+
description:
|
|
36142
|
+
'User key associated with the access grant.',
|
|
36143
|
+
type: 'string',
|
|
36144
|
+
},
|
|
36145
|
+
},
|
|
36146
|
+
required: ['name', 'booking_key'],
|
|
36147
|
+
type: 'object',
|
|
36148
|
+
},
|
|
36149
|
+
type: 'array',
|
|
36150
|
+
},
|
|
36151
|
+
buildings: {
|
|
36152
|
+
description: 'List of buildings.',
|
|
36153
|
+
items: {
|
|
36154
|
+
properties: {
|
|
36155
|
+
building_key: {
|
|
36156
|
+
description:
|
|
36157
|
+
'Your unique identifier for the building.',
|
|
36158
|
+
type: 'string',
|
|
36159
|
+
},
|
|
36160
|
+
name: {
|
|
36161
|
+
description:
|
|
36162
|
+
'Your display name for this location resource.',
|
|
36163
|
+
type: 'string',
|
|
36164
|
+
},
|
|
36165
|
+
},
|
|
36166
|
+
required: ['name', 'building_key'],
|
|
36167
|
+
type: 'object',
|
|
36168
|
+
},
|
|
36169
|
+
type: 'array',
|
|
36170
|
+
},
|
|
36171
|
+
common_areas: {
|
|
36172
|
+
description: 'List of shared common areas.',
|
|
36173
|
+
items: {
|
|
36174
|
+
properties: {
|
|
36175
|
+
common_area_key: {
|
|
36176
|
+
description:
|
|
36177
|
+
'Your unique identifier for the common area.',
|
|
36178
|
+
type: 'string',
|
|
36179
|
+
},
|
|
36180
|
+
name: {
|
|
36181
|
+
description:
|
|
36182
|
+
'Your display name for this location resource.',
|
|
36183
|
+
type: 'string',
|
|
36184
|
+
},
|
|
36185
|
+
},
|
|
36186
|
+
required: ['name', 'common_area_key'],
|
|
36187
|
+
type: 'object',
|
|
36188
|
+
},
|
|
36189
|
+
type: 'array',
|
|
36190
|
+
},
|
|
36191
|
+
customer_key: {
|
|
36192
|
+
description:
|
|
36193
|
+
'Your unique identifier for the customer.',
|
|
36194
|
+
type: 'string',
|
|
36195
|
+
},
|
|
36196
|
+
facilities: {
|
|
36197
|
+
description: 'List of gym or fitness facilities.',
|
|
36198
|
+
items: {
|
|
36199
|
+
properties: {
|
|
36200
|
+
facility_key: {
|
|
36201
|
+
description:
|
|
36202
|
+
'Your unique identifier for the facility.',
|
|
36203
|
+
type: 'string',
|
|
36204
|
+
},
|
|
36205
|
+
name: {
|
|
36206
|
+
description:
|
|
36207
|
+
'Your display name for this location resource.',
|
|
36208
|
+
type: 'string',
|
|
36209
|
+
},
|
|
36210
|
+
},
|
|
36211
|
+
required: ['name', 'facility_key'],
|
|
36212
|
+
type: 'object',
|
|
36213
|
+
},
|
|
36214
|
+
type: 'array',
|
|
36215
|
+
},
|
|
36216
|
+
guests: {
|
|
36217
|
+
description: 'List of guests.',
|
|
36218
|
+
items: {
|
|
36219
|
+
properties: {
|
|
36220
|
+
email_address: {
|
|
36221
|
+
description:
|
|
36222
|
+
'Email address associated with the user identity.',
|
|
36223
|
+
type: 'string',
|
|
36224
|
+
},
|
|
36225
|
+
guest_key: {
|
|
36226
|
+
description:
|
|
36227
|
+
'Your unique identifier for the guest.',
|
|
36228
|
+
type: 'string',
|
|
36229
|
+
},
|
|
36230
|
+
name: {
|
|
36231
|
+
description:
|
|
36232
|
+
'Your display name for this user identity resource.',
|
|
36233
|
+
type: 'string',
|
|
36234
|
+
},
|
|
36235
|
+
phone_number: {
|
|
36236
|
+
description:
|
|
36237
|
+
'Phone number associated with the user identity.',
|
|
36238
|
+
type: 'string',
|
|
36239
|
+
},
|
|
36240
|
+
},
|
|
36241
|
+
required: ['name', 'guest_key'],
|
|
36242
|
+
type: 'object',
|
|
36243
|
+
},
|
|
36244
|
+
type: 'array',
|
|
36245
|
+
},
|
|
36246
|
+
listings: {
|
|
36247
|
+
description: 'List of property listings.',
|
|
36248
|
+
items: {
|
|
36249
|
+
properties: {
|
|
36250
|
+
listing_key: {
|
|
36251
|
+
description:
|
|
36252
|
+
'Your unique identifier for the listing.',
|
|
36253
|
+
type: 'string',
|
|
36254
|
+
},
|
|
36255
|
+
name: {
|
|
36256
|
+
description:
|
|
36257
|
+
'Your display name for this location resource.',
|
|
36258
|
+
type: 'string',
|
|
36259
|
+
},
|
|
36260
|
+
},
|
|
36261
|
+
required: ['name', 'listing_key'],
|
|
36262
|
+
type: 'object',
|
|
36263
|
+
},
|
|
36264
|
+
type: 'array',
|
|
36265
|
+
},
|
|
36266
|
+
properties: {
|
|
36267
|
+
description:
|
|
36268
|
+
'List of short-term rental properties.',
|
|
36269
|
+
items: {
|
|
36270
|
+
properties: {
|
|
36271
|
+
name: {
|
|
36272
|
+
description:
|
|
36273
|
+
'Your display name for this location resource.',
|
|
36274
|
+
type: 'string',
|
|
36275
|
+
},
|
|
36276
|
+
property_key: {
|
|
36277
|
+
description:
|
|
36278
|
+
'Your unique identifier for the property.',
|
|
36279
|
+
type: 'string',
|
|
36280
|
+
},
|
|
36281
|
+
},
|
|
36282
|
+
required: ['name', 'property_key'],
|
|
36283
|
+
type: 'object',
|
|
36284
|
+
},
|
|
36285
|
+
type: 'array',
|
|
36286
|
+
},
|
|
36287
|
+
reservations: {
|
|
36288
|
+
description: 'List of reservations.',
|
|
36289
|
+
items: {
|
|
36290
|
+
properties: {
|
|
36291
|
+
building_keys: {
|
|
36292
|
+
description:
|
|
36293
|
+
'Building keys associated with the access grant.',
|
|
36294
|
+
items: { type: 'string' },
|
|
36295
|
+
type: 'array',
|
|
36296
|
+
},
|
|
36297
|
+
common_area_keys: {
|
|
36298
|
+
description:
|
|
36299
|
+
'Common area keys associated with the access grant.',
|
|
36300
|
+
items: { type: 'string' },
|
|
36301
|
+
type: 'array',
|
|
36302
|
+
},
|
|
36303
|
+
ends_at: {
|
|
36304
|
+
description:
|
|
36305
|
+
'Ending date and time for the access grant.',
|
|
36306
|
+
type: 'string',
|
|
36307
|
+
},
|
|
36308
|
+
facility_keys: {
|
|
36309
|
+
description:
|
|
36310
|
+
'Facility keys associated with the access grant.',
|
|
36311
|
+
items: { type: 'string' },
|
|
36312
|
+
type: 'array',
|
|
36313
|
+
},
|
|
36314
|
+
guest_key: {
|
|
36315
|
+
description:
|
|
36316
|
+
'Guest key associated with the access grant.',
|
|
36317
|
+
type: 'string',
|
|
36318
|
+
},
|
|
36319
|
+
listing_keys: {
|
|
36320
|
+
description:
|
|
36321
|
+
'Listing keys associated with the access grant.',
|
|
36322
|
+
items: { type: 'string' },
|
|
36323
|
+
type: 'array',
|
|
36324
|
+
},
|
|
36325
|
+
name: {
|
|
36326
|
+
description:
|
|
36327
|
+
'Your display name for this access grant resource.',
|
|
36328
|
+
type: 'string',
|
|
36329
|
+
},
|
|
36330
|
+
property_keys: {
|
|
36331
|
+
description:
|
|
36332
|
+
'Property keys associated with the access grant.',
|
|
36333
|
+
items: { type: 'string' },
|
|
36334
|
+
type: 'array',
|
|
36335
|
+
},
|
|
36336
|
+
reservation_key: {
|
|
36337
|
+
description:
|
|
36338
|
+
'Your unique identifier for the reservation.',
|
|
36339
|
+
type: 'string',
|
|
36340
|
+
},
|
|
36341
|
+
resident_key: {
|
|
36342
|
+
description:
|
|
36343
|
+
'Resident key associated with the access grant.',
|
|
36344
|
+
type: 'string',
|
|
36345
|
+
},
|
|
36346
|
+
room_keys: {
|
|
36347
|
+
description:
|
|
36348
|
+
'Room keys associated with the access grant.',
|
|
36349
|
+
items: { type: 'string' },
|
|
36350
|
+
type: 'array',
|
|
36351
|
+
},
|
|
36352
|
+
space_keys: {
|
|
36353
|
+
description:
|
|
36354
|
+
'Space keys associated with the access grant.',
|
|
36355
|
+
items: { type: 'string' },
|
|
36356
|
+
type: 'array',
|
|
36357
|
+
},
|
|
36358
|
+
starts_at: {
|
|
36359
|
+
description:
|
|
36360
|
+
'Starting date and time for the access grant.',
|
|
36361
|
+
type: 'string',
|
|
36362
|
+
},
|
|
36363
|
+
tenant_key: {
|
|
36364
|
+
description:
|
|
36365
|
+
'Tenant key associated with the access grant.',
|
|
36366
|
+
type: 'string',
|
|
36367
|
+
},
|
|
36368
|
+
unit_keys: {
|
|
36369
|
+
description:
|
|
36370
|
+
'Unit keys associated with the access grant.',
|
|
36371
|
+
items: { type: 'string' },
|
|
36372
|
+
type: 'array',
|
|
36373
|
+
},
|
|
36374
|
+
user_identity_key: {
|
|
36375
|
+
description:
|
|
36376
|
+
'User identity key associated with the access grant.',
|
|
36377
|
+
type: 'string',
|
|
36378
|
+
},
|
|
36379
|
+
user_key: {
|
|
36380
|
+
description:
|
|
36381
|
+
'User key associated with the access grant.',
|
|
36382
|
+
type: 'string',
|
|
36383
|
+
},
|
|
36384
|
+
},
|
|
36385
|
+
required: ['name', 'reservation_key'],
|
|
36386
|
+
type: 'object',
|
|
36387
|
+
},
|
|
36388
|
+
type: 'array',
|
|
36389
|
+
},
|
|
36390
|
+
residents: {
|
|
36391
|
+
description: 'List of residents.',
|
|
36392
|
+
items: {
|
|
36393
|
+
properties: {
|
|
36394
|
+
email_address: {
|
|
36395
|
+
description:
|
|
36396
|
+
'Email address associated with the user identity.',
|
|
36397
|
+
type: 'string',
|
|
36398
|
+
},
|
|
36399
|
+
name: {
|
|
36400
|
+
description:
|
|
36401
|
+
'Your display name for this user identity resource.',
|
|
36402
|
+
type: 'string',
|
|
36403
|
+
},
|
|
36404
|
+
phone_number: {
|
|
36405
|
+
description:
|
|
36406
|
+
'Phone number associated with the user identity.',
|
|
36407
|
+
type: 'string',
|
|
36408
|
+
},
|
|
36409
|
+
resident_key: {
|
|
36410
|
+
description:
|
|
36411
|
+
'Your unique identifier for the resident.',
|
|
36412
|
+
type: 'string',
|
|
36413
|
+
},
|
|
36414
|
+
},
|
|
36415
|
+
required: ['name', 'resident_key'],
|
|
36416
|
+
type: 'object',
|
|
36417
|
+
},
|
|
36418
|
+
type: 'array',
|
|
36419
|
+
},
|
|
36420
|
+
rooms: {
|
|
36421
|
+
description: 'List of hotel or hospitality rooms.',
|
|
36422
|
+
items: {
|
|
36423
|
+
properties: {
|
|
36424
|
+
name: {
|
|
36425
|
+
description:
|
|
36426
|
+
'Your display name for this location resource.',
|
|
36427
|
+
type: 'string',
|
|
36428
|
+
},
|
|
36429
|
+
room_key: {
|
|
36430
|
+
description:
|
|
36431
|
+
'Your unique identifier for the room.',
|
|
36432
|
+
type: 'string',
|
|
36433
|
+
},
|
|
36434
|
+
},
|
|
36435
|
+
required: ['name', 'room_key'],
|
|
36436
|
+
type: 'object',
|
|
36437
|
+
},
|
|
36438
|
+
type: 'array',
|
|
36439
|
+
},
|
|
36440
|
+
spaces: {
|
|
36441
|
+
description: 'List of general spaces or areas.',
|
|
36442
|
+
items: {
|
|
36443
|
+
properties: {
|
|
36444
|
+
name: {
|
|
36445
|
+
description:
|
|
36446
|
+
'Your display name for this location resource.',
|
|
36447
|
+
type: 'string',
|
|
36448
|
+
},
|
|
36449
|
+
space_key: {
|
|
36450
|
+
description:
|
|
36451
|
+
'Your unique identifier for the space.',
|
|
36452
|
+
type: 'string',
|
|
36453
|
+
},
|
|
36454
|
+
},
|
|
36455
|
+
required: ['name', 'space_key'],
|
|
36456
|
+
type: 'object',
|
|
36457
|
+
},
|
|
36458
|
+
type: 'array',
|
|
36459
|
+
},
|
|
36460
|
+
tenants: {
|
|
36461
|
+
description: 'List of tenants.',
|
|
36462
|
+
items: {
|
|
36463
|
+
properties: {
|
|
36464
|
+
email_address: {
|
|
36465
|
+
description:
|
|
36466
|
+
'Email address associated with the user identity.',
|
|
36467
|
+
type: 'string',
|
|
36468
|
+
},
|
|
36469
|
+
name: {
|
|
36470
|
+
description:
|
|
36471
|
+
'Your display name for this user identity resource.',
|
|
36472
|
+
type: 'string',
|
|
36473
|
+
},
|
|
36474
|
+
phone_number: {
|
|
36475
|
+
description:
|
|
36476
|
+
'Phone number associated with the user identity.',
|
|
36477
|
+
type: 'string',
|
|
36478
|
+
},
|
|
36479
|
+
tenant_key: {
|
|
36480
|
+
description:
|
|
36481
|
+
'Your unique identifier for the tenant.',
|
|
36482
|
+
type: 'string',
|
|
36483
|
+
},
|
|
36484
|
+
},
|
|
36485
|
+
required: ['name', 'tenant_key'],
|
|
36486
|
+
type: 'object',
|
|
36487
|
+
},
|
|
36488
|
+
type: 'array',
|
|
36489
|
+
},
|
|
36490
|
+
units: {
|
|
36491
|
+
description:
|
|
36492
|
+
'List of multi-family residential units.',
|
|
36493
|
+
items: {
|
|
36494
|
+
properties: {
|
|
36495
|
+
name: {
|
|
36496
|
+
description:
|
|
36497
|
+
'Your display name for this location resource.',
|
|
36498
|
+
type: 'string',
|
|
36499
|
+
},
|
|
36500
|
+
unit_key: {
|
|
36501
|
+
description:
|
|
36502
|
+
'Your unique identifier for the unit.',
|
|
36503
|
+
type: 'string',
|
|
36504
|
+
},
|
|
36505
|
+
},
|
|
36506
|
+
required: ['name', 'unit_key'],
|
|
36507
|
+
type: 'object',
|
|
36508
|
+
},
|
|
36509
|
+
type: 'array',
|
|
36510
|
+
},
|
|
36511
|
+
user_identities: {
|
|
36512
|
+
description: 'List of user identities.',
|
|
36513
|
+
items: {
|
|
36514
|
+
properties: {
|
|
36515
|
+
email_address: {
|
|
36516
|
+
description:
|
|
36517
|
+
'Email address associated with the user identity.',
|
|
36518
|
+
type: 'string',
|
|
36519
|
+
},
|
|
36520
|
+
name: {
|
|
36521
|
+
description:
|
|
36522
|
+
'Your display name for this user identity resource.',
|
|
36523
|
+
type: 'string',
|
|
36524
|
+
},
|
|
36525
|
+
phone_number: {
|
|
36526
|
+
description:
|
|
36527
|
+
'Phone number associated with the user identity.',
|
|
36528
|
+
type: 'string',
|
|
36529
|
+
},
|
|
36530
|
+
user_identity_key: {
|
|
36531
|
+
description:
|
|
36532
|
+
'Your unique identifier for the user identity.',
|
|
36533
|
+
type: 'string',
|
|
36534
|
+
},
|
|
36535
|
+
},
|
|
36536
|
+
required: ['name', 'user_identity_key'],
|
|
36537
|
+
type: 'object',
|
|
36538
|
+
},
|
|
36539
|
+
type: 'array',
|
|
36540
|
+
},
|
|
36541
|
+
users: {
|
|
36542
|
+
description: 'List of users.',
|
|
36543
|
+
items: {
|
|
36544
|
+
properties: {
|
|
36545
|
+
email_address: {
|
|
36546
|
+
description:
|
|
36547
|
+
'Email address associated with the user identity.',
|
|
36548
|
+
type: 'string',
|
|
36549
|
+
},
|
|
36550
|
+
name: {
|
|
36551
|
+
description:
|
|
36552
|
+
'Your display name for this user identity resource.',
|
|
36553
|
+
type: 'string',
|
|
36554
|
+
},
|
|
36555
|
+
phone_number: {
|
|
36556
|
+
description:
|
|
36557
|
+
'Phone number associated with the user identity.',
|
|
36558
|
+
type: 'string',
|
|
36559
|
+
},
|
|
36560
|
+
user_key: {
|
|
36561
|
+
description:
|
|
36562
|
+
'Your unique identifier for the user.',
|
|
36563
|
+
type: 'string',
|
|
36564
|
+
},
|
|
36565
|
+
},
|
|
36566
|
+
required: ['name', 'user_key'],
|
|
36567
|
+
type: 'object',
|
|
36568
|
+
},
|
|
36569
|
+
type: 'array',
|
|
36570
|
+
},
|
|
36571
|
+
},
|
|
36572
|
+
required: ['customer_key'],
|
|
36573
|
+
type: 'object',
|
|
36574
|
+
},
|
|
36575
|
+
},
|
|
36576
|
+
type: 'object',
|
|
36577
|
+
},
|
|
36578
|
+
],
|
|
36579
|
+
},
|
|
36580
|
+
},
|
|
36581
|
+
},
|
|
36582
|
+
},
|
|
36583
|
+
responses: {
|
|
36584
|
+
200: {
|
|
36585
|
+
content: {
|
|
36586
|
+
'application/json': {
|
|
36587
|
+
schema: {
|
|
36588
|
+
properties: {
|
|
36589
|
+
magic_link: { $ref: '#/components/schemas/magic_link' },
|
|
36590
|
+
ok: { type: 'boolean' },
|
|
36591
|
+
},
|
|
36592
|
+
required: ['magic_link', 'ok'],
|
|
36593
|
+
type: 'object',
|
|
36594
|
+
},
|
|
36595
|
+
},
|
|
36596
|
+
},
|
|
36597
|
+
description: 'OK',
|
|
36598
|
+
},
|
|
36599
|
+
400: { description: 'Bad Request' },
|
|
36600
|
+
401: { description: 'Unauthorized' },
|
|
36601
|
+
},
|
|
36602
|
+
security: [
|
|
36603
|
+
{ pat_with_workspace: [] },
|
|
36604
|
+
{ console_session_with_workspace: [] },
|
|
36605
|
+
{ api_key: [] },
|
|
36606
|
+
],
|
|
36607
|
+
summary: '/customers/create_portal',
|
|
36608
|
+
tags: [],
|
|
36609
|
+
'x-fern-sdk-group-name': ['customers'],
|
|
36610
|
+
'x-fern-sdk-method-name': 'create_portal',
|
|
36611
|
+
'x-fern-sdk-return-value': 'magic_link',
|
|
36612
|
+
'x-response-key': 'magic_link',
|
|
36613
|
+
'x-title': 'Create Customer Portal',
|
|
36614
|
+
},
|
|
36615
|
+
},
|
|
36616
|
+
'/customers/push_data': {
|
|
36617
|
+
post: {
|
|
36618
|
+
description:
|
|
36619
|
+
'Pushes customer data including resources like spaces, properties, rooms, users, etc.',
|
|
36620
|
+
operationId: 'customersPushDataPost',
|
|
36621
|
+
requestBody: {
|
|
36622
|
+
content: {
|
|
36623
|
+
'application/json': {
|
|
36624
|
+
schema: {
|
|
36625
|
+
properties: {
|
|
36626
|
+
access_grants: {
|
|
36627
|
+
description: 'List of access grants.',
|
|
36628
|
+
items: {
|
|
36629
|
+
properties: {
|
|
36630
|
+
access_grant_key: {
|
|
36631
|
+
description:
|
|
36632
|
+
'Your unique identifier for the access grant.',
|
|
36633
|
+
type: 'string',
|
|
36634
|
+
},
|
|
36635
|
+
building_keys: {
|
|
36636
|
+
description:
|
|
36637
|
+
'Building keys associated with the access grant.',
|
|
36638
|
+
items: { type: 'string' },
|
|
36639
|
+
type: 'array',
|
|
36640
|
+
},
|
|
36641
|
+
common_area_keys: {
|
|
36642
|
+
description:
|
|
36643
|
+
'Common area keys associated with the access grant.',
|
|
36644
|
+
items: { type: 'string' },
|
|
36645
|
+
type: 'array',
|
|
36646
|
+
},
|
|
36647
|
+
ends_at: {
|
|
36648
|
+
description:
|
|
36649
|
+
'Ending date and time for the access grant.',
|
|
36650
|
+
type: 'string',
|
|
36651
|
+
},
|
|
36652
|
+
facility_keys: {
|
|
36653
|
+
description:
|
|
36654
|
+
'Facility keys associated with the access grant.',
|
|
36655
|
+
items: { type: 'string' },
|
|
36656
|
+
type: 'array',
|
|
36657
|
+
},
|
|
36658
|
+
guest_key: {
|
|
36659
|
+
description:
|
|
36660
|
+
'Guest key associated with the access grant.',
|
|
36661
|
+
type: 'string',
|
|
36662
|
+
},
|
|
36663
|
+
listing_keys: {
|
|
36664
|
+
description:
|
|
36665
|
+
'Listing keys associated with the access grant.',
|
|
36666
|
+
items: { type: 'string' },
|
|
36667
|
+
type: 'array',
|
|
36668
|
+
},
|
|
36669
|
+
name: {
|
|
36670
|
+
description:
|
|
36671
|
+
'Your display name for this access grant resource.',
|
|
36672
|
+
type: 'string',
|
|
36673
|
+
},
|
|
36674
|
+
property_keys: {
|
|
36675
|
+
description:
|
|
36676
|
+
'Property keys associated with the access grant.',
|
|
36677
|
+
items: { type: 'string' },
|
|
36678
|
+
type: 'array',
|
|
36679
|
+
},
|
|
36680
|
+
resident_key: {
|
|
36681
|
+
description:
|
|
36682
|
+
'Resident key associated with the access grant.',
|
|
36683
|
+
type: 'string',
|
|
36684
|
+
},
|
|
36685
|
+
room_keys: {
|
|
36686
|
+
description:
|
|
36687
|
+
'Room keys associated with the access grant.',
|
|
36688
|
+
items: { type: 'string' },
|
|
36689
|
+
type: 'array',
|
|
36690
|
+
},
|
|
36691
|
+
space_keys: {
|
|
36692
|
+
description:
|
|
36693
|
+
'Space keys associated with the access grant.',
|
|
36694
|
+
items: { type: 'string' },
|
|
36695
|
+
type: 'array',
|
|
36696
|
+
},
|
|
36697
|
+
starts_at: {
|
|
36698
|
+
description:
|
|
36699
|
+
'Starting date and time for the access grant.',
|
|
36700
|
+
type: 'string',
|
|
36701
|
+
},
|
|
36702
|
+
tenant_key: {
|
|
36703
|
+
description:
|
|
36704
|
+
'Tenant key associated with the access grant.',
|
|
36705
|
+
type: 'string',
|
|
36706
|
+
},
|
|
36707
|
+
unit_keys: {
|
|
36708
|
+
description:
|
|
36709
|
+
'Unit keys associated with the access grant.',
|
|
36710
|
+
items: { type: 'string' },
|
|
36711
|
+
type: 'array',
|
|
36712
|
+
},
|
|
36713
|
+
user_identity_key: {
|
|
36714
|
+
description:
|
|
36715
|
+
'User identity key associated with the access grant.',
|
|
36716
|
+
type: 'string',
|
|
36717
|
+
},
|
|
36718
|
+
user_key: {
|
|
36719
|
+
description:
|
|
36720
|
+
'User key associated with the access grant.',
|
|
36721
|
+
type: 'string',
|
|
36722
|
+
},
|
|
36723
|
+
},
|
|
36724
|
+
required: ['name', 'access_grant_key'],
|
|
36725
|
+
type: 'object',
|
|
36726
|
+
},
|
|
36727
|
+
type: 'array',
|
|
36728
|
+
},
|
|
36729
|
+
bookings: {
|
|
36730
|
+
description: 'List of bookings.',
|
|
36731
|
+
items: {
|
|
36732
|
+
properties: {
|
|
36733
|
+
booking_key: {
|
|
36734
|
+
description:
|
|
36735
|
+
'Your unique identifier for the booking.',
|
|
36736
|
+
type: 'string',
|
|
36737
|
+
},
|
|
36738
|
+
building_keys: {
|
|
36739
|
+
description:
|
|
36740
|
+
'Building keys associated with the access grant.',
|
|
36741
|
+
items: { type: 'string' },
|
|
36742
|
+
type: 'array',
|
|
36743
|
+
},
|
|
36744
|
+
common_area_keys: {
|
|
36745
|
+
description:
|
|
36746
|
+
'Common area keys associated with the access grant.',
|
|
36747
|
+
items: { type: 'string' },
|
|
36748
|
+
type: 'array',
|
|
36749
|
+
},
|
|
36750
|
+
ends_at: {
|
|
36751
|
+
description:
|
|
36752
|
+
'Ending date and time for the access grant.',
|
|
36753
|
+
type: 'string',
|
|
36754
|
+
},
|
|
36755
|
+
facility_keys: {
|
|
36756
|
+
description:
|
|
36757
|
+
'Facility keys associated with the access grant.',
|
|
36758
|
+
items: { type: 'string' },
|
|
36759
|
+
type: 'array',
|
|
36760
|
+
},
|
|
36761
|
+
guest_key: {
|
|
36762
|
+
description:
|
|
36763
|
+
'Guest key associated with the access grant.',
|
|
36764
|
+
type: 'string',
|
|
36765
|
+
},
|
|
36766
|
+
listing_keys: {
|
|
36767
|
+
description:
|
|
36768
|
+
'Listing keys associated with the access grant.',
|
|
36769
|
+
items: { type: 'string' },
|
|
36770
|
+
type: 'array',
|
|
36771
|
+
},
|
|
36772
|
+
name: {
|
|
36773
|
+
description:
|
|
36774
|
+
'Your display name for this access grant resource.',
|
|
36775
|
+
type: 'string',
|
|
36776
|
+
},
|
|
36777
|
+
property_keys: {
|
|
36778
|
+
description:
|
|
36779
|
+
'Property keys associated with the access grant.',
|
|
36780
|
+
items: { type: 'string' },
|
|
36781
|
+
type: 'array',
|
|
36782
|
+
},
|
|
36783
|
+
resident_key: {
|
|
36784
|
+
description:
|
|
36785
|
+
'Resident key associated with the access grant.',
|
|
36786
|
+
type: 'string',
|
|
36787
|
+
},
|
|
36788
|
+
room_keys: {
|
|
36789
|
+
description:
|
|
36790
|
+
'Room keys associated with the access grant.',
|
|
36791
|
+
items: { type: 'string' },
|
|
36792
|
+
type: 'array',
|
|
36793
|
+
},
|
|
36794
|
+
space_keys: {
|
|
36795
|
+
description:
|
|
36796
|
+
'Space keys associated with the access grant.',
|
|
36797
|
+
items: { type: 'string' },
|
|
36798
|
+
type: 'array',
|
|
36799
|
+
},
|
|
36800
|
+
starts_at: {
|
|
36801
|
+
description:
|
|
36802
|
+
'Starting date and time for the access grant.',
|
|
36803
|
+
type: 'string',
|
|
36804
|
+
},
|
|
36805
|
+
tenant_key: {
|
|
36806
|
+
description:
|
|
36807
|
+
'Tenant key associated with the access grant.',
|
|
36808
|
+
type: 'string',
|
|
36809
|
+
},
|
|
36810
|
+
unit_keys: {
|
|
36811
|
+
description:
|
|
36812
|
+
'Unit keys associated with the access grant.',
|
|
36813
|
+
items: { type: 'string' },
|
|
36814
|
+
type: 'array',
|
|
36815
|
+
},
|
|
36816
|
+
user_identity_key: {
|
|
36817
|
+
description:
|
|
36818
|
+
'User identity key associated with the access grant.',
|
|
36819
|
+
type: 'string',
|
|
36820
|
+
},
|
|
36821
|
+
user_key: {
|
|
36822
|
+
description:
|
|
36823
|
+
'User key associated with the access grant.',
|
|
36824
|
+
type: 'string',
|
|
36825
|
+
},
|
|
36826
|
+
},
|
|
36827
|
+
required: ['name', 'booking_key'],
|
|
36828
|
+
type: 'object',
|
|
36829
|
+
},
|
|
36830
|
+
type: 'array',
|
|
36831
|
+
},
|
|
36832
|
+
buildings: {
|
|
36833
|
+
description: 'List of buildings.',
|
|
36834
|
+
items: {
|
|
36835
|
+
properties: {
|
|
36836
|
+
building_key: {
|
|
36837
|
+
description:
|
|
36838
|
+
'Your unique identifier for the building.',
|
|
36839
|
+
type: 'string',
|
|
36840
|
+
},
|
|
36841
|
+
name: {
|
|
36842
|
+
description:
|
|
36843
|
+
'Your display name for this location resource.',
|
|
36844
|
+
type: 'string',
|
|
36845
|
+
},
|
|
36846
|
+
},
|
|
36847
|
+
required: ['name', 'building_key'],
|
|
36848
|
+
type: 'object',
|
|
36849
|
+
},
|
|
36850
|
+
type: 'array',
|
|
36851
|
+
},
|
|
36852
|
+
common_areas: {
|
|
36853
|
+
description: 'List of shared common areas.',
|
|
36854
|
+
items: {
|
|
36855
|
+
properties: {
|
|
36856
|
+
common_area_key: {
|
|
36857
|
+
description:
|
|
36858
|
+
'Your unique identifier for the common area.',
|
|
36859
|
+
type: 'string',
|
|
36860
|
+
},
|
|
36861
|
+
name: {
|
|
36862
|
+
description:
|
|
36863
|
+
'Your display name for this location resource.',
|
|
36864
|
+
type: 'string',
|
|
36865
|
+
},
|
|
36866
|
+
},
|
|
36867
|
+
required: ['name', 'common_area_key'],
|
|
36868
|
+
type: 'object',
|
|
36869
|
+
},
|
|
36870
|
+
type: 'array',
|
|
36871
|
+
},
|
|
36872
|
+
customer_key: {
|
|
36873
|
+
description: 'Your unique identifier for the customer.',
|
|
36874
|
+
type: 'string',
|
|
36875
|
+
},
|
|
36876
|
+
facilities: {
|
|
36877
|
+
description: 'List of gym or fitness facilities.',
|
|
36878
|
+
items: {
|
|
36879
|
+
properties: {
|
|
36880
|
+
facility_key: {
|
|
36881
|
+
description:
|
|
36882
|
+
'Your unique identifier for the facility.',
|
|
36883
|
+
type: 'string',
|
|
36884
|
+
},
|
|
36885
|
+
name: {
|
|
36886
|
+
description:
|
|
36887
|
+
'Your display name for this location resource.',
|
|
36888
|
+
type: 'string',
|
|
36889
|
+
},
|
|
36890
|
+
},
|
|
36891
|
+
required: ['name', 'facility_key'],
|
|
36892
|
+
type: 'object',
|
|
36893
|
+
},
|
|
36894
|
+
type: 'array',
|
|
36895
|
+
},
|
|
36896
|
+
guests: {
|
|
36897
|
+
description: 'List of guests.',
|
|
36898
|
+
items: {
|
|
36899
|
+
properties: {
|
|
36900
|
+
email_address: {
|
|
36901
|
+
description:
|
|
36902
|
+
'Email address associated with the user identity.',
|
|
36903
|
+
type: 'string',
|
|
36904
|
+
},
|
|
36905
|
+
guest_key: {
|
|
36906
|
+
description: 'Your unique identifier for the guest.',
|
|
36907
|
+
type: 'string',
|
|
36908
|
+
},
|
|
36909
|
+
name: {
|
|
36910
|
+
description:
|
|
36911
|
+
'Your display name for this user identity resource.',
|
|
36912
|
+
type: 'string',
|
|
36913
|
+
},
|
|
36914
|
+
phone_number: {
|
|
36915
|
+
description:
|
|
36916
|
+
'Phone number associated with the user identity.',
|
|
36917
|
+
type: 'string',
|
|
36918
|
+
},
|
|
36919
|
+
},
|
|
36920
|
+
required: ['name', 'guest_key'],
|
|
36921
|
+
type: 'object',
|
|
36922
|
+
},
|
|
36923
|
+
type: 'array',
|
|
36924
|
+
},
|
|
36925
|
+
listings: {
|
|
36926
|
+
description: 'List of property listings.',
|
|
36927
|
+
items: {
|
|
36928
|
+
properties: {
|
|
36929
|
+
listing_key: {
|
|
36930
|
+
description:
|
|
36931
|
+
'Your unique identifier for the listing.',
|
|
36932
|
+
type: 'string',
|
|
36933
|
+
},
|
|
36934
|
+
name: {
|
|
36935
|
+
description:
|
|
36936
|
+
'Your display name for this location resource.',
|
|
36937
|
+
type: 'string',
|
|
36938
|
+
},
|
|
36939
|
+
},
|
|
36940
|
+
required: ['name', 'listing_key'],
|
|
36941
|
+
type: 'object',
|
|
36942
|
+
},
|
|
36943
|
+
type: 'array',
|
|
36944
|
+
},
|
|
36945
|
+
properties: {
|
|
36946
|
+
description: 'List of short-term rental properties.',
|
|
36947
|
+
items: {
|
|
36948
|
+
properties: {
|
|
36949
|
+
name: {
|
|
36950
|
+
description:
|
|
36951
|
+
'Your display name for this location resource.',
|
|
36952
|
+
type: 'string',
|
|
36953
|
+
},
|
|
36954
|
+
property_key: {
|
|
36955
|
+
description:
|
|
36956
|
+
'Your unique identifier for the property.',
|
|
36957
|
+
type: 'string',
|
|
36958
|
+
},
|
|
36959
|
+
},
|
|
36960
|
+
required: ['name', 'property_key'],
|
|
36961
|
+
type: 'object',
|
|
36962
|
+
},
|
|
36963
|
+
type: 'array',
|
|
36964
|
+
},
|
|
36965
|
+
reservations: {
|
|
36966
|
+
description: 'List of reservations.',
|
|
36967
|
+
items: {
|
|
36968
|
+
properties: {
|
|
36969
|
+
building_keys: {
|
|
36970
|
+
description:
|
|
36971
|
+
'Building keys associated with the access grant.',
|
|
36972
|
+
items: { type: 'string' },
|
|
36973
|
+
type: 'array',
|
|
36974
|
+
},
|
|
36975
|
+
common_area_keys: {
|
|
36976
|
+
description:
|
|
36977
|
+
'Common area keys associated with the access grant.',
|
|
36978
|
+
items: { type: 'string' },
|
|
36979
|
+
type: 'array',
|
|
36980
|
+
},
|
|
36981
|
+
ends_at: {
|
|
36982
|
+
description:
|
|
36983
|
+
'Ending date and time for the access grant.',
|
|
36984
|
+
type: 'string',
|
|
36985
|
+
},
|
|
36986
|
+
facility_keys: {
|
|
36987
|
+
description:
|
|
36988
|
+
'Facility keys associated with the access grant.',
|
|
36989
|
+
items: { type: 'string' },
|
|
36990
|
+
type: 'array',
|
|
36991
|
+
},
|
|
36992
|
+
guest_key: {
|
|
36993
|
+
description:
|
|
36994
|
+
'Guest key associated with the access grant.',
|
|
36995
|
+
type: 'string',
|
|
36996
|
+
},
|
|
36997
|
+
listing_keys: {
|
|
36998
|
+
description:
|
|
36999
|
+
'Listing keys associated with the access grant.',
|
|
37000
|
+
items: { type: 'string' },
|
|
37001
|
+
type: 'array',
|
|
37002
|
+
},
|
|
37003
|
+
name: {
|
|
37004
|
+
description:
|
|
37005
|
+
'Your display name for this access grant resource.',
|
|
37006
|
+
type: 'string',
|
|
37007
|
+
},
|
|
37008
|
+
property_keys: {
|
|
37009
|
+
description:
|
|
37010
|
+
'Property keys associated with the access grant.',
|
|
37011
|
+
items: { type: 'string' },
|
|
37012
|
+
type: 'array',
|
|
37013
|
+
},
|
|
37014
|
+
reservation_key: {
|
|
37015
|
+
description:
|
|
37016
|
+
'Your unique identifier for the reservation.',
|
|
37017
|
+
type: 'string',
|
|
37018
|
+
},
|
|
37019
|
+
resident_key: {
|
|
37020
|
+
description:
|
|
37021
|
+
'Resident key associated with the access grant.',
|
|
37022
|
+
type: 'string',
|
|
37023
|
+
},
|
|
37024
|
+
room_keys: {
|
|
37025
|
+
description:
|
|
37026
|
+
'Room keys associated with the access grant.',
|
|
37027
|
+
items: { type: 'string' },
|
|
37028
|
+
type: 'array',
|
|
37029
|
+
},
|
|
37030
|
+
space_keys: {
|
|
37031
|
+
description:
|
|
37032
|
+
'Space keys associated with the access grant.',
|
|
37033
|
+
items: { type: 'string' },
|
|
37034
|
+
type: 'array',
|
|
37035
|
+
},
|
|
37036
|
+
starts_at: {
|
|
37037
|
+
description:
|
|
37038
|
+
'Starting date and time for the access grant.',
|
|
37039
|
+
type: 'string',
|
|
37040
|
+
},
|
|
37041
|
+
tenant_key: {
|
|
37042
|
+
description:
|
|
37043
|
+
'Tenant key associated with the access grant.',
|
|
37044
|
+
type: 'string',
|
|
37045
|
+
},
|
|
37046
|
+
unit_keys: {
|
|
37047
|
+
description:
|
|
37048
|
+
'Unit keys associated with the access grant.',
|
|
37049
|
+
items: { type: 'string' },
|
|
37050
|
+
type: 'array',
|
|
37051
|
+
},
|
|
37052
|
+
user_identity_key: {
|
|
37053
|
+
description:
|
|
37054
|
+
'User identity key associated with the access grant.',
|
|
37055
|
+
type: 'string',
|
|
37056
|
+
},
|
|
37057
|
+
user_key: {
|
|
37058
|
+
description:
|
|
37059
|
+
'User key associated with the access grant.',
|
|
37060
|
+
type: 'string',
|
|
37061
|
+
},
|
|
37062
|
+
},
|
|
37063
|
+
required: ['name', 'reservation_key'],
|
|
37064
|
+
type: 'object',
|
|
37065
|
+
},
|
|
37066
|
+
type: 'array',
|
|
37067
|
+
},
|
|
37068
|
+
residents: {
|
|
37069
|
+
description: 'List of residents.',
|
|
37070
|
+
items: {
|
|
37071
|
+
properties: {
|
|
37072
|
+
email_address: {
|
|
37073
|
+
description:
|
|
37074
|
+
'Email address associated with the user identity.',
|
|
37075
|
+
type: 'string',
|
|
37076
|
+
},
|
|
37077
|
+
name: {
|
|
37078
|
+
description:
|
|
37079
|
+
'Your display name for this user identity resource.',
|
|
37080
|
+
type: 'string',
|
|
37081
|
+
},
|
|
37082
|
+
phone_number: {
|
|
37083
|
+
description:
|
|
37084
|
+
'Phone number associated with the user identity.',
|
|
37085
|
+
type: 'string',
|
|
37086
|
+
},
|
|
37087
|
+
resident_key: {
|
|
37088
|
+
description:
|
|
37089
|
+
'Your unique identifier for the resident.',
|
|
37090
|
+
type: 'string',
|
|
37091
|
+
},
|
|
37092
|
+
},
|
|
37093
|
+
required: ['name', 'resident_key'],
|
|
37094
|
+
type: 'object',
|
|
37095
|
+
},
|
|
37096
|
+
type: 'array',
|
|
37097
|
+
},
|
|
37098
|
+
rooms: {
|
|
37099
|
+
description: 'List of hotel or hospitality rooms.',
|
|
37100
|
+
items: {
|
|
37101
|
+
properties: {
|
|
37102
|
+
name: {
|
|
37103
|
+
description:
|
|
37104
|
+
'Your display name for this location resource.',
|
|
37105
|
+
type: 'string',
|
|
37106
|
+
},
|
|
37107
|
+
room_key: {
|
|
37108
|
+
description: 'Your unique identifier for the room.',
|
|
37109
|
+
type: 'string',
|
|
37110
|
+
},
|
|
37111
|
+
},
|
|
37112
|
+
required: ['name', 'room_key'],
|
|
37113
|
+
type: 'object',
|
|
37114
|
+
},
|
|
37115
|
+
type: 'array',
|
|
37116
|
+
},
|
|
37117
|
+
spaces: {
|
|
37118
|
+
description: 'List of general spaces or areas.',
|
|
37119
|
+
items: {
|
|
37120
|
+
properties: {
|
|
37121
|
+
name: {
|
|
37122
|
+
description:
|
|
37123
|
+
'Your display name for this location resource.',
|
|
37124
|
+
type: 'string',
|
|
37125
|
+
},
|
|
37126
|
+
space_key: {
|
|
37127
|
+
description: 'Your unique identifier for the space.',
|
|
37128
|
+
type: 'string',
|
|
37129
|
+
},
|
|
37130
|
+
},
|
|
37131
|
+
required: ['name', 'space_key'],
|
|
37132
|
+
type: 'object',
|
|
37133
|
+
},
|
|
37134
|
+
type: 'array',
|
|
37135
|
+
},
|
|
37136
|
+
tenants: {
|
|
37137
|
+
description: 'List of tenants.',
|
|
37138
|
+
items: {
|
|
37139
|
+
properties: {
|
|
37140
|
+
email_address: {
|
|
37141
|
+
description:
|
|
37142
|
+
'Email address associated with the user identity.',
|
|
37143
|
+
type: 'string',
|
|
37144
|
+
},
|
|
37145
|
+
name: {
|
|
37146
|
+
description:
|
|
37147
|
+
'Your display name for this user identity resource.',
|
|
37148
|
+
type: 'string',
|
|
37149
|
+
},
|
|
37150
|
+
phone_number: {
|
|
37151
|
+
description:
|
|
37152
|
+
'Phone number associated with the user identity.',
|
|
37153
|
+
type: 'string',
|
|
37154
|
+
},
|
|
37155
|
+
tenant_key: {
|
|
37156
|
+
description: 'Your unique identifier for the tenant.',
|
|
37157
|
+
type: 'string',
|
|
37158
|
+
},
|
|
37159
|
+
},
|
|
37160
|
+
required: ['name', 'tenant_key'],
|
|
37161
|
+
type: 'object',
|
|
37162
|
+
},
|
|
37163
|
+
type: 'array',
|
|
37164
|
+
},
|
|
37165
|
+
units: {
|
|
37166
|
+
description: 'List of multi-family residential units.',
|
|
37167
|
+
items: {
|
|
37168
|
+
properties: {
|
|
37169
|
+
name: {
|
|
37170
|
+
description:
|
|
37171
|
+
'Your display name for this location resource.',
|
|
37172
|
+
type: 'string',
|
|
37173
|
+
},
|
|
37174
|
+
unit_key: {
|
|
37175
|
+
description: 'Your unique identifier for the unit.',
|
|
37176
|
+
type: 'string',
|
|
37177
|
+
},
|
|
37178
|
+
},
|
|
37179
|
+
required: ['name', 'unit_key'],
|
|
37180
|
+
type: 'object',
|
|
37181
|
+
},
|
|
37182
|
+
type: 'array',
|
|
37183
|
+
},
|
|
37184
|
+
user_identities: {
|
|
37185
|
+
description: 'List of user identities.',
|
|
37186
|
+
items: {
|
|
37187
|
+
properties: {
|
|
37188
|
+
email_address: {
|
|
37189
|
+
description:
|
|
37190
|
+
'Email address associated with the user identity.',
|
|
37191
|
+
type: 'string',
|
|
37192
|
+
},
|
|
37193
|
+
name: {
|
|
37194
|
+
description:
|
|
37195
|
+
'Your display name for this user identity resource.',
|
|
37196
|
+
type: 'string',
|
|
37197
|
+
},
|
|
37198
|
+
phone_number: {
|
|
37199
|
+
description:
|
|
37200
|
+
'Phone number associated with the user identity.',
|
|
37201
|
+
type: 'string',
|
|
37202
|
+
},
|
|
37203
|
+
user_identity_key: {
|
|
37204
|
+
description:
|
|
37205
|
+
'Your unique identifier for the user identity.',
|
|
37206
|
+
type: 'string',
|
|
37207
|
+
},
|
|
37208
|
+
},
|
|
37209
|
+
required: ['name', 'user_identity_key'],
|
|
37210
|
+
type: 'object',
|
|
37211
|
+
},
|
|
37212
|
+
type: 'array',
|
|
37213
|
+
},
|
|
37214
|
+
users: {
|
|
37215
|
+
description: 'List of users.',
|
|
37216
|
+
items: {
|
|
37217
|
+
properties: {
|
|
37218
|
+
email_address: {
|
|
37219
|
+
description:
|
|
37220
|
+
'Email address associated with the user identity.',
|
|
37221
|
+
type: 'string',
|
|
37222
|
+
},
|
|
37223
|
+
name: {
|
|
37224
|
+
description:
|
|
37225
|
+
'Your display name for this user identity resource.',
|
|
37226
|
+
type: 'string',
|
|
37227
|
+
},
|
|
37228
|
+
phone_number: {
|
|
37229
|
+
description:
|
|
37230
|
+
'Phone number associated with the user identity.',
|
|
37231
|
+
type: 'string',
|
|
37232
|
+
},
|
|
37233
|
+
user_key: {
|
|
37234
|
+
description: 'Your unique identifier for the user.',
|
|
37235
|
+
type: 'string',
|
|
37236
|
+
},
|
|
37237
|
+
},
|
|
37238
|
+
required: ['name', 'user_key'],
|
|
37239
|
+
type: 'object',
|
|
37240
|
+
},
|
|
37241
|
+
type: 'array',
|
|
37242
|
+
},
|
|
37243
|
+
},
|
|
37244
|
+
required: ['customer_key'],
|
|
37245
|
+
type: 'object',
|
|
37246
|
+
},
|
|
37247
|
+
},
|
|
37248
|
+
},
|
|
37249
|
+
},
|
|
37250
|
+
responses: {
|
|
37251
|
+
200: {
|
|
37252
|
+
content: {
|
|
37253
|
+
'application/json': {
|
|
37254
|
+
schema: {
|
|
37255
|
+
properties: { ok: { type: 'boolean' } },
|
|
37256
|
+
required: ['ok'],
|
|
37257
|
+
type: 'object',
|
|
37258
|
+
},
|
|
37259
|
+
},
|
|
37260
|
+
},
|
|
37261
|
+
description: 'OK',
|
|
37262
|
+
},
|
|
37263
|
+
400: { description: 'Bad Request' },
|
|
37264
|
+
401: { description: 'Unauthorized' },
|
|
37265
|
+
},
|
|
37266
|
+
security: [
|
|
37267
|
+
{ pat_with_workspace: [] },
|
|
37268
|
+
{ console_session_with_workspace: [] },
|
|
37269
|
+
{ api_key: [] },
|
|
37270
|
+
],
|
|
37271
|
+
summary: '/customers/push_data',
|
|
37272
|
+
tags: [],
|
|
37273
|
+
'x-fern-sdk-group-name': ['customers'],
|
|
37274
|
+
'x-fern-sdk-method-name': 'push_data',
|
|
37275
|
+
'x-response-key': null,
|
|
37276
|
+
'x-title': 'Push Customer Data',
|
|
37277
|
+
},
|
|
37278
|
+
},
|
|
37279
|
+
'/devices/delete': {
|
|
37280
|
+
delete: {
|
|
37281
|
+
description:
|
|
37282
|
+
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
37283
|
+
operationId: 'devicesDeleteDelete',
|
|
37284
|
+
parameters: [
|
|
37285
|
+
{
|
|
37286
|
+
in: 'query',
|
|
37287
|
+
name: 'device_id',
|
|
37288
|
+
required: true,
|
|
37289
|
+
schema: {
|
|
37290
|
+
description: 'ID of the device that you want to delete.',
|
|
37291
|
+
format: 'uuid',
|
|
37292
|
+
type: 'string',
|
|
37293
|
+
},
|
|
37294
|
+
},
|
|
37295
|
+
],
|
|
37296
|
+
responses: {
|
|
37297
|
+
200: {
|
|
37298
|
+
content: {
|
|
37299
|
+
'application/json': {
|
|
37300
|
+
schema: {
|
|
37301
|
+
properties: { ok: { type: 'boolean' } },
|
|
37302
|
+
required: ['ok'],
|
|
37303
|
+
type: 'object',
|
|
37304
|
+
},
|
|
37305
|
+
},
|
|
37306
|
+
},
|
|
37307
|
+
description: 'OK',
|
|
37308
|
+
},
|
|
37309
|
+
400: { description: 'Bad Request' },
|
|
37310
|
+
401: { description: 'Unauthorized' },
|
|
37311
|
+
},
|
|
37312
|
+
security: [
|
|
37313
|
+
{ api_key: [] },
|
|
37314
|
+
{ pat_with_workspace: [] },
|
|
37315
|
+
{ console_session_with_workspace: [] },
|
|
37316
|
+
],
|
|
37317
|
+
summary: '/devices/delete',
|
|
37318
|
+
tags: ['/devices'],
|
|
37319
|
+
'x-deprecated':
|
|
37320
|
+
'Deleting a device is no longer supported and will be removed.',
|
|
37321
|
+
'x-fern-sdk-group-name': ['devices'],
|
|
37322
|
+
'x-fern-sdk-method-name': 'delete',
|
|
37323
|
+
'x-response-key': null,
|
|
37324
|
+
'x-title': 'Delete a Device',
|
|
37325
|
+
'x-undocumented':
|
|
37326
|
+
'Deleting a device is no longer supported and will be removed.',
|
|
37327
|
+
},
|
|
37328
|
+
post: {
|
|
37329
|
+
description:
|
|
37330
|
+
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
37331
|
+
operationId: 'devicesDeletePost',
|
|
37332
|
+
requestBody: {
|
|
37333
|
+
content: {
|
|
37334
|
+
'application/json': {
|
|
37335
|
+
schema: {
|
|
37336
|
+
properties: {
|
|
37337
|
+
device_id: {
|
|
37338
|
+
description: 'ID of the device that you want to delete.',
|
|
37339
|
+
format: 'uuid',
|
|
37340
|
+
type: 'string',
|
|
37341
|
+
},
|
|
37342
|
+
},
|
|
37343
|
+
required: ['device_id'],
|
|
37344
|
+
type: 'object',
|
|
37345
|
+
},
|
|
37346
|
+
},
|
|
37347
|
+
},
|
|
37348
|
+
},
|
|
37349
|
+
responses: {
|
|
37350
|
+
200: {
|
|
37351
|
+
content: {
|
|
37352
|
+
'application/json': {
|
|
37353
|
+
schema: {
|
|
37354
|
+
properties: { ok: { type: 'boolean' } },
|
|
37355
|
+
required: ['ok'],
|
|
37356
|
+
type: 'object',
|
|
37357
|
+
},
|
|
37358
|
+
},
|
|
37359
|
+
},
|
|
37360
|
+
description: 'OK',
|
|
37361
|
+
},
|
|
37362
|
+
400: { description: 'Bad Request' },
|
|
37363
|
+
401: { description: 'Unauthorized' },
|
|
37364
|
+
},
|
|
37365
|
+
security: [
|
|
37366
|
+
{ api_key: [] },
|
|
37367
|
+
{ pat_with_workspace: [] },
|
|
37368
|
+
{ console_session_with_workspace: [] },
|
|
37369
|
+
],
|
|
37370
|
+
summary: '/devices/delete',
|
|
37371
|
+
tags: ['/devices'],
|
|
37372
|
+
'x-deprecated':
|
|
37373
|
+
'Deleting a device is no longer supported and will be removed.',
|
|
37374
|
+
'x-fern-sdk-group-name': ['devices'],
|
|
37375
|
+
'x-fern-sdk-method-name': 'delete',
|
|
37376
|
+
'x-response-key': null,
|
|
37377
|
+
'x-title': 'Delete a Device',
|
|
37378
|
+
'x-undocumented':
|
|
37379
|
+
'Deleting a device is no longer supported and will be removed.',
|
|
37380
|
+
},
|
|
37381
|
+
},
|
|
37382
|
+
'/devices/get': {
|
|
37383
|
+
get: {
|
|
37384
|
+
description:
|
|
37385
|
+
'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
|
|
37386
|
+
operationId: 'devicesGetGet',
|
|
37387
|
+
parameters: [
|
|
37388
|
+
{
|
|
37389
|
+
in: 'query',
|
|
37390
|
+
name: 'device_id',
|
|
37391
|
+
schema: {
|
|
37392
|
+
description: 'ID of the device that you want to get.',
|
|
37393
|
+
format: 'uuid',
|
|
37394
|
+
type: 'string',
|
|
37395
|
+
},
|
|
37396
|
+
},
|
|
37397
|
+
{
|
|
37398
|
+
in: 'query',
|
|
37399
|
+
name: 'name',
|
|
37400
|
+
schema: {
|
|
37401
|
+
description: 'Name of the device that you want to get.',
|
|
37402
|
+
type: 'string',
|
|
37403
|
+
},
|
|
37404
|
+
},
|
|
37405
|
+
],
|
|
37406
|
+
responses: {
|
|
37407
|
+
200: {
|
|
37408
|
+
content: {
|
|
37409
|
+
'application/json': {
|
|
37410
|
+
schema: {
|
|
37411
|
+
properties: {
|
|
37412
|
+
device: { $ref: '#/components/schemas/device' },
|
|
37413
|
+
ok: { type: 'boolean' },
|
|
37414
|
+
},
|
|
37415
|
+
required: ['device', 'ok'],
|
|
37416
|
+
type: 'object',
|
|
37417
|
+
},
|
|
37418
|
+
},
|
|
37419
|
+
},
|
|
37420
|
+
description: 'OK',
|
|
37421
|
+
},
|
|
37422
|
+
400: { description: 'Bad Request' },
|
|
37423
|
+
401: { description: 'Unauthorized' },
|
|
37424
|
+
},
|
|
37425
|
+
security: [
|
|
37426
|
+
{ client_session: [] },
|
|
37427
|
+
{ client_session_with_customer: [] },
|
|
37428
|
+
{ pat_with_workspace: [] },
|
|
37429
|
+
{ console_session_with_workspace: [] },
|
|
37430
|
+
{ api_key: [] },
|
|
37431
|
+
],
|
|
37432
|
+
summary: '/devices/get',
|
|
37433
|
+
tags: ['/devices'],
|
|
37434
|
+
'x-fern-sdk-group-name': ['devices'],
|
|
37435
|
+
'x-fern-sdk-method-name': 'get',
|
|
37436
|
+
'x-fern-sdk-return-value': 'device',
|
|
37437
|
+
'x-response-key': 'device',
|
|
37438
|
+
'x-title': 'Get a Device',
|
|
37439
|
+
},
|
|
37440
|
+
post: {
|
|
37441
|
+
description:
|
|
37442
|
+
'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
|
|
37443
|
+
operationId: 'devicesGetPost',
|
|
37444
|
+
requestBody: {
|
|
37445
|
+
content: {
|
|
37446
|
+
'application/json': {
|
|
37447
|
+
schema: {
|
|
37448
|
+
properties: {
|
|
37449
|
+
device_id: {
|
|
37450
|
+
description: 'ID of the device that you want to get.',
|
|
37451
|
+
format: 'uuid',
|
|
37452
|
+
type: 'string',
|
|
37453
|
+
},
|
|
37454
|
+
name: {
|
|
37455
|
+
description: 'Name of the device that you want to get.',
|
|
37456
|
+
type: 'string',
|
|
36119
37457
|
},
|
|
36120
37458
|
},
|
|
36121
37459
|
type: 'object',
|
|
@@ -42646,16 +43984,200 @@ export default {
|
|
|
42646
43984
|
content: {
|
|
42647
43985
|
'application/json': {
|
|
42648
43986
|
schema: {
|
|
42649
|
-
properties: {
|
|
42650
|
-
bridge_connected_systems: {
|
|
42651
|
-
items: {
|
|
42652
|
-
$ref: '#/components/schemas/bridge_connected_systems',
|
|
42653
|
-
},
|
|
42654
|
-
type: 'array',
|
|
42655
|
-
},
|
|
42656
|
-
ok: { type: 'boolean' },
|
|
42657
|
-
},
|
|
42658
|
-
required: ['bridge_connected_systems', 'ok'],
|
|
43987
|
+
properties: {
|
|
43988
|
+
bridge_connected_systems: {
|
|
43989
|
+
items: {
|
|
43990
|
+
$ref: '#/components/schemas/bridge_connected_systems',
|
|
43991
|
+
},
|
|
43992
|
+
type: 'array',
|
|
43993
|
+
},
|
|
43994
|
+
ok: { type: 'boolean' },
|
|
43995
|
+
},
|
|
43996
|
+
required: ['bridge_connected_systems', 'ok'],
|
|
43997
|
+
type: 'object',
|
|
43998
|
+
},
|
|
43999
|
+
},
|
|
44000
|
+
},
|
|
44001
|
+
description: 'OK',
|
|
44002
|
+
},
|
|
44003
|
+
400: { description: 'Bad Request' },
|
|
44004
|
+
401: { description: 'Unauthorized' },
|
|
44005
|
+
},
|
|
44006
|
+
security: [{ bridge_client_session: [] }],
|
|
44007
|
+
summary: '/seam/bridge/v1/bridge_connected_systems/list',
|
|
44008
|
+
tags: [],
|
|
44009
|
+
'x-fern-sdk-group-name': [
|
|
44010
|
+
'seam',
|
|
44011
|
+
'bridge',
|
|
44012
|
+
'v1',
|
|
44013
|
+
'bridge_connected_systems',
|
|
44014
|
+
],
|
|
44015
|
+
'x-fern-sdk-method-name': 'list',
|
|
44016
|
+
'x-fern-sdk-return-value': 'bridge_connected_systems',
|
|
44017
|
+
'x-response-key': 'bridge_connected_systems',
|
|
44018
|
+
'x-title': 'List Bridge-Connected Systems',
|
|
44019
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
44020
|
+
},
|
|
44021
|
+
},
|
|
44022
|
+
'/seam/customer/v1/portals/get': {
|
|
44023
|
+
get: {
|
|
44024
|
+
description:
|
|
44025
|
+
'Retrieves the configuration for a customer portal identified by customer_portal_id.',
|
|
44026
|
+
operationId: 'seamCustomerV1PortalsGetGet',
|
|
44027
|
+
parameters: [
|
|
44028
|
+
{
|
|
44029
|
+
in: 'query',
|
|
44030
|
+
name: 'customer_portal_id',
|
|
44031
|
+
required: true,
|
|
44032
|
+
schema: { description: 'Customer portal ID.', type: 'string' },
|
|
44033
|
+
},
|
|
44034
|
+
],
|
|
44035
|
+
responses: {
|
|
44036
|
+
200: {
|
|
44037
|
+
content: {
|
|
44038
|
+
'application/json': {
|
|
44039
|
+
schema: {
|
|
44040
|
+
properties: {
|
|
44041
|
+
customer_portal: {
|
|
44042
|
+
properties: {
|
|
44043
|
+
business_vertical: {
|
|
44044
|
+
description:
|
|
44045
|
+
'Business vertical of the customer portal.',
|
|
44046
|
+
enum: [
|
|
44047
|
+
'short_term_rental',
|
|
44048
|
+
'hospitality',
|
|
44049
|
+
'multi_family',
|
|
44050
|
+
'gym_management',
|
|
44051
|
+
'property_tours',
|
|
44052
|
+
],
|
|
44053
|
+
type: 'string',
|
|
44054
|
+
},
|
|
44055
|
+
features: {
|
|
44056
|
+
properties: {
|
|
44057
|
+
connect: {
|
|
44058
|
+
properties: { exclude: { type: 'boolean' } },
|
|
44059
|
+
type: 'object',
|
|
44060
|
+
},
|
|
44061
|
+
manage_devices: {
|
|
44062
|
+
properties: { exclude: { type: 'boolean' } },
|
|
44063
|
+
type: 'object',
|
|
44064
|
+
},
|
|
44065
|
+
organize: {
|
|
44066
|
+
properties: { exclude: { type: 'boolean' } },
|
|
44067
|
+
type: 'object',
|
|
44068
|
+
},
|
|
44069
|
+
},
|
|
44070
|
+
type: 'object',
|
|
44071
|
+
},
|
|
44072
|
+
},
|
|
44073
|
+
type: 'object',
|
|
44074
|
+
},
|
|
44075
|
+
ok: { type: 'boolean' },
|
|
44076
|
+
},
|
|
44077
|
+
required: ['customer_portal', 'ok'],
|
|
44078
|
+
type: 'object',
|
|
44079
|
+
},
|
|
44080
|
+
},
|
|
44081
|
+
},
|
|
44082
|
+
description: 'OK',
|
|
44083
|
+
},
|
|
44084
|
+
400: { description: 'Bad Request' },
|
|
44085
|
+
401: { description: 'Unauthorized' },
|
|
44086
|
+
},
|
|
44087
|
+
security: [{ client_session_with_customer: [] }],
|
|
44088
|
+
summary: '/seam/customer/v1/portals/get',
|
|
44089
|
+
tags: [],
|
|
44090
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
44091
|
+
'x-fern-sdk-method-name': 'get',
|
|
44092
|
+
'x-fern-sdk-return-value': 'portal_configuration',
|
|
44093
|
+
'x-response-key': 'portal_configuration',
|
|
44094
|
+
'x-title': 'Get Customer Portal Configuration',
|
|
44095
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44096
|
+
},
|
|
44097
|
+
},
|
|
44098
|
+
'/seam/customer/v1/settings/update': {
|
|
44099
|
+
patch: {
|
|
44100
|
+
description: 'Updates the settings for a customer portal workspace.',
|
|
44101
|
+
operationId: 'seamCustomerV1SettingsUpdatePatch',
|
|
44102
|
+
requestBody: {
|
|
44103
|
+
content: {
|
|
44104
|
+
'application/json': {
|
|
44105
|
+
schema: {
|
|
44106
|
+
properties: {
|
|
44107
|
+
business_vertical: {
|
|
44108
|
+
description: 'Business vertical to set on the workspace.',
|
|
44109
|
+
enum: [
|
|
44110
|
+
'short_term_rental',
|
|
44111
|
+
'hospitality',
|
|
44112
|
+
'multi_family',
|
|
44113
|
+
'gym_management',
|
|
44114
|
+
'property_tours',
|
|
44115
|
+
],
|
|
44116
|
+
type: 'string',
|
|
44117
|
+
},
|
|
44118
|
+
},
|
|
44119
|
+
type: 'object',
|
|
44120
|
+
},
|
|
44121
|
+
},
|
|
44122
|
+
},
|
|
44123
|
+
},
|
|
44124
|
+
responses: {
|
|
44125
|
+
200: {
|
|
44126
|
+
content: {
|
|
44127
|
+
'application/json': {
|
|
44128
|
+
schema: {
|
|
44129
|
+
properties: { ok: { type: 'boolean' } },
|
|
44130
|
+
required: ['ok'],
|
|
44131
|
+
type: 'object',
|
|
44132
|
+
},
|
|
44133
|
+
},
|
|
44134
|
+
},
|
|
44135
|
+
description: 'OK',
|
|
44136
|
+
},
|
|
44137
|
+
400: { description: 'Bad Request' },
|
|
44138
|
+
401: { description: 'Unauthorized' },
|
|
44139
|
+
},
|
|
44140
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
44141
|
+
summary: '/seam/customer/v1/settings/update',
|
|
44142
|
+
tags: [],
|
|
44143
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
|
|
44144
|
+
'x-fern-sdk-method-name': 'update',
|
|
44145
|
+
'x-response-key': null,
|
|
44146
|
+
'x-title': 'Update Customer Portal Settings',
|
|
44147
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44148
|
+
},
|
|
44149
|
+
post: {
|
|
44150
|
+
description: 'Updates the settings for a customer portal workspace.',
|
|
44151
|
+
operationId: 'seamCustomerV1SettingsUpdatePost',
|
|
44152
|
+
requestBody: {
|
|
44153
|
+
content: {
|
|
44154
|
+
'application/json': {
|
|
44155
|
+
schema: {
|
|
44156
|
+
properties: {
|
|
44157
|
+
business_vertical: {
|
|
44158
|
+
description: 'Business vertical to set on the workspace.',
|
|
44159
|
+
enum: [
|
|
44160
|
+
'short_term_rental',
|
|
44161
|
+
'hospitality',
|
|
44162
|
+
'multi_family',
|
|
44163
|
+
'gym_management',
|
|
44164
|
+
'property_tours',
|
|
44165
|
+
],
|
|
44166
|
+
type: 'string',
|
|
44167
|
+
},
|
|
44168
|
+
},
|
|
44169
|
+
type: 'object',
|
|
44170
|
+
},
|
|
44171
|
+
},
|
|
44172
|
+
},
|
|
44173
|
+
},
|
|
44174
|
+
responses: {
|
|
44175
|
+
200: {
|
|
44176
|
+
content: {
|
|
44177
|
+
'application/json': {
|
|
44178
|
+
schema: {
|
|
44179
|
+
properties: { ok: { type: 'boolean' } },
|
|
44180
|
+
required: ['ok'],
|
|
42659
44181
|
type: 'object',
|
|
42660
44182
|
},
|
|
42661
44183
|
},
|
|
@@ -42665,20 +44187,14 @@ export default {
|
|
|
42665
44187
|
400: { description: 'Bad Request' },
|
|
42666
44188
|
401: { description: 'Unauthorized' },
|
|
42667
44189
|
},
|
|
42668
|
-
security: [{
|
|
42669
|
-
summary: '/seam/
|
|
44190
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
44191
|
+
summary: '/seam/customer/v1/settings/update',
|
|
42670
44192
|
tags: [],
|
|
42671
|
-
'x-fern-sdk-group-name': [
|
|
42672
|
-
|
|
42673
|
-
|
|
42674
|
-
|
|
42675
|
-
|
|
42676
|
-
],
|
|
42677
|
-
'x-fern-sdk-method-name': 'list',
|
|
42678
|
-
'x-fern-sdk-return-value': 'bridge_connected_systems',
|
|
42679
|
-
'x-response-key': 'bridge_connected_systems',
|
|
42680
|
-
'x-title': 'List Bridge-Connected Systems',
|
|
42681
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
44193
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
|
|
44194
|
+
'x-fern-sdk-method-name': 'update',
|
|
44195
|
+
'x-response-key': null,
|
|
44196
|
+
'x-title': 'Update Customer Portal Settings',
|
|
44197
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
42682
44198
|
},
|
|
42683
44199
|
},
|
|
42684
44200
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
@@ -43087,105 +44603,6 @@ export default {
|
|
|
43087
44603
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
43088
44604
|
},
|
|
43089
44605
|
},
|
|
43090
|
-
'/seam/partner/v1/resources/list': {
|
|
43091
|
-
get: {
|
|
43092
|
-
description: 'Lists partner resources that have been pushed to Seam.',
|
|
43093
|
-
operationId: 'seamPartnerV1ResourcesListGet',
|
|
43094
|
-
parameters: [
|
|
43095
|
-
{
|
|
43096
|
-
in: 'query',
|
|
43097
|
-
name: 'resource_type_alias',
|
|
43098
|
-
schema: {
|
|
43099
|
-
description:
|
|
43100
|
-
'Resource type alias by which you want to filter partner resources.',
|
|
43101
|
-
type: 'string',
|
|
43102
|
-
},
|
|
43103
|
-
},
|
|
43104
|
-
],
|
|
43105
|
-
responses: {
|
|
43106
|
-
200: {
|
|
43107
|
-
content: {
|
|
43108
|
-
'application/json': {
|
|
43109
|
-
schema: {
|
|
43110
|
-
properties: {
|
|
43111
|
-
ok: { type: 'boolean' },
|
|
43112
|
-
partner_resources: {
|
|
43113
|
-
items: { $ref: '#/components/schemas/partner_resource' },
|
|
43114
|
-
type: 'array',
|
|
43115
|
-
},
|
|
43116
|
-
},
|
|
43117
|
-
required: ['partner_resources', 'ok'],
|
|
43118
|
-
type: 'object',
|
|
43119
|
-
},
|
|
43120
|
-
},
|
|
43121
|
-
},
|
|
43122
|
-
description: 'OK',
|
|
43123
|
-
},
|
|
43124
|
-
400: { description: 'Bad Request' },
|
|
43125
|
-
401: { description: 'Unauthorized' },
|
|
43126
|
-
},
|
|
43127
|
-
security: [{ client_session_with_customer: [] }],
|
|
43128
|
-
summary: '/seam/partner/v1/resources/list',
|
|
43129
|
-
tags: [],
|
|
43130
|
-
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
43131
|
-
'x-fern-sdk-method-name': 'list',
|
|
43132
|
-
'x-fern-sdk-return-value': 'partner_resources',
|
|
43133
|
-
'x-response-key': 'partner_resources',
|
|
43134
|
-
'x-title': 'List Partner Resources at Seam',
|
|
43135
|
-
'x-undocumented': 'Partner building blocks/UI only.',
|
|
43136
|
-
},
|
|
43137
|
-
post: {
|
|
43138
|
-
description: 'Lists partner resources that have been pushed to Seam.',
|
|
43139
|
-
operationId: 'seamPartnerV1ResourcesListPost',
|
|
43140
|
-
requestBody: {
|
|
43141
|
-
content: {
|
|
43142
|
-
'application/json': {
|
|
43143
|
-
schema: {
|
|
43144
|
-
properties: {
|
|
43145
|
-
resource_type_alias: {
|
|
43146
|
-
description:
|
|
43147
|
-
'Resource type alias by which you want to filter partner resources.',
|
|
43148
|
-
type: 'string',
|
|
43149
|
-
},
|
|
43150
|
-
},
|
|
43151
|
-
type: 'object',
|
|
43152
|
-
},
|
|
43153
|
-
},
|
|
43154
|
-
},
|
|
43155
|
-
},
|
|
43156
|
-
responses: {
|
|
43157
|
-
200: {
|
|
43158
|
-
content: {
|
|
43159
|
-
'application/json': {
|
|
43160
|
-
schema: {
|
|
43161
|
-
properties: {
|
|
43162
|
-
ok: { type: 'boolean' },
|
|
43163
|
-
partner_resources: {
|
|
43164
|
-
items: { $ref: '#/components/schemas/partner_resource' },
|
|
43165
|
-
type: 'array',
|
|
43166
|
-
},
|
|
43167
|
-
},
|
|
43168
|
-
required: ['partner_resources', 'ok'],
|
|
43169
|
-
type: 'object',
|
|
43170
|
-
},
|
|
43171
|
-
},
|
|
43172
|
-
},
|
|
43173
|
-
description: 'OK',
|
|
43174
|
-
},
|
|
43175
|
-
400: { description: 'Bad Request' },
|
|
43176
|
-
401: { description: 'Unauthorized' },
|
|
43177
|
-
},
|
|
43178
|
-
security: [{ client_session_with_customer: [] }],
|
|
43179
|
-
summary: '/seam/partner/v1/resources/list',
|
|
43180
|
-
tags: [],
|
|
43181
|
-
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
43182
|
-
'x-fern-sdk-method-name': 'list',
|
|
43183
|
-
'x-fern-sdk-return-value': 'partner_resources',
|
|
43184
|
-
'x-response-key': 'partner_resources',
|
|
43185
|
-
'x-title': 'List Partner Resources at Seam',
|
|
43186
|
-
'x-undocumented': 'Partner building blocks/UI only.',
|
|
43187
|
-
},
|
|
43188
|
-
},
|
|
43189
44606
|
'/spaces/add_acs_entrances': {
|
|
43190
44607
|
post: {
|
|
43191
44608
|
description:
|
|
@@ -49216,32 +50633,19 @@ export default {
|
|
|
49216
50633
|
description:
|
|
49217
50634
|
'Optional list of spaces that you want to include in the new building block magic link.',
|
|
49218
50635
|
items: {
|
|
49219
|
-
description:
|
|
49220
|
-
'Represents a partner resource that enables you to send your space resources to Seam.',
|
|
49221
50636
|
properties: {
|
|
49222
|
-
custom_metadata: {
|
|
49223
|
-
additionalProperties: { type: 'string' },
|
|
49224
|
-
description:
|
|
49225
|
-
'Custom metadata associated with the space resource.',
|
|
49226
|
-
type: 'object',
|
|
49227
|
-
},
|
|
49228
|
-
description: {
|
|
49229
|
-
description: 'Description of the space resource.',
|
|
49230
|
-
type: 'string',
|
|
49231
|
-
},
|
|
49232
50637
|
name: {
|
|
49233
|
-
description:
|
|
50638
|
+
description:
|
|
50639
|
+
'Your display name for this location resource.',
|
|
49234
50640
|
type: 'string',
|
|
49235
50641
|
},
|
|
49236
50642
|
space_key: {
|
|
49237
|
-
description: '
|
|
50643
|
+
description: 'Your unique identifier for the space.',
|
|
49238
50644
|
type: 'string',
|
|
49239
50645
|
},
|
|
49240
50646
|
},
|
|
49241
|
-
required: ['
|
|
50647
|
+
required: ['name', 'space_key'],
|
|
49242
50648
|
type: 'object',
|
|
49243
|
-
'x-route-path': '/unstable_partner/resources',
|
|
49244
|
-
'x-undocumented': 'Unreleased.',
|
|
49245
50649
|
},
|
|
49246
50650
|
type: 'array',
|
|
49247
50651
|
},
|
|
@@ -49308,32 +50712,19 @@ export default {
|
|
|
49308
50712
|
description:
|
|
49309
50713
|
'Optional list of spaces that you want to include in the new building block magic link.',
|
|
49310
50714
|
items: {
|
|
49311
|
-
description:
|
|
49312
|
-
'Represents a partner resource that enables you to send your space resources to Seam.',
|
|
49313
50715
|
properties: {
|
|
49314
|
-
custom_metadata: {
|
|
49315
|
-
additionalProperties: { type: 'string' },
|
|
49316
|
-
description:
|
|
49317
|
-
'Custom metadata associated with the space resource.',
|
|
49318
|
-
type: 'object',
|
|
49319
|
-
},
|
|
49320
|
-
description: {
|
|
49321
|
-
description: 'Description of the space resource.',
|
|
49322
|
-
type: 'string',
|
|
49323
|
-
},
|
|
49324
50716
|
name: {
|
|
49325
|
-
description:
|
|
50717
|
+
description:
|
|
50718
|
+
'Your display name for this location resource.',
|
|
49326
50719
|
type: 'string',
|
|
49327
50720
|
},
|
|
49328
50721
|
space_key: {
|
|
49329
|
-
description: '
|
|
50722
|
+
description: 'Your unique identifier for the space.',
|
|
49330
50723
|
type: 'string',
|
|
49331
50724
|
},
|
|
49332
50725
|
},
|
|
49333
|
-
required: ['
|
|
50726
|
+
required: ['name', 'space_key'],
|
|
49334
50727
|
type: 'object',
|
|
49335
|
-
'x-route-path': '/unstable_partner/resources',
|
|
49336
|
-
'x-undocumented': 'Unreleased.',
|
|
49337
50728
|
},
|
|
49338
50729
|
type: 'array',
|
|
49339
50730
|
},
|
|
@@ -49453,32 +50844,19 @@ export default {
|
|
|
49453
50844
|
description:
|
|
49454
50845
|
'Optional list of spaces that you want to include in the new building block magic link.',
|
|
49455
50846
|
items: {
|
|
49456
|
-
description:
|
|
49457
|
-
'Represents a partner resource that enables you to send your space resources to Seam.',
|
|
49458
50847
|
properties: {
|
|
49459
|
-
custom_metadata: {
|
|
49460
|
-
additionalProperties: { type: 'string' },
|
|
49461
|
-
description:
|
|
49462
|
-
'Custom metadata associated with the space resource.',
|
|
49463
|
-
type: 'object',
|
|
49464
|
-
},
|
|
49465
|
-
description: {
|
|
49466
|
-
description: 'Description of the space resource.',
|
|
49467
|
-
type: 'string',
|
|
49468
|
-
},
|
|
49469
50848
|
name: {
|
|
49470
|
-
description:
|
|
50849
|
+
description:
|
|
50850
|
+
'Your display name for this location resource.',
|
|
49471
50851
|
type: 'string',
|
|
49472
50852
|
},
|
|
49473
50853
|
space_key: {
|
|
49474
|
-
description: '
|
|
50854
|
+
description: 'Your unique identifier for the space.',
|
|
49475
50855
|
type: 'string',
|
|
49476
50856
|
},
|
|
49477
50857
|
},
|
|
49478
|
-
required: ['
|
|
50858
|
+
required: ['name', 'space_key'],
|
|
49479
50859
|
type: 'object',
|
|
49480
|
-
'x-route-path': '/unstable_partner/resources',
|
|
49481
|
-
'x-undocumented': 'Unreleased.',
|
|
49482
50860
|
},
|
|
49483
50861
|
type: 'array',
|
|
49484
50862
|
},
|
|
@@ -49523,191 +50901,6 @@ export default {
|
|
|
49523
50901
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
49524
50902
|
},
|
|
49525
50903
|
},
|
|
49526
|
-
'/unstable_partner/resources/push': {
|
|
49527
|
-
post: {
|
|
49528
|
-
description: 'Sends Seam some of your resources.',
|
|
49529
|
-
operationId: 'unstablePartnerResourcesPushPost',
|
|
49530
|
-
requestBody: {
|
|
49531
|
-
content: {
|
|
49532
|
-
'application/json': {
|
|
49533
|
-
schema: {
|
|
49534
|
-
oneOf: [
|
|
49535
|
-
{
|
|
49536
|
-
items: {
|
|
49537
|
-
description:
|
|
49538
|
-
'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
|
|
49539
|
-
properties: {
|
|
49540
|
-
custom_metadata: {
|
|
49541
|
-
additionalProperties: { type: 'string' },
|
|
49542
|
-
description:
|
|
49543
|
-
'Custom metadata associated with the partner resource.',
|
|
49544
|
-
type: 'object',
|
|
49545
|
-
},
|
|
49546
|
-
customer_key: {
|
|
49547
|
-
description:
|
|
49548
|
-
'Customer key associated with the resource that you want to push to Seam.',
|
|
49549
|
-
type: 'string',
|
|
49550
|
-
},
|
|
49551
|
-
description: {
|
|
49552
|
-
description: 'Description of the partner resource.',
|
|
49553
|
-
type: 'string',
|
|
49554
|
-
},
|
|
49555
|
-
email_address: {
|
|
49556
|
-
description:
|
|
49557
|
-
'Email address associated with the user identity partner resource.',
|
|
49558
|
-
type: 'string',
|
|
49559
|
-
},
|
|
49560
|
-
ends_at: {
|
|
49561
|
-
description:
|
|
49562
|
-
'Ending date and time associated with the access grant partner resource.',
|
|
49563
|
-
type: 'string',
|
|
49564
|
-
},
|
|
49565
|
-
location_keys: {
|
|
49566
|
-
description:
|
|
49567
|
-
'Location keys associated with the access grant partner resource.',
|
|
49568
|
-
items: { type: 'string' },
|
|
49569
|
-
type: 'array',
|
|
49570
|
-
},
|
|
49571
|
-
name: {
|
|
49572
|
-
description: 'Name of the partner resource.',
|
|
49573
|
-
type: 'string',
|
|
49574
|
-
},
|
|
49575
|
-
partner_resource_key: {
|
|
49576
|
-
description:
|
|
49577
|
-
'Key of the resource that you want to push to Seam.',
|
|
49578
|
-
type: 'string',
|
|
49579
|
-
},
|
|
49580
|
-
partner_resource_type: {
|
|
49581
|
-
description:
|
|
49582
|
-
'Type of the resource that you want to push to Seam.',
|
|
49583
|
-
type: 'string',
|
|
49584
|
-
},
|
|
49585
|
-
phone_number: {
|
|
49586
|
-
description:
|
|
49587
|
-
'Phone number associated with the user identity partner resource.',
|
|
49588
|
-
type: 'string',
|
|
49589
|
-
},
|
|
49590
|
-
starts_at: {
|
|
49591
|
-
description:
|
|
49592
|
-
'Starting date and time associated with the access grant partner resource.',
|
|
49593
|
-
type: 'string',
|
|
49594
|
-
},
|
|
49595
|
-
user_identity_key: {
|
|
49596
|
-
description:
|
|
49597
|
-
'User identity key associated with the access grant partner resource.',
|
|
49598
|
-
type: 'string',
|
|
49599
|
-
},
|
|
49600
|
-
},
|
|
49601
|
-
type: 'object',
|
|
49602
|
-
'x-route-path': '/unstable_partner/resources',
|
|
49603
|
-
'x-undocumented': 'Unreleased.',
|
|
49604
|
-
},
|
|
49605
|
-
type: 'array',
|
|
49606
|
-
},
|
|
49607
|
-
{
|
|
49608
|
-
description:
|
|
49609
|
-
'Represents a partner resource that enables you to send your user identity and access grant resources to Seam.',
|
|
49610
|
-
properties: {
|
|
49611
|
-
custom_metadata: {
|
|
49612
|
-
additionalProperties: { type: 'string' },
|
|
49613
|
-
description:
|
|
49614
|
-
'Custom metadata associated with the partner resource.',
|
|
49615
|
-
type: 'object',
|
|
49616
|
-
},
|
|
49617
|
-
customer_key: {
|
|
49618
|
-
description:
|
|
49619
|
-
'Customer key associated with the resource that you want to push to Seam.',
|
|
49620
|
-
type: 'string',
|
|
49621
|
-
},
|
|
49622
|
-
description: {
|
|
49623
|
-
description: 'Description of the partner resource.',
|
|
49624
|
-
type: 'string',
|
|
49625
|
-
},
|
|
49626
|
-
email_address: {
|
|
49627
|
-
description:
|
|
49628
|
-
'Email address associated with the user identity partner resource.',
|
|
49629
|
-
type: 'string',
|
|
49630
|
-
},
|
|
49631
|
-
ends_at: {
|
|
49632
|
-
description:
|
|
49633
|
-
'Ending date and time associated with the access grant partner resource.',
|
|
49634
|
-
type: 'string',
|
|
49635
|
-
},
|
|
49636
|
-
location_keys: {
|
|
49637
|
-
description:
|
|
49638
|
-
'Location keys associated with the access grant partner resource.',
|
|
49639
|
-
items: { type: 'string' },
|
|
49640
|
-
type: 'array',
|
|
49641
|
-
},
|
|
49642
|
-
name: {
|
|
49643
|
-
description: 'Name of the partner resource.',
|
|
49644
|
-
type: 'string',
|
|
49645
|
-
},
|
|
49646
|
-
partner_resource_key: {
|
|
49647
|
-
description:
|
|
49648
|
-
'Key of the resource that you want to push to Seam.',
|
|
49649
|
-
type: 'string',
|
|
49650
|
-
},
|
|
49651
|
-
partner_resource_type: {
|
|
49652
|
-
description:
|
|
49653
|
-
'Type of the resource that you want to push to Seam.',
|
|
49654
|
-
type: 'string',
|
|
49655
|
-
},
|
|
49656
|
-
phone_number: {
|
|
49657
|
-
description:
|
|
49658
|
-
'Phone number associated with the user identity partner resource.',
|
|
49659
|
-
type: 'string',
|
|
49660
|
-
},
|
|
49661
|
-
starts_at: {
|
|
49662
|
-
description:
|
|
49663
|
-
'Starting date and time associated with the access grant partner resource.',
|
|
49664
|
-
type: 'string',
|
|
49665
|
-
},
|
|
49666
|
-
user_identity_key: {
|
|
49667
|
-
description:
|
|
49668
|
-
'User identity key associated with the access grant partner resource.',
|
|
49669
|
-
type: 'string',
|
|
49670
|
-
},
|
|
49671
|
-
},
|
|
49672
|
-
type: 'object',
|
|
49673
|
-
'x-route-path': '/unstable_partner/resources',
|
|
49674
|
-
'x-undocumented': 'Unreleased.',
|
|
49675
|
-
},
|
|
49676
|
-
],
|
|
49677
|
-
},
|
|
49678
|
-
},
|
|
49679
|
-
},
|
|
49680
|
-
},
|
|
49681
|
-
responses: {
|
|
49682
|
-
200: {
|
|
49683
|
-
content: {
|
|
49684
|
-
'application/json': {
|
|
49685
|
-
schema: {
|
|
49686
|
-
properties: { ok: { type: 'boolean' } },
|
|
49687
|
-
required: ['ok'],
|
|
49688
|
-
type: 'object',
|
|
49689
|
-
},
|
|
49690
|
-
},
|
|
49691
|
-
},
|
|
49692
|
-
description: 'OK',
|
|
49693
|
-
},
|
|
49694
|
-
400: { description: 'Bad Request' },
|
|
49695
|
-
401: { description: 'Unauthorized' },
|
|
49696
|
-
},
|
|
49697
|
-
security: [
|
|
49698
|
-
{ pat_with_workspace: [] },
|
|
49699
|
-
{ console_session_with_workspace: [] },
|
|
49700
|
-
{ api_key: [] },
|
|
49701
|
-
],
|
|
49702
|
-
summary: '/unstable_partner/resources/push',
|
|
49703
|
-
tags: [],
|
|
49704
|
-
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
49705
|
-
'x-fern-sdk-method-name': 'push',
|
|
49706
|
-
'x-response-key': null,
|
|
49707
|
-
'x-title': 'Push Partner Resources at Seam',
|
|
49708
|
-
'x-undocumented': 'Experimental partner resources.',
|
|
49709
|
-
},
|
|
49710
|
-
},
|
|
49711
50904
|
'/user_identities/add_acs_user': {
|
|
49712
50905
|
post: {
|
|
49713
50906
|
description:
|