@seamapi/types 1.769.0 → 1.771.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +777 -35
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1530 -269
- package/dist/index.cjs +777 -35
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +10 -10
- package/lib/seam/connect/models/access-grants/access-method.d.ts +6 -6
- package/lib/seam/connect/models/access-grants/access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
- package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -6
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -4
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +15 -0
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +15 -0
- package/lib/seam/connect/models/action-attempts/encode-credential.js +11 -0
- package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +38 -17
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -16
- package/lib/seam/connect/openapi.d.ts +952 -0
- package/lib/seam/connect/openapi.js +758 -27
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +336 -63
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -2
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +4 -4
- package/src/lib/seam/connect/models/action-attempts/encode-credential.ts +18 -0
- package/src/lib/seam/connect/openapi.ts +825 -27
- package/src/lib/seam/connect/route-types.ts +407 -63
|
@@ -2099,8 +2099,8 @@ export default {
|
|
|
2099
2099
|
},
|
|
2100
2100
|
mode: {
|
|
2101
2101
|
description:
|
|
2102
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
2103
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
2102
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
2103
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
2104
2104
|
type: 'string',
|
|
2105
2105
|
},
|
|
2106
2106
|
},
|
|
@@ -2432,8 +2432,8 @@ export default {
|
|
|
2432
2432
|
},
|
|
2433
2433
|
mode: {
|
|
2434
2434
|
description:
|
|
2435
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
2436
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
2435
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
2436
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
2437
2437
|
type: 'string',
|
|
2438
2438
|
},
|
|
2439
2439
|
pending_mutations: {
|
|
@@ -3906,7 +3906,7 @@ export default {
|
|
|
3906
3906
|
},
|
|
3907
3907
|
can_unlock_with_cloud_key: {
|
|
3908
3908
|
description:
|
|
3909
|
-
'Indicates whether the ACS entrance can be
|
|
3909
|
+
'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
|
|
3910
3910
|
type: 'boolean',
|
|
3911
3911
|
},
|
|
3912
3912
|
can_unlock_with_code: {
|
|
@@ -8098,6 +8098,25 @@ export default {
|
|
|
8098
8098
|
required: ['type', 'message'],
|
|
8099
8099
|
type: 'object',
|
|
8100
8100
|
},
|
|
8101
|
+
{
|
|
8102
|
+
description:
|
|
8103
|
+
'Error to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
|
|
8104
|
+
properties: {
|
|
8105
|
+
message: {
|
|
8106
|
+
description:
|
|
8107
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
8108
|
+
type: 'string',
|
|
8109
|
+
},
|
|
8110
|
+
type: {
|
|
8111
|
+
description:
|
|
8112
|
+
'Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
|
|
8113
|
+
enum: ['encoding_interrupted'],
|
|
8114
|
+
type: 'string',
|
|
8115
|
+
},
|
|
8116
|
+
},
|
|
8117
|
+
required: ['type', 'message'],
|
|
8118
|
+
type: 'object',
|
|
8119
|
+
},
|
|
8101
8120
|
],
|
|
8102
8121
|
},
|
|
8103
8122
|
result: {
|
|
@@ -24367,7 +24386,7 @@ export default {
|
|
|
24367
24386
|
},
|
|
24368
24387
|
can_unlock_with_cloud_key: {
|
|
24369
24388
|
description:
|
|
24370
|
-
'Indicates whether the ACS entrance can be
|
|
24389
|
+
'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
|
|
24371
24390
|
type: 'boolean',
|
|
24372
24391
|
},
|
|
24373
24392
|
can_unlock_with_code: {
|
|
@@ -34219,8 +34238,8 @@ export default {
|
|
|
34219
34238
|
},
|
|
34220
34239
|
mode: {
|
|
34221
34240
|
description:
|
|
34222
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
34223
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
34241
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
34242
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
34224
34243
|
type: 'string',
|
|
34225
34244
|
},
|
|
34226
34245
|
},
|
|
@@ -35095,8 +35114,8 @@ export default {
|
|
|
35095
35114
|
},
|
|
35096
35115
|
mode: {
|
|
35097
35116
|
description:
|
|
35098
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
35099
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
35117
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
35118
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
35100
35119
|
type: 'string',
|
|
35101
35120
|
},
|
|
35102
35121
|
},
|
|
@@ -35453,8 +35472,13 @@ export default {
|
|
|
35453
35472
|
},
|
|
35454
35473
|
mode: {
|
|
35455
35474
|
description:
|
|
35456
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
35457
|
-
enum: [
|
|
35475
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
35476
|
+
enum: [
|
|
35477
|
+
'code',
|
|
35478
|
+
'card',
|
|
35479
|
+
'mobile_key',
|
|
35480
|
+
'cloud_key',
|
|
35481
|
+
],
|
|
35458
35482
|
type: 'string',
|
|
35459
35483
|
},
|
|
35460
35484
|
},
|
|
@@ -36074,8 +36098,13 @@ export default {
|
|
|
36074
36098
|
},
|
|
36075
36099
|
mode: {
|
|
36076
36100
|
description:
|
|
36077
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
36078
|
-
enum: [
|
|
36101
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
36102
|
+
enum: [
|
|
36103
|
+
'code',
|
|
36104
|
+
'card',
|
|
36105
|
+
'mobile_key',
|
|
36106
|
+
'cloud_key',
|
|
36107
|
+
],
|
|
36079
36108
|
type: 'string',
|
|
36080
36109
|
},
|
|
36081
36110
|
},
|
|
@@ -36743,8 +36772,13 @@ export default {
|
|
|
36743
36772
|
},
|
|
36744
36773
|
mode: {
|
|
36745
36774
|
description:
|
|
36746
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
36747
|
-
enum: [
|
|
36775
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
36776
|
+
enum: [
|
|
36777
|
+
'code',
|
|
36778
|
+
'card',
|
|
36779
|
+
'mobile_key',
|
|
36780
|
+
'cloud_key',
|
|
36781
|
+
],
|
|
36748
36782
|
type: 'string',
|
|
36749
36783
|
},
|
|
36750
36784
|
},
|
|
@@ -37400,8 +37434,13 @@ export default {
|
|
|
37400
37434
|
},
|
|
37401
37435
|
mode: {
|
|
37402
37436
|
description:
|
|
37403
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
37404
|
-
enum: [
|
|
37437
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
37438
|
+
enum: [
|
|
37439
|
+
'code',
|
|
37440
|
+
'card',
|
|
37441
|
+
'mobile_key',
|
|
37442
|
+
'cloud_key',
|
|
37443
|
+
],
|
|
37405
37444
|
type: 'string',
|
|
37406
37445
|
},
|
|
37407
37446
|
},
|
|
@@ -38799,8 +38838,8 @@ export default {
|
|
|
38799
38838
|
},
|
|
38800
38839
|
mode: {
|
|
38801
38840
|
description:
|
|
38802
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
38803
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
38841
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
38842
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
38804
38843
|
type: 'string',
|
|
38805
38844
|
},
|
|
38806
38845
|
pending_mutations: {
|
|
@@ -39244,8 +39283,8 @@ export default {
|
|
|
39244
39283
|
},
|
|
39245
39284
|
mode: {
|
|
39246
39285
|
description:
|
|
39247
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
39248
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
39286
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
39287
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
39249
39288
|
type: 'string',
|
|
39250
39289
|
},
|
|
39251
39290
|
pending_mutations: {
|
|
@@ -39721,8 +39760,8 @@ export default {
|
|
|
39721
39760
|
},
|
|
39722
39761
|
mode: {
|
|
39723
39762
|
description:
|
|
39724
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
39725
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
39763
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
39764
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
39726
39765
|
type: 'string',
|
|
39727
39766
|
},
|
|
39728
39767
|
pending_mutations: {
|
|
@@ -40190,8 +40229,8 @@ export default {
|
|
|
40190
40229
|
},
|
|
40191
40230
|
mode: {
|
|
40192
40231
|
description:
|
|
40193
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
40194
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
40232
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
40233
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
40195
40234
|
type: 'string',
|
|
40196
40235
|
},
|
|
40197
40236
|
pending_mutations: {
|
|
@@ -43742,7 +43781,10 @@ export default {
|
|
|
43742
43781
|
error_code: {
|
|
43743
43782
|
default: 'no_credential_on_encoder',
|
|
43744
43783
|
description: 'Code of the error to simulate.',
|
|
43745
|
-
enum: [
|
|
43784
|
+
enum: [
|
|
43785
|
+
'no_credential_on_encoder',
|
|
43786
|
+
'encoding_interrupted',
|
|
43787
|
+
],
|
|
43746
43788
|
type: 'string',
|
|
43747
43789
|
},
|
|
43748
43790
|
},
|
|
@@ -66974,6 +67016,762 @@ export default {
|
|
|
66974
67016
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
66975
67017
|
},
|
|
66976
67018
|
},
|
|
67019
|
+
'/seam/customer/v1/portals/update': {
|
|
67020
|
+
patch: {
|
|
67021
|
+
description: 'Updates the configuration for a customer portal.',
|
|
67022
|
+
operationId: 'seamCustomerV1PortalsUpdatePatch',
|
|
67023
|
+
requestBody: {
|
|
67024
|
+
content: {
|
|
67025
|
+
'application/json': {
|
|
67026
|
+
schema: {
|
|
67027
|
+
properties: {
|
|
67028
|
+
customer_portal_id: {
|
|
67029
|
+
description: 'ID of the customer portal to update.',
|
|
67030
|
+
format: 'uuid',
|
|
67031
|
+
type: 'string',
|
|
67032
|
+
},
|
|
67033
|
+
portal_configuration: {
|
|
67034
|
+
description:
|
|
67035
|
+
'Partial portal configuration to merge with the existing configuration.',
|
|
67036
|
+
properties: {
|
|
67037
|
+
customer_resources_filters: {
|
|
67038
|
+
description:
|
|
67039
|
+
'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',
|
|
67040
|
+
items: {
|
|
67041
|
+
properties: {
|
|
67042
|
+
field: {
|
|
67043
|
+
description:
|
|
67044
|
+
'The custom_metadata field name to filter on.',
|
|
67045
|
+
pattern: '^[a-zA-Z_]\\w*$',
|
|
67046
|
+
type: 'string',
|
|
67047
|
+
},
|
|
67048
|
+
operation: {
|
|
67049
|
+
description:
|
|
67050
|
+
"The comparison operation. Currently only '=' is supported.",
|
|
67051
|
+
enum: ['='],
|
|
67052
|
+
type: 'string',
|
|
67053
|
+
},
|
|
67054
|
+
value: {
|
|
67055
|
+
description: 'The value to compare against.',
|
|
67056
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
67057
|
+
},
|
|
67058
|
+
},
|
|
67059
|
+
required: ['field', 'operation', 'value'],
|
|
67060
|
+
type: 'object',
|
|
67061
|
+
},
|
|
67062
|
+
type: 'array',
|
|
67063
|
+
},
|
|
67064
|
+
customization_profile_id: {
|
|
67065
|
+
description:
|
|
67066
|
+
'The ID of the customization profile to use for the portal.',
|
|
67067
|
+
format: 'uuid',
|
|
67068
|
+
type: 'string',
|
|
67069
|
+
},
|
|
67070
|
+
deep_link: {
|
|
67071
|
+
description:
|
|
67072
|
+
'Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.',
|
|
67073
|
+
properties: {
|
|
67074
|
+
resource_key: { type: 'string' },
|
|
67075
|
+
resource_type: {
|
|
67076
|
+
enum: ['reservation', 'space'],
|
|
67077
|
+
type: 'string',
|
|
67078
|
+
},
|
|
67079
|
+
},
|
|
67080
|
+
required: ['resource_type', 'resource_key'],
|
|
67081
|
+
type: 'object',
|
|
67082
|
+
'x-undocumented':
|
|
67083
|
+
'Internal endpoint for customer portals.',
|
|
67084
|
+
},
|
|
67085
|
+
exclude_locale_picker: {
|
|
67086
|
+
default: false,
|
|
67087
|
+
description:
|
|
67088
|
+
'Whether to exclude the option to select a locale within the portal UI.',
|
|
67089
|
+
type: 'boolean',
|
|
67090
|
+
},
|
|
67091
|
+
features: {
|
|
67092
|
+
default: {},
|
|
67093
|
+
properties: {
|
|
67094
|
+
configure: {
|
|
67095
|
+
default: {},
|
|
67096
|
+
description:
|
|
67097
|
+
'Configuration for the configure feature.',
|
|
67098
|
+
properties: {
|
|
67099
|
+
allow_access_automation_rule_customization: {
|
|
67100
|
+
default: false,
|
|
67101
|
+
description:
|
|
67102
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
67103
|
+
type: 'boolean',
|
|
67104
|
+
},
|
|
67105
|
+
allow_climate_automation_rule_customization: {
|
|
67106
|
+
default: false,
|
|
67107
|
+
description:
|
|
67108
|
+
'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
67109
|
+
type: 'boolean',
|
|
67110
|
+
},
|
|
67111
|
+
allow_instant_key_customization: {
|
|
67112
|
+
default: false,
|
|
67113
|
+
description:
|
|
67114
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
67115
|
+
type: 'boolean',
|
|
67116
|
+
},
|
|
67117
|
+
exclude: {
|
|
67118
|
+
default: false,
|
|
67119
|
+
description:
|
|
67120
|
+
'Whether to exclude this feature from the portal.',
|
|
67121
|
+
type: 'boolean',
|
|
67122
|
+
},
|
|
67123
|
+
},
|
|
67124
|
+
type: 'object',
|
|
67125
|
+
},
|
|
67126
|
+
connect: {
|
|
67127
|
+
default: {},
|
|
67128
|
+
description:
|
|
67129
|
+
'Configuration for the connect accounts feature.',
|
|
67130
|
+
properties: {
|
|
67131
|
+
accepted_providers: {
|
|
67132
|
+
description:
|
|
67133
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
67134
|
+
items: { type: 'string' },
|
|
67135
|
+
type: 'array',
|
|
67136
|
+
},
|
|
67137
|
+
exclude: {
|
|
67138
|
+
default: false,
|
|
67139
|
+
description:
|
|
67140
|
+
'Whether to exclude this feature from the portal.',
|
|
67141
|
+
type: 'boolean',
|
|
67142
|
+
},
|
|
67143
|
+
excluded_providers: {
|
|
67144
|
+
description:
|
|
67145
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
67146
|
+
items: { type: 'string' },
|
|
67147
|
+
type: 'array',
|
|
67148
|
+
},
|
|
67149
|
+
},
|
|
67150
|
+
type: 'object',
|
|
67151
|
+
},
|
|
67152
|
+
manage: {
|
|
67153
|
+
default: {},
|
|
67154
|
+
description:
|
|
67155
|
+
'Configuration for the manage feature.',
|
|
67156
|
+
properties: {
|
|
67157
|
+
events: {
|
|
67158
|
+
description:
|
|
67159
|
+
'Configuration for event type filtering in the manage feature.',
|
|
67160
|
+
properties: {
|
|
67161
|
+
allowed_events: {
|
|
67162
|
+
description:
|
|
67163
|
+
'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.',
|
|
67164
|
+
items: { type: 'string' },
|
|
67165
|
+
type: 'array',
|
|
67166
|
+
},
|
|
67167
|
+
default_events: {
|
|
67168
|
+
description:
|
|
67169
|
+
'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
67170
|
+
items: { type: 'string' },
|
|
67171
|
+
type: 'array',
|
|
67172
|
+
},
|
|
67173
|
+
},
|
|
67174
|
+
type: 'object',
|
|
67175
|
+
},
|
|
67176
|
+
exclude: {
|
|
67177
|
+
default: false,
|
|
67178
|
+
description:
|
|
67179
|
+
'Whether to exclude this feature from the portal.',
|
|
67180
|
+
type: 'boolean',
|
|
67181
|
+
},
|
|
67182
|
+
exclude_reservation_management: {
|
|
67183
|
+
default: false,
|
|
67184
|
+
description:
|
|
67185
|
+
'Indicates whether the customer can manage reservations for their properties.',
|
|
67186
|
+
type: 'boolean',
|
|
67187
|
+
},
|
|
67188
|
+
exclude_reservation_technical_details: {
|
|
67189
|
+
default: false,
|
|
67190
|
+
description:
|
|
67191
|
+
'Indicates whether to exclude technical details from reservation views.',
|
|
67192
|
+
type: 'boolean',
|
|
67193
|
+
},
|
|
67194
|
+
exclude_staff_management: {
|
|
67195
|
+
default: false,
|
|
67196
|
+
description:
|
|
67197
|
+
'Indicates whether the customer can manage staff for their properties.',
|
|
67198
|
+
type: 'boolean',
|
|
67199
|
+
},
|
|
67200
|
+
},
|
|
67201
|
+
type: 'object',
|
|
67202
|
+
},
|
|
67203
|
+
manage_devices: {
|
|
67204
|
+
default: {},
|
|
67205
|
+
description:
|
|
67206
|
+
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
67207
|
+
properties: {
|
|
67208
|
+
exclude: {
|
|
67209
|
+
default: false,
|
|
67210
|
+
description:
|
|
67211
|
+
'Whether to exclude this feature from the portal.',
|
|
67212
|
+
type: 'boolean',
|
|
67213
|
+
},
|
|
67214
|
+
},
|
|
67215
|
+
type: 'object',
|
|
67216
|
+
},
|
|
67217
|
+
organize: {
|
|
67218
|
+
default: {},
|
|
67219
|
+
description:
|
|
67220
|
+
'Configuration for the organize feature.',
|
|
67221
|
+
properties: {
|
|
67222
|
+
exclude: {
|
|
67223
|
+
default: false,
|
|
67224
|
+
description:
|
|
67225
|
+
'Whether to exclude this feature from the portal.',
|
|
67226
|
+
type: 'boolean',
|
|
67227
|
+
},
|
|
67228
|
+
},
|
|
67229
|
+
type: 'object',
|
|
67230
|
+
},
|
|
67231
|
+
},
|
|
67232
|
+
type: 'object',
|
|
67233
|
+
},
|
|
67234
|
+
is_embedded: {
|
|
67235
|
+
default: false,
|
|
67236
|
+
description:
|
|
67237
|
+
'Whether the portal is embedded in another application.',
|
|
67238
|
+
type: 'boolean',
|
|
67239
|
+
},
|
|
67240
|
+
landing_page: {
|
|
67241
|
+
description:
|
|
67242
|
+
'Configuration for the landing page when the portal loads.',
|
|
67243
|
+
properties: {
|
|
67244
|
+
manage: {
|
|
67245
|
+
oneOf: [
|
|
67246
|
+
{
|
|
67247
|
+
oneOf: [
|
|
67248
|
+
{
|
|
67249
|
+
properties: {
|
|
67250
|
+
space_key: { type: 'string' },
|
|
67251
|
+
},
|
|
67252
|
+
required: ['space_key'],
|
|
67253
|
+
type: 'object',
|
|
67254
|
+
},
|
|
67255
|
+
{
|
|
67256
|
+
properties: {
|
|
67257
|
+
property_key: { type: 'string' },
|
|
67258
|
+
},
|
|
67259
|
+
required: ['property_key'],
|
|
67260
|
+
type: 'object',
|
|
67261
|
+
},
|
|
67262
|
+
{
|
|
67263
|
+
properties: {
|
|
67264
|
+
room_key: { type: 'string' },
|
|
67265
|
+
},
|
|
67266
|
+
required: ['room_key'],
|
|
67267
|
+
type: 'object',
|
|
67268
|
+
},
|
|
67269
|
+
{
|
|
67270
|
+
properties: {
|
|
67271
|
+
common_area_key: { type: 'string' },
|
|
67272
|
+
},
|
|
67273
|
+
required: ['common_area_key'],
|
|
67274
|
+
type: 'object',
|
|
67275
|
+
},
|
|
67276
|
+
{
|
|
67277
|
+
properties: {
|
|
67278
|
+
unit_key: { type: 'string' },
|
|
67279
|
+
},
|
|
67280
|
+
required: ['unit_key'],
|
|
67281
|
+
type: 'object',
|
|
67282
|
+
},
|
|
67283
|
+
{
|
|
67284
|
+
properties: {
|
|
67285
|
+
facility_key: { type: 'string' },
|
|
67286
|
+
},
|
|
67287
|
+
required: ['facility_key'],
|
|
67288
|
+
type: 'object',
|
|
67289
|
+
},
|
|
67290
|
+
{
|
|
67291
|
+
properties: {
|
|
67292
|
+
building_key: { type: 'string' },
|
|
67293
|
+
},
|
|
67294
|
+
required: ['building_key'],
|
|
67295
|
+
type: 'object',
|
|
67296
|
+
},
|
|
67297
|
+
{
|
|
67298
|
+
properties: {
|
|
67299
|
+
listing_key: { type: 'string' },
|
|
67300
|
+
},
|
|
67301
|
+
required: ['listing_key'],
|
|
67302
|
+
type: 'object',
|
|
67303
|
+
},
|
|
67304
|
+
{
|
|
67305
|
+
properties: {
|
|
67306
|
+
property_listing_key: { type: 'string' },
|
|
67307
|
+
},
|
|
67308
|
+
required: ['property_listing_key'],
|
|
67309
|
+
type: 'object',
|
|
67310
|
+
},
|
|
67311
|
+
{
|
|
67312
|
+
properties: {
|
|
67313
|
+
site_key: { type: 'string' },
|
|
67314
|
+
},
|
|
67315
|
+
required: ['site_key'],
|
|
67316
|
+
type: 'object',
|
|
67317
|
+
},
|
|
67318
|
+
],
|
|
67319
|
+
},
|
|
67320
|
+
{
|
|
67321
|
+
oneOf: [
|
|
67322
|
+
{
|
|
67323
|
+
properties: {
|
|
67324
|
+
reservation_key: { type: 'string' },
|
|
67325
|
+
},
|
|
67326
|
+
required: ['reservation_key'],
|
|
67327
|
+
type: 'object',
|
|
67328
|
+
},
|
|
67329
|
+
{
|
|
67330
|
+
properties: {
|
|
67331
|
+
booking_key: { type: 'string' },
|
|
67332
|
+
},
|
|
67333
|
+
required: ['booking_key'],
|
|
67334
|
+
type: 'object',
|
|
67335
|
+
},
|
|
67336
|
+
{
|
|
67337
|
+
properties: {
|
|
67338
|
+
access_grant_key: { type: 'string' },
|
|
67339
|
+
},
|
|
67340
|
+
required: ['access_grant_key'],
|
|
67341
|
+
type: 'object',
|
|
67342
|
+
},
|
|
67343
|
+
],
|
|
67344
|
+
},
|
|
67345
|
+
],
|
|
67346
|
+
},
|
|
67347
|
+
},
|
|
67348
|
+
type: 'object',
|
|
67349
|
+
},
|
|
67350
|
+
locale: {
|
|
67351
|
+
description: 'The locale to use for the portal.',
|
|
67352
|
+
enum: ['en-US', 'pt-PT', 'fr-FR', 'it-IT', 'es-ES'],
|
|
67353
|
+
type: 'string',
|
|
67354
|
+
},
|
|
67355
|
+
navigation_mode: {
|
|
67356
|
+
default: 'full',
|
|
67357
|
+
description:
|
|
67358
|
+
"Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.",
|
|
67359
|
+
enum: ['full', 'restricted'],
|
|
67360
|
+
type: 'string',
|
|
67361
|
+
},
|
|
67362
|
+
},
|
|
67363
|
+
type: 'object',
|
|
67364
|
+
},
|
|
67365
|
+
},
|
|
67366
|
+
required: ['customer_portal_id', 'portal_configuration'],
|
|
67367
|
+
type: 'object',
|
|
67368
|
+
},
|
|
67369
|
+
},
|
|
67370
|
+
},
|
|
67371
|
+
},
|
|
67372
|
+
responses: {
|
|
67373
|
+
200: {
|
|
67374
|
+
content: {
|
|
67375
|
+
'application/json': {
|
|
67376
|
+
schema: {
|
|
67377
|
+
properties: { ok: { type: 'boolean' } },
|
|
67378
|
+
required: ['ok'],
|
|
67379
|
+
type: 'object',
|
|
67380
|
+
},
|
|
67381
|
+
},
|
|
67382
|
+
},
|
|
67383
|
+
description: 'OK',
|
|
67384
|
+
},
|
|
67385
|
+
400: { description: 'Bad Request' },
|
|
67386
|
+
401: { description: 'Unauthorized' },
|
|
67387
|
+
},
|
|
67388
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
67389
|
+
summary: '/seam/customer/v1/portals/update',
|
|
67390
|
+
tags: [],
|
|
67391
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
67392
|
+
'x-fern-sdk-method-name': 'update',
|
|
67393
|
+
'x-response-key': null,
|
|
67394
|
+
'x-title': 'Update Customer Portal Configuration',
|
|
67395
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
67396
|
+
},
|
|
67397
|
+
post: {
|
|
67398
|
+
description: 'Updates the configuration for a customer portal.',
|
|
67399
|
+
operationId: 'seamCustomerV1PortalsUpdatePost',
|
|
67400
|
+
requestBody: {
|
|
67401
|
+
content: {
|
|
67402
|
+
'application/json': {
|
|
67403
|
+
schema: {
|
|
67404
|
+
properties: {
|
|
67405
|
+
customer_portal_id: {
|
|
67406
|
+
description: 'ID of the customer portal to update.',
|
|
67407
|
+
format: 'uuid',
|
|
67408
|
+
type: 'string',
|
|
67409
|
+
},
|
|
67410
|
+
portal_configuration: {
|
|
67411
|
+
description:
|
|
67412
|
+
'Partial portal configuration to merge with the existing configuration.',
|
|
67413
|
+
properties: {
|
|
67414
|
+
customer_resources_filters: {
|
|
67415
|
+
description:
|
|
67416
|
+
'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',
|
|
67417
|
+
items: {
|
|
67418
|
+
properties: {
|
|
67419
|
+
field: {
|
|
67420
|
+
description:
|
|
67421
|
+
'The custom_metadata field name to filter on.',
|
|
67422
|
+
pattern: '^[a-zA-Z_]\\w*$',
|
|
67423
|
+
type: 'string',
|
|
67424
|
+
},
|
|
67425
|
+
operation: {
|
|
67426
|
+
description:
|
|
67427
|
+
"The comparison operation. Currently only '=' is supported.",
|
|
67428
|
+
enum: ['='],
|
|
67429
|
+
type: 'string',
|
|
67430
|
+
},
|
|
67431
|
+
value: {
|
|
67432
|
+
description: 'The value to compare against.',
|
|
67433
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
67434
|
+
},
|
|
67435
|
+
},
|
|
67436
|
+
required: ['field', 'operation', 'value'],
|
|
67437
|
+
type: 'object',
|
|
67438
|
+
},
|
|
67439
|
+
type: 'array',
|
|
67440
|
+
},
|
|
67441
|
+
customization_profile_id: {
|
|
67442
|
+
description:
|
|
67443
|
+
'The ID of the customization profile to use for the portal.',
|
|
67444
|
+
format: 'uuid',
|
|
67445
|
+
type: 'string',
|
|
67446
|
+
},
|
|
67447
|
+
deep_link: {
|
|
67448
|
+
description:
|
|
67449
|
+
'Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.',
|
|
67450
|
+
properties: {
|
|
67451
|
+
resource_key: { type: 'string' },
|
|
67452
|
+
resource_type: {
|
|
67453
|
+
enum: ['reservation', 'space'],
|
|
67454
|
+
type: 'string',
|
|
67455
|
+
},
|
|
67456
|
+
},
|
|
67457
|
+
required: ['resource_type', 'resource_key'],
|
|
67458
|
+
type: 'object',
|
|
67459
|
+
'x-undocumented':
|
|
67460
|
+
'Internal endpoint for customer portals.',
|
|
67461
|
+
},
|
|
67462
|
+
exclude_locale_picker: {
|
|
67463
|
+
default: false,
|
|
67464
|
+
description:
|
|
67465
|
+
'Whether to exclude the option to select a locale within the portal UI.',
|
|
67466
|
+
type: 'boolean',
|
|
67467
|
+
},
|
|
67468
|
+
features: {
|
|
67469
|
+
default: {},
|
|
67470
|
+
properties: {
|
|
67471
|
+
configure: {
|
|
67472
|
+
default: {},
|
|
67473
|
+
description:
|
|
67474
|
+
'Configuration for the configure feature.',
|
|
67475
|
+
properties: {
|
|
67476
|
+
allow_access_automation_rule_customization: {
|
|
67477
|
+
default: false,
|
|
67478
|
+
description:
|
|
67479
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
67480
|
+
type: 'boolean',
|
|
67481
|
+
},
|
|
67482
|
+
allow_climate_automation_rule_customization: {
|
|
67483
|
+
default: false,
|
|
67484
|
+
description:
|
|
67485
|
+
'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
67486
|
+
type: 'boolean',
|
|
67487
|
+
},
|
|
67488
|
+
allow_instant_key_customization: {
|
|
67489
|
+
default: false,
|
|
67490
|
+
description:
|
|
67491
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
67492
|
+
type: 'boolean',
|
|
67493
|
+
},
|
|
67494
|
+
exclude: {
|
|
67495
|
+
default: false,
|
|
67496
|
+
description:
|
|
67497
|
+
'Whether to exclude this feature from the portal.',
|
|
67498
|
+
type: 'boolean',
|
|
67499
|
+
},
|
|
67500
|
+
},
|
|
67501
|
+
type: 'object',
|
|
67502
|
+
},
|
|
67503
|
+
connect: {
|
|
67504
|
+
default: {},
|
|
67505
|
+
description:
|
|
67506
|
+
'Configuration for the connect accounts feature.',
|
|
67507
|
+
properties: {
|
|
67508
|
+
accepted_providers: {
|
|
67509
|
+
description:
|
|
67510
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
67511
|
+
items: { type: 'string' },
|
|
67512
|
+
type: 'array',
|
|
67513
|
+
},
|
|
67514
|
+
exclude: {
|
|
67515
|
+
default: false,
|
|
67516
|
+
description:
|
|
67517
|
+
'Whether to exclude this feature from the portal.',
|
|
67518
|
+
type: 'boolean',
|
|
67519
|
+
},
|
|
67520
|
+
excluded_providers: {
|
|
67521
|
+
description:
|
|
67522
|
+
'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
|
|
67523
|
+
items: { type: 'string' },
|
|
67524
|
+
type: 'array',
|
|
67525
|
+
},
|
|
67526
|
+
},
|
|
67527
|
+
type: 'object',
|
|
67528
|
+
},
|
|
67529
|
+
manage: {
|
|
67530
|
+
default: {},
|
|
67531
|
+
description:
|
|
67532
|
+
'Configuration for the manage feature.',
|
|
67533
|
+
properties: {
|
|
67534
|
+
events: {
|
|
67535
|
+
description:
|
|
67536
|
+
'Configuration for event type filtering in the manage feature.',
|
|
67537
|
+
properties: {
|
|
67538
|
+
allowed_events: {
|
|
67539
|
+
description:
|
|
67540
|
+
'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.',
|
|
67541
|
+
items: { type: 'string' },
|
|
67542
|
+
type: 'array',
|
|
67543
|
+
},
|
|
67544
|
+
default_events: {
|
|
67545
|
+
description:
|
|
67546
|
+
'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
67547
|
+
items: { type: 'string' },
|
|
67548
|
+
type: 'array',
|
|
67549
|
+
},
|
|
67550
|
+
},
|
|
67551
|
+
type: 'object',
|
|
67552
|
+
},
|
|
67553
|
+
exclude: {
|
|
67554
|
+
default: false,
|
|
67555
|
+
description:
|
|
67556
|
+
'Whether to exclude this feature from the portal.',
|
|
67557
|
+
type: 'boolean',
|
|
67558
|
+
},
|
|
67559
|
+
exclude_reservation_management: {
|
|
67560
|
+
default: false,
|
|
67561
|
+
description:
|
|
67562
|
+
'Indicates whether the customer can manage reservations for their properties.',
|
|
67563
|
+
type: 'boolean',
|
|
67564
|
+
},
|
|
67565
|
+
exclude_reservation_technical_details: {
|
|
67566
|
+
default: false,
|
|
67567
|
+
description:
|
|
67568
|
+
'Indicates whether to exclude technical details from reservation views.',
|
|
67569
|
+
type: 'boolean',
|
|
67570
|
+
},
|
|
67571
|
+
exclude_staff_management: {
|
|
67572
|
+
default: false,
|
|
67573
|
+
description:
|
|
67574
|
+
'Indicates whether the customer can manage staff for their properties.',
|
|
67575
|
+
type: 'boolean',
|
|
67576
|
+
},
|
|
67577
|
+
},
|
|
67578
|
+
type: 'object',
|
|
67579
|
+
},
|
|
67580
|
+
manage_devices: {
|
|
67581
|
+
default: {},
|
|
67582
|
+
description:
|
|
67583
|
+
'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
67584
|
+
properties: {
|
|
67585
|
+
exclude: {
|
|
67586
|
+
default: false,
|
|
67587
|
+
description:
|
|
67588
|
+
'Whether to exclude this feature from the portal.',
|
|
67589
|
+
type: 'boolean',
|
|
67590
|
+
},
|
|
67591
|
+
},
|
|
67592
|
+
type: 'object',
|
|
67593
|
+
},
|
|
67594
|
+
organize: {
|
|
67595
|
+
default: {},
|
|
67596
|
+
description:
|
|
67597
|
+
'Configuration for the organize feature.',
|
|
67598
|
+
properties: {
|
|
67599
|
+
exclude: {
|
|
67600
|
+
default: false,
|
|
67601
|
+
description:
|
|
67602
|
+
'Whether to exclude this feature from the portal.',
|
|
67603
|
+
type: 'boolean',
|
|
67604
|
+
},
|
|
67605
|
+
},
|
|
67606
|
+
type: 'object',
|
|
67607
|
+
},
|
|
67608
|
+
},
|
|
67609
|
+
type: 'object',
|
|
67610
|
+
},
|
|
67611
|
+
is_embedded: {
|
|
67612
|
+
default: false,
|
|
67613
|
+
description:
|
|
67614
|
+
'Whether the portal is embedded in another application.',
|
|
67615
|
+
type: 'boolean',
|
|
67616
|
+
},
|
|
67617
|
+
landing_page: {
|
|
67618
|
+
description:
|
|
67619
|
+
'Configuration for the landing page when the portal loads.',
|
|
67620
|
+
properties: {
|
|
67621
|
+
manage: {
|
|
67622
|
+
oneOf: [
|
|
67623
|
+
{
|
|
67624
|
+
oneOf: [
|
|
67625
|
+
{
|
|
67626
|
+
properties: {
|
|
67627
|
+
space_key: { type: 'string' },
|
|
67628
|
+
},
|
|
67629
|
+
required: ['space_key'],
|
|
67630
|
+
type: 'object',
|
|
67631
|
+
},
|
|
67632
|
+
{
|
|
67633
|
+
properties: {
|
|
67634
|
+
property_key: { type: 'string' },
|
|
67635
|
+
},
|
|
67636
|
+
required: ['property_key'],
|
|
67637
|
+
type: 'object',
|
|
67638
|
+
},
|
|
67639
|
+
{
|
|
67640
|
+
properties: {
|
|
67641
|
+
room_key: { type: 'string' },
|
|
67642
|
+
},
|
|
67643
|
+
required: ['room_key'],
|
|
67644
|
+
type: 'object',
|
|
67645
|
+
},
|
|
67646
|
+
{
|
|
67647
|
+
properties: {
|
|
67648
|
+
common_area_key: { type: 'string' },
|
|
67649
|
+
},
|
|
67650
|
+
required: ['common_area_key'],
|
|
67651
|
+
type: 'object',
|
|
67652
|
+
},
|
|
67653
|
+
{
|
|
67654
|
+
properties: {
|
|
67655
|
+
unit_key: { type: 'string' },
|
|
67656
|
+
},
|
|
67657
|
+
required: ['unit_key'],
|
|
67658
|
+
type: 'object',
|
|
67659
|
+
},
|
|
67660
|
+
{
|
|
67661
|
+
properties: {
|
|
67662
|
+
facility_key: { type: 'string' },
|
|
67663
|
+
},
|
|
67664
|
+
required: ['facility_key'],
|
|
67665
|
+
type: 'object',
|
|
67666
|
+
},
|
|
67667
|
+
{
|
|
67668
|
+
properties: {
|
|
67669
|
+
building_key: { type: 'string' },
|
|
67670
|
+
},
|
|
67671
|
+
required: ['building_key'],
|
|
67672
|
+
type: 'object',
|
|
67673
|
+
},
|
|
67674
|
+
{
|
|
67675
|
+
properties: {
|
|
67676
|
+
listing_key: { type: 'string' },
|
|
67677
|
+
},
|
|
67678
|
+
required: ['listing_key'],
|
|
67679
|
+
type: 'object',
|
|
67680
|
+
},
|
|
67681
|
+
{
|
|
67682
|
+
properties: {
|
|
67683
|
+
property_listing_key: { type: 'string' },
|
|
67684
|
+
},
|
|
67685
|
+
required: ['property_listing_key'],
|
|
67686
|
+
type: 'object',
|
|
67687
|
+
},
|
|
67688
|
+
{
|
|
67689
|
+
properties: {
|
|
67690
|
+
site_key: { type: 'string' },
|
|
67691
|
+
},
|
|
67692
|
+
required: ['site_key'],
|
|
67693
|
+
type: 'object',
|
|
67694
|
+
},
|
|
67695
|
+
],
|
|
67696
|
+
},
|
|
67697
|
+
{
|
|
67698
|
+
oneOf: [
|
|
67699
|
+
{
|
|
67700
|
+
properties: {
|
|
67701
|
+
reservation_key: { type: 'string' },
|
|
67702
|
+
},
|
|
67703
|
+
required: ['reservation_key'],
|
|
67704
|
+
type: 'object',
|
|
67705
|
+
},
|
|
67706
|
+
{
|
|
67707
|
+
properties: {
|
|
67708
|
+
booking_key: { type: 'string' },
|
|
67709
|
+
},
|
|
67710
|
+
required: ['booking_key'],
|
|
67711
|
+
type: 'object',
|
|
67712
|
+
},
|
|
67713
|
+
{
|
|
67714
|
+
properties: {
|
|
67715
|
+
access_grant_key: { type: 'string' },
|
|
67716
|
+
},
|
|
67717
|
+
required: ['access_grant_key'],
|
|
67718
|
+
type: 'object',
|
|
67719
|
+
},
|
|
67720
|
+
],
|
|
67721
|
+
},
|
|
67722
|
+
],
|
|
67723
|
+
},
|
|
67724
|
+
},
|
|
67725
|
+
type: 'object',
|
|
67726
|
+
},
|
|
67727
|
+
locale: {
|
|
67728
|
+
description: 'The locale to use for the portal.',
|
|
67729
|
+
enum: ['en-US', 'pt-PT', 'fr-FR', 'it-IT', 'es-ES'],
|
|
67730
|
+
type: 'string',
|
|
67731
|
+
},
|
|
67732
|
+
navigation_mode: {
|
|
67733
|
+
default: 'full',
|
|
67734
|
+
description:
|
|
67735
|
+
"Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.",
|
|
67736
|
+
enum: ['full', 'restricted'],
|
|
67737
|
+
type: 'string',
|
|
67738
|
+
},
|
|
67739
|
+
},
|
|
67740
|
+
type: 'object',
|
|
67741
|
+
},
|
|
67742
|
+
},
|
|
67743
|
+
required: ['customer_portal_id', 'portal_configuration'],
|
|
67744
|
+
type: 'object',
|
|
67745
|
+
},
|
|
67746
|
+
},
|
|
67747
|
+
},
|
|
67748
|
+
},
|
|
67749
|
+
responses: {
|
|
67750
|
+
200: {
|
|
67751
|
+
content: {
|
|
67752
|
+
'application/json': {
|
|
67753
|
+
schema: {
|
|
67754
|
+
properties: { ok: { type: 'boolean' } },
|
|
67755
|
+
required: ['ok'],
|
|
67756
|
+
type: 'object',
|
|
67757
|
+
},
|
|
67758
|
+
},
|
|
67759
|
+
},
|
|
67760
|
+
description: 'OK',
|
|
67761
|
+
},
|
|
67762
|
+
400: { description: 'Bad Request' },
|
|
67763
|
+
401: { description: 'Unauthorized' },
|
|
67764
|
+
},
|
|
67765
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
67766
|
+
summary: '/seam/customer/v1/portals/update',
|
|
67767
|
+
tags: [],
|
|
67768
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
67769
|
+
'x-fern-sdk-method-name': 'update',
|
|
67770
|
+
'x-response-key': null,
|
|
67771
|
+
'x-title': 'Update Customer Portal Configuration',
|
|
67772
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
67773
|
+
},
|
|
67774
|
+
},
|
|
66977
67775
|
'/seam/customer/v1/reservations/get': {
|
|
66978
67776
|
get: {
|
|
66979
67777
|
description:
|