@seamapi/types 1.421.1 → 1.422.1
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 +1638 -591
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2655 -1028
- 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 +1647 -600
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +580 -116
- package/package.json +2 -2
- 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 +1802 -609
- package/src/lib/seam/connect/route-types.ts +670 -118
- 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
package/dist/connect.cjs
CHANGED
|
@@ -21860,69 +21860,6 @@ var openapi_default = {
|
|
|
21860
21860
|
required: ["next_page_cursor", "has_next_page", "next_page_url"],
|
|
21861
21861
|
type: "object"
|
|
21862
21862
|
},
|
|
21863
|
-
partner_resource: {
|
|
21864
|
-
description: "Represents a partner resource that enables you to send your user identity and access grant resources to Seam.",
|
|
21865
|
-
properties: {
|
|
21866
|
-
custom_metadata: {
|
|
21867
|
-
additionalProperties: { type: "string" },
|
|
21868
|
-
description: "Custom metadata associated with the partner resource.",
|
|
21869
|
-
type: "object"
|
|
21870
|
-
},
|
|
21871
|
-
customer_key: {
|
|
21872
|
-
description: "Customer key associated with the partner resource.",
|
|
21873
|
-
type: "string"
|
|
21874
|
-
},
|
|
21875
|
-
description: {
|
|
21876
|
-
description: "Description of the partner resource.",
|
|
21877
|
-
type: "string"
|
|
21878
|
-
},
|
|
21879
|
-
email_address: {
|
|
21880
|
-
description: "Email address associated with the user identity partner resource.",
|
|
21881
|
-
type: "string"
|
|
21882
|
-
},
|
|
21883
|
-
ends_at: {
|
|
21884
|
-
description: "Ending date and time associated with the access grant partner resource.",
|
|
21885
|
-
type: "string"
|
|
21886
|
-
},
|
|
21887
|
-
location_keys: {
|
|
21888
|
-
description: "Location keys associated with the access grant partner resource.",
|
|
21889
|
-
items: { type: "string" },
|
|
21890
|
-
type: "array"
|
|
21891
|
-
},
|
|
21892
|
-
name: {
|
|
21893
|
-
description: "Name of the partner resource.",
|
|
21894
|
-
type: "string"
|
|
21895
|
-
},
|
|
21896
|
-
partner_resource_key: {
|
|
21897
|
-
description: "Key of the partner resource.",
|
|
21898
|
-
type: "string"
|
|
21899
|
-
},
|
|
21900
|
-
partner_resource_type: {
|
|
21901
|
-
description: "Type of the partner resource.",
|
|
21902
|
-
type: "string"
|
|
21903
|
-
},
|
|
21904
|
-
phone_number: {
|
|
21905
|
-
description: "Phone number associated with the user identity partner resource.",
|
|
21906
|
-
type: "string"
|
|
21907
|
-
},
|
|
21908
|
-
starts_at: {
|
|
21909
|
-
description: "Starting date and time associated with the access grant partner resource.",
|
|
21910
|
-
type: "string"
|
|
21911
|
-
},
|
|
21912
|
-
user_identity_key: {
|
|
21913
|
-
description: "User identity key associated with the access grant partner resource.",
|
|
21914
|
-
type: "string"
|
|
21915
|
-
}
|
|
21916
|
-
},
|
|
21917
|
-
required: [
|
|
21918
|
-
"partner_resource_type",
|
|
21919
|
-
"partner_resource_key",
|
|
21920
|
-
"customer_key"
|
|
21921
|
-
],
|
|
21922
|
-
type: "object",
|
|
21923
|
-
"x-route-path": "/unstable_partner/resources",
|
|
21924
|
-
"x-undocumented": "Unreleased."
|
|
21925
|
-
},
|
|
21926
21863
|
phone: {
|
|
21927
21864
|
description: "Represents an app user's mobile phone.",
|
|
21928
21865
|
properties: {
|
|
@@ -27080,7 +27017,7 @@ var openapi_default = {
|
|
|
27080
27017
|
type: "string"
|
|
27081
27018
|
},
|
|
27082
27019
|
name: {
|
|
27083
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
27020
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
27084
27021
|
type: "string"
|
|
27085
27022
|
},
|
|
27086
27023
|
prefer_native_scheduling: {
|
|
@@ -27210,7 +27147,7 @@ var openapi_default = {
|
|
|
27210
27147
|
type: "string"
|
|
27211
27148
|
},
|
|
27212
27149
|
name: {
|
|
27213
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
27150
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
27214
27151
|
type: "string"
|
|
27215
27152
|
},
|
|
27216
27153
|
prefer_native_scheduling: {
|
|
@@ -27331,7 +27268,7 @@ var openapi_default = {
|
|
|
27331
27268
|
type: "string"
|
|
27332
27269
|
},
|
|
27333
27270
|
name: {
|
|
27334
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
27271
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
27335
27272
|
type: "string"
|
|
27336
27273
|
},
|
|
27337
27274
|
prefer_native_scheduling: {
|
|
@@ -28847,7 +28784,7 @@ var openapi_default = {
|
|
|
28847
28784
|
type: "string"
|
|
28848
28785
|
},
|
|
28849
28786
|
name: {
|
|
28850
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
28787
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
28851
28788
|
type: "string"
|
|
28852
28789
|
},
|
|
28853
28790
|
prefer_native_scheduling: {
|
|
@@ -28981,7 +28918,7 @@ var openapi_default = {
|
|
|
28981
28918
|
type: "string"
|
|
28982
28919
|
},
|
|
28983
28920
|
name: {
|
|
28984
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
28921
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
28985
28922
|
type: "string"
|
|
28986
28923
|
},
|
|
28987
28924
|
prefer_native_scheduling: {
|
|
@@ -29115,7 +29052,7 @@ var openapi_default = {
|
|
|
29115
29052
|
type: "string"
|
|
29116
29053
|
},
|
|
29117
29054
|
name: {
|
|
29118
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
29055
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
29119
29056
|
type: "string"
|
|
29120
29057
|
},
|
|
29121
29058
|
prefer_native_scheduling: {
|
|
@@ -29208,7 +29145,7 @@ var openapi_default = {
|
|
|
29208
29145
|
type: "string"
|
|
29209
29146
|
},
|
|
29210
29147
|
name: {
|
|
29211
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
29148
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
29212
29149
|
type: "string"
|
|
29213
29150
|
},
|
|
29214
29151
|
starts_at: {
|
|
@@ -29268,7 +29205,7 @@ var openapi_default = {
|
|
|
29268
29205
|
type: "string"
|
|
29269
29206
|
},
|
|
29270
29207
|
name: {
|
|
29271
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
29208
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
29272
29209
|
type: "string"
|
|
29273
29210
|
},
|
|
29274
29211
|
starts_at: {
|
|
@@ -38227,199 +38164,1429 @@ var openapi_default = {
|
|
|
38227
38164
|
"x-title": "Update a Connected Account"
|
|
38228
38165
|
}
|
|
38229
38166
|
},
|
|
38230
|
-
"/
|
|
38231
|
-
delete: {
|
|
38232
|
-
description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
38233
|
-
operationId: "devicesDeleteDelete",
|
|
38234
|
-
parameters: [
|
|
38235
|
-
{
|
|
38236
|
-
in: "query",
|
|
38237
|
-
name: "device_id",
|
|
38238
|
-
required: true,
|
|
38239
|
-
schema: {
|
|
38240
|
-
description: "ID of the device that you want to delete.",
|
|
38241
|
-
format: "uuid",
|
|
38242
|
-
type: "string"
|
|
38243
|
-
}
|
|
38244
|
-
}
|
|
38245
|
-
],
|
|
38246
|
-
responses: {
|
|
38247
|
-
200: {
|
|
38248
|
-
content: {
|
|
38249
|
-
"application/json": {
|
|
38250
|
-
schema: {
|
|
38251
|
-
properties: { ok: { type: "boolean" } },
|
|
38252
|
-
required: ["ok"],
|
|
38253
|
-
type: "object"
|
|
38254
|
-
}
|
|
38255
|
-
}
|
|
38256
|
-
},
|
|
38257
|
-
description: "OK"
|
|
38258
|
-
},
|
|
38259
|
-
400: { description: "Bad Request" },
|
|
38260
|
-
401: { description: "Unauthorized" }
|
|
38261
|
-
},
|
|
38262
|
-
security: [
|
|
38263
|
-
{ api_key: [] },
|
|
38264
|
-
{ pat_with_workspace: [] },
|
|
38265
|
-
{ console_session_with_workspace: [] }
|
|
38266
|
-
],
|
|
38267
|
-
summary: "/devices/delete",
|
|
38268
|
-
tags: ["/devices"],
|
|
38269
|
-
"x-deprecated": "Deleting a device is no longer supported and will be removed.",
|
|
38270
|
-
"x-fern-sdk-group-name": ["devices"],
|
|
38271
|
-
"x-fern-sdk-method-name": "delete",
|
|
38272
|
-
"x-response-key": null,
|
|
38273
|
-
"x-title": "Delete a Device",
|
|
38274
|
-
"x-undocumented": "Deleting a device is no longer supported and will be removed."
|
|
38275
|
-
},
|
|
38276
|
-
post: {
|
|
38277
|
-
description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
38278
|
-
operationId: "devicesDeletePost",
|
|
38279
|
-
requestBody: {
|
|
38280
|
-
content: {
|
|
38281
|
-
"application/json": {
|
|
38282
|
-
schema: {
|
|
38283
|
-
properties: {
|
|
38284
|
-
device_id: {
|
|
38285
|
-
description: "ID of the device that you want to delete.",
|
|
38286
|
-
format: "uuid",
|
|
38287
|
-
type: "string"
|
|
38288
|
-
}
|
|
38289
|
-
},
|
|
38290
|
-
required: ["device_id"],
|
|
38291
|
-
type: "object"
|
|
38292
|
-
}
|
|
38293
|
-
}
|
|
38294
|
-
}
|
|
38295
|
-
},
|
|
38296
|
-
responses: {
|
|
38297
|
-
200: {
|
|
38298
|
-
content: {
|
|
38299
|
-
"application/json": {
|
|
38300
|
-
schema: {
|
|
38301
|
-
properties: { ok: { type: "boolean" } },
|
|
38302
|
-
required: ["ok"],
|
|
38303
|
-
type: "object"
|
|
38304
|
-
}
|
|
38305
|
-
}
|
|
38306
|
-
},
|
|
38307
|
-
description: "OK"
|
|
38308
|
-
},
|
|
38309
|
-
400: { description: "Bad Request" },
|
|
38310
|
-
401: { description: "Unauthorized" }
|
|
38311
|
-
},
|
|
38312
|
-
security: [
|
|
38313
|
-
{ api_key: [] },
|
|
38314
|
-
{ pat_with_workspace: [] },
|
|
38315
|
-
{ console_session_with_workspace: [] }
|
|
38316
|
-
],
|
|
38317
|
-
summary: "/devices/delete",
|
|
38318
|
-
tags: ["/devices"],
|
|
38319
|
-
"x-deprecated": "Deleting a device is no longer supported and will be removed.",
|
|
38320
|
-
"x-fern-sdk-group-name": ["devices"],
|
|
38321
|
-
"x-fern-sdk-method-name": "delete",
|
|
38322
|
-
"x-response-key": null,
|
|
38323
|
-
"x-title": "Delete a Device",
|
|
38324
|
-
"x-undocumented": "Deleting a device is no longer supported and will be removed."
|
|
38325
|
-
}
|
|
38326
|
-
},
|
|
38327
|
-
"/devices/get": {
|
|
38328
|
-
get: {
|
|
38329
|
-
description: "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.",
|
|
38330
|
-
operationId: "devicesGetGet",
|
|
38331
|
-
parameters: [
|
|
38332
|
-
{
|
|
38333
|
-
in: "query",
|
|
38334
|
-
name: "device_id",
|
|
38335
|
-
schema: {
|
|
38336
|
-
description: "ID of the device that you want to get.",
|
|
38337
|
-
format: "uuid",
|
|
38338
|
-
type: "string"
|
|
38339
|
-
}
|
|
38340
|
-
},
|
|
38341
|
-
{
|
|
38342
|
-
in: "query",
|
|
38343
|
-
name: "name",
|
|
38344
|
-
schema: {
|
|
38345
|
-
description: "Name of the device that you want to get.",
|
|
38346
|
-
type: "string"
|
|
38347
|
-
}
|
|
38348
|
-
}
|
|
38349
|
-
],
|
|
38350
|
-
responses: {
|
|
38351
|
-
200: {
|
|
38352
|
-
content: {
|
|
38353
|
-
"application/json": {
|
|
38354
|
-
schema: {
|
|
38355
|
-
properties: {
|
|
38356
|
-
device: { $ref: "#/components/schemas/device" },
|
|
38357
|
-
ok: { type: "boolean" }
|
|
38358
|
-
},
|
|
38359
|
-
required: ["device", "ok"],
|
|
38360
|
-
type: "object"
|
|
38361
|
-
}
|
|
38362
|
-
}
|
|
38363
|
-
},
|
|
38364
|
-
description: "OK"
|
|
38365
|
-
},
|
|
38366
|
-
400: { description: "Bad Request" },
|
|
38367
|
-
401: { description: "Unauthorized" }
|
|
38368
|
-
},
|
|
38369
|
-
security: [
|
|
38370
|
-
{ client_session: [] },
|
|
38371
|
-
{ client_session_with_customer: [] },
|
|
38372
|
-
{ pat_with_workspace: [] },
|
|
38373
|
-
{ console_session_with_workspace: [] },
|
|
38374
|
-
{ api_key: [] }
|
|
38375
|
-
],
|
|
38376
|
-
summary: "/devices/get",
|
|
38377
|
-
tags: ["/devices"],
|
|
38378
|
-
"x-fern-sdk-group-name": ["devices"],
|
|
38379
|
-
"x-fern-sdk-method-name": "get",
|
|
38380
|
-
"x-fern-sdk-return-value": "device",
|
|
38381
|
-
"x-response-key": "device",
|
|
38382
|
-
"x-title": "Get a Device"
|
|
38383
|
-
},
|
|
38167
|
+
"/customers/create_portal": {
|
|
38384
38168
|
post: {
|
|
38385
|
-
description: "
|
|
38386
|
-
operationId: "
|
|
38169
|
+
description: "Creates a new customer portal magic link with configurable features.",
|
|
38170
|
+
operationId: "customersCreatePortalPost",
|
|
38387
38171
|
requestBody: {
|
|
38388
38172
|
content: {
|
|
38389
38173
|
"application/json": {
|
|
38390
38174
|
schema: {
|
|
38391
|
-
|
|
38392
|
-
|
|
38393
|
-
|
|
38394
|
-
|
|
38395
|
-
|
|
38396
|
-
|
|
38397
|
-
|
|
38398
|
-
|
|
38399
|
-
|
|
38400
|
-
|
|
38401
|
-
|
|
38402
|
-
|
|
38403
|
-
|
|
38404
|
-
|
|
38405
|
-
|
|
38406
|
-
|
|
38407
|
-
|
|
38408
|
-
|
|
38409
|
-
|
|
38410
|
-
|
|
38411
|
-
|
|
38412
|
-
|
|
38413
|
-
|
|
38414
|
-
|
|
38175
|
+
allOf: [
|
|
38176
|
+
{
|
|
38177
|
+
default: {
|
|
38178
|
+
features: {
|
|
38179
|
+
connect: { exclude: false },
|
|
38180
|
+
manage_devices: { exclude: false },
|
|
38181
|
+
organize: { exclude: false }
|
|
38182
|
+
}
|
|
38183
|
+
},
|
|
38184
|
+
description: "Configuration for a customer portal",
|
|
38185
|
+
properties: {
|
|
38186
|
+
features: {
|
|
38187
|
+
default: {},
|
|
38188
|
+
properties: {
|
|
38189
|
+
connect: {
|
|
38190
|
+
default: {},
|
|
38191
|
+
description: "Configuration for the connect accounts feature.",
|
|
38192
|
+
properties: {
|
|
38193
|
+
exclude: {
|
|
38194
|
+
default: false,
|
|
38195
|
+
description: "Whether to exclude this feature from the portal.",
|
|
38196
|
+
type: "boolean"
|
|
38197
|
+
}
|
|
38198
|
+
},
|
|
38199
|
+
type: "object"
|
|
38200
|
+
},
|
|
38201
|
+
manage_devices: {
|
|
38202
|
+
default: {},
|
|
38203
|
+
description: "Configuration for the manage devices feature.",
|
|
38204
|
+
properties: {
|
|
38205
|
+
exclude: {
|
|
38206
|
+
default: false,
|
|
38207
|
+
description: "Whether to exclude this feature from the portal.",
|
|
38208
|
+
type: "boolean"
|
|
38209
|
+
}
|
|
38210
|
+
},
|
|
38211
|
+
type: "object"
|
|
38212
|
+
},
|
|
38213
|
+
organize: {
|
|
38214
|
+
default: {},
|
|
38215
|
+
description: "Configuration for the organize feature.",
|
|
38216
|
+
properties: {
|
|
38217
|
+
exclude: {
|
|
38218
|
+
default: false,
|
|
38219
|
+
description: "Whether to exclude this feature from the portal.",
|
|
38220
|
+
type: "boolean"
|
|
38221
|
+
}
|
|
38222
|
+
},
|
|
38223
|
+
type: "object"
|
|
38224
|
+
}
|
|
38225
|
+
},
|
|
38226
|
+
type: "object"
|
|
38227
|
+
}
|
|
38228
|
+
},
|
|
38229
|
+
type: "object"
|
|
38415
38230
|
},
|
|
38416
|
-
|
|
38417
|
-
|
|
38418
|
-
|
|
38419
|
-
|
|
38420
|
-
|
|
38421
|
-
|
|
38422
|
-
|
|
38231
|
+
{
|
|
38232
|
+
properties: {
|
|
38233
|
+
customer_data: {
|
|
38234
|
+
properties: {
|
|
38235
|
+
access_grants: {
|
|
38236
|
+
description: "List of access grants.",
|
|
38237
|
+
items: {
|
|
38238
|
+
properties: {
|
|
38239
|
+
access_grant_key: {
|
|
38240
|
+
description: "Your unique identifier for the access grant.",
|
|
38241
|
+
type: "string"
|
|
38242
|
+
},
|
|
38243
|
+
building_keys: {
|
|
38244
|
+
description: "Building keys associated with the access grant.",
|
|
38245
|
+
items: { type: "string" },
|
|
38246
|
+
type: "array"
|
|
38247
|
+
},
|
|
38248
|
+
common_area_keys: {
|
|
38249
|
+
description: "Common area keys associated with the access grant.",
|
|
38250
|
+
items: { type: "string" },
|
|
38251
|
+
type: "array"
|
|
38252
|
+
},
|
|
38253
|
+
ends_at: {
|
|
38254
|
+
description: "Ending date and time for the access grant.",
|
|
38255
|
+
type: "string"
|
|
38256
|
+
},
|
|
38257
|
+
facility_keys: {
|
|
38258
|
+
description: "Facility keys associated with the access grant.",
|
|
38259
|
+
items: { type: "string" },
|
|
38260
|
+
type: "array"
|
|
38261
|
+
},
|
|
38262
|
+
guest_key: {
|
|
38263
|
+
description: "Guest key associated with the access grant.",
|
|
38264
|
+
type: "string"
|
|
38265
|
+
},
|
|
38266
|
+
listing_keys: {
|
|
38267
|
+
description: "Listing keys associated with the access grant.",
|
|
38268
|
+
items: { type: "string" },
|
|
38269
|
+
type: "array"
|
|
38270
|
+
},
|
|
38271
|
+
name: {
|
|
38272
|
+
description: "Your display name for this access grant resource.",
|
|
38273
|
+
type: "string"
|
|
38274
|
+
},
|
|
38275
|
+
property_keys: {
|
|
38276
|
+
description: "Property keys associated with the access grant.",
|
|
38277
|
+
items: { type: "string" },
|
|
38278
|
+
type: "array"
|
|
38279
|
+
},
|
|
38280
|
+
resident_key: {
|
|
38281
|
+
description: "Resident key associated with the access grant.",
|
|
38282
|
+
type: "string"
|
|
38283
|
+
},
|
|
38284
|
+
room_keys: {
|
|
38285
|
+
description: "Room keys associated with the access grant.",
|
|
38286
|
+
items: { type: "string" },
|
|
38287
|
+
type: "array"
|
|
38288
|
+
},
|
|
38289
|
+
space_keys: {
|
|
38290
|
+
description: "Space keys associated with the access grant.",
|
|
38291
|
+
items: { type: "string" },
|
|
38292
|
+
type: "array"
|
|
38293
|
+
},
|
|
38294
|
+
starts_at: {
|
|
38295
|
+
description: "Starting date and time for the access grant.",
|
|
38296
|
+
type: "string"
|
|
38297
|
+
},
|
|
38298
|
+
tenant_key: {
|
|
38299
|
+
description: "Tenant key associated with the access grant.",
|
|
38300
|
+
type: "string"
|
|
38301
|
+
},
|
|
38302
|
+
unit_keys: {
|
|
38303
|
+
description: "Unit keys associated with the access grant.",
|
|
38304
|
+
items: { type: "string" },
|
|
38305
|
+
type: "array"
|
|
38306
|
+
},
|
|
38307
|
+
user_identity_key: {
|
|
38308
|
+
description: "User identity key associated with the access grant.",
|
|
38309
|
+
type: "string"
|
|
38310
|
+
},
|
|
38311
|
+
user_key: {
|
|
38312
|
+
description: "User key associated with the access grant.",
|
|
38313
|
+
type: "string"
|
|
38314
|
+
}
|
|
38315
|
+
},
|
|
38316
|
+
required: ["name", "access_grant_key"],
|
|
38317
|
+
type: "object"
|
|
38318
|
+
},
|
|
38319
|
+
type: "array"
|
|
38320
|
+
},
|
|
38321
|
+
bookings: {
|
|
38322
|
+
description: "List of bookings.",
|
|
38323
|
+
items: {
|
|
38324
|
+
properties: {
|
|
38325
|
+
booking_key: {
|
|
38326
|
+
description: "Your unique identifier for the booking.",
|
|
38327
|
+
type: "string"
|
|
38328
|
+
},
|
|
38329
|
+
building_keys: {
|
|
38330
|
+
description: "Building keys associated with the access grant.",
|
|
38331
|
+
items: { type: "string" },
|
|
38332
|
+
type: "array"
|
|
38333
|
+
},
|
|
38334
|
+
common_area_keys: {
|
|
38335
|
+
description: "Common area keys associated with the access grant.",
|
|
38336
|
+
items: { type: "string" },
|
|
38337
|
+
type: "array"
|
|
38338
|
+
},
|
|
38339
|
+
ends_at: {
|
|
38340
|
+
description: "Ending date and time for the access grant.",
|
|
38341
|
+
type: "string"
|
|
38342
|
+
},
|
|
38343
|
+
facility_keys: {
|
|
38344
|
+
description: "Facility keys associated with the access grant.",
|
|
38345
|
+
items: { type: "string" },
|
|
38346
|
+
type: "array"
|
|
38347
|
+
},
|
|
38348
|
+
guest_key: {
|
|
38349
|
+
description: "Guest key associated with the access grant.",
|
|
38350
|
+
type: "string"
|
|
38351
|
+
},
|
|
38352
|
+
listing_keys: {
|
|
38353
|
+
description: "Listing keys associated with the access grant.",
|
|
38354
|
+
items: { type: "string" },
|
|
38355
|
+
type: "array"
|
|
38356
|
+
},
|
|
38357
|
+
name: {
|
|
38358
|
+
description: "Your display name for this access grant resource.",
|
|
38359
|
+
type: "string"
|
|
38360
|
+
},
|
|
38361
|
+
property_keys: {
|
|
38362
|
+
description: "Property keys associated with the access grant.",
|
|
38363
|
+
items: { type: "string" },
|
|
38364
|
+
type: "array"
|
|
38365
|
+
},
|
|
38366
|
+
resident_key: {
|
|
38367
|
+
description: "Resident key associated with the access grant.",
|
|
38368
|
+
type: "string"
|
|
38369
|
+
},
|
|
38370
|
+
room_keys: {
|
|
38371
|
+
description: "Room keys associated with the access grant.",
|
|
38372
|
+
items: { type: "string" },
|
|
38373
|
+
type: "array"
|
|
38374
|
+
},
|
|
38375
|
+
space_keys: {
|
|
38376
|
+
description: "Space keys associated with the access grant.",
|
|
38377
|
+
items: { type: "string" },
|
|
38378
|
+
type: "array"
|
|
38379
|
+
},
|
|
38380
|
+
starts_at: {
|
|
38381
|
+
description: "Starting date and time for the access grant.",
|
|
38382
|
+
type: "string"
|
|
38383
|
+
},
|
|
38384
|
+
tenant_key: {
|
|
38385
|
+
description: "Tenant key associated with the access grant.",
|
|
38386
|
+
type: "string"
|
|
38387
|
+
},
|
|
38388
|
+
unit_keys: {
|
|
38389
|
+
description: "Unit keys associated with the access grant.",
|
|
38390
|
+
items: { type: "string" },
|
|
38391
|
+
type: "array"
|
|
38392
|
+
},
|
|
38393
|
+
user_identity_key: {
|
|
38394
|
+
description: "User identity key associated with the access grant.",
|
|
38395
|
+
type: "string"
|
|
38396
|
+
},
|
|
38397
|
+
user_key: {
|
|
38398
|
+
description: "User key associated with the access grant.",
|
|
38399
|
+
type: "string"
|
|
38400
|
+
}
|
|
38401
|
+
},
|
|
38402
|
+
required: ["name", "booking_key"],
|
|
38403
|
+
type: "object"
|
|
38404
|
+
},
|
|
38405
|
+
type: "array"
|
|
38406
|
+
},
|
|
38407
|
+
buildings: {
|
|
38408
|
+
description: "List of buildings.",
|
|
38409
|
+
items: {
|
|
38410
|
+
properties: {
|
|
38411
|
+
building_key: {
|
|
38412
|
+
description: "Your unique identifier for the building.",
|
|
38413
|
+
type: "string"
|
|
38414
|
+
},
|
|
38415
|
+
name: {
|
|
38416
|
+
description: "Your display name for this location resource.",
|
|
38417
|
+
type: "string"
|
|
38418
|
+
}
|
|
38419
|
+
},
|
|
38420
|
+
required: ["name", "building_key"],
|
|
38421
|
+
type: "object"
|
|
38422
|
+
},
|
|
38423
|
+
type: "array"
|
|
38424
|
+
},
|
|
38425
|
+
common_areas: {
|
|
38426
|
+
description: "List of shared common areas.",
|
|
38427
|
+
items: {
|
|
38428
|
+
properties: {
|
|
38429
|
+
common_area_key: {
|
|
38430
|
+
description: "Your unique identifier for the common area.",
|
|
38431
|
+
type: "string"
|
|
38432
|
+
},
|
|
38433
|
+
name: {
|
|
38434
|
+
description: "Your display name for this location resource.",
|
|
38435
|
+
type: "string"
|
|
38436
|
+
}
|
|
38437
|
+
},
|
|
38438
|
+
required: ["name", "common_area_key"],
|
|
38439
|
+
type: "object"
|
|
38440
|
+
},
|
|
38441
|
+
type: "array"
|
|
38442
|
+
},
|
|
38443
|
+
customer_key: {
|
|
38444
|
+
description: "Your unique identifier for the customer.",
|
|
38445
|
+
type: "string"
|
|
38446
|
+
},
|
|
38447
|
+
facilities: {
|
|
38448
|
+
description: "List of gym or fitness facilities.",
|
|
38449
|
+
items: {
|
|
38450
|
+
properties: {
|
|
38451
|
+
facility_key: {
|
|
38452
|
+
description: "Your unique identifier for the facility.",
|
|
38453
|
+
type: "string"
|
|
38454
|
+
},
|
|
38455
|
+
name: {
|
|
38456
|
+
description: "Your display name for this location resource.",
|
|
38457
|
+
type: "string"
|
|
38458
|
+
}
|
|
38459
|
+
},
|
|
38460
|
+
required: ["name", "facility_key"],
|
|
38461
|
+
type: "object"
|
|
38462
|
+
},
|
|
38463
|
+
type: "array"
|
|
38464
|
+
},
|
|
38465
|
+
guests: {
|
|
38466
|
+
description: "List of guests.",
|
|
38467
|
+
items: {
|
|
38468
|
+
properties: {
|
|
38469
|
+
email_address: {
|
|
38470
|
+
description: "Email address associated with the user identity.",
|
|
38471
|
+
type: "string"
|
|
38472
|
+
},
|
|
38473
|
+
guest_key: {
|
|
38474
|
+
description: "Your unique identifier for the guest.",
|
|
38475
|
+
type: "string"
|
|
38476
|
+
},
|
|
38477
|
+
name: {
|
|
38478
|
+
description: "Your display name for this user identity resource.",
|
|
38479
|
+
type: "string"
|
|
38480
|
+
},
|
|
38481
|
+
phone_number: {
|
|
38482
|
+
description: "Phone number associated with the user identity.",
|
|
38483
|
+
type: "string"
|
|
38484
|
+
}
|
|
38485
|
+
},
|
|
38486
|
+
required: ["name", "guest_key"],
|
|
38487
|
+
type: "object"
|
|
38488
|
+
},
|
|
38489
|
+
type: "array"
|
|
38490
|
+
},
|
|
38491
|
+
listings: {
|
|
38492
|
+
description: "List of property listings.",
|
|
38493
|
+
items: {
|
|
38494
|
+
properties: {
|
|
38495
|
+
listing_key: {
|
|
38496
|
+
description: "Your unique identifier for the listing.",
|
|
38497
|
+
type: "string"
|
|
38498
|
+
},
|
|
38499
|
+
name: {
|
|
38500
|
+
description: "Your display name for this location resource.",
|
|
38501
|
+
type: "string"
|
|
38502
|
+
}
|
|
38503
|
+
},
|
|
38504
|
+
required: ["name", "listing_key"],
|
|
38505
|
+
type: "object"
|
|
38506
|
+
},
|
|
38507
|
+
type: "array"
|
|
38508
|
+
},
|
|
38509
|
+
properties: {
|
|
38510
|
+
description: "List of short-term rental properties.",
|
|
38511
|
+
items: {
|
|
38512
|
+
properties: {
|
|
38513
|
+
name: {
|
|
38514
|
+
description: "Your display name for this location resource.",
|
|
38515
|
+
type: "string"
|
|
38516
|
+
},
|
|
38517
|
+
property_key: {
|
|
38518
|
+
description: "Your unique identifier for the property.",
|
|
38519
|
+
type: "string"
|
|
38520
|
+
}
|
|
38521
|
+
},
|
|
38522
|
+
required: ["name", "property_key"],
|
|
38523
|
+
type: "object"
|
|
38524
|
+
},
|
|
38525
|
+
type: "array"
|
|
38526
|
+
},
|
|
38527
|
+
reservations: {
|
|
38528
|
+
description: "List of reservations.",
|
|
38529
|
+
items: {
|
|
38530
|
+
properties: {
|
|
38531
|
+
building_keys: {
|
|
38532
|
+
description: "Building keys associated with the access grant.",
|
|
38533
|
+
items: { type: "string" },
|
|
38534
|
+
type: "array"
|
|
38535
|
+
},
|
|
38536
|
+
common_area_keys: {
|
|
38537
|
+
description: "Common area keys associated with the access grant.",
|
|
38538
|
+
items: { type: "string" },
|
|
38539
|
+
type: "array"
|
|
38540
|
+
},
|
|
38541
|
+
ends_at: {
|
|
38542
|
+
description: "Ending date and time for the access grant.",
|
|
38543
|
+
type: "string"
|
|
38544
|
+
},
|
|
38545
|
+
facility_keys: {
|
|
38546
|
+
description: "Facility keys associated with the access grant.",
|
|
38547
|
+
items: { type: "string" },
|
|
38548
|
+
type: "array"
|
|
38549
|
+
},
|
|
38550
|
+
guest_key: {
|
|
38551
|
+
description: "Guest key associated with the access grant.",
|
|
38552
|
+
type: "string"
|
|
38553
|
+
},
|
|
38554
|
+
listing_keys: {
|
|
38555
|
+
description: "Listing keys associated with the access grant.",
|
|
38556
|
+
items: { type: "string" },
|
|
38557
|
+
type: "array"
|
|
38558
|
+
},
|
|
38559
|
+
name: {
|
|
38560
|
+
description: "Your display name for this access grant resource.",
|
|
38561
|
+
type: "string"
|
|
38562
|
+
},
|
|
38563
|
+
property_keys: {
|
|
38564
|
+
description: "Property keys associated with the access grant.",
|
|
38565
|
+
items: { type: "string" },
|
|
38566
|
+
type: "array"
|
|
38567
|
+
},
|
|
38568
|
+
reservation_key: {
|
|
38569
|
+
description: "Your unique identifier for the reservation.",
|
|
38570
|
+
type: "string"
|
|
38571
|
+
},
|
|
38572
|
+
resident_key: {
|
|
38573
|
+
description: "Resident key associated with the access grant.",
|
|
38574
|
+
type: "string"
|
|
38575
|
+
},
|
|
38576
|
+
room_keys: {
|
|
38577
|
+
description: "Room keys associated with the access grant.",
|
|
38578
|
+
items: { type: "string" },
|
|
38579
|
+
type: "array"
|
|
38580
|
+
},
|
|
38581
|
+
space_keys: {
|
|
38582
|
+
description: "Space keys associated with the access grant.",
|
|
38583
|
+
items: { type: "string" },
|
|
38584
|
+
type: "array"
|
|
38585
|
+
},
|
|
38586
|
+
starts_at: {
|
|
38587
|
+
description: "Starting date and time for the access grant.",
|
|
38588
|
+
type: "string"
|
|
38589
|
+
},
|
|
38590
|
+
tenant_key: {
|
|
38591
|
+
description: "Tenant key associated with the access grant.",
|
|
38592
|
+
type: "string"
|
|
38593
|
+
},
|
|
38594
|
+
unit_keys: {
|
|
38595
|
+
description: "Unit keys associated with the access grant.",
|
|
38596
|
+
items: { type: "string" },
|
|
38597
|
+
type: "array"
|
|
38598
|
+
},
|
|
38599
|
+
user_identity_key: {
|
|
38600
|
+
description: "User identity key associated with the access grant.",
|
|
38601
|
+
type: "string"
|
|
38602
|
+
},
|
|
38603
|
+
user_key: {
|
|
38604
|
+
description: "User key associated with the access grant.",
|
|
38605
|
+
type: "string"
|
|
38606
|
+
}
|
|
38607
|
+
},
|
|
38608
|
+
required: ["name", "reservation_key"],
|
|
38609
|
+
type: "object"
|
|
38610
|
+
},
|
|
38611
|
+
type: "array"
|
|
38612
|
+
},
|
|
38613
|
+
residents: {
|
|
38614
|
+
description: "List of residents.",
|
|
38615
|
+
items: {
|
|
38616
|
+
properties: {
|
|
38617
|
+
email_address: {
|
|
38618
|
+
description: "Email address associated with the user identity.",
|
|
38619
|
+
type: "string"
|
|
38620
|
+
},
|
|
38621
|
+
name: {
|
|
38622
|
+
description: "Your display name for this user identity resource.",
|
|
38623
|
+
type: "string"
|
|
38624
|
+
},
|
|
38625
|
+
phone_number: {
|
|
38626
|
+
description: "Phone number associated with the user identity.",
|
|
38627
|
+
type: "string"
|
|
38628
|
+
},
|
|
38629
|
+
resident_key: {
|
|
38630
|
+
description: "Your unique identifier for the resident.",
|
|
38631
|
+
type: "string"
|
|
38632
|
+
}
|
|
38633
|
+
},
|
|
38634
|
+
required: ["name", "resident_key"],
|
|
38635
|
+
type: "object"
|
|
38636
|
+
},
|
|
38637
|
+
type: "array"
|
|
38638
|
+
},
|
|
38639
|
+
rooms: {
|
|
38640
|
+
description: "List of hotel or hospitality rooms.",
|
|
38641
|
+
items: {
|
|
38642
|
+
properties: {
|
|
38643
|
+
name: {
|
|
38644
|
+
description: "Your display name for this location resource.",
|
|
38645
|
+
type: "string"
|
|
38646
|
+
},
|
|
38647
|
+
room_key: {
|
|
38648
|
+
description: "Your unique identifier for the room.",
|
|
38649
|
+
type: "string"
|
|
38650
|
+
}
|
|
38651
|
+
},
|
|
38652
|
+
required: ["name", "room_key"],
|
|
38653
|
+
type: "object"
|
|
38654
|
+
},
|
|
38655
|
+
type: "array"
|
|
38656
|
+
},
|
|
38657
|
+
spaces: {
|
|
38658
|
+
description: "List of general spaces or areas.",
|
|
38659
|
+
items: {
|
|
38660
|
+
properties: {
|
|
38661
|
+
name: {
|
|
38662
|
+
description: "Your display name for this location resource.",
|
|
38663
|
+
type: "string"
|
|
38664
|
+
},
|
|
38665
|
+
space_key: {
|
|
38666
|
+
description: "Your unique identifier for the space.",
|
|
38667
|
+
type: "string"
|
|
38668
|
+
}
|
|
38669
|
+
},
|
|
38670
|
+
required: ["name", "space_key"],
|
|
38671
|
+
type: "object"
|
|
38672
|
+
},
|
|
38673
|
+
type: "array"
|
|
38674
|
+
},
|
|
38675
|
+
tenants: {
|
|
38676
|
+
description: "List of tenants.",
|
|
38677
|
+
items: {
|
|
38678
|
+
properties: {
|
|
38679
|
+
email_address: {
|
|
38680
|
+
description: "Email address associated with the user identity.",
|
|
38681
|
+
type: "string"
|
|
38682
|
+
},
|
|
38683
|
+
name: {
|
|
38684
|
+
description: "Your display name for this user identity resource.",
|
|
38685
|
+
type: "string"
|
|
38686
|
+
},
|
|
38687
|
+
phone_number: {
|
|
38688
|
+
description: "Phone number associated with the user identity.",
|
|
38689
|
+
type: "string"
|
|
38690
|
+
},
|
|
38691
|
+
tenant_key: {
|
|
38692
|
+
description: "Your unique identifier for the tenant.",
|
|
38693
|
+
type: "string"
|
|
38694
|
+
}
|
|
38695
|
+
},
|
|
38696
|
+
required: ["name", "tenant_key"],
|
|
38697
|
+
type: "object"
|
|
38698
|
+
},
|
|
38699
|
+
type: "array"
|
|
38700
|
+
},
|
|
38701
|
+
units: {
|
|
38702
|
+
description: "List of multi-family residential units.",
|
|
38703
|
+
items: {
|
|
38704
|
+
properties: {
|
|
38705
|
+
name: {
|
|
38706
|
+
description: "Your display name for this location resource.",
|
|
38707
|
+
type: "string"
|
|
38708
|
+
},
|
|
38709
|
+
unit_key: {
|
|
38710
|
+
description: "Your unique identifier for the unit.",
|
|
38711
|
+
type: "string"
|
|
38712
|
+
}
|
|
38713
|
+
},
|
|
38714
|
+
required: ["name", "unit_key"],
|
|
38715
|
+
type: "object"
|
|
38716
|
+
},
|
|
38717
|
+
type: "array"
|
|
38718
|
+
},
|
|
38719
|
+
user_identities: {
|
|
38720
|
+
description: "List of user identities.",
|
|
38721
|
+
items: {
|
|
38722
|
+
properties: {
|
|
38723
|
+
email_address: {
|
|
38724
|
+
description: "Email address associated with the user identity.",
|
|
38725
|
+
type: "string"
|
|
38726
|
+
},
|
|
38727
|
+
name: {
|
|
38728
|
+
description: "Your display name for this user identity resource.",
|
|
38729
|
+
type: "string"
|
|
38730
|
+
},
|
|
38731
|
+
phone_number: {
|
|
38732
|
+
description: "Phone number associated with the user identity.",
|
|
38733
|
+
type: "string"
|
|
38734
|
+
},
|
|
38735
|
+
user_identity_key: {
|
|
38736
|
+
description: "Your unique identifier for the user identity.",
|
|
38737
|
+
type: "string"
|
|
38738
|
+
}
|
|
38739
|
+
},
|
|
38740
|
+
required: ["name", "user_identity_key"],
|
|
38741
|
+
type: "object"
|
|
38742
|
+
},
|
|
38743
|
+
type: "array"
|
|
38744
|
+
},
|
|
38745
|
+
users: {
|
|
38746
|
+
description: "List of users.",
|
|
38747
|
+
items: {
|
|
38748
|
+
properties: {
|
|
38749
|
+
email_address: {
|
|
38750
|
+
description: "Email address associated with the user identity.",
|
|
38751
|
+
type: "string"
|
|
38752
|
+
},
|
|
38753
|
+
name: {
|
|
38754
|
+
description: "Your display name for this user identity resource.",
|
|
38755
|
+
type: "string"
|
|
38756
|
+
},
|
|
38757
|
+
phone_number: {
|
|
38758
|
+
description: "Phone number associated with the user identity.",
|
|
38759
|
+
type: "string"
|
|
38760
|
+
},
|
|
38761
|
+
user_key: {
|
|
38762
|
+
description: "Your unique identifier for the user.",
|
|
38763
|
+
type: "string"
|
|
38764
|
+
}
|
|
38765
|
+
},
|
|
38766
|
+
required: ["name", "user_key"],
|
|
38767
|
+
type: "object"
|
|
38768
|
+
},
|
|
38769
|
+
type: "array"
|
|
38770
|
+
}
|
|
38771
|
+
},
|
|
38772
|
+
required: ["customer_key"],
|
|
38773
|
+
type: "object"
|
|
38774
|
+
}
|
|
38775
|
+
},
|
|
38776
|
+
type: "object"
|
|
38777
|
+
}
|
|
38778
|
+
]
|
|
38779
|
+
}
|
|
38780
|
+
}
|
|
38781
|
+
}
|
|
38782
|
+
},
|
|
38783
|
+
responses: {
|
|
38784
|
+
200: {
|
|
38785
|
+
content: {
|
|
38786
|
+
"application/json": {
|
|
38787
|
+
schema: {
|
|
38788
|
+
properties: {
|
|
38789
|
+
magic_link: { $ref: "#/components/schemas/magic_link" },
|
|
38790
|
+
ok: { type: "boolean" }
|
|
38791
|
+
},
|
|
38792
|
+
required: ["magic_link", "ok"],
|
|
38793
|
+
type: "object"
|
|
38794
|
+
}
|
|
38795
|
+
}
|
|
38796
|
+
},
|
|
38797
|
+
description: "OK"
|
|
38798
|
+
},
|
|
38799
|
+
400: { description: "Bad Request" },
|
|
38800
|
+
401: { description: "Unauthorized" }
|
|
38801
|
+
},
|
|
38802
|
+
security: [
|
|
38803
|
+
{ pat_with_workspace: [] },
|
|
38804
|
+
{ console_session_with_workspace: [] },
|
|
38805
|
+
{ api_key: [] }
|
|
38806
|
+
],
|
|
38807
|
+
summary: "/customers/create_portal",
|
|
38808
|
+
tags: [],
|
|
38809
|
+
"x-fern-sdk-group-name": ["customers"],
|
|
38810
|
+
"x-fern-sdk-method-name": "create_portal",
|
|
38811
|
+
"x-fern-sdk-return-value": "magic_link",
|
|
38812
|
+
"x-response-key": "magic_link",
|
|
38813
|
+
"x-title": "Create Customer Portal"
|
|
38814
|
+
}
|
|
38815
|
+
},
|
|
38816
|
+
"/customers/push_data": {
|
|
38817
|
+
post: {
|
|
38818
|
+
description: "Pushes customer data including resources like spaces, properties, rooms, users, etc.",
|
|
38819
|
+
operationId: "customersPushDataPost",
|
|
38820
|
+
requestBody: {
|
|
38821
|
+
content: {
|
|
38822
|
+
"application/json": {
|
|
38823
|
+
schema: {
|
|
38824
|
+
properties: {
|
|
38825
|
+
access_grants: {
|
|
38826
|
+
description: "List of access grants.",
|
|
38827
|
+
items: {
|
|
38828
|
+
properties: {
|
|
38829
|
+
access_grant_key: {
|
|
38830
|
+
description: "Your unique identifier for the access grant.",
|
|
38831
|
+
type: "string"
|
|
38832
|
+
},
|
|
38833
|
+
building_keys: {
|
|
38834
|
+
description: "Building keys associated with the access grant.",
|
|
38835
|
+
items: { type: "string" },
|
|
38836
|
+
type: "array"
|
|
38837
|
+
},
|
|
38838
|
+
common_area_keys: {
|
|
38839
|
+
description: "Common area keys associated with the access grant.",
|
|
38840
|
+
items: { type: "string" },
|
|
38841
|
+
type: "array"
|
|
38842
|
+
},
|
|
38843
|
+
ends_at: {
|
|
38844
|
+
description: "Ending date and time for the access grant.",
|
|
38845
|
+
type: "string"
|
|
38846
|
+
},
|
|
38847
|
+
facility_keys: {
|
|
38848
|
+
description: "Facility keys associated with the access grant.",
|
|
38849
|
+
items: { type: "string" },
|
|
38850
|
+
type: "array"
|
|
38851
|
+
},
|
|
38852
|
+
guest_key: {
|
|
38853
|
+
description: "Guest key associated with the access grant.",
|
|
38854
|
+
type: "string"
|
|
38855
|
+
},
|
|
38856
|
+
listing_keys: {
|
|
38857
|
+
description: "Listing keys associated with the access grant.",
|
|
38858
|
+
items: { type: "string" },
|
|
38859
|
+
type: "array"
|
|
38860
|
+
},
|
|
38861
|
+
name: {
|
|
38862
|
+
description: "Your display name for this access grant resource.",
|
|
38863
|
+
type: "string"
|
|
38864
|
+
},
|
|
38865
|
+
property_keys: {
|
|
38866
|
+
description: "Property keys associated with the access grant.",
|
|
38867
|
+
items: { type: "string" },
|
|
38868
|
+
type: "array"
|
|
38869
|
+
},
|
|
38870
|
+
resident_key: {
|
|
38871
|
+
description: "Resident key associated with the access grant.",
|
|
38872
|
+
type: "string"
|
|
38873
|
+
},
|
|
38874
|
+
room_keys: {
|
|
38875
|
+
description: "Room keys associated with the access grant.",
|
|
38876
|
+
items: { type: "string" },
|
|
38877
|
+
type: "array"
|
|
38878
|
+
},
|
|
38879
|
+
space_keys: {
|
|
38880
|
+
description: "Space keys associated with the access grant.",
|
|
38881
|
+
items: { type: "string" },
|
|
38882
|
+
type: "array"
|
|
38883
|
+
},
|
|
38884
|
+
starts_at: {
|
|
38885
|
+
description: "Starting date and time for the access grant.",
|
|
38886
|
+
type: "string"
|
|
38887
|
+
},
|
|
38888
|
+
tenant_key: {
|
|
38889
|
+
description: "Tenant key associated with the access grant.",
|
|
38890
|
+
type: "string"
|
|
38891
|
+
},
|
|
38892
|
+
unit_keys: {
|
|
38893
|
+
description: "Unit keys associated with the access grant.",
|
|
38894
|
+
items: { type: "string" },
|
|
38895
|
+
type: "array"
|
|
38896
|
+
},
|
|
38897
|
+
user_identity_key: {
|
|
38898
|
+
description: "User identity key associated with the access grant.",
|
|
38899
|
+
type: "string"
|
|
38900
|
+
},
|
|
38901
|
+
user_key: {
|
|
38902
|
+
description: "User key associated with the access grant.",
|
|
38903
|
+
type: "string"
|
|
38904
|
+
}
|
|
38905
|
+
},
|
|
38906
|
+
required: ["name", "access_grant_key"],
|
|
38907
|
+
type: "object"
|
|
38908
|
+
},
|
|
38909
|
+
type: "array"
|
|
38910
|
+
},
|
|
38911
|
+
bookings: {
|
|
38912
|
+
description: "List of bookings.",
|
|
38913
|
+
items: {
|
|
38914
|
+
properties: {
|
|
38915
|
+
booking_key: {
|
|
38916
|
+
description: "Your unique identifier for the booking.",
|
|
38917
|
+
type: "string"
|
|
38918
|
+
},
|
|
38919
|
+
building_keys: {
|
|
38920
|
+
description: "Building keys associated with the access grant.",
|
|
38921
|
+
items: { type: "string" },
|
|
38922
|
+
type: "array"
|
|
38923
|
+
},
|
|
38924
|
+
common_area_keys: {
|
|
38925
|
+
description: "Common area keys associated with the access grant.",
|
|
38926
|
+
items: { type: "string" },
|
|
38927
|
+
type: "array"
|
|
38928
|
+
},
|
|
38929
|
+
ends_at: {
|
|
38930
|
+
description: "Ending date and time for the access grant.",
|
|
38931
|
+
type: "string"
|
|
38932
|
+
},
|
|
38933
|
+
facility_keys: {
|
|
38934
|
+
description: "Facility keys associated with the access grant.",
|
|
38935
|
+
items: { type: "string" },
|
|
38936
|
+
type: "array"
|
|
38937
|
+
},
|
|
38938
|
+
guest_key: {
|
|
38939
|
+
description: "Guest key associated with the access grant.",
|
|
38940
|
+
type: "string"
|
|
38941
|
+
},
|
|
38942
|
+
listing_keys: {
|
|
38943
|
+
description: "Listing keys associated with the access grant.",
|
|
38944
|
+
items: { type: "string" },
|
|
38945
|
+
type: "array"
|
|
38946
|
+
},
|
|
38947
|
+
name: {
|
|
38948
|
+
description: "Your display name for this access grant resource.",
|
|
38949
|
+
type: "string"
|
|
38950
|
+
},
|
|
38951
|
+
property_keys: {
|
|
38952
|
+
description: "Property keys associated with the access grant.",
|
|
38953
|
+
items: { type: "string" },
|
|
38954
|
+
type: "array"
|
|
38955
|
+
},
|
|
38956
|
+
resident_key: {
|
|
38957
|
+
description: "Resident key associated with the access grant.",
|
|
38958
|
+
type: "string"
|
|
38959
|
+
},
|
|
38960
|
+
room_keys: {
|
|
38961
|
+
description: "Room keys associated with the access grant.",
|
|
38962
|
+
items: { type: "string" },
|
|
38963
|
+
type: "array"
|
|
38964
|
+
},
|
|
38965
|
+
space_keys: {
|
|
38966
|
+
description: "Space keys associated with the access grant.",
|
|
38967
|
+
items: { type: "string" },
|
|
38968
|
+
type: "array"
|
|
38969
|
+
},
|
|
38970
|
+
starts_at: {
|
|
38971
|
+
description: "Starting date and time for the access grant.",
|
|
38972
|
+
type: "string"
|
|
38973
|
+
},
|
|
38974
|
+
tenant_key: {
|
|
38975
|
+
description: "Tenant key associated with the access grant.",
|
|
38976
|
+
type: "string"
|
|
38977
|
+
},
|
|
38978
|
+
unit_keys: {
|
|
38979
|
+
description: "Unit keys associated with the access grant.",
|
|
38980
|
+
items: { type: "string" },
|
|
38981
|
+
type: "array"
|
|
38982
|
+
},
|
|
38983
|
+
user_identity_key: {
|
|
38984
|
+
description: "User identity key associated with the access grant.",
|
|
38985
|
+
type: "string"
|
|
38986
|
+
},
|
|
38987
|
+
user_key: {
|
|
38988
|
+
description: "User key associated with the access grant.",
|
|
38989
|
+
type: "string"
|
|
38990
|
+
}
|
|
38991
|
+
},
|
|
38992
|
+
required: ["name", "booking_key"],
|
|
38993
|
+
type: "object"
|
|
38994
|
+
},
|
|
38995
|
+
type: "array"
|
|
38996
|
+
},
|
|
38997
|
+
buildings: {
|
|
38998
|
+
description: "List of buildings.",
|
|
38999
|
+
items: {
|
|
39000
|
+
properties: {
|
|
39001
|
+
building_key: {
|
|
39002
|
+
description: "Your unique identifier for the building.",
|
|
39003
|
+
type: "string"
|
|
39004
|
+
},
|
|
39005
|
+
name: {
|
|
39006
|
+
description: "Your display name for this location resource.",
|
|
39007
|
+
type: "string"
|
|
39008
|
+
}
|
|
39009
|
+
},
|
|
39010
|
+
required: ["name", "building_key"],
|
|
39011
|
+
type: "object"
|
|
39012
|
+
},
|
|
39013
|
+
type: "array"
|
|
39014
|
+
},
|
|
39015
|
+
common_areas: {
|
|
39016
|
+
description: "List of shared common areas.",
|
|
39017
|
+
items: {
|
|
39018
|
+
properties: {
|
|
39019
|
+
common_area_key: {
|
|
39020
|
+
description: "Your unique identifier for the common area.",
|
|
39021
|
+
type: "string"
|
|
39022
|
+
},
|
|
39023
|
+
name: {
|
|
39024
|
+
description: "Your display name for this location resource.",
|
|
39025
|
+
type: "string"
|
|
39026
|
+
}
|
|
39027
|
+
},
|
|
39028
|
+
required: ["name", "common_area_key"],
|
|
39029
|
+
type: "object"
|
|
39030
|
+
},
|
|
39031
|
+
type: "array"
|
|
39032
|
+
},
|
|
39033
|
+
customer_key: {
|
|
39034
|
+
description: "Your unique identifier for the customer.",
|
|
39035
|
+
type: "string"
|
|
39036
|
+
},
|
|
39037
|
+
facilities: {
|
|
39038
|
+
description: "List of gym or fitness facilities.",
|
|
39039
|
+
items: {
|
|
39040
|
+
properties: {
|
|
39041
|
+
facility_key: {
|
|
39042
|
+
description: "Your unique identifier for the facility.",
|
|
39043
|
+
type: "string"
|
|
39044
|
+
},
|
|
39045
|
+
name: {
|
|
39046
|
+
description: "Your display name for this location resource.",
|
|
39047
|
+
type: "string"
|
|
39048
|
+
}
|
|
39049
|
+
},
|
|
39050
|
+
required: ["name", "facility_key"],
|
|
39051
|
+
type: "object"
|
|
39052
|
+
},
|
|
39053
|
+
type: "array"
|
|
39054
|
+
},
|
|
39055
|
+
guests: {
|
|
39056
|
+
description: "List of guests.",
|
|
39057
|
+
items: {
|
|
39058
|
+
properties: {
|
|
39059
|
+
email_address: {
|
|
39060
|
+
description: "Email address associated with the user identity.",
|
|
39061
|
+
type: "string"
|
|
39062
|
+
},
|
|
39063
|
+
guest_key: {
|
|
39064
|
+
description: "Your unique identifier for the guest.",
|
|
39065
|
+
type: "string"
|
|
39066
|
+
},
|
|
39067
|
+
name: {
|
|
39068
|
+
description: "Your display name for this user identity resource.",
|
|
39069
|
+
type: "string"
|
|
39070
|
+
},
|
|
39071
|
+
phone_number: {
|
|
39072
|
+
description: "Phone number associated with the user identity.",
|
|
39073
|
+
type: "string"
|
|
39074
|
+
}
|
|
39075
|
+
},
|
|
39076
|
+
required: ["name", "guest_key"],
|
|
39077
|
+
type: "object"
|
|
39078
|
+
},
|
|
39079
|
+
type: "array"
|
|
39080
|
+
},
|
|
39081
|
+
listings: {
|
|
39082
|
+
description: "List of property listings.",
|
|
39083
|
+
items: {
|
|
39084
|
+
properties: {
|
|
39085
|
+
listing_key: {
|
|
39086
|
+
description: "Your unique identifier for the listing.",
|
|
39087
|
+
type: "string"
|
|
39088
|
+
},
|
|
39089
|
+
name: {
|
|
39090
|
+
description: "Your display name for this location resource.",
|
|
39091
|
+
type: "string"
|
|
39092
|
+
}
|
|
39093
|
+
},
|
|
39094
|
+
required: ["name", "listing_key"],
|
|
39095
|
+
type: "object"
|
|
39096
|
+
},
|
|
39097
|
+
type: "array"
|
|
39098
|
+
},
|
|
39099
|
+
properties: {
|
|
39100
|
+
description: "List of short-term rental properties.",
|
|
39101
|
+
items: {
|
|
39102
|
+
properties: {
|
|
39103
|
+
name: {
|
|
39104
|
+
description: "Your display name for this location resource.",
|
|
39105
|
+
type: "string"
|
|
39106
|
+
},
|
|
39107
|
+
property_key: {
|
|
39108
|
+
description: "Your unique identifier for the property.",
|
|
39109
|
+
type: "string"
|
|
39110
|
+
}
|
|
39111
|
+
},
|
|
39112
|
+
required: ["name", "property_key"],
|
|
39113
|
+
type: "object"
|
|
39114
|
+
},
|
|
39115
|
+
type: "array"
|
|
39116
|
+
},
|
|
39117
|
+
reservations: {
|
|
39118
|
+
description: "List of reservations.",
|
|
39119
|
+
items: {
|
|
39120
|
+
properties: {
|
|
39121
|
+
building_keys: {
|
|
39122
|
+
description: "Building keys associated with the access grant.",
|
|
39123
|
+
items: { type: "string" },
|
|
39124
|
+
type: "array"
|
|
39125
|
+
},
|
|
39126
|
+
common_area_keys: {
|
|
39127
|
+
description: "Common area keys associated with the access grant.",
|
|
39128
|
+
items: { type: "string" },
|
|
39129
|
+
type: "array"
|
|
39130
|
+
},
|
|
39131
|
+
ends_at: {
|
|
39132
|
+
description: "Ending date and time for the access grant.",
|
|
39133
|
+
type: "string"
|
|
39134
|
+
},
|
|
39135
|
+
facility_keys: {
|
|
39136
|
+
description: "Facility keys associated with the access grant.",
|
|
39137
|
+
items: { type: "string" },
|
|
39138
|
+
type: "array"
|
|
39139
|
+
},
|
|
39140
|
+
guest_key: {
|
|
39141
|
+
description: "Guest key associated with the access grant.",
|
|
39142
|
+
type: "string"
|
|
39143
|
+
},
|
|
39144
|
+
listing_keys: {
|
|
39145
|
+
description: "Listing keys associated with the access grant.",
|
|
39146
|
+
items: { type: "string" },
|
|
39147
|
+
type: "array"
|
|
39148
|
+
},
|
|
39149
|
+
name: {
|
|
39150
|
+
description: "Your display name for this access grant resource.",
|
|
39151
|
+
type: "string"
|
|
39152
|
+
},
|
|
39153
|
+
property_keys: {
|
|
39154
|
+
description: "Property keys associated with the access grant.",
|
|
39155
|
+
items: { type: "string" },
|
|
39156
|
+
type: "array"
|
|
39157
|
+
},
|
|
39158
|
+
reservation_key: {
|
|
39159
|
+
description: "Your unique identifier for the reservation.",
|
|
39160
|
+
type: "string"
|
|
39161
|
+
},
|
|
39162
|
+
resident_key: {
|
|
39163
|
+
description: "Resident key associated with the access grant.",
|
|
39164
|
+
type: "string"
|
|
39165
|
+
},
|
|
39166
|
+
room_keys: {
|
|
39167
|
+
description: "Room keys associated with the access grant.",
|
|
39168
|
+
items: { type: "string" },
|
|
39169
|
+
type: "array"
|
|
39170
|
+
},
|
|
39171
|
+
space_keys: {
|
|
39172
|
+
description: "Space keys associated with the access grant.",
|
|
39173
|
+
items: { type: "string" },
|
|
39174
|
+
type: "array"
|
|
39175
|
+
},
|
|
39176
|
+
starts_at: {
|
|
39177
|
+
description: "Starting date and time for the access grant.",
|
|
39178
|
+
type: "string"
|
|
39179
|
+
},
|
|
39180
|
+
tenant_key: {
|
|
39181
|
+
description: "Tenant key associated with the access grant.",
|
|
39182
|
+
type: "string"
|
|
39183
|
+
},
|
|
39184
|
+
unit_keys: {
|
|
39185
|
+
description: "Unit keys associated with the access grant.",
|
|
39186
|
+
items: { type: "string" },
|
|
39187
|
+
type: "array"
|
|
39188
|
+
},
|
|
39189
|
+
user_identity_key: {
|
|
39190
|
+
description: "User identity key associated with the access grant.",
|
|
39191
|
+
type: "string"
|
|
39192
|
+
},
|
|
39193
|
+
user_key: {
|
|
39194
|
+
description: "User key associated with the access grant.",
|
|
39195
|
+
type: "string"
|
|
39196
|
+
}
|
|
39197
|
+
},
|
|
39198
|
+
required: ["name", "reservation_key"],
|
|
39199
|
+
type: "object"
|
|
39200
|
+
},
|
|
39201
|
+
type: "array"
|
|
39202
|
+
},
|
|
39203
|
+
residents: {
|
|
39204
|
+
description: "List of residents.",
|
|
39205
|
+
items: {
|
|
39206
|
+
properties: {
|
|
39207
|
+
email_address: {
|
|
39208
|
+
description: "Email address associated with the user identity.",
|
|
39209
|
+
type: "string"
|
|
39210
|
+
},
|
|
39211
|
+
name: {
|
|
39212
|
+
description: "Your display name for this user identity resource.",
|
|
39213
|
+
type: "string"
|
|
39214
|
+
},
|
|
39215
|
+
phone_number: {
|
|
39216
|
+
description: "Phone number associated with the user identity.",
|
|
39217
|
+
type: "string"
|
|
39218
|
+
},
|
|
39219
|
+
resident_key: {
|
|
39220
|
+
description: "Your unique identifier for the resident.",
|
|
39221
|
+
type: "string"
|
|
39222
|
+
}
|
|
39223
|
+
},
|
|
39224
|
+
required: ["name", "resident_key"],
|
|
39225
|
+
type: "object"
|
|
39226
|
+
},
|
|
39227
|
+
type: "array"
|
|
39228
|
+
},
|
|
39229
|
+
rooms: {
|
|
39230
|
+
description: "List of hotel or hospitality rooms.",
|
|
39231
|
+
items: {
|
|
39232
|
+
properties: {
|
|
39233
|
+
name: {
|
|
39234
|
+
description: "Your display name for this location resource.",
|
|
39235
|
+
type: "string"
|
|
39236
|
+
},
|
|
39237
|
+
room_key: {
|
|
39238
|
+
description: "Your unique identifier for the room.",
|
|
39239
|
+
type: "string"
|
|
39240
|
+
}
|
|
39241
|
+
},
|
|
39242
|
+
required: ["name", "room_key"],
|
|
39243
|
+
type: "object"
|
|
39244
|
+
},
|
|
39245
|
+
type: "array"
|
|
39246
|
+
},
|
|
39247
|
+
spaces: {
|
|
39248
|
+
description: "List of general spaces or areas.",
|
|
39249
|
+
items: {
|
|
39250
|
+
properties: {
|
|
39251
|
+
name: {
|
|
39252
|
+
description: "Your display name for this location resource.",
|
|
39253
|
+
type: "string"
|
|
39254
|
+
},
|
|
39255
|
+
space_key: {
|
|
39256
|
+
description: "Your unique identifier for the space.",
|
|
39257
|
+
type: "string"
|
|
39258
|
+
}
|
|
39259
|
+
},
|
|
39260
|
+
required: ["name", "space_key"],
|
|
39261
|
+
type: "object"
|
|
39262
|
+
},
|
|
39263
|
+
type: "array"
|
|
39264
|
+
},
|
|
39265
|
+
tenants: {
|
|
39266
|
+
description: "List of tenants.",
|
|
39267
|
+
items: {
|
|
39268
|
+
properties: {
|
|
39269
|
+
email_address: {
|
|
39270
|
+
description: "Email address associated with the user identity.",
|
|
39271
|
+
type: "string"
|
|
39272
|
+
},
|
|
39273
|
+
name: {
|
|
39274
|
+
description: "Your display name for this user identity resource.",
|
|
39275
|
+
type: "string"
|
|
39276
|
+
},
|
|
39277
|
+
phone_number: {
|
|
39278
|
+
description: "Phone number associated with the user identity.",
|
|
39279
|
+
type: "string"
|
|
39280
|
+
},
|
|
39281
|
+
tenant_key: {
|
|
39282
|
+
description: "Your unique identifier for the tenant.",
|
|
39283
|
+
type: "string"
|
|
39284
|
+
}
|
|
39285
|
+
},
|
|
39286
|
+
required: ["name", "tenant_key"],
|
|
39287
|
+
type: "object"
|
|
39288
|
+
},
|
|
39289
|
+
type: "array"
|
|
39290
|
+
},
|
|
39291
|
+
units: {
|
|
39292
|
+
description: "List of multi-family residential units.",
|
|
39293
|
+
items: {
|
|
39294
|
+
properties: {
|
|
39295
|
+
name: {
|
|
39296
|
+
description: "Your display name for this location resource.",
|
|
39297
|
+
type: "string"
|
|
39298
|
+
},
|
|
39299
|
+
unit_key: {
|
|
39300
|
+
description: "Your unique identifier for the unit.",
|
|
39301
|
+
type: "string"
|
|
39302
|
+
}
|
|
39303
|
+
},
|
|
39304
|
+
required: ["name", "unit_key"],
|
|
39305
|
+
type: "object"
|
|
39306
|
+
},
|
|
39307
|
+
type: "array"
|
|
39308
|
+
},
|
|
39309
|
+
user_identities: {
|
|
39310
|
+
description: "List of user identities.",
|
|
39311
|
+
items: {
|
|
39312
|
+
properties: {
|
|
39313
|
+
email_address: {
|
|
39314
|
+
description: "Email address associated with the user identity.",
|
|
39315
|
+
type: "string"
|
|
39316
|
+
},
|
|
39317
|
+
name: {
|
|
39318
|
+
description: "Your display name for this user identity resource.",
|
|
39319
|
+
type: "string"
|
|
39320
|
+
},
|
|
39321
|
+
phone_number: {
|
|
39322
|
+
description: "Phone number associated with the user identity.",
|
|
39323
|
+
type: "string"
|
|
39324
|
+
},
|
|
39325
|
+
user_identity_key: {
|
|
39326
|
+
description: "Your unique identifier for the user identity.",
|
|
39327
|
+
type: "string"
|
|
39328
|
+
}
|
|
39329
|
+
},
|
|
39330
|
+
required: ["name", "user_identity_key"],
|
|
39331
|
+
type: "object"
|
|
39332
|
+
},
|
|
39333
|
+
type: "array"
|
|
39334
|
+
},
|
|
39335
|
+
users: {
|
|
39336
|
+
description: "List of users.",
|
|
39337
|
+
items: {
|
|
39338
|
+
properties: {
|
|
39339
|
+
email_address: {
|
|
39340
|
+
description: "Email address associated with the user identity.",
|
|
39341
|
+
type: "string"
|
|
39342
|
+
},
|
|
39343
|
+
name: {
|
|
39344
|
+
description: "Your display name for this user identity resource.",
|
|
39345
|
+
type: "string"
|
|
39346
|
+
},
|
|
39347
|
+
phone_number: {
|
|
39348
|
+
description: "Phone number associated with the user identity.",
|
|
39349
|
+
type: "string"
|
|
39350
|
+
},
|
|
39351
|
+
user_key: {
|
|
39352
|
+
description: "Your unique identifier for the user.",
|
|
39353
|
+
type: "string"
|
|
39354
|
+
}
|
|
39355
|
+
},
|
|
39356
|
+
required: ["name", "user_key"],
|
|
39357
|
+
type: "object"
|
|
39358
|
+
},
|
|
39359
|
+
type: "array"
|
|
39360
|
+
}
|
|
39361
|
+
},
|
|
39362
|
+
required: ["customer_key"],
|
|
39363
|
+
type: "object"
|
|
39364
|
+
}
|
|
39365
|
+
}
|
|
39366
|
+
}
|
|
39367
|
+
},
|
|
39368
|
+
responses: {
|
|
39369
|
+
200: {
|
|
39370
|
+
content: {
|
|
39371
|
+
"application/json": {
|
|
39372
|
+
schema: {
|
|
39373
|
+
properties: { ok: { type: "boolean" } },
|
|
39374
|
+
required: ["ok"],
|
|
39375
|
+
type: "object"
|
|
39376
|
+
}
|
|
39377
|
+
}
|
|
39378
|
+
},
|
|
39379
|
+
description: "OK"
|
|
39380
|
+
},
|
|
39381
|
+
400: { description: "Bad Request" },
|
|
39382
|
+
401: { description: "Unauthorized" }
|
|
39383
|
+
},
|
|
39384
|
+
security: [
|
|
39385
|
+
{ pat_with_workspace: [] },
|
|
39386
|
+
{ console_session_with_workspace: [] },
|
|
39387
|
+
{ api_key: [] }
|
|
39388
|
+
],
|
|
39389
|
+
summary: "/customers/push_data",
|
|
39390
|
+
tags: [],
|
|
39391
|
+
"x-fern-sdk-group-name": ["customers"],
|
|
39392
|
+
"x-fern-sdk-method-name": "push_data",
|
|
39393
|
+
"x-response-key": null,
|
|
39394
|
+
"x-title": "Push Customer Data"
|
|
39395
|
+
}
|
|
39396
|
+
},
|
|
39397
|
+
"/devices/delete": {
|
|
39398
|
+
delete: {
|
|
39399
|
+
description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
39400
|
+
operationId: "devicesDeleteDelete",
|
|
39401
|
+
parameters: [
|
|
39402
|
+
{
|
|
39403
|
+
in: "query",
|
|
39404
|
+
name: "device_id",
|
|
39405
|
+
required: true,
|
|
39406
|
+
schema: {
|
|
39407
|
+
description: "ID of the device that you want to delete.",
|
|
39408
|
+
format: "uuid",
|
|
39409
|
+
type: "string"
|
|
39410
|
+
}
|
|
39411
|
+
}
|
|
39412
|
+
],
|
|
39413
|
+
responses: {
|
|
39414
|
+
200: {
|
|
39415
|
+
content: {
|
|
39416
|
+
"application/json": {
|
|
39417
|
+
schema: {
|
|
39418
|
+
properties: { ok: { type: "boolean" } },
|
|
39419
|
+
required: ["ok"],
|
|
39420
|
+
type: "object"
|
|
39421
|
+
}
|
|
39422
|
+
}
|
|
39423
|
+
},
|
|
39424
|
+
description: "OK"
|
|
39425
|
+
},
|
|
39426
|
+
400: { description: "Bad Request" },
|
|
39427
|
+
401: { description: "Unauthorized" }
|
|
39428
|
+
},
|
|
39429
|
+
security: [
|
|
39430
|
+
{ api_key: [] },
|
|
39431
|
+
{ pat_with_workspace: [] },
|
|
39432
|
+
{ console_session_with_workspace: [] }
|
|
39433
|
+
],
|
|
39434
|
+
summary: "/devices/delete",
|
|
39435
|
+
tags: ["/devices"],
|
|
39436
|
+
"x-deprecated": "Deleting a device is no longer supported and will be removed.",
|
|
39437
|
+
"x-fern-sdk-group-name": ["devices"],
|
|
39438
|
+
"x-fern-sdk-method-name": "delete",
|
|
39439
|
+
"x-response-key": null,
|
|
39440
|
+
"x-title": "Delete a Device",
|
|
39441
|
+
"x-undocumented": "Deleting a device is no longer supported and will be removed."
|
|
39442
|
+
},
|
|
39443
|
+
post: {
|
|
39444
|
+
description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
39445
|
+
operationId: "devicesDeletePost",
|
|
39446
|
+
requestBody: {
|
|
39447
|
+
content: {
|
|
39448
|
+
"application/json": {
|
|
39449
|
+
schema: {
|
|
39450
|
+
properties: {
|
|
39451
|
+
device_id: {
|
|
39452
|
+
description: "ID of the device that you want to delete.",
|
|
39453
|
+
format: "uuid",
|
|
39454
|
+
type: "string"
|
|
39455
|
+
}
|
|
39456
|
+
},
|
|
39457
|
+
required: ["device_id"],
|
|
39458
|
+
type: "object"
|
|
39459
|
+
}
|
|
39460
|
+
}
|
|
39461
|
+
}
|
|
39462
|
+
},
|
|
39463
|
+
responses: {
|
|
39464
|
+
200: {
|
|
39465
|
+
content: {
|
|
39466
|
+
"application/json": {
|
|
39467
|
+
schema: {
|
|
39468
|
+
properties: { ok: { type: "boolean" } },
|
|
39469
|
+
required: ["ok"],
|
|
39470
|
+
type: "object"
|
|
39471
|
+
}
|
|
39472
|
+
}
|
|
39473
|
+
},
|
|
39474
|
+
description: "OK"
|
|
39475
|
+
},
|
|
39476
|
+
400: { description: "Bad Request" },
|
|
39477
|
+
401: { description: "Unauthorized" }
|
|
39478
|
+
},
|
|
39479
|
+
security: [
|
|
39480
|
+
{ api_key: [] },
|
|
39481
|
+
{ pat_with_workspace: [] },
|
|
39482
|
+
{ console_session_with_workspace: [] }
|
|
39483
|
+
],
|
|
39484
|
+
summary: "/devices/delete",
|
|
39485
|
+
tags: ["/devices"],
|
|
39486
|
+
"x-deprecated": "Deleting a device is no longer supported and will be removed.",
|
|
39487
|
+
"x-fern-sdk-group-name": ["devices"],
|
|
39488
|
+
"x-fern-sdk-method-name": "delete",
|
|
39489
|
+
"x-response-key": null,
|
|
39490
|
+
"x-title": "Delete a Device",
|
|
39491
|
+
"x-undocumented": "Deleting a device is no longer supported and will be removed."
|
|
39492
|
+
}
|
|
39493
|
+
},
|
|
39494
|
+
"/devices/get": {
|
|
39495
|
+
get: {
|
|
39496
|
+
description: "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.",
|
|
39497
|
+
operationId: "devicesGetGet",
|
|
39498
|
+
parameters: [
|
|
39499
|
+
{
|
|
39500
|
+
in: "query",
|
|
39501
|
+
name: "device_id",
|
|
39502
|
+
schema: {
|
|
39503
|
+
description: "ID of the device that you want to get.",
|
|
39504
|
+
format: "uuid",
|
|
39505
|
+
type: "string"
|
|
39506
|
+
}
|
|
39507
|
+
},
|
|
39508
|
+
{
|
|
39509
|
+
in: "query",
|
|
39510
|
+
name: "name",
|
|
39511
|
+
schema: {
|
|
39512
|
+
description: "Name of the device that you want to get.",
|
|
39513
|
+
type: "string"
|
|
39514
|
+
}
|
|
39515
|
+
}
|
|
39516
|
+
],
|
|
39517
|
+
responses: {
|
|
39518
|
+
200: {
|
|
39519
|
+
content: {
|
|
39520
|
+
"application/json": {
|
|
39521
|
+
schema: {
|
|
39522
|
+
properties: {
|
|
39523
|
+
device: { $ref: "#/components/schemas/device" },
|
|
39524
|
+
ok: { type: "boolean" }
|
|
39525
|
+
},
|
|
39526
|
+
required: ["device", "ok"],
|
|
39527
|
+
type: "object"
|
|
39528
|
+
}
|
|
39529
|
+
}
|
|
39530
|
+
},
|
|
39531
|
+
description: "OK"
|
|
39532
|
+
},
|
|
39533
|
+
400: { description: "Bad Request" },
|
|
39534
|
+
401: { description: "Unauthorized" }
|
|
39535
|
+
},
|
|
39536
|
+
security: [
|
|
39537
|
+
{ client_session: [] },
|
|
39538
|
+
{ client_session_with_customer: [] },
|
|
39539
|
+
{ pat_with_workspace: [] },
|
|
39540
|
+
{ console_session_with_workspace: [] },
|
|
39541
|
+
{ api_key: [] }
|
|
39542
|
+
],
|
|
39543
|
+
summary: "/devices/get",
|
|
39544
|
+
tags: ["/devices"],
|
|
39545
|
+
"x-fern-sdk-group-name": ["devices"],
|
|
39546
|
+
"x-fern-sdk-method-name": "get",
|
|
39547
|
+
"x-fern-sdk-return-value": "device",
|
|
39548
|
+
"x-response-key": "device",
|
|
39549
|
+
"x-title": "Get a Device"
|
|
39550
|
+
},
|
|
39551
|
+
post: {
|
|
39552
|
+
description: "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.",
|
|
39553
|
+
operationId: "devicesGetPost",
|
|
39554
|
+
requestBody: {
|
|
39555
|
+
content: {
|
|
39556
|
+
"application/json": {
|
|
39557
|
+
schema: {
|
|
39558
|
+
properties: {
|
|
39559
|
+
device_id: {
|
|
39560
|
+
description: "ID of the device that you want to get.",
|
|
39561
|
+
format: "uuid",
|
|
39562
|
+
type: "string"
|
|
39563
|
+
},
|
|
39564
|
+
name: {
|
|
39565
|
+
description: "Name of the device that you want to get.",
|
|
39566
|
+
type: "string"
|
|
39567
|
+
}
|
|
39568
|
+
},
|
|
39569
|
+
type: "object"
|
|
39570
|
+
}
|
|
39571
|
+
}
|
|
39572
|
+
}
|
|
39573
|
+
},
|
|
39574
|
+
responses: {
|
|
39575
|
+
200: {
|
|
39576
|
+
content: {
|
|
39577
|
+
"application/json": {
|
|
39578
|
+
schema: {
|
|
39579
|
+
properties: {
|
|
39580
|
+
device: { $ref: "#/components/schemas/device" },
|
|
39581
|
+
ok: { type: "boolean" }
|
|
39582
|
+
},
|
|
39583
|
+
required: ["device", "ok"],
|
|
39584
|
+
type: "object"
|
|
39585
|
+
}
|
|
39586
|
+
}
|
|
39587
|
+
},
|
|
39588
|
+
description: "OK"
|
|
39589
|
+
},
|
|
38423
39590
|
400: { description: "Bad Request" },
|
|
38424
39591
|
401: { description: "Unauthorized" }
|
|
38425
39592
|
},
|
|
@@ -44633,23 +45800,205 @@ var openapi_default = {
|
|
|
44633
45800
|
"x-undocumented": "Seam Bridge Client only."
|
|
44634
45801
|
},
|
|
44635
45802
|
post: {
|
|
44636
|
-
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
|
|
44637
|
-
operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
|
|
45803
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
|
|
45804
|
+
operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
|
|
45805
|
+
responses: {
|
|
45806
|
+
200: {
|
|
45807
|
+
content: {
|
|
45808
|
+
"application/json": {
|
|
45809
|
+
schema: {
|
|
45810
|
+
properties: {
|
|
45811
|
+
bridge_connected_systems: {
|
|
45812
|
+
items: {
|
|
45813
|
+
$ref: "#/components/schemas/bridge_connected_systems"
|
|
45814
|
+
},
|
|
45815
|
+
type: "array"
|
|
45816
|
+
},
|
|
45817
|
+
ok: { type: "boolean" }
|
|
45818
|
+
},
|
|
45819
|
+
required: ["bridge_connected_systems", "ok"],
|
|
45820
|
+
type: "object"
|
|
45821
|
+
}
|
|
45822
|
+
}
|
|
45823
|
+
},
|
|
45824
|
+
description: "OK"
|
|
45825
|
+
},
|
|
45826
|
+
400: { description: "Bad Request" },
|
|
45827
|
+
401: { description: "Unauthorized" }
|
|
45828
|
+
},
|
|
45829
|
+
security: [{ bridge_client_session: [] }],
|
|
45830
|
+
summary: "/seam/bridge/v1/bridge_connected_systems/list",
|
|
45831
|
+
tags: [],
|
|
45832
|
+
"x-fern-sdk-group-name": [
|
|
45833
|
+
"seam",
|
|
45834
|
+
"bridge",
|
|
45835
|
+
"v1",
|
|
45836
|
+
"bridge_connected_systems"
|
|
45837
|
+
],
|
|
45838
|
+
"x-fern-sdk-method-name": "list",
|
|
45839
|
+
"x-fern-sdk-return-value": "bridge_connected_systems",
|
|
45840
|
+
"x-response-key": "bridge_connected_systems",
|
|
45841
|
+
"x-title": "List Bridge-Connected Systems",
|
|
45842
|
+
"x-undocumented": "Seam Bridge Client only."
|
|
45843
|
+
}
|
|
45844
|
+
},
|
|
45845
|
+
"/seam/customer/v1/portals/get": {
|
|
45846
|
+
get: {
|
|
45847
|
+
description: "Retrieves the configuration for a customer portal identified by customer_portal_id.",
|
|
45848
|
+
operationId: "seamCustomerV1PortalsGetGet",
|
|
45849
|
+
parameters: [
|
|
45850
|
+
{
|
|
45851
|
+
in: "query",
|
|
45852
|
+
name: "customer_portal_id",
|
|
45853
|
+
required: true,
|
|
45854
|
+
schema: { description: "Customer portal ID.", type: "string" }
|
|
45855
|
+
}
|
|
45856
|
+
],
|
|
45857
|
+
responses: {
|
|
45858
|
+
200: {
|
|
45859
|
+
content: {
|
|
45860
|
+
"application/json": {
|
|
45861
|
+
schema: {
|
|
45862
|
+
properties: {
|
|
45863
|
+
customer_portal: {
|
|
45864
|
+
properties: {
|
|
45865
|
+
business_vertical: {
|
|
45866
|
+
description: "Business vertical of the customer portal.",
|
|
45867
|
+
enum: [
|
|
45868
|
+
"short_term_rental",
|
|
45869
|
+
"hospitality",
|
|
45870
|
+
"multi_family",
|
|
45871
|
+
"gym_management",
|
|
45872
|
+
"property_tours"
|
|
45873
|
+
],
|
|
45874
|
+
type: "string"
|
|
45875
|
+
},
|
|
45876
|
+
features: {
|
|
45877
|
+
properties: {
|
|
45878
|
+
connect: {
|
|
45879
|
+
properties: { exclude: { type: "boolean" } },
|
|
45880
|
+
type: "object"
|
|
45881
|
+
},
|
|
45882
|
+
manage_devices: {
|
|
45883
|
+
properties: { exclude: { type: "boolean" } },
|
|
45884
|
+
type: "object"
|
|
45885
|
+
},
|
|
45886
|
+
organize: {
|
|
45887
|
+
properties: { exclude: { type: "boolean" } },
|
|
45888
|
+
type: "object"
|
|
45889
|
+
}
|
|
45890
|
+
},
|
|
45891
|
+
type: "object"
|
|
45892
|
+
}
|
|
45893
|
+
},
|
|
45894
|
+
type: "object"
|
|
45895
|
+
},
|
|
45896
|
+
ok: { type: "boolean" }
|
|
45897
|
+
},
|
|
45898
|
+
required: ["customer_portal", "ok"],
|
|
45899
|
+
type: "object"
|
|
45900
|
+
}
|
|
45901
|
+
}
|
|
45902
|
+
},
|
|
45903
|
+
description: "OK"
|
|
45904
|
+
},
|
|
45905
|
+
400: { description: "Bad Request" },
|
|
45906
|
+
401: { description: "Unauthorized" }
|
|
45907
|
+
},
|
|
45908
|
+
security: [{ client_session_with_customer: [] }],
|
|
45909
|
+
summary: "/seam/customer/v1/portals/get",
|
|
45910
|
+
tags: [],
|
|
45911
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "portals"],
|
|
45912
|
+
"x-fern-sdk-method-name": "get",
|
|
45913
|
+
"x-fern-sdk-return-value": "portal_configuration",
|
|
45914
|
+
"x-response-key": "portal_configuration",
|
|
45915
|
+
"x-title": "Get Customer Portal Configuration",
|
|
45916
|
+
"x-undocumented": "Internal endpoint for customer portals."
|
|
45917
|
+
}
|
|
45918
|
+
},
|
|
45919
|
+
"/seam/customer/v1/settings/update": {
|
|
45920
|
+
patch: {
|
|
45921
|
+
description: "Updates the settings for a customer portal workspace.",
|
|
45922
|
+
operationId: "seamCustomerV1SettingsUpdatePatch",
|
|
45923
|
+
requestBody: {
|
|
45924
|
+
content: {
|
|
45925
|
+
"application/json": {
|
|
45926
|
+
schema: {
|
|
45927
|
+
properties: {
|
|
45928
|
+
business_vertical: {
|
|
45929
|
+
description: "Business vertical to set on the workspace.",
|
|
45930
|
+
enum: [
|
|
45931
|
+
"short_term_rental",
|
|
45932
|
+
"hospitality",
|
|
45933
|
+
"multi_family",
|
|
45934
|
+
"gym_management",
|
|
45935
|
+
"property_tours"
|
|
45936
|
+
],
|
|
45937
|
+
type: "string"
|
|
45938
|
+
}
|
|
45939
|
+
},
|
|
45940
|
+
type: "object"
|
|
45941
|
+
}
|
|
45942
|
+
}
|
|
45943
|
+
}
|
|
45944
|
+
},
|
|
45945
|
+
responses: {
|
|
45946
|
+
200: {
|
|
45947
|
+
content: {
|
|
45948
|
+
"application/json": {
|
|
45949
|
+
schema: {
|
|
45950
|
+
properties: { ok: { type: "boolean" } },
|
|
45951
|
+
required: ["ok"],
|
|
45952
|
+
type: "object"
|
|
45953
|
+
}
|
|
45954
|
+
}
|
|
45955
|
+
},
|
|
45956
|
+
description: "OK"
|
|
45957
|
+
},
|
|
45958
|
+
400: { description: "Bad Request" },
|
|
45959
|
+
401: { description: "Unauthorized" }
|
|
45960
|
+
},
|
|
45961
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
45962
|
+
summary: "/seam/customer/v1/settings/update",
|
|
45963
|
+
tags: [],
|
|
45964
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"],
|
|
45965
|
+
"x-fern-sdk-method-name": "update",
|
|
45966
|
+
"x-response-key": null,
|
|
45967
|
+
"x-title": "Update Customer Portal Settings",
|
|
45968
|
+
"x-undocumented": "Internal endpoint for customer portals."
|
|
45969
|
+
},
|
|
45970
|
+
post: {
|
|
45971
|
+
description: "Updates the settings for a customer portal workspace.",
|
|
45972
|
+
operationId: "seamCustomerV1SettingsUpdatePost",
|
|
45973
|
+
requestBody: {
|
|
45974
|
+
content: {
|
|
45975
|
+
"application/json": {
|
|
45976
|
+
schema: {
|
|
45977
|
+
properties: {
|
|
45978
|
+
business_vertical: {
|
|
45979
|
+
description: "Business vertical to set on the workspace.",
|
|
45980
|
+
enum: [
|
|
45981
|
+
"short_term_rental",
|
|
45982
|
+
"hospitality",
|
|
45983
|
+
"multi_family",
|
|
45984
|
+
"gym_management",
|
|
45985
|
+
"property_tours"
|
|
45986
|
+
],
|
|
45987
|
+
type: "string"
|
|
45988
|
+
}
|
|
45989
|
+
},
|
|
45990
|
+
type: "object"
|
|
45991
|
+
}
|
|
45992
|
+
}
|
|
45993
|
+
}
|
|
45994
|
+
},
|
|
44638
45995
|
responses: {
|
|
44639
45996
|
200: {
|
|
44640
45997
|
content: {
|
|
44641
45998
|
"application/json": {
|
|
44642
45999
|
schema: {
|
|
44643
|
-
properties: {
|
|
44644
|
-
|
|
44645
|
-
items: {
|
|
44646
|
-
$ref: "#/components/schemas/bridge_connected_systems"
|
|
44647
|
-
},
|
|
44648
|
-
type: "array"
|
|
44649
|
-
},
|
|
44650
|
-
ok: { type: "boolean" }
|
|
44651
|
-
},
|
|
44652
|
-
required: ["bridge_connected_systems", "ok"],
|
|
46000
|
+
properties: { ok: { type: "boolean" } },
|
|
46001
|
+
required: ["ok"],
|
|
44653
46002
|
type: "object"
|
|
44654
46003
|
}
|
|
44655
46004
|
}
|
|
@@ -44659,20 +46008,14 @@ var openapi_default = {
|
|
|
44659
46008
|
400: { description: "Bad Request" },
|
|
44660
46009
|
401: { description: "Unauthorized" }
|
|
44661
46010
|
},
|
|
44662
|
-
security: [{
|
|
44663
|
-
summary: "/seam/
|
|
46011
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
46012
|
+
summary: "/seam/customer/v1/settings/update",
|
|
44664
46013
|
tags: [],
|
|
44665
|
-
"x-fern-sdk-group-name": [
|
|
44666
|
-
|
|
44667
|
-
|
|
44668
|
-
|
|
44669
|
-
|
|
44670
|
-
],
|
|
44671
|
-
"x-fern-sdk-method-name": "list",
|
|
44672
|
-
"x-fern-sdk-return-value": "bridge_connected_systems",
|
|
44673
|
-
"x-response-key": "bridge_connected_systems",
|
|
44674
|
-
"x-title": "List Bridge-Connected Systems",
|
|
44675
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
46014
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "settings"],
|
|
46015
|
+
"x-fern-sdk-method-name": "update",
|
|
46016
|
+
"x-response-key": null,
|
|
46017
|
+
"x-title": "Update Customer Portal Settings",
|
|
46018
|
+
"x-undocumented": "Internal endpoint for customer portals."
|
|
44676
46019
|
}
|
|
44677
46020
|
},
|
|
44678
46021
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
@@ -45072,103 +46415,6 @@ var openapi_default = {
|
|
|
45072
46415
|
"x-undocumented": "Partner building blocks/UI only."
|
|
45073
46416
|
}
|
|
45074
46417
|
},
|
|
45075
|
-
"/seam/partner/v1/resources/list": {
|
|
45076
|
-
get: {
|
|
45077
|
-
description: "Lists partner resources that have been pushed to Seam.",
|
|
45078
|
-
operationId: "seamPartnerV1ResourcesListGet",
|
|
45079
|
-
parameters: [
|
|
45080
|
-
{
|
|
45081
|
-
in: "query",
|
|
45082
|
-
name: "resource_type_alias",
|
|
45083
|
-
schema: {
|
|
45084
|
-
description: "Resource type alias by which you want to filter partner resources.",
|
|
45085
|
-
type: "string"
|
|
45086
|
-
}
|
|
45087
|
-
}
|
|
45088
|
-
],
|
|
45089
|
-
responses: {
|
|
45090
|
-
200: {
|
|
45091
|
-
content: {
|
|
45092
|
-
"application/json": {
|
|
45093
|
-
schema: {
|
|
45094
|
-
properties: {
|
|
45095
|
-
ok: { type: "boolean" },
|
|
45096
|
-
partner_resources: {
|
|
45097
|
-
items: { $ref: "#/components/schemas/partner_resource" },
|
|
45098
|
-
type: "array"
|
|
45099
|
-
}
|
|
45100
|
-
},
|
|
45101
|
-
required: ["partner_resources", "ok"],
|
|
45102
|
-
type: "object"
|
|
45103
|
-
}
|
|
45104
|
-
}
|
|
45105
|
-
},
|
|
45106
|
-
description: "OK"
|
|
45107
|
-
},
|
|
45108
|
-
400: { description: "Bad Request" },
|
|
45109
|
-
401: { description: "Unauthorized" }
|
|
45110
|
-
},
|
|
45111
|
-
security: [{ client_session_with_customer: [] }],
|
|
45112
|
-
summary: "/seam/partner/v1/resources/list",
|
|
45113
|
-
tags: [],
|
|
45114
|
-
"x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
|
|
45115
|
-
"x-fern-sdk-method-name": "list",
|
|
45116
|
-
"x-fern-sdk-return-value": "partner_resources",
|
|
45117
|
-
"x-response-key": "partner_resources",
|
|
45118
|
-
"x-title": "List Partner Resources at Seam",
|
|
45119
|
-
"x-undocumented": "Partner building blocks/UI only."
|
|
45120
|
-
},
|
|
45121
|
-
post: {
|
|
45122
|
-
description: "Lists partner resources that have been pushed to Seam.",
|
|
45123
|
-
operationId: "seamPartnerV1ResourcesListPost",
|
|
45124
|
-
requestBody: {
|
|
45125
|
-
content: {
|
|
45126
|
-
"application/json": {
|
|
45127
|
-
schema: {
|
|
45128
|
-
properties: {
|
|
45129
|
-
resource_type_alias: {
|
|
45130
|
-
description: "Resource type alias by which you want to filter partner resources.",
|
|
45131
|
-
type: "string"
|
|
45132
|
-
}
|
|
45133
|
-
},
|
|
45134
|
-
type: "object"
|
|
45135
|
-
}
|
|
45136
|
-
}
|
|
45137
|
-
}
|
|
45138
|
-
},
|
|
45139
|
-
responses: {
|
|
45140
|
-
200: {
|
|
45141
|
-
content: {
|
|
45142
|
-
"application/json": {
|
|
45143
|
-
schema: {
|
|
45144
|
-
properties: {
|
|
45145
|
-
ok: { type: "boolean" },
|
|
45146
|
-
partner_resources: {
|
|
45147
|
-
items: { $ref: "#/components/schemas/partner_resource" },
|
|
45148
|
-
type: "array"
|
|
45149
|
-
}
|
|
45150
|
-
},
|
|
45151
|
-
required: ["partner_resources", "ok"],
|
|
45152
|
-
type: "object"
|
|
45153
|
-
}
|
|
45154
|
-
}
|
|
45155
|
-
},
|
|
45156
|
-
description: "OK"
|
|
45157
|
-
},
|
|
45158
|
-
400: { description: "Bad Request" },
|
|
45159
|
-
401: { description: "Unauthorized" }
|
|
45160
|
-
},
|
|
45161
|
-
security: [{ client_session_with_customer: [] }],
|
|
45162
|
-
summary: "/seam/partner/v1/resources/list",
|
|
45163
|
-
tags: [],
|
|
45164
|
-
"x-fern-sdk-group-name": ["seam", "partner", "v1", "resources"],
|
|
45165
|
-
"x-fern-sdk-method-name": "list",
|
|
45166
|
-
"x-fern-sdk-return-value": "partner_resources",
|
|
45167
|
-
"x-response-key": "partner_resources",
|
|
45168
|
-
"x-title": "List Partner Resources at Seam",
|
|
45169
|
-
"x-undocumented": "Partner building blocks/UI only."
|
|
45170
|
-
}
|
|
45171
|
-
},
|
|
45172
46418
|
"/spaces/add_acs_entrances": {
|
|
45173
46419
|
post: {
|
|
45174
46420
|
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
|
|
@@ -50919,30 +52165,18 @@ var openapi_default = {
|
|
|
50919
52165
|
schema: {
|
|
50920
52166
|
description: "Optional list of spaces that you want to include in the new building block magic link.",
|
|
50921
52167
|
items: {
|
|
50922
|
-
description: "Represents a partner resource that enables you to send your space resources to Seam.",
|
|
50923
52168
|
properties: {
|
|
50924
|
-
custom_metadata: {
|
|
50925
|
-
additionalProperties: { type: "string" },
|
|
50926
|
-
description: "Custom metadata associated with the space resource.",
|
|
50927
|
-
type: "object"
|
|
50928
|
-
},
|
|
50929
|
-
description: {
|
|
50930
|
-
description: "Description of the space resource.",
|
|
50931
|
-
type: "string"
|
|
50932
|
-
},
|
|
50933
52169
|
name: {
|
|
50934
|
-
description: "
|
|
52170
|
+
description: "Your display name for this location resource.",
|
|
50935
52171
|
type: "string"
|
|
50936
52172
|
},
|
|
50937
52173
|
space_key: {
|
|
50938
|
-
description: "
|
|
52174
|
+
description: "Your unique identifier for the space.",
|
|
50939
52175
|
type: "string"
|
|
50940
52176
|
}
|
|
50941
52177
|
},
|
|
50942
|
-
required: ["
|
|
50943
|
-
type: "object"
|
|
50944
|
-
"x-route-path": "/unstable_partner/resources",
|
|
50945
|
-
"x-undocumented": "Unreleased."
|
|
52178
|
+
required: ["name", "space_key"],
|
|
52179
|
+
type: "object"
|
|
50946
52180
|
},
|
|
50947
52181
|
type: "array"
|
|
50948
52182
|
}
|
|
@@ -51006,30 +52240,18 @@ var openapi_default = {
|
|
|
51006
52240
|
spaces: {
|
|
51007
52241
|
description: "Optional list of spaces that you want to include in the new building block magic link.",
|
|
51008
52242
|
items: {
|
|
51009
|
-
description: "Represents a partner resource that enables you to send your space resources to Seam.",
|
|
51010
52243
|
properties: {
|
|
51011
|
-
custom_metadata: {
|
|
51012
|
-
additionalProperties: { type: "string" },
|
|
51013
|
-
description: "Custom metadata associated with the space resource.",
|
|
51014
|
-
type: "object"
|
|
51015
|
-
},
|
|
51016
|
-
description: {
|
|
51017
|
-
description: "Description of the space resource.",
|
|
51018
|
-
type: "string"
|
|
51019
|
-
},
|
|
51020
52244
|
name: {
|
|
51021
|
-
description: "
|
|
52245
|
+
description: "Your display name for this location resource.",
|
|
51022
52246
|
type: "string"
|
|
51023
52247
|
},
|
|
51024
52248
|
space_key: {
|
|
51025
|
-
description: "
|
|
52249
|
+
description: "Your unique identifier for the space.",
|
|
51026
52250
|
type: "string"
|
|
51027
52251
|
}
|
|
51028
52252
|
},
|
|
51029
|
-
required: ["
|
|
51030
|
-
type: "object"
|
|
51031
|
-
"x-route-path": "/unstable_partner/resources",
|
|
51032
|
-
"x-undocumented": "Unreleased."
|
|
52253
|
+
required: ["name", "space_key"],
|
|
52254
|
+
type: "object"
|
|
51033
52255
|
},
|
|
51034
52256
|
type: "array"
|
|
51035
52257
|
}
|
|
@@ -51144,30 +52366,18 @@ var openapi_default = {
|
|
|
51144
52366
|
spaces: {
|
|
51145
52367
|
description: "Optional list of spaces that you want to include in the new building block magic link.",
|
|
51146
52368
|
items: {
|
|
51147
|
-
description: "Represents a partner resource that enables you to send your space resources to Seam.",
|
|
51148
52369
|
properties: {
|
|
51149
|
-
custom_metadata: {
|
|
51150
|
-
additionalProperties: { type: "string" },
|
|
51151
|
-
description: "Custom metadata associated with the space resource.",
|
|
51152
|
-
type: "object"
|
|
51153
|
-
},
|
|
51154
|
-
description: {
|
|
51155
|
-
description: "Description of the space resource.",
|
|
51156
|
-
type: "string"
|
|
51157
|
-
},
|
|
51158
52370
|
name: {
|
|
51159
|
-
description: "
|
|
52371
|
+
description: "Your display name for this location resource.",
|
|
51160
52372
|
type: "string"
|
|
51161
52373
|
},
|
|
51162
52374
|
space_key: {
|
|
51163
|
-
description: "
|
|
52375
|
+
description: "Your unique identifier for the space.",
|
|
51164
52376
|
type: "string"
|
|
51165
52377
|
}
|
|
51166
52378
|
},
|
|
51167
|
-
required: ["
|
|
51168
|
-
type: "object"
|
|
51169
|
-
"x-route-path": "/unstable_partner/resources",
|
|
51170
|
-
"x-undocumented": "Unreleased."
|
|
52379
|
+
required: ["name", "space_key"],
|
|
52380
|
+
type: "object"
|
|
51171
52381
|
},
|
|
51172
52382
|
type: "array"
|
|
51173
52383
|
}
|
|
@@ -51212,169 +52422,6 @@ var openapi_default = {
|
|
|
51212
52422
|
"x-undocumented": "Experimental partner building blocks."
|
|
51213
52423
|
}
|
|
51214
52424
|
},
|
|
51215
|
-
"/unstable_partner/resources/push": {
|
|
51216
|
-
post: {
|
|
51217
|
-
description: "Sends Seam some of your resources.",
|
|
51218
|
-
operationId: "unstablePartnerResourcesPushPost",
|
|
51219
|
-
requestBody: {
|
|
51220
|
-
content: {
|
|
51221
|
-
"application/json": {
|
|
51222
|
-
schema: {
|
|
51223
|
-
oneOf: [
|
|
51224
|
-
{
|
|
51225
|
-
items: {
|
|
51226
|
-
description: "Represents a partner resource that enables you to send your user identity and access grant resources to Seam.",
|
|
51227
|
-
properties: {
|
|
51228
|
-
custom_metadata: {
|
|
51229
|
-
additionalProperties: { type: "string" },
|
|
51230
|
-
description: "Custom metadata associated with the partner resource.",
|
|
51231
|
-
type: "object"
|
|
51232
|
-
},
|
|
51233
|
-
customer_key: {
|
|
51234
|
-
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
51235
|
-
type: "string"
|
|
51236
|
-
},
|
|
51237
|
-
description: {
|
|
51238
|
-
description: "Description of the partner resource.",
|
|
51239
|
-
type: "string"
|
|
51240
|
-
},
|
|
51241
|
-
email_address: {
|
|
51242
|
-
description: "Email address associated with the user identity partner resource.",
|
|
51243
|
-
type: "string"
|
|
51244
|
-
},
|
|
51245
|
-
ends_at: {
|
|
51246
|
-
description: "Ending date and time associated with the access grant partner resource.",
|
|
51247
|
-
type: "string"
|
|
51248
|
-
},
|
|
51249
|
-
location_keys: {
|
|
51250
|
-
description: "Location keys associated with the access grant partner resource.",
|
|
51251
|
-
items: { type: "string" },
|
|
51252
|
-
type: "array"
|
|
51253
|
-
},
|
|
51254
|
-
name: {
|
|
51255
|
-
description: "Name of the partner resource.",
|
|
51256
|
-
type: "string"
|
|
51257
|
-
},
|
|
51258
|
-
partner_resource_key: {
|
|
51259
|
-
description: "Key of the resource that you want to push to Seam.",
|
|
51260
|
-
type: "string"
|
|
51261
|
-
},
|
|
51262
|
-
partner_resource_type: {
|
|
51263
|
-
description: "Type of the resource that you want to push to Seam.",
|
|
51264
|
-
type: "string"
|
|
51265
|
-
},
|
|
51266
|
-
phone_number: {
|
|
51267
|
-
description: "Phone number associated with the user identity partner resource.",
|
|
51268
|
-
type: "string"
|
|
51269
|
-
},
|
|
51270
|
-
starts_at: {
|
|
51271
|
-
description: "Starting date and time associated with the access grant partner resource.",
|
|
51272
|
-
type: "string"
|
|
51273
|
-
},
|
|
51274
|
-
user_identity_key: {
|
|
51275
|
-
description: "User identity key associated with the access grant partner resource.",
|
|
51276
|
-
type: "string"
|
|
51277
|
-
}
|
|
51278
|
-
},
|
|
51279
|
-
type: "object",
|
|
51280
|
-
"x-route-path": "/unstable_partner/resources",
|
|
51281
|
-
"x-undocumented": "Unreleased."
|
|
51282
|
-
},
|
|
51283
|
-
type: "array"
|
|
51284
|
-
},
|
|
51285
|
-
{
|
|
51286
|
-
description: "Represents a partner resource that enables you to send your user identity and access grant resources to Seam.",
|
|
51287
|
-
properties: {
|
|
51288
|
-
custom_metadata: {
|
|
51289
|
-
additionalProperties: { type: "string" },
|
|
51290
|
-
description: "Custom metadata associated with the partner resource.",
|
|
51291
|
-
type: "object"
|
|
51292
|
-
},
|
|
51293
|
-
customer_key: {
|
|
51294
|
-
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
51295
|
-
type: "string"
|
|
51296
|
-
},
|
|
51297
|
-
description: {
|
|
51298
|
-
description: "Description of the partner resource.",
|
|
51299
|
-
type: "string"
|
|
51300
|
-
},
|
|
51301
|
-
email_address: {
|
|
51302
|
-
description: "Email address associated with the user identity partner resource.",
|
|
51303
|
-
type: "string"
|
|
51304
|
-
},
|
|
51305
|
-
ends_at: {
|
|
51306
|
-
description: "Ending date and time associated with the access grant partner resource.",
|
|
51307
|
-
type: "string"
|
|
51308
|
-
},
|
|
51309
|
-
location_keys: {
|
|
51310
|
-
description: "Location keys associated with the access grant partner resource.",
|
|
51311
|
-
items: { type: "string" },
|
|
51312
|
-
type: "array"
|
|
51313
|
-
},
|
|
51314
|
-
name: {
|
|
51315
|
-
description: "Name of the partner resource.",
|
|
51316
|
-
type: "string"
|
|
51317
|
-
},
|
|
51318
|
-
partner_resource_key: {
|
|
51319
|
-
description: "Key of the resource that you want to push to Seam.",
|
|
51320
|
-
type: "string"
|
|
51321
|
-
},
|
|
51322
|
-
partner_resource_type: {
|
|
51323
|
-
description: "Type of the resource that you want to push to Seam.",
|
|
51324
|
-
type: "string"
|
|
51325
|
-
},
|
|
51326
|
-
phone_number: {
|
|
51327
|
-
description: "Phone number associated with the user identity partner resource.",
|
|
51328
|
-
type: "string"
|
|
51329
|
-
},
|
|
51330
|
-
starts_at: {
|
|
51331
|
-
description: "Starting date and time associated with the access grant partner resource.",
|
|
51332
|
-
type: "string"
|
|
51333
|
-
},
|
|
51334
|
-
user_identity_key: {
|
|
51335
|
-
description: "User identity key associated with the access grant partner resource.",
|
|
51336
|
-
type: "string"
|
|
51337
|
-
}
|
|
51338
|
-
},
|
|
51339
|
-
type: "object",
|
|
51340
|
-
"x-route-path": "/unstable_partner/resources",
|
|
51341
|
-
"x-undocumented": "Unreleased."
|
|
51342
|
-
}
|
|
51343
|
-
]
|
|
51344
|
-
}
|
|
51345
|
-
}
|
|
51346
|
-
}
|
|
51347
|
-
},
|
|
51348
|
-
responses: {
|
|
51349
|
-
200: {
|
|
51350
|
-
content: {
|
|
51351
|
-
"application/json": {
|
|
51352
|
-
schema: {
|
|
51353
|
-
properties: { ok: { type: "boolean" } },
|
|
51354
|
-
required: ["ok"],
|
|
51355
|
-
type: "object"
|
|
51356
|
-
}
|
|
51357
|
-
}
|
|
51358
|
-
},
|
|
51359
|
-
description: "OK"
|
|
51360
|
-
},
|
|
51361
|
-
400: { description: "Bad Request" },
|
|
51362
|
-
401: { description: "Unauthorized" }
|
|
51363
|
-
},
|
|
51364
|
-
security: [
|
|
51365
|
-
{ pat_with_workspace: [] },
|
|
51366
|
-
{ console_session_with_workspace: [] },
|
|
51367
|
-
{ api_key: [] }
|
|
51368
|
-
],
|
|
51369
|
-
summary: "/unstable_partner/resources/push",
|
|
51370
|
-
tags: [],
|
|
51371
|
-
"x-fern-sdk-group-name": ["unstable_partner", "resources"],
|
|
51372
|
-
"x-fern-sdk-method-name": "push",
|
|
51373
|
-
"x-response-key": null,
|
|
51374
|
-
"x-title": "Push Partner Resources at Seam",
|
|
51375
|
-
"x-undocumented": "Experimental partner resources."
|
|
51376
|
-
}
|
|
51377
|
-
},
|
|
51378
52425
|
"/user_identities/add_acs_user": {
|
|
51379
52426
|
post: {
|
|
51380
52427
|
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|