@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
|
@@ -14870,6 +14870,183 @@ const openapi: OpenAPISpec = {
|
|
|
14870
14870
|
nullable: true,
|
|
14871
14871
|
type: 'string',
|
|
14872
14872
|
},
|
|
14873
|
+
customer_portal_features: {
|
|
14874
|
+
description:
|
|
14875
|
+
"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.",
|
|
14876
|
+
properties: {
|
|
14877
|
+
configure: {
|
|
14878
|
+
description: 'Configuration for the configure feature.',
|
|
14879
|
+
properties: {
|
|
14880
|
+
allow_access_automation_rule_customization: {
|
|
14881
|
+
default: false,
|
|
14882
|
+
description:
|
|
14883
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
14884
|
+
type: 'boolean',
|
|
14885
|
+
},
|
|
14886
|
+
allow_climate_automation_rule_customization: {
|
|
14887
|
+
default: false,
|
|
14888
|
+
description:
|
|
14889
|
+
'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
14890
|
+
type: 'boolean',
|
|
14891
|
+
},
|
|
14892
|
+
allow_instant_key_customization: {
|
|
14893
|
+
default: false,
|
|
14894
|
+
description:
|
|
14895
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
14896
|
+
type: 'boolean',
|
|
14897
|
+
},
|
|
14898
|
+
allow_notification_customization: {
|
|
14899
|
+
default: false,
|
|
14900
|
+
description:
|
|
14901
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
14902
|
+
type: 'boolean',
|
|
14903
|
+
},
|
|
14904
|
+
allow_sound_automation_rule_customization: {
|
|
14905
|
+
default: false,
|
|
14906
|
+
description:
|
|
14907
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
14908
|
+
type: 'boolean',
|
|
14909
|
+
},
|
|
14910
|
+
exclude: {
|
|
14911
|
+
default: false,
|
|
14912
|
+
description:
|
|
14913
|
+
'Whether to exclude this feature from the portal.',
|
|
14914
|
+
type: 'boolean',
|
|
14915
|
+
},
|
|
14916
|
+
},
|
|
14917
|
+
type: 'object',
|
|
14918
|
+
},
|
|
14919
|
+
connect: {
|
|
14920
|
+
description: 'Configuration for the connect accounts feature.',
|
|
14921
|
+
properties: {
|
|
14922
|
+
accepted_providers: {
|
|
14923
|
+
description:
|
|
14924
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
14925
|
+
items: { type: 'string' },
|
|
14926
|
+
type: 'array',
|
|
14927
|
+
},
|
|
14928
|
+
exclude: {
|
|
14929
|
+
default: false,
|
|
14930
|
+
description:
|
|
14931
|
+
'Whether to exclude this feature from the portal.',
|
|
14932
|
+
type: 'boolean',
|
|
14933
|
+
},
|
|
14934
|
+
excluded_providers: {
|
|
14935
|
+
description:
|
|
14936
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
14937
|
+
items: { type: 'string' },
|
|
14938
|
+
type: 'array',
|
|
14939
|
+
},
|
|
14940
|
+
},
|
|
14941
|
+
type: 'object',
|
|
14942
|
+
},
|
|
14943
|
+
manage: {
|
|
14944
|
+
description: 'Configuration for the manage feature.',
|
|
14945
|
+
properties: {
|
|
14946
|
+
device_management_confirmation: {
|
|
14947
|
+
description:
|
|
14948
|
+
'\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 ',
|
|
14949
|
+
properties: {
|
|
14950
|
+
body: {
|
|
14951
|
+
description:
|
|
14952
|
+
'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.',
|
|
14953
|
+
type: 'string',
|
|
14954
|
+
},
|
|
14955
|
+
cancel_button_label: {
|
|
14956
|
+
description: 'Custom label for the cancel button.',
|
|
14957
|
+
type: 'string',
|
|
14958
|
+
},
|
|
14959
|
+
confirm_button_label: {
|
|
14960
|
+
description: 'Custom label for the confirm button.',
|
|
14961
|
+
type: 'string',
|
|
14962
|
+
},
|
|
14963
|
+
title: {
|
|
14964
|
+
description: 'Custom title for the confirmation modal.',
|
|
14965
|
+
type: 'string',
|
|
14966
|
+
},
|
|
14967
|
+
},
|
|
14968
|
+
type: 'object',
|
|
14969
|
+
},
|
|
14970
|
+
events: {
|
|
14971
|
+
description:
|
|
14972
|
+
'Configuration for event type filtering in the manage feature.',
|
|
14973
|
+
properties: {
|
|
14974
|
+
allowed_events: {
|
|
14975
|
+
description:
|
|
14976
|
+
'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.',
|
|
14977
|
+
items: { type: 'string' },
|
|
14978
|
+
type: 'array',
|
|
14979
|
+
},
|
|
14980
|
+
default_events: {
|
|
14981
|
+
description:
|
|
14982
|
+
'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
14983
|
+
items: { type: 'string' },
|
|
14984
|
+
type: 'array',
|
|
14985
|
+
},
|
|
14986
|
+
},
|
|
14987
|
+
type: 'object',
|
|
14988
|
+
},
|
|
14989
|
+
exclude: {
|
|
14990
|
+
default: false,
|
|
14991
|
+
description:
|
|
14992
|
+
'Whether to exclude this feature from the portal.',
|
|
14993
|
+
type: 'boolean',
|
|
14994
|
+
},
|
|
14995
|
+
exclude_device_management: {
|
|
14996
|
+
default: false,
|
|
14997
|
+
description:
|
|
14998
|
+
'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
14999
|
+
type: 'boolean',
|
|
15000
|
+
},
|
|
15001
|
+
exclude_reservation_management: {
|
|
15002
|
+
default: false,
|
|
15003
|
+
description:
|
|
15004
|
+
'Indicates whether the customer can manage reservations for their properties.',
|
|
15005
|
+
type: 'boolean',
|
|
15006
|
+
},
|
|
15007
|
+
exclude_reservation_technical_details: {
|
|
15008
|
+
default: false,
|
|
15009
|
+
description:
|
|
15010
|
+
'Indicates whether to exclude technical details from reservation views.',
|
|
15011
|
+
type: 'boolean',
|
|
15012
|
+
},
|
|
15013
|
+
exclude_staff_management: {
|
|
15014
|
+
default: false,
|
|
15015
|
+
description:
|
|
15016
|
+
'Indicates whether the customer can manage staff for their properties.',
|
|
15017
|
+
type: 'boolean',
|
|
15018
|
+
},
|
|
15019
|
+
},
|
|
15020
|
+
type: 'object',
|
|
15021
|
+
},
|
|
15022
|
+
manage_devices: {
|
|
15023
|
+
description:
|
|
15024
|
+
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
15025
|
+
properties: {
|
|
15026
|
+
exclude: {
|
|
15027
|
+
default: false,
|
|
15028
|
+
description:
|
|
15029
|
+
'Whether to exclude this feature from the portal.',
|
|
15030
|
+
type: 'boolean',
|
|
15031
|
+
},
|
|
15032
|
+
},
|
|
15033
|
+
type: 'object',
|
|
15034
|
+
},
|
|
15035
|
+
organize: {
|
|
15036
|
+
description: 'Configuration for the organize feature.',
|
|
15037
|
+
properties: {
|
|
15038
|
+
exclude: {
|
|
15039
|
+
default: false,
|
|
15040
|
+
description:
|
|
15041
|
+
'Whether to exclude this feature from the portal.',
|
|
15042
|
+
type: 'boolean',
|
|
15043
|
+
},
|
|
15044
|
+
},
|
|
15045
|
+
type: 'object',
|
|
15046
|
+
},
|
|
15047
|
+
},
|
|
15048
|
+
type: 'object',
|
|
15049
|
+
},
|
|
14873
15050
|
customer_portal_theme: {
|
|
14874
15051
|
properties: {
|
|
14875
15052
|
font_family: { type: 'string' },
|
|
@@ -51929,32 +52106,6 @@ const openapi: OpenAPISpec = {
|
|
|
51929
52106
|
schema: {
|
|
51930
52107
|
allOf: [
|
|
51931
52108
|
{
|
|
51932
|
-
default: {
|
|
51933
|
-
exclude_locale_picker: false,
|
|
51934
|
-
features: {
|
|
51935
|
-
configure: {
|
|
51936
|
-
allow_access_automation_rule_customization: false,
|
|
51937
|
-
allow_climate_automation_rule_customization: false,
|
|
51938
|
-
allow_instant_key_customization: false,
|
|
51939
|
-
allow_notification_customization: false,
|
|
51940
|
-
allow_sound_automation_rule_customization: false,
|
|
51941
|
-
exclude: false,
|
|
51942
|
-
},
|
|
51943
|
-
connect: { exclude: false },
|
|
51944
|
-
manage: {
|
|
51945
|
-
exclude: false,
|
|
51946
|
-
exclude_device_management: false,
|
|
51947
|
-
exclude_reservation_management: false,
|
|
51948
|
-
exclude_reservation_technical_details: false,
|
|
51949
|
-
exclude_staff_management: false,
|
|
51950
|
-
},
|
|
51951
|
-
manage_devices: { exclude: false },
|
|
51952
|
-
organize: { exclude: false },
|
|
51953
|
-
},
|
|
51954
|
-
is_embedded: false,
|
|
51955
|
-
read_only: false,
|
|
51956
|
-
},
|
|
51957
|
-
description: 'Configuration for a customer portal',
|
|
51958
52109
|
properties: {
|
|
51959
52110
|
_dev: {
|
|
51960
52111
|
default: false,
|
|
@@ -52056,10 +52207,10 @@ const openapi: OpenAPISpec = {
|
|
|
52056
52207
|
type: 'boolean',
|
|
52057
52208
|
},
|
|
52058
52209
|
features: {
|
|
52059
|
-
|
|
52210
|
+
description:
|
|
52211
|
+
"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.",
|
|
52060
52212
|
properties: {
|
|
52061
52213
|
configure: {
|
|
52062
|
-
default: {},
|
|
52063
52214
|
description:
|
|
52064
52215
|
'Configuration for the configure feature.',
|
|
52065
52216
|
properties: {
|
|
@@ -52103,7 +52254,6 @@ const openapi: OpenAPISpec = {
|
|
|
52103
52254
|
type: 'object',
|
|
52104
52255
|
},
|
|
52105
52256
|
connect: {
|
|
52106
|
-
default: {},
|
|
52107
52257
|
description:
|
|
52108
52258
|
'Configuration for the connect accounts feature.',
|
|
52109
52259
|
properties: {
|
|
@@ -52129,7 +52279,6 @@ const openapi: OpenAPISpec = {
|
|
|
52129
52279
|
type: 'object',
|
|
52130
52280
|
},
|
|
52131
52281
|
manage: {
|
|
52132
|
-
default: {},
|
|
52133
52282
|
description:
|
|
52134
52283
|
'Configuration for the manage feature.',
|
|
52135
52284
|
properties: {
|
|
@@ -52213,7 +52362,6 @@ const openapi: OpenAPISpec = {
|
|
|
52213
52362
|
type: 'object',
|
|
52214
52363
|
},
|
|
52215
52364
|
manage_devices: {
|
|
52216
|
-
default: {},
|
|
52217
52365
|
description:
|
|
52218
52366
|
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
52219
52367
|
properties: {
|
|
@@ -52227,7 +52375,6 @@ const openapi: OpenAPISpec = {
|
|
|
52227
52375
|
type: 'object',
|
|
52228
52376
|
},
|
|
52229
52377
|
organize: {
|
|
52230
|
-
default: {},
|
|
52231
52378
|
description:
|
|
52232
52379
|
'Configuration for the organize feature.',
|
|
52233
52380
|
properties: {
|
|
@@ -67787,10 +67934,10 @@ const openapi: OpenAPISpec = {
|
|
|
67787
67934
|
type: 'boolean',
|
|
67788
67935
|
},
|
|
67789
67936
|
features: {
|
|
67790
|
-
|
|
67937
|
+
description:
|
|
67938
|
+
'Customer portal features. Settings you omit use the Seam default.',
|
|
67791
67939
|
properties: {
|
|
67792
67940
|
configure: {
|
|
67793
|
-
default: {},
|
|
67794
67941
|
description:
|
|
67795
67942
|
'Configuration for the configure feature.',
|
|
67796
67943
|
properties: {
|
|
@@ -67834,7 +67981,6 @@ const openapi: OpenAPISpec = {
|
|
|
67834
67981
|
type: 'object',
|
|
67835
67982
|
},
|
|
67836
67983
|
connect: {
|
|
67837
|
-
default: {},
|
|
67838
67984
|
description:
|
|
67839
67985
|
'Configuration for the connect accounts feature.',
|
|
67840
67986
|
properties: {
|
|
@@ -67860,7 +68006,6 @@ const openapi: OpenAPISpec = {
|
|
|
67860
68006
|
type: 'object',
|
|
67861
68007
|
},
|
|
67862
68008
|
manage: {
|
|
67863
|
-
default: {},
|
|
67864
68009
|
description:
|
|
67865
68010
|
'Configuration for the manage feature.',
|
|
67866
68011
|
properties: {
|
|
@@ -67944,7 +68089,6 @@ const openapi: OpenAPISpec = {
|
|
|
67944
68089
|
type: 'object',
|
|
67945
68090
|
},
|
|
67946
68091
|
manage_devices: {
|
|
67947
|
-
default: {},
|
|
67948
68092
|
description:
|
|
67949
68093
|
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
67950
68094
|
properties: {
|
|
@@ -67958,7 +68102,6 @@ const openapi: OpenAPISpec = {
|
|
|
67958
68102
|
type: 'object',
|
|
67959
68103
|
},
|
|
67960
68104
|
organize: {
|
|
67961
|
-
default: {},
|
|
67962
68105
|
description:
|
|
67963
68106
|
'Configuration for the organize feature.',
|
|
67964
68107
|
properties: {
|
|
@@ -75291,6 +75434,12 @@ const openapi: OpenAPISpec = {
|
|
|
75291
75434
|
items: { format: 'uuid', type: 'string' },
|
|
75292
75435
|
type: 'array',
|
|
75293
75436
|
},
|
|
75437
|
+
customer_key: {
|
|
75438
|
+
description:
|
|
75439
|
+
"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.",
|
|
75440
|
+
minLength: 1,
|
|
75441
|
+
type: 'string',
|
|
75442
|
+
},
|
|
75294
75443
|
email_address: {
|
|
75295
75444
|
description:
|
|
75296
75445
|
'Unique email address for the new user identity.',
|
|
@@ -77057,6 +77206,187 @@ const openapi: OpenAPISpec = {
|
|
|
77057
77206
|
format: 'uuid',
|
|
77058
77207
|
type: 'string',
|
|
77059
77208
|
},
|
|
77209
|
+
customer_portal_features: {
|
|
77210
|
+
description:
|
|
77211
|
+
'Features for customer portals that use this profile. Settings passed when creating a portal take precedence.',
|
|
77212
|
+
properties: {
|
|
77213
|
+
configure: {
|
|
77214
|
+
description: 'Configuration for the configure feature.',
|
|
77215
|
+
properties: {
|
|
77216
|
+
allow_access_automation_rule_customization: {
|
|
77217
|
+
default: false,
|
|
77218
|
+
description:
|
|
77219
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
77220
|
+
type: 'boolean',
|
|
77221
|
+
},
|
|
77222
|
+
allow_climate_automation_rule_customization: {
|
|
77223
|
+
default: false,
|
|
77224
|
+
description:
|
|
77225
|
+
'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
77226
|
+
type: 'boolean',
|
|
77227
|
+
},
|
|
77228
|
+
allow_instant_key_customization: {
|
|
77229
|
+
default: false,
|
|
77230
|
+
description:
|
|
77231
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
77232
|
+
type: 'boolean',
|
|
77233
|
+
},
|
|
77234
|
+
allow_notification_customization: {
|
|
77235
|
+
default: false,
|
|
77236
|
+
description:
|
|
77237
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
77238
|
+
type: 'boolean',
|
|
77239
|
+
},
|
|
77240
|
+
allow_sound_automation_rule_customization: {
|
|
77241
|
+
default: false,
|
|
77242
|
+
description:
|
|
77243
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
77244
|
+
type: 'boolean',
|
|
77245
|
+
},
|
|
77246
|
+
exclude: {
|
|
77247
|
+
default: false,
|
|
77248
|
+
description:
|
|
77249
|
+
'Whether to exclude this feature from the portal.',
|
|
77250
|
+
type: 'boolean',
|
|
77251
|
+
},
|
|
77252
|
+
},
|
|
77253
|
+
type: 'object',
|
|
77254
|
+
},
|
|
77255
|
+
connect: {
|
|
77256
|
+
description:
|
|
77257
|
+
'Configuration for the connect accounts feature.',
|
|
77258
|
+
properties: {
|
|
77259
|
+
accepted_providers: {
|
|
77260
|
+
description:
|
|
77261
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
77262
|
+
items: { type: 'string' },
|
|
77263
|
+
type: 'array',
|
|
77264
|
+
},
|
|
77265
|
+
exclude: {
|
|
77266
|
+
default: false,
|
|
77267
|
+
description:
|
|
77268
|
+
'Whether to exclude this feature from the portal.',
|
|
77269
|
+
type: 'boolean',
|
|
77270
|
+
},
|
|
77271
|
+
excluded_providers: {
|
|
77272
|
+
description:
|
|
77273
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
77274
|
+
items: { type: 'string' },
|
|
77275
|
+
type: 'array',
|
|
77276
|
+
},
|
|
77277
|
+
},
|
|
77278
|
+
type: 'object',
|
|
77279
|
+
},
|
|
77280
|
+
manage: {
|
|
77281
|
+
description: 'Configuration for the manage feature.',
|
|
77282
|
+
properties: {
|
|
77283
|
+
device_management_confirmation: {
|
|
77284
|
+
description:
|
|
77285
|
+
'\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 ',
|
|
77286
|
+
properties: {
|
|
77287
|
+
body: {
|
|
77288
|
+
description:
|
|
77289
|
+
'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.',
|
|
77290
|
+
type: 'string',
|
|
77291
|
+
},
|
|
77292
|
+
cancel_button_label: {
|
|
77293
|
+
description:
|
|
77294
|
+
'Custom label for the cancel button.',
|
|
77295
|
+
type: 'string',
|
|
77296
|
+
},
|
|
77297
|
+
confirm_button_label: {
|
|
77298
|
+
description:
|
|
77299
|
+
'Custom label for the confirm button.',
|
|
77300
|
+
type: 'string',
|
|
77301
|
+
},
|
|
77302
|
+
title: {
|
|
77303
|
+
description:
|
|
77304
|
+
'Custom title for the confirmation modal.',
|
|
77305
|
+
type: 'string',
|
|
77306
|
+
},
|
|
77307
|
+
},
|
|
77308
|
+
type: 'object',
|
|
77309
|
+
},
|
|
77310
|
+
events: {
|
|
77311
|
+
description:
|
|
77312
|
+
'Configuration for event type filtering in the manage feature.',
|
|
77313
|
+
properties: {
|
|
77314
|
+
allowed_events: {
|
|
77315
|
+
description:
|
|
77316
|
+
'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.',
|
|
77317
|
+
items: { type: 'string' },
|
|
77318
|
+
type: 'array',
|
|
77319
|
+
},
|
|
77320
|
+
default_events: {
|
|
77321
|
+
description:
|
|
77322
|
+
'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
77323
|
+
items: { type: 'string' },
|
|
77324
|
+
type: 'array',
|
|
77325
|
+
},
|
|
77326
|
+
},
|
|
77327
|
+
type: 'object',
|
|
77328
|
+
},
|
|
77329
|
+
exclude: {
|
|
77330
|
+
default: false,
|
|
77331
|
+
description:
|
|
77332
|
+
'Whether to exclude this feature from the portal.',
|
|
77333
|
+
type: 'boolean',
|
|
77334
|
+
},
|
|
77335
|
+
exclude_device_management: {
|
|
77336
|
+
default: false,
|
|
77337
|
+
description:
|
|
77338
|
+
'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
77339
|
+
type: 'boolean',
|
|
77340
|
+
},
|
|
77341
|
+
exclude_reservation_management: {
|
|
77342
|
+
default: false,
|
|
77343
|
+
description:
|
|
77344
|
+
'Indicates whether the customer can manage reservations for their properties.',
|
|
77345
|
+
type: 'boolean',
|
|
77346
|
+
},
|
|
77347
|
+
exclude_reservation_technical_details: {
|
|
77348
|
+
default: false,
|
|
77349
|
+
description:
|
|
77350
|
+
'Indicates whether to exclude technical details from reservation views.',
|
|
77351
|
+
type: 'boolean',
|
|
77352
|
+
},
|
|
77353
|
+
exclude_staff_management: {
|
|
77354
|
+
default: false,
|
|
77355
|
+
description:
|
|
77356
|
+
'Indicates whether the customer can manage staff for their properties.',
|
|
77357
|
+
type: 'boolean',
|
|
77358
|
+
},
|
|
77359
|
+
},
|
|
77360
|
+
type: 'object',
|
|
77361
|
+
},
|
|
77362
|
+
manage_devices: {
|
|
77363
|
+
description:
|
|
77364
|
+
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
77365
|
+
properties: {
|
|
77366
|
+
exclude: {
|
|
77367
|
+
default: false,
|
|
77368
|
+
description:
|
|
77369
|
+
'Whether to exclude this feature from the portal.',
|
|
77370
|
+
type: 'boolean',
|
|
77371
|
+
},
|
|
77372
|
+
},
|
|
77373
|
+
type: 'object',
|
|
77374
|
+
},
|
|
77375
|
+
organize: {
|
|
77376
|
+
description: 'Configuration for the organize feature.',
|
|
77377
|
+
properties: {
|
|
77378
|
+
exclude: {
|
|
77379
|
+
default: false,
|
|
77380
|
+
description:
|
|
77381
|
+
'Whether to exclude this feature from the portal.',
|
|
77382
|
+
type: 'boolean',
|
|
77383
|
+
},
|
|
77384
|
+
},
|
|
77385
|
+
type: 'object',
|
|
77386
|
+
},
|
|
77387
|
+
},
|
|
77388
|
+
type: 'object',
|
|
77389
|
+
},
|
|
77060
77390
|
customer_portal_theme: {
|
|
77061
77391
|
properties: {
|
|
77062
77392
|
font_family: { type: 'string' },
|
|
@@ -77550,6 +77880,188 @@ const openapi: OpenAPISpec = {
|
|
|
77550
77880
|
'application/json': {
|
|
77551
77881
|
schema: {
|
|
77552
77882
|
properties: {
|
|
77883
|
+
customer_portal_features: {
|
|
77884
|
+
description:
|
|
77885
|
+
"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.",
|
|
77886
|
+
nullable: true,
|
|
77887
|
+
properties: {
|
|
77888
|
+
configure: {
|
|
77889
|
+
description: 'Configuration for the configure feature.',
|
|
77890
|
+
properties: {
|
|
77891
|
+
allow_access_automation_rule_customization: {
|
|
77892
|
+
default: false,
|
|
77893
|
+
description:
|
|
77894
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
77895
|
+
type: 'boolean',
|
|
77896
|
+
},
|
|
77897
|
+
allow_climate_automation_rule_customization: {
|
|
77898
|
+
default: false,
|
|
77899
|
+
description:
|
|
77900
|
+
'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
77901
|
+
type: 'boolean',
|
|
77902
|
+
},
|
|
77903
|
+
allow_instant_key_customization: {
|
|
77904
|
+
default: false,
|
|
77905
|
+
description:
|
|
77906
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
77907
|
+
type: 'boolean',
|
|
77908
|
+
},
|
|
77909
|
+
allow_notification_customization: {
|
|
77910
|
+
default: false,
|
|
77911
|
+
description:
|
|
77912
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
77913
|
+
type: 'boolean',
|
|
77914
|
+
},
|
|
77915
|
+
allow_sound_automation_rule_customization: {
|
|
77916
|
+
default: false,
|
|
77917
|
+
description:
|
|
77918
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
77919
|
+
type: 'boolean',
|
|
77920
|
+
},
|
|
77921
|
+
exclude: {
|
|
77922
|
+
default: false,
|
|
77923
|
+
description:
|
|
77924
|
+
'Whether to exclude this feature from the portal.',
|
|
77925
|
+
type: 'boolean',
|
|
77926
|
+
},
|
|
77927
|
+
},
|
|
77928
|
+
type: 'object',
|
|
77929
|
+
},
|
|
77930
|
+
connect: {
|
|
77931
|
+
description:
|
|
77932
|
+
'Configuration for the connect accounts feature.',
|
|
77933
|
+
properties: {
|
|
77934
|
+
accepted_providers: {
|
|
77935
|
+
description:
|
|
77936
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
77937
|
+
items: { type: 'string' },
|
|
77938
|
+
type: 'array',
|
|
77939
|
+
},
|
|
77940
|
+
exclude: {
|
|
77941
|
+
default: false,
|
|
77942
|
+
description:
|
|
77943
|
+
'Whether to exclude this feature from the portal.',
|
|
77944
|
+
type: 'boolean',
|
|
77945
|
+
},
|
|
77946
|
+
excluded_providers: {
|
|
77947
|
+
description:
|
|
77948
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
77949
|
+
items: { type: 'string' },
|
|
77950
|
+
type: 'array',
|
|
77951
|
+
},
|
|
77952
|
+
},
|
|
77953
|
+
type: 'object',
|
|
77954
|
+
},
|
|
77955
|
+
manage: {
|
|
77956
|
+
description: 'Configuration for the manage feature.',
|
|
77957
|
+
properties: {
|
|
77958
|
+
device_management_confirmation: {
|
|
77959
|
+
description:
|
|
77960
|
+
'\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 ',
|
|
77961
|
+
properties: {
|
|
77962
|
+
body: {
|
|
77963
|
+
description:
|
|
77964
|
+
'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.',
|
|
77965
|
+
type: 'string',
|
|
77966
|
+
},
|
|
77967
|
+
cancel_button_label: {
|
|
77968
|
+
description:
|
|
77969
|
+
'Custom label for the cancel button.',
|
|
77970
|
+
type: 'string',
|
|
77971
|
+
},
|
|
77972
|
+
confirm_button_label: {
|
|
77973
|
+
description:
|
|
77974
|
+
'Custom label for the confirm button.',
|
|
77975
|
+
type: 'string',
|
|
77976
|
+
},
|
|
77977
|
+
title: {
|
|
77978
|
+
description:
|
|
77979
|
+
'Custom title for the confirmation modal.',
|
|
77980
|
+
type: 'string',
|
|
77981
|
+
},
|
|
77982
|
+
},
|
|
77983
|
+
type: 'object',
|
|
77984
|
+
},
|
|
77985
|
+
events: {
|
|
77986
|
+
description:
|
|
77987
|
+
'Configuration for event type filtering in the manage feature.',
|
|
77988
|
+
properties: {
|
|
77989
|
+
allowed_events: {
|
|
77990
|
+
description:
|
|
77991
|
+
'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.',
|
|
77992
|
+
items: { type: 'string' },
|
|
77993
|
+
type: 'array',
|
|
77994
|
+
},
|
|
77995
|
+
default_events: {
|
|
77996
|
+
description:
|
|
77997
|
+
'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
77998
|
+
items: { type: 'string' },
|
|
77999
|
+
type: 'array',
|
|
78000
|
+
},
|
|
78001
|
+
},
|
|
78002
|
+
type: 'object',
|
|
78003
|
+
},
|
|
78004
|
+
exclude: {
|
|
78005
|
+
default: false,
|
|
78006
|
+
description:
|
|
78007
|
+
'Whether to exclude this feature from the portal.',
|
|
78008
|
+
type: 'boolean',
|
|
78009
|
+
},
|
|
78010
|
+
exclude_device_management: {
|
|
78011
|
+
default: false,
|
|
78012
|
+
description:
|
|
78013
|
+
'Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.',
|
|
78014
|
+
type: 'boolean',
|
|
78015
|
+
},
|
|
78016
|
+
exclude_reservation_management: {
|
|
78017
|
+
default: false,
|
|
78018
|
+
description:
|
|
78019
|
+
'Indicates whether the customer can manage reservations for their properties.',
|
|
78020
|
+
type: 'boolean',
|
|
78021
|
+
},
|
|
78022
|
+
exclude_reservation_technical_details: {
|
|
78023
|
+
default: false,
|
|
78024
|
+
description:
|
|
78025
|
+
'Indicates whether to exclude technical details from reservation views.',
|
|
78026
|
+
type: 'boolean',
|
|
78027
|
+
},
|
|
78028
|
+
exclude_staff_management: {
|
|
78029
|
+
default: false,
|
|
78030
|
+
description:
|
|
78031
|
+
'Indicates whether the customer can manage staff for their properties.',
|
|
78032
|
+
type: 'boolean',
|
|
78033
|
+
},
|
|
78034
|
+
},
|
|
78035
|
+
type: 'object',
|
|
78036
|
+
},
|
|
78037
|
+
manage_devices: {
|
|
78038
|
+
description:
|
|
78039
|
+
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
78040
|
+
properties: {
|
|
78041
|
+
exclude: {
|
|
78042
|
+
default: false,
|
|
78043
|
+
description:
|
|
78044
|
+
'Whether to exclude this feature from the portal.',
|
|
78045
|
+
type: 'boolean',
|
|
78046
|
+
},
|
|
78047
|
+
},
|
|
78048
|
+
type: 'object',
|
|
78049
|
+
},
|
|
78050
|
+
organize: {
|
|
78051
|
+
description: 'Configuration for the organize feature.',
|
|
78052
|
+
properties: {
|
|
78053
|
+
exclude: {
|
|
78054
|
+
default: false,
|
|
78055
|
+
description:
|
|
78056
|
+
'Whether to exclude this feature from the portal.',
|
|
78057
|
+
type: 'boolean',
|
|
78058
|
+
},
|
|
78059
|
+
},
|
|
78060
|
+
type: 'object',
|
|
78061
|
+
},
|
|
78062
|
+
},
|
|
78063
|
+
type: 'object',
|
|
78064
|
+
},
|
|
77553
78065
|
customer_portal_theme: {
|
|
77554
78066
|
nullable: true,
|
|
77555
78067
|
properties: {
|