@seamapi/types 1.1127.0 → 1.1129.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +14 -14
- package/lib/seam/connect/models/customer/customer-data.d.ts +24 -24
- package/lib/seam/connect/models/customer/customer-delete-data.d.ts +2 -2
- package/lib/seam/connect/models/customer/customer-portal.d.ts +214 -24
- package/lib/seam/connect/models/customer/customer-portal.js +23 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/customization-profiles/customization-profile.d.ts +266 -0
- package/lib/seam/connect/models/customization-profiles/customization-profile.js +4 -0
- package/lib/seam/connect/models/customization-profiles/customization-profile.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +12 -12
- package/lib/seam/connect/models/events/spaces.d.ts +24 -24
- package/lib/seam/connect/openapi.js +470 -38
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +659 -144
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/customer/customer-portal.ts +24 -0
- package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +550 -38
- package/src/lib/seam/connect/route-types.ts +891 -154
|
@@ -13179,6 +13179,160 @@ const openapi = {
|
|
|
13179
13179
|
nullable: true,
|
|
13180
13180
|
type: 'string',
|
|
13181
13181
|
},
|
|
13182
|
+
customer_portal_features: {
|
|
13183
|
+
description: "Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load.",
|
|
13184
|
+
properties: {
|
|
13185
|
+
configure: {
|
|
13186
|
+
description: 'Configuration for the configure feature.',
|
|
13187
|
+
properties: {
|
|
13188
|
+
allow_access_automation_rule_customization: {
|
|
13189
|
+
default: false,
|
|
13190
|
+
description: 'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
13191
|
+
type: 'boolean',
|
|
13192
|
+
},
|
|
13193
|
+
allow_climate_automation_rule_customization: {
|
|
13194
|
+
default: false,
|
|
13195
|
+
description: 'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
13196
|
+
type: 'boolean',
|
|
13197
|
+
},
|
|
13198
|
+
allow_instant_key_customization: {
|
|
13199
|
+
default: false,
|
|
13200
|
+
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
13201
|
+
type: 'boolean',
|
|
13202
|
+
},
|
|
13203
|
+
allow_notification_customization: {
|
|
13204
|
+
default: false,
|
|
13205
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
13206
|
+
type: 'boolean',
|
|
13207
|
+
},
|
|
13208
|
+
allow_sound_automation_rule_customization: {
|
|
13209
|
+
default: false,
|
|
13210
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
13211
|
+
type: 'boolean',
|
|
13212
|
+
},
|
|
13213
|
+
exclude: {
|
|
13214
|
+
default: false,
|
|
13215
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
13216
|
+
type: 'boolean',
|
|
13217
|
+
},
|
|
13218
|
+
},
|
|
13219
|
+
type: 'object',
|
|
13220
|
+
},
|
|
13221
|
+
connect: {
|
|
13222
|
+
description: 'Configuration for the connect accounts feature.',
|
|
13223
|
+
properties: {
|
|
13224
|
+
accepted_providers: {
|
|
13225
|
+
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
13226
|
+
items: { type: 'string' },
|
|
13227
|
+
type: 'array',
|
|
13228
|
+
},
|
|
13229
|
+
exclude: {
|
|
13230
|
+
default: false,
|
|
13231
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
13232
|
+
type: 'boolean',
|
|
13233
|
+
},
|
|
13234
|
+
excluded_providers: {
|
|
13235
|
+
description: 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
13236
|
+
items: { type: 'string' },
|
|
13237
|
+
type: 'array',
|
|
13238
|
+
},
|
|
13239
|
+
},
|
|
13240
|
+
type: 'object',
|
|
13241
|
+
},
|
|
13242
|
+
manage: {
|
|
13243
|
+
description: 'Configuration for the manage feature.',
|
|
13244
|
+
properties: {
|
|
13245
|
+
device_management_confirmation: {
|
|
13246
|
+
description: '\n Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.\n ',
|
|
13247
|
+
properties: {
|
|
13248
|
+
body: {
|
|
13249
|
+
description: 'Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.',
|
|
13250
|
+
type: 'string',
|
|
13251
|
+
},
|
|
13252
|
+
cancel_button_label: {
|
|
13253
|
+
description: 'Custom label for the cancel button.',
|
|
13254
|
+
type: 'string',
|
|
13255
|
+
},
|
|
13256
|
+
confirm_button_label: {
|
|
13257
|
+
description: 'Custom label for the confirm button.',
|
|
13258
|
+
type: 'string',
|
|
13259
|
+
},
|
|
13260
|
+
title: {
|
|
13261
|
+
description: 'Custom title for the confirmation modal.',
|
|
13262
|
+
type: 'string',
|
|
13263
|
+
},
|
|
13264
|
+
},
|
|
13265
|
+
type: 'object',
|
|
13266
|
+
},
|
|
13267
|
+
events: {
|
|
13268
|
+
description: 'Configuration for event type filtering in the manage feature.',
|
|
13269
|
+
properties: {
|
|
13270
|
+
allowed_events: {
|
|
13271
|
+
description: 'List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.',
|
|
13272
|
+
items: { type: 'string' },
|
|
13273
|
+
type: 'array',
|
|
13274
|
+
},
|
|
13275
|
+
default_events: {
|
|
13276
|
+
description: 'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
13277
|
+
items: { type: 'string' },
|
|
13278
|
+
type: 'array',
|
|
13279
|
+
},
|
|
13280
|
+
},
|
|
13281
|
+
type: 'object',
|
|
13282
|
+
},
|
|
13283
|
+
exclude: {
|
|
13284
|
+
default: false,
|
|
13285
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
13286
|
+
type: 'boolean',
|
|
13287
|
+
},
|
|
13288
|
+
exclude_device_management: {
|
|
13289
|
+
default: false,
|
|
13290
|
+
description: 'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
13291
|
+
type: 'boolean',
|
|
13292
|
+
},
|
|
13293
|
+
exclude_reservation_management: {
|
|
13294
|
+
default: false,
|
|
13295
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
13296
|
+
type: 'boolean',
|
|
13297
|
+
},
|
|
13298
|
+
exclude_reservation_technical_details: {
|
|
13299
|
+
default: false,
|
|
13300
|
+
description: 'Indicates whether to exclude technical details from reservation views.',
|
|
13301
|
+
type: 'boolean',
|
|
13302
|
+
},
|
|
13303
|
+
exclude_staff_management: {
|
|
13304
|
+
default: false,
|
|
13305
|
+
description: 'Indicates whether the customer can manage staff for their properties.',
|
|
13306
|
+
type: 'boolean',
|
|
13307
|
+
},
|
|
13308
|
+
},
|
|
13309
|
+
type: 'object',
|
|
13310
|
+
},
|
|
13311
|
+
manage_devices: {
|
|
13312
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
13313
|
+
properties: {
|
|
13314
|
+
exclude: {
|
|
13315
|
+
default: false,
|
|
13316
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
13317
|
+
type: 'boolean',
|
|
13318
|
+
},
|
|
13319
|
+
},
|
|
13320
|
+
type: 'object',
|
|
13321
|
+
},
|
|
13322
|
+
organize: {
|
|
13323
|
+
description: 'Configuration for the organize feature.',
|
|
13324
|
+
properties: {
|
|
13325
|
+
exclude: {
|
|
13326
|
+
default: false,
|
|
13327
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
13328
|
+
type: 'boolean',
|
|
13329
|
+
},
|
|
13330
|
+
},
|
|
13331
|
+
type: 'object',
|
|
13332
|
+
},
|
|
13333
|
+
},
|
|
13334
|
+
type: 'object',
|
|
13335
|
+
},
|
|
13182
13336
|
customer_portal_theme: {
|
|
13183
13337
|
properties: {
|
|
13184
13338
|
font_family: { type: 'string' },
|
|
@@ -46896,32 +47050,6 @@ const openapi = {
|
|
|
46896
47050
|
schema: {
|
|
46897
47051
|
allOf: [
|
|
46898
47052
|
{
|
|
46899
|
-
default: {
|
|
46900
|
-
exclude_locale_picker: false,
|
|
46901
|
-
features: {
|
|
46902
|
-
configure: {
|
|
46903
|
-
allow_access_automation_rule_customization: false,
|
|
46904
|
-
allow_climate_automation_rule_customization: false,
|
|
46905
|
-
allow_instant_key_customization: false,
|
|
46906
|
-
allow_notification_customization: false,
|
|
46907
|
-
allow_sound_automation_rule_customization: false,
|
|
46908
|
-
exclude: false,
|
|
46909
|
-
},
|
|
46910
|
-
connect: { exclude: false },
|
|
46911
|
-
manage: {
|
|
46912
|
-
exclude: false,
|
|
46913
|
-
exclude_device_management: false,
|
|
46914
|
-
exclude_reservation_management: false,
|
|
46915
|
-
exclude_reservation_technical_details: false,
|
|
46916
|
-
exclude_staff_management: false,
|
|
46917
|
-
},
|
|
46918
|
-
manage_devices: { exclude: false },
|
|
46919
|
-
organize: { exclude: false },
|
|
46920
|
-
},
|
|
46921
|
-
is_embedded: false,
|
|
46922
|
-
read_only: false,
|
|
46923
|
-
},
|
|
46924
|
-
description: 'Configuration for a customer portal',
|
|
46925
47053
|
properties: {
|
|
46926
47054
|
_dev: {
|
|
46927
47055
|
default: false,
|
|
@@ -47015,10 +47143,9 @@ const openapi = {
|
|
|
47015
47143
|
type: 'boolean',
|
|
47016
47144
|
},
|
|
47017
47145
|
features: {
|
|
47018
|
-
|
|
47146
|
+
description: "Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them.",
|
|
47019
47147
|
properties: {
|
|
47020
47148
|
configure: {
|
|
47021
|
-
default: {},
|
|
47022
47149
|
description: 'Configuration for the configure feature.',
|
|
47023
47150
|
properties: {
|
|
47024
47151
|
allow_access_automation_rule_customization: {
|
|
@@ -47055,7 +47182,6 @@ const openapi = {
|
|
|
47055
47182
|
type: 'object',
|
|
47056
47183
|
},
|
|
47057
47184
|
connect: {
|
|
47058
|
-
default: {},
|
|
47059
47185
|
description: 'Configuration for the connect accounts feature.',
|
|
47060
47186
|
properties: {
|
|
47061
47187
|
accepted_providers: {
|
|
@@ -47077,7 +47203,6 @@ const openapi = {
|
|
|
47077
47203
|
type: 'object',
|
|
47078
47204
|
},
|
|
47079
47205
|
manage: {
|
|
47080
|
-
default: {},
|
|
47081
47206
|
description: 'Configuration for the manage feature.',
|
|
47082
47207
|
properties: {
|
|
47083
47208
|
device_management_confirmation: {
|
|
@@ -47147,7 +47272,6 @@ const openapi = {
|
|
|
47147
47272
|
type: 'object',
|
|
47148
47273
|
},
|
|
47149
47274
|
manage_devices: {
|
|
47150
|
-
default: {},
|
|
47151
47275
|
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
47152
47276
|
properties: {
|
|
47153
47277
|
exclude: {
|
|
@@ -47159,7 +47283,6 @@ const openapi = {
|
|
|
47159
47283
|
type: 'object',
|
|
47160
47284
|
},
|
|
47161
47285
|
organize: {
|
|
47162
|
-
default: {},
|
|
47163
47286
|
description: 'Configuration for the organize feature.',
|
|
47164
47287
|
properties: {
|
|
47165
47288
|
exclude: {
|
|
@@ -62113,10 +62236,9 @@ const openapi = {
|
|
|
62113
62236
|
type: 'boolean',
|
|
62114
62237
|
},
|
|
62115
62238
|
features: {
|
|
62116
|
-
|
|
62239
|
+
description: 'Customer portal features. Settings you omit use the Seam default.',
|
|
62117
62240
|
properties: {
|
|
62118
62241
|
configure: {
|
|
62119
|
-
default: {},
|
|
62120
62242
|
description: 'Configuration for the configure feature.',
|
|
62121
62243
|
properties: {
|
|
62122
62244
|
allow_access_automation_rule_customization: {
|
|
@@ -62153,7 +62275,6 @@ const openapi = {
|
|
|
62153
62275
|
type: 'object',
|
|
62154
62276
|
},
|
|
62155
62277
|
connect: {
|
|
62156
|
-
default: {},
|
|
62157
62278
|
description: 'Configuration for the connect accounts feature.',
|
|
62158
62279
|
properties: {
|
|
62159
62280
|
accepted_providers: {
|
|
@@ -62175,7 +62296,6 @@ const openapi = {
|
|
|
62175
62296
|
type: 'object',
|
|
62176
62297
|
},
|
|
62177
62298
|
manage: {
|
|
62178
|
-
default: {},
|
|
62179
62299
|
description: 'Configuration for the manage feature.',
|
|
62180
62300
|
properties: {
|
|
62181
62301
|
device_management_confirmation: {
|
|
@@ -62245,7 +62365,6 @@ const openapi = {
|
|
|
62245
62365
|
type: 'object',
|
|
62246
62366
|
},
|
|
62247
62367
|
manage_devices: {
|
|
62248
|
-
default: {},
|
|
62249
62368
|
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
62250
62369
|
properties: {
|
|
62251
62370
|
exclude: {
|
|
@@ -62257,7 +62376,6 @@ const openapi = {
|
|
|
62257
62376
|
type: 'object',
|
|
62258
62377
|
},
|
|
62259
62378
|
organize: {
|
|
62260
|
-
default: {},
|
|
62261
62379
|
description: 'Configuration for the organize feature.',
|
|
62262
62380
|
properties: {
|
|
62263
62381
|
exclude: {
|
|
@@ -69231,6 +69349,11 @@ const openapi = {
|
|
|
69231
69349
|
items: { format: 'uuid', type: 'string' },
|
|
69232
69350
|
type: 'array',
|
|
69233
69351
|
},
|
|
69352
|
+
customer_key: {
|
|
69353
|
+
description: "Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal.",
|
|
69354
|
+
minLength: 1,
|
|
69355
|
+
type: 'string',
|
|
69356
|
+
},
|
|
69234
69357
|
email_address: {
|
|
69235
69358
|
description: 'Unique email address for the new user identity.',
|
|
69236
69359
|
format: 'email',
|
|
@@ -70917,6 +71040,160 @@ const openapi = {
|
|
|
70917
71040
|
format: 'uuid',
|
|
70918
71041
|
type: 'string',
|
|
70919
71042
|
},
|
|
71043
|
+
customer_portal_features: {
|
|
71044
|
+
description: 'Features for customer portals that use this profile. Settings passed when creating a portal take precedence.',
|
|
71045
|
+
properties: {
|
|
71046
|
+
configure: {
|
|
71047
|
+
description: 'Configuration for the configure feature.',
|
|
71048
|
+
properties: {
|
|
71049
|
+
allow_access_automation_rule_customization: {
|
|
71050
|
+
default: false,
|
|
71051
|
+
description: 'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
71052
|
+
type: 'boolean',
|
|
71053
|
+
},
|
|
71054
|
+
allow_climate_automation_rule_customization: {
|
|
71055
|
+
default: false,
|
|
71056
|
+
description: 'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
71057
|
+
type: 'boolean',
|
|
71058
|
+
},
|
|
71059
|
+
allow_instant_key_customization: {
|
|
71060
|
+
default: false,
|
|
71061
|
+
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
71062
|
+
type: 'boolean',
|
|
71063
|
+
},
|
|
71064
|
+
allow_notification_customization: {
|
|
71065
|
+
default: false,
|
|
71066
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
71067
|
+
type: 'boolean',
|
|
71068
|
+
},
|
|
71069
|
+
allow_sound_automation_rule_customization: {
|
|
71070
|
+
default: false,
|
|
71071
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
71072
|
+
type: 'boolean',
|
|
71073
|
+
},
|
|
71074
|
+
exclude: {
|
|
71075
|
+
default: false,
|
|
71076
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71077
|
+
type: 'boolean',
|
|
71078
|
+
},
|
|
71079
|
+
},
|
|
71080
|
+
type: 'object',
|
|
71081
|
+
},
|
|
71082
|
+
connect: {
|
|
71083
|
+
description: 'Configuration for the connect accounts feature.',
|
|
71084
|
+
properties: {
|
|
71085
|
+
accepted_providers: {
|
|
71086
|
+
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
71087
|
+
items: { type: 'string' },
|
|
71088
|
+
type: 'array',
|
|
71089
|
+
},
|
|
71090
|
+
exclude: {
|
|
71091
|
+
default: false,
|
|
71092
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71093
|
+
type: 'boolean',
|
|
71094
|
+
},
|
|
71095
|
+
excluded_providers: {
|
|
71096
|
+
description: 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
71097
|
+
items: { type: 'string' },
|
|
71098
|
+
type: 'array',
|
|
71099
|
+
},
|
|
71100
|
+
},
|
|
71101
|
+
type: 'object',
|
|
71102
|
+
},
|
|
71103
|
+
manage: {
|
|
71104
|
+
description: 'Configuration for the manage feature.',
|
|
71105
|
+
properties: {
|
|
71106
|
+
device_management_confirmation: {
|
|
71107
|
+
description: '\n Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.\n ',
|
|
71108
|
+
properties: {
|
|
71109
|
+
body: {
|
|
71110
|
+
description: 'Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.',
|
|
71111
|
+
type: 'string',
|
|
71112
|
+
},
|
|
71113
|
+
cancel_button_label: {
|
|
71114
|
+
description: 'Custom label for the cancel button.',
|
|
71115
|
+
type: 'string',
|
|
71116
|
+
},
|
|
71117
|
+
confirm_button_label: {
|
|
71118
|
+
description: 'Custom label for the confirm button.',
|
|
71119
|
+
type: 'string',
|
|
71120
|
+
},
|
|
71121
|
+
title: {
|
|
71122
|
+
description: 'Custom title for the confirmation modal.',
|
|
71123
|
+
type: 'string',
|
|
71124
|
+
},
|
|
71125
|
+
},
|
|
71126
|
+
type: 'object',
|
|
71127
|
+
},
|
|
71128
|
+
events: {
|
|
71129
|
+
description: 'Configuration for event type filtering in the manage feature.',
|
|
71130
|
+
properties: {
|
|
71131
|
+
allowed_events: {
|
|
71132
|
+
description: 'List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.',
|
|
71133
|
+
items: { type: 'string' },
|
|
71134
|
+
type: 'array',
|
|
71135
|
+
},
|
|
71136
|
+
default_events: {
|
|
71137
|
+
description: 'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
71138
|
+
items: { type: 'string' },
|
|
71139
|
+
type: 'array',
|
|
71140
|
+
},
|
|
71141
|
+
},
|
|
71142
|
+
type: 'object',
|
|
71143
|
+
},
|
|
71144
|
+
exclude: {
|
|
71145
|
+
default: false,
|
|
71146
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71147
|
+
type: 'boolean',
|
|
71148
|
+
},
|
|
71149
|
+
exclude_device_management: {
|
|
71150
|
+
default: false,
|
|
71151
|
+
description: 'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
71152
|
+
type: 'boolean',
|
|
71153
|
+
},
|
|
71154
|
+
exclude_reservation_management: {
|
|
71155
|
+
default: false,
|
|
71156
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
71157
|
+
type: 'boolean',
|
|
71158
|
+
},
|
|
71159
|
+
exclude_reservation_technical_details: {
|
|
71160
|
+
default: false,
|
|
71161
|
+
description: 'Indicates whether to exclude technical details from reservation views.',
|
|
71162
|
+
type: 'boolean',
|
|
71163
|
+
},
|
|
71164
|
+
exclude_staff_management: {
|
|
71165
|
+
default: false,
|
|
71166
|
+
description: 'Indicates whether the customer can manage staff for their properties.',
|
|
71167
|
+
type: 'boolean',
|
|
71168
|
+
},
|
|
71169
|
+
},
|
|
71170
|
+
type: 'object',
|
|
71171
|
+
},
|
|
71172
|
+
manage_devices: {
|
|
71173
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
71174
|
+
properties: {
|
|
71175
|
+
exclude: {
|
|
71176
|
+
default: false,
|
|
71177
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71178
|
+
type: 'boolean',
|
|
71179
|
+
},
|
|
71180
|
+
},
|
|
71181
|
+
type: 'object',
|
|
71182
|
+
},
|
|
71183
|
+
organize: {
|
|
71184
|
+
description: 'Configuration for the organize feature.',
|
|
71185
|
+
properties: {
|
|
71186
|
+
exclude: {
|
|
71187
|
+
default: false,
|
|
71188
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71189
|
+
type: 'boolean',
|
|
71190
|
+
},
|
|
71191
|
+
},
|
|
71192
|
+
type: 'object',
|
|
71193
|
+
},
|
|
71194
|
+
},
|
|
71195
|
+
type: 'object',
|
|
71196
|
+
},
|
|
70920
71197
|
customer_portal_theme: {
|
|
70921
71198
|
properties: {
|
|
70922
71199
|
font_family: { type: 'string' },
|
|
@@ -71400,6 +71677,161 @@ const openapi = {
|
|
|
71400
71677
|
'application/json': {
|
|
71401
71678
|
schema: {
|
|
71402
71679
|
properties: {
|
|
71680
|
+
customer_portal_features: {
|
|
71681
|
+
description: "Features for customer portals that use this profile. Replaces the profile's current features; pass `null` to remove them. Portals pick up the change the next time they load.",
|
|
71682
|
+
nullable: true,
|
|
71683
|
+
properties: {
|
|
71684
|
+
configure: {
|
|
71685
|
+
description: 'Configuration for the configure feature.',
|
|
71686
|
+
properties: {
|
|
71687
|
+
allow_access_automation_rule_customization: {
|
|
71688
|
+
default: false,
|
|
71689
|
+
description: 'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
71690
|
+
type: 'boolean',
|
|
71691
|
+
},
|
|
71692
|
+
allow_climate_automation_rule_customization: {
|
|
71693
|
+
default: false,
|
|
71694
|
+
description: 'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
71695
|
+
type: 'boolean',
|
|
71696
|
+
},
|
|
71697
|
+
allow_instant_key_customization: {
|
|
71698
|
+
default: false,
|
|
71699
|
+
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
71700
|
+
type: 'boolean',
|
|
71701
|
+
},
|
|
71702
|
+
allow_notification_customization: {
|
|
71703
|
+
default: false,
|
|
71704
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
71705
|
+
type: 'boolean',
|
|
71706
|
+
},
|
|
71707
|
+
allow_sound_automation_rule_customization: {
|
|
71708
|
+
default: false,
|
|
71709
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
71710
|
+
type: 'boolean',
|
|
71711
|
+
},
|
|
71712
|
+
exclude: {
|
|
71713
|
+
default: false,
|
|
71714
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71715
|
+
type: 'boolean',
|
|
71716
|
+
},
|
|
71717
|
+
},
|
|
71718
|
+
type: 'object',
|
|
71719
|
+
},
|
|
71720
|
+
connect: {
|
|
71721
|
+
description: 'Configuration for the connect accounts feature.',
|
|
71722
|
+
properties: {
|
|
71723
|
+
accepted_providers: {
|
|
71724
|
+
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
71725
|
+
items: { type: 'string' },
|
|
71726
|
+
type: 'array',
|
|
71727
|
+
},
|
|
71728
|
+
exclude: {
|
|
71729
|
+
default: false,
|
|
71730
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71731
|
+
type: 'boolean',
|
|
71732
|
+
},
|
|
71733
|
+
excluded_providers: {
|
|
71734
|
+
description: 'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
71735
|
+
items: { type: 'string' },
|
|
71736
|
+
type: 'array',
|
|
71737
|
+
},
|
|
71738
|
+
},
|
|
71739
|
+
type: 'object',
|
|
71740
|
+
},
|
|
71741
|
+
manage: {
|
|
71742
|
+
description: 'Configuration for the manage feature.',
|
|
71743
|
+
properties: {
|
|
71744
|
+
device_management_confirmation: {
|
|
71745
|
+
description: '\n Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.\n ',
|
|
71746
|
+
properties: {
|
|
71747
|
+
body: {
|
|
71748
|
+
description: 'Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.',
|
|
71749
|
+
type: 'string',
|
|
71750
|
+
},
|
|
71751
|
+
cancel_button_label: {
|
|
71752
|
+
description: 'Custom label for the cancel button.',
|
|
71753
|
+
type: 'string',
|
|
71754
|
+
},
|
|
71755
|
+
confirm_button_label: {
|
|
71756
|
+
description: 'Custom label for the confirm button.',
|
|
71757
|
+
type: 'string',
|
|
71758
|
+
},
|
|
71759
|
+
title: {
|
|
71760
|
+
description: 'Custom title for the confirmation modal.',
|
|
71761
|
+
type: 'string',
|
|
71762
|
+
},
|
|
71763
|
+
},
|
|
71764
|
+
type: 'object',
|
|
71765
|
+
},
|
|
71766
|
+
events: {
|
|
71767
|
+
description: 'Configuration for event type filtering in the manage feature.',
|
|
71768
|
+
properties: {
|
|
71769
|
+
allowed_events: {
|
|
71770
|
+
description: 'List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.',
|
|
71771
|
+
items: { type: 'string' },
|
|
71772
|
+
type: 'array',
|
|
71773
|
+
},
|
|
71774
|
+
default_events: {
|
|
71775
|
+
description: 'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
71776
|
+
items: { type: 'string' },
|
|
71777
|
+
type: 'array',
|
|
71778
|
+
},
|
|
71779
|
+
},
|
|
71780
|
+
type: 'object',
|
|
71781
|
+
},
|
|
71782
|
+
exclude: {
|
|
71783
|
+
default: false,
|
|
71784
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71785
|
+
type: 'boolean',
|
|
71786
|
+
},
|
|
71787
|
+
exclude_device_management: {
|
|
71788
|
+
default: false,
|
|
71789
|
+
description: 'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
71790
|
+
type: 'boolean',
|
|
71791
|
+
},
|
|
71792
|
+
exclude_reservation_management: {
|
|
71793
|
+
default: false,
|
|
71794
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
71795
|
+
type: 'boolean',
|
|
71796
|
+
},
|
|
71797
|
+
exclude_reservation_technical_details: {
|
|
71798
|
+
default: false,
|
|
71799
|
+
description: 'Indicates whether to exclude technical details from reservation views.',
|
|
71800
|
+
type: 'boolean',
|
|
71801
|
+
},
|
|
71802
|
+
exclude_staff_management: {
|
|
71803
|
+
default: false,
|
|
71804
|
+
description: 'Indicates whether the customer can manage staff for their properties.',
|
|
71805
|
+
type: 'boolean',
|
|
71806
|
+
},
|
|
71807
|
+
},
|
|
71808
|
+
type: 'object',
|
|
71809
|
+
},
|
|
71810
|
+
manage_devices: {
|
|
71811
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
71812
|
+
properties: {
|
|
71813
|
+
exclude: {
|
|
71814
|
+
default: false,
|
|
71815
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71816
|
+
type: 'boolean',
|
|
71817
|
+
},
|
|
71818
|
+
},
|
|
71819
|
+
type: 'object',
|
|
71820
|
+
},
|
|
71821
|
+
organize: {
|
|
71822
|
+
description: 'Configuration for the organize feature.',
|
|
71823
|
+
properties: {
|
|
71824
|
+
exclude: {
|
|
71825
|
+
default: false,
|
|
71826
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
71827
|
+
type: 'boolean',
|
|
71828
|
+
},
|
|
71829
|
+
},
|
|
71830
|
+
type: 'object',
|
|
71831
|
+
},
|
|
71832
|
+
},
|
|
71833
|
+
type: 'object',
|
|
71834
|
+
},
|
|
71403
71835
|
customer_portal_theme: {
|
|
71404
71836
|
nullable: true,
|
|
71405
71837
|
properties: {
|