@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
|
@@ -1823,8 +1823,8 @@ export default {
|
|
|
1823
1823
|
type: 'integer',
|
|
1824
1824
|
},
|
|
1825
1825
|
mode: {
|
|
1826
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
1827
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
1826
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
1827
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
1828
1828
|
type: 'string',
|
|
1829
1829
|
},
|
|
1830
1830
|
},
|
|
@@ -2115,8 +2115,8 @@ export default {
|
|
|
2115
2115
|
type: 'string',
|
|
2116
2116
|
},
|
|
2117
2117
|
mode: {
|
|
2118
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
2119
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
2118
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
2119
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
2120
2120
|
type: 'string',
|
|
2121
2121
|
},
|
|
2122
2122
|
pending_mutations: {
|
|
@@ -3431,7 +3431,7 @@ export default {
|
|
|
3431
3431
|
type: 'boolean',
|
|
3432
3432
|
},
|
|
3433
3433
|
can_unlock_with_cloud_key: {
|
|
3434
|
-
description: 'Indicates whether the ACS entrance can be
|
|
3434
|
+
description: 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
|
|
3435
3435
|
type: 'boolean',
|
|
3436
3436
|
},
|
|
3437
3437
|
can_unlock_with_code: {
|
|
@@ -7083,6 +7083,22 @@ export default {
|
|
|
7083
7083
|
required: ['type', 'message'],
|
|
7084
7084
|
type: 'object',
|
|
7085
7085
|
},
|
|
7086
|
+
{
|
|
7087
|
+
description: 'Error to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
|
|
7088
|
+
properties: {
|
|
7089
|
+
message: {
|
|
7090
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7091
|
+
type: 'string',
|
|
7092
|
+
},
|
|
7093
|
+
type: {
|
|
7094
|
+
description: 'Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.',
|
|
7095
|
+
enum: ['encoding_interrupted'],
|
|
7096
|
+
type: 'string',
|
|
7097
|
+
},
|
|
7098
|
+
},
|
|
7099
|
+
required: ['type', 'message'],
|
|
7100
|
+
type: 'object',
|
|
7101
|
+
},
|
|
7086
7102
|
],
|
|
7087
7103
|
},
|
|
7088
7104
|
result: {
|
|
@@ -21924,7 +21940,7 @@ export default {
|
|
|
21924
21940
|
type: 'boolean',
|
|
21925
21941
|
},
|
|
21926
21942
|
can_unlock_with_cloud_key: {
|
|
21927
|
-
description: 'Indicates whether the ACS entrance can be
|
|
21943
|
+
description: 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
|
|
21928
21944
|
type: 'boolean',
|
|
21929
21945
|
},
|
|
21930
21946
|
can_unlock_with_code: {
|
|
@@ -30730,8 +30746,8 @@ export default {
|
|
|
30730
30746
|
type: 'integer',
|
|
30731
30747
|
},
|
|
30732
30748
|
mode: {
|
|
30733
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
30734
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
30749
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
30750
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
30735
30751
|
type: 'string',
|
|
30736
30752
|
},
|
|
30737
30753
|
},
|
|
@@ -31577,8 +31593,8 @@ export default {
|
|
|
31577
31593
|
type: 'integer',
|
|
31578
31594
|
},
|
|
31579
31595
|
mode: {
|
|
31580
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31581
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
31596
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
31597
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
31582
31598
|
type: 'string',
|
|
31583
31599
|
},
|
|
31584
31600
|
},
|
|
@@ -31899,8 +31915,13 @@ export default {
|
|
|
31899
31915
|
type: 'integer',
|
|
31900
31916
|
},
|
|
31901
31917
|
mode: {
|
|
31902
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31903
|
-
enum: [
|
|
31918
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
31919
|
+
enum: [
|
|
31920
|
+
'code',
|
|
31921
|
+
'card',
|
|
31922
|
+
'mobile_key',
|
|
31923
|
+
'cloud_key',
|
|
31924
|
+
],
|
|
31904
31925
|
type: 'string',
|
|
31905
31926
|
},
|
|
31906
31927
|
},
|
|
@@ -32449,8 +32470,13 @@ export default {
|
|
|
32449
32470
|
type: 'integer',
|
|
32450
32471
|
},
|
|
32451
32472
|
mode: {
|
|
32452
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
32453
|
-
enum: [
|
|
32473
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
32474
|
+
enum: [
|
|
32475
|
+
'code',
|
|
32476
|
+
'card',
|
|
32477
|
+
'mobile_key',
|
|
32478
|
+
'cloud_key',
|
|
32479
|
+
],
|
|
32454
32480
|
type: 'string',
|
|
32455
32481
|
},
|
|
32456
32482
|
},
|
|
@@ -33041,8 +33067,13 @@ export default {
|
|
|
33041
33067
|
type: 'integer',
|
|
33042
33068
|
},
|
|
33043
33069
|
mode: {
|
|
33044
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
33045
|
-
enum: [
|
|
33070
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
33071
|
+
enum: [
|
|
33072
|
+
'code',
|
|
33073
|
+
'card',
|
|
33074
|
+
'mobile_key',
|
|
33075
|
+
'cloud_key',
|
|
33076
|
+
],
|
|
33046
33077
|
type: 'string',
|
|
33047
33078
|
},
|
|
33048
33079
|
},
|
|
@@ -33619,8 +33650,13 @@ export default {
|
|
|
33619
33650
|
type: 'integer',
|
|
33620
33651
|
},
|
|
33621
33652
|
mode: {
|
|
33622
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
33623
|
-
enum: [
|
|
33653
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
33654
|
+
enum: [
|
|
33655
|
+
'code',
|
|
33656
|
+
'card',
|
|
33657
|
+
'mobile_key',
|
|
33658
|
+
'cloud_key',
|
|
33659
|
+
],
|
|
33624
33660
|
type: 'string',
|
|
33625
33661
|
},
|
|
33626
33662
|
},
|
|
@@ -34944,8 +34980,8 @@ export default {
|
|
|
34944
34980
|
type: 'string',
|
|
34945
34981
|
},
|
|
34946
34982
|
mode: {
|
|
34947
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
34948
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
34983
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
34984
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
34949
34985
|
type: 'string',
|
|
34950
34986
|
},
|
|
34951
34987
|
pending_mutations: {
|
|
@@ -35340,8 +35376,8 @@ export default {
|
|
|
35340
35376
|
type: 'string',
|
|
35341
35377
|
},
|
|
35342
35378
|
mode: {
|
|
35343
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
35344
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
35379
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
35380
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
35345
35381
|
type: 'string',
|
|
35346
35382
|
},
|
|
35347
35383
|
pending_mutations: {
|
|
@@ -35764,8 +35800,8 @@ export default {
|
|
|
35764
35800
|
type: 'string',
|
|
35765
35801
|
},
|
|
35766
35802
|
mode: {
|
|
35767
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
35768
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
35803
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
35804
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
35769
35805
|
type: 'string',
|
|
35770
35806
|
},
|
|
35771
35807
|
pending_mutations: {
|
|
@@ -36179,8 +36215,8 @@ export default {
|
|
|
36179
36215
|
type: 'string',
|
|
36180
36216
|
},
|
|
36181
36217
|
mode: {
|
|
36182
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
36183
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
36218
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
36219
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
36184
36220
|
type: 'string',
|
|
36185
36221
|
},
|
|
36186
36222
|
pending_mutations: {
|
|
@@ -39526,7 +39562,10 @@ export default {
|
|
|
39526
39562
|
error_code: {
|
|
39527
39563
|
default: 'no_credential_on_encoder',
|
|
39528
39564
|
description: 'Code of the error to simulate.',
|
|
39529
|
-
enum: [
|
|
39565
|
+
enum: [
|
|
39566
|
+
'no_credential_on_encoder',
|
|
39567
|
+
'encoding_interrupted',
|
|
39568
|
+
],
|
|
39530
39569
|
type: 'string',
|
|
39531
39570
|
},
|
|
39532
39571
|
},
|
|
@@ -61654,6 +61693,698 @@ export default {
|
|
|
61654
61693
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
61655
61694
|
},
|
|
61656
61695
|
},
|
|
61696
|
+
'/seam/customer/v1/portals/update': {
|
|
61697
|
+
patch: {
|
|
61698
|
+
description: 'Updates the configuration for a customer portal.',
|
|
61699
|
+
operationId: 'seamCustomerV1PortalsUpdatePatch',
|
|
61700
|
+
requestBody: {
|
|
61701
|
+
content: {
|
|
61702
|
+
'application/json': {
|
|
61703
|
+
schema: {
|
|
61704
|
+
properties: {
|
|
61705
|
+
customer_portal_id: {
|
|
61706
|
+
description: 'ID of the customer portal to update.',
|
|
61707
|
+
format: 'uuid',
|
|
61708
|
+
type: 'string',
|
|
61709
|
+
},
|
|
61710
|
+
portal_configuration: {
|
|
61711
|
+
description: 'Partial portal configuration to merge with the existing configuration.',
|
|
61712
|
+
properties: {
|
|
61713
|
+
customer_resources_filters: {
|
|
61714
|
+
description: 'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',
|
|
61715
|
+
items: {
|
|
61716
|
+
properties: {
|
|
61717
|
+
field: {
|
|
61718
|
+
description: 'The custom_metadata field name to filter on.',
|
|
61719
|
+
pattern: '^[a-zA-Z_]\\w*$',
|
|
61720
|
+
type: 'string',
|
|
61721
|
+
},
|
|
61722
|
+
operation: {
|
|
61723
|
+
description: "The comparison operation. Currently only '=' is supported.",
|
|
61724
|
+
enum: ['='],
|
|
61725
|
+
type: 'string',
|
|
61726
|
+
},
|
|
61727
|
+
value: {
|
|
61728
|
+
description: 'The value to compare against.',
|
|
61729
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
61730
|
+
},
|
|
61731
|
+
},
|
|
61732
|
+
required: ['field', 'operation', 'value'],
|
|
61733
|
+
type: 'object',
|
|
61734
|
+
},
|
|
61735
|
+
type: 'array',
|
|
61736
|
+
},
|
|
61737
|
+
customization_profile_id: {
|
|
61738
|
+
description: 'The ID of the customization profile to use for the portal.',
|
|
61739
|
+
format: 'uuid',
|
|
61740
|
+
type: 'string',
|
|
61741
|
+
},
|
|
61742
|
+
deep_link: {
|
|
61743
|
+
description: 'Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.',
|
|
61744
|
+
properties: {
|
|
61745
|
+
resource_key: { type: 'string' },
|
|
61746
|
+
resource_type: {
|
|
61747
|
+
enum: ['reservation', 'space'],
|
|
61748
|
+
type: 'string',
|
|
61749
|
+
},
|
|
61750
|
+
},
|
|
61751
|
+
required: ['resource_type', 'resource_key'],
|
|
61752
|
+
type: 'object',
|
|
61753
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
61754
|
+
},
|
|
61755
|
+
exclude_locale_picker: {
|
|
61756
|
+
default: false,
|
|
61757
|
+
description: 'Whether to exclude the option to select a locale within the portal UI.',
|
|
61758
|
+
type: 'boolean',
|
|
61759
|
+
},
|
|
61760
|
+
features: {
|
|
61761
|
+
default: {},
|
|
61762
|
+
properties: {
|
|
61763
|
+
configure: {
|
|
61764
|
+
default: {},
|
|
61765
|
+
description: 'Configuration for the configure feature.',
|
|
61766
|
+
properties: {
|
|
61767
|
+
allow_access_automation_rule_customization: {
|
|
61768
|
+
default: false,
|
|
61769
|
+
description: 'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
61770
|
+
type: 'boolean',
|
|
61771
|
+
},
|
|
61772
|
+
allow_climate_automation_rule_customization: {
|
|
61773
|
+
default: false,
|
|
61774
|
+
description: 'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
61775
|
+
type: 'boolean',
|
|
61776
|
+
},
|
|
61777
|
+
allow_instant_key_customization: {
|
|
61778
|
+
default: false,
|
|
61779
|
+
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
61780
|
+
type: 'boolean',
|
|
61781
|
+
},
|
|
61782
|
+
exclude: {
|
|
61783
|
+
default: false,
|
|
61784
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
61785
|
+
type: 'boolean',
|
|
61786
|
+
},
|
|
61787
|
+
},
|
|
61788
|
+
type: 'object',
|
|
61789
|
+
},
|
|
61790
|
+
connect: {
|
|
61791
|
+
default: {},
|
|
61792
|
+
description: 'Configuration for the connect accounts feature.',
|
|
61793
|
+
properties: {
|
|
61794
|
+
accepted_providers: {
|
|
61795
|
+
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
61796
|
+
items: { type: 'string' },
|
|
61797
|
+
type: 'array',
|
|
61798
|
+
},
|
|
61799
|
+
exclude: {
|
|
61800
|
+
default: false,
|
|
61801
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
61802
|
+
type: 'boolean',
|
|
61803
|
+
},
|
|
61804
|
+
excluded_providers: {
|
|
61805
|
+
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.',
|
|
61806
|
+
items: { type: 'string' },
|
|
61807
|
+
type: 'array',
|
|
61808
|
+
},
|
|
61809
|
+
},
|
|
61810
|
+
type: 'object',
|
|
61811
|
+
},
|
|
61812
|
+
manage: {
|
|
61813
|
+
default: {},
|
|
61814
|
+
description: 'Configuration for the manage feature.',
|
|
61815
|
+
properties: {
|
|
61816
|
+
events: {
|
|
61817
|
+
description: 'Configuration for event type filtering in the manage feature.',
|
|
61818
|
+
properties: {
|
|
61819
|
+
allowed_events: {
|
|
61820
|
+
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.',
|
|
61821
|
+
items: { type: 'string' },
|
|
61822
|
+
type: 'array',
|
|
61823
|
+
},
|
|
61824
|
+
default_events: {
|
|
61825
|
+
description: 'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
61826
|
+
items: { type: 'string' },
|
|
61827
|
+
type: 'array',
|
|
61828
|
+
},
|
|
61829
|
+
},
|
|
61830
|
+
type: 'object',
|
|
61831
|
+
},
|
|
61832
|
+
exclude: {
|
|
61833
|
+
default: false,
|
|
61834
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
61835
|
+
type: 'boolean',
|
|
61836
|
+
},
|
|
61837
|
+
exclude_reservation_management: {
|
|
61838
|
+
default: false,
|
|
61839
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
61840
|
+
type: 'boolean',
|
|
61841
|
+
},
|
|
61842
|
+
exclude_reservation_technical_details: {
|
|
61843
|
+
default: false,
|
|
61844
|
+
description: 'Indicates whether to exclude technical details from reservation views.',
|
|
61845
|
+
type: 'boolean',
|
|
61846
|
+
},
|
|
61847
|
+
exclude_staff_management: {
|
|
61848
|
+
default: false,
|
|
61849
|
+
description: 'Indicates whether the customer can manage staff for their properties.',
|
|
61850
|
+
type: 'boolean',
|
|
61851
|
+
},
|
|
61852
|
+
},
|
|
61853
|
+
type: 'object',
|
|
61854
|
+
},
|
|
61855
|
+
manage_devices: {
|
|
61856
|
+
default: {},
|
|
61857
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
61858
|
+
properties: {
|
|
61859
|
+
exclude: {
|
|
61860
|
+
default: false,
|
|
61861
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
61862
|
+
type: 'boolean',
|
|
61863
|
+
},
|
|
61864
|
+
},
|
|
61865
|
+
type: 'object',
|
|
61866
|
+
},
|
|
61867
|
+
organize: {
|
|
61868
|
+
default: {},
|
|
61869
|
+
description: 'Configuration for the organize feature.',
|
|
61870
|
+
properties: {
|
|
61871
|
+
exclude: {
|
|
61872
|
+
default: false,
|
|
61873
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
61874
|
+
type: 'boolean',
|
|
61875
|
+
},
|
|
61876
|
+
},
|
|
61877
|
+
type: 'object',
|
|
61878
|
+
},
|
|
61879
|
+
},
|
|
61880
|
+
type: 'object',
|
|
61881
|
+
},
|
|
61882
|
+
is_embedded: {
|
|
61883
|
+
default: false,
|
|
61884
|
+
description: 'Whether the portal is embedded in another application.',
|
|
61885
|
+
type: 'boolean',
|
|
61886
|
+
},
|
|
61887
|
+
landing_page: {
|
|
61888
|
+
description: 'Configuration for the landing page when the portal loads.',
|
|
61889
|
+
properties: {
|
|
61890
|
+
manage: {
|
|
61891
|
+
oneOf: [
|
|
61892
|
+
{
|
|
61893
|
+
oneOf: [
|
|
61894
|
+
{
|
|
61895
|
+
properties: {
|
|
61896
|
+
space_key: { type: 'string' },
|
|
61897
|
+
},
|
|
61898
|
+
required: ['space_key'],
|
|
61899
|
+
type: 'object',
|
|
61900
|
+
},
|
|
61901
|
+
{
|
|
61902
|
+
properties: {
|
|
61903
|
+
property_key: { type: 'string' },
|
|
61904
|
+
},
|
|
61905
|
+
required: ['property_key'],
|
|
61906
|
+
type: 'object',
|
|
61907
|
+
},
|
|
61908
|
+
{
|
|
61909
|
+
properties: {
|
|
61910
|
+
room_key: { type: 'string' },
|
|
61911
|
+
},
|
|
61912
|
+
required: ['room_key'],
|
|
61913
|
+
type: 'object',
|
|
61914
|
+
},
|
|
61915
|
+
{
|
|
61916
|
+
properties: {
|
|
61917
|
+
common_area_key: { type: 'string' },
|
|
61918
|
+
},
|
|
61919
|
+
required: ['common_area_key'],
|
|
61920
|
+
type: 'object',
|
|
61921
|
+
},
|
|
61922
|
+
{
|
|
61923
|
+
properties: {
|
|
61924
|
+
unit_key: { type: 'string' },
|
|
61925
|
+
},
|
|
61926
|
+
required: ['unit_key'],
|
|
61927
|
+
type: 'object',
|
|
61928
|
+
},
|
|
61929
|
+
{
|
|
61930
|
+
properties: {
|
|
61931
|
+
facility_key: { type: 'string' },
|
|
61932
|
+
},
|
|
61933
|
+
required: ['facility_key'],
|
|
61934
|
+
type: 'object',
|
|
61935
|
+
},
|
|
61936
|
+
{
|
|
61937
|
+
properties: {
|
|
61938
|
+
building_key: { type: 'string' },
|
|
61939
|
+
},
|
|
61940
|
+
required: ['building_key'],
|
|
61941
|
+
type: 'object',
|
|
61942
|
+
},
|
|
61943
|
+
{
|
|
61944
|
+
properties: {
|
|
61945
|
+
listing_key: { type: 'string' },
|
|
61946
|
+
},
|
|
61947
|
+
required: ['listing_key'],
|
|
61948
|
+
type: 'object',
|
|
61949
|
+
},
|
|
61950
|
+
{
|
|
61951
|
+
properties: {
|
|
61952
|
+
property_listing_key: { type: 'string' },
|
|
61953
|
+
},
|
|
61954
|
+
required: ['property_listing_key'],
|
|
61955
|
+
type: 'object',
|
|
61956
|
+
},
|
|
61957
|
+
{
|
|
61958
|
+
properties: {
|
|
61959
|
+
site_key: { type: 'string' },
|
|
61960
|
+
},
|
|
61961
|
+
required: ['site_key'],
|
|
61962
|
+
type: 'object',
|
|
61963
|
+
},
|
|
61964
|
+
],
|
|
61965
|
+
},
|
|
61966
|
+
{
|
|
61967
|
+
oneOf: [
|
|
61968
|
+
{
|
|
61969
|
+
properties: {
|
|
61970
|
+
reservation_key: { type: 'string' },
|
|
61971
|
+
},
|
|
61972
|
+
required: ['reservation_key'],
|
|
61973
|
+
type: 'object',
|
|
61974
|
+
},
|
|
61975
|
+
{
|
|
61976
|
+
properties: {
|
|
61977
|
+
booking_key: { type: 'string' },
|
|
61978
|
+
},
|
|
61979
|
+
required: ['booking_key'],
|
|
61980
|
+
type: 'object',
|
|
61981
|
+
},
|
|
61982
|
+
{
|
|
61983
|
+
properties: {
|
|
61984
|
+
access_grant_key: { type: 'string' },
|
|
61985
|
+
},
|
|
61986
|
+
required: ['access_grant_key'],
|
|
61987
|
+
type: 'object',
|
|
61988
|
+
},
|
|
61989
|
+
],
|
|
61990
|
+
},
|
|
61991
|
+
],
|
|
61992
|
+
},
|
|
61993
|
+
},
|
|
61994
|
+
type: 'object',
|
|
61995
|
+
},
|
|
61996
|
+
locale: {
|
|
61997
|
+
description: 'The locale to use for the portal.',
|
|
61998
|
+
enum: ['en-US', 'pt-PT', 'fr-FR', 'it-IT', 'es-ES'],
|
|
61999
|
+
type: 'string',
|
|
62000
|
+
},
|
|
62001
|
+
navigation_mode: {
|
|
62002
|
+
default: 'full',
|
|
62003
|
+
description: "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.",
|
|
62004
|
+
enum: ['full', 'restricted'],
|
|
62005
|
+
type: 'string',
|
|
62006
|
+
},
|
|
62007
|
+
},
|
|
62008
|
+
type: 'object',
|
|
62009
|
+
},
|
|
62010
|
+
},
|
|
62011
|
+
required: ['customer_portal_id', 'portal_configuration'],
|
|
62012
|
+
type: 'object',
|
|
62013
|
+
},
|
|
62014
|
+
},
|
|
62015
|
+
},
|
|
62016
|
+
},
|
|
62017
|
+
responses: {
|
|
62018
|
+
200: {
|
|
62019
|
+
content: {
|
|
62020
|
+
'application/json': {
|
|
62021
|
+
schema: {
|
|
62022
|
+
properties: { ok: { type: 'boolean' } },
|
|
62023
|
+
required: ['ok'],
|
|
62024
|
+
type: 'object',
|
|
62025
|
+
},
|
|
62026
|
+
},
|
|
62027
|
+
},
|
|
62028
|
+
description: 'OK',
|
|
62029
|
+
},
|
|
62030
|
+
400: { description: 'Bad Request' },
|
|
62031
|
+
401: { description: 'Unauthorized' },
|
|
62032
|
+
},
|
|
62033
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
62034
|
+
summary: '/seam/customer/v1/portals/update',
|
|
62035
|
+
tags: [],
|
|
62036
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
62037
|
+
'x-fern-sdk-method-name': 'update',
|
|
62038
|
+
'x-response-key': null,
|
|
62039
|
+
'x-title': 'Update Customer Portal Configuration',
|
|
62040
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
62041
|
+
},
|
|
62042
|
+
post: {
|
|
62043
|
+
description: 'Updates the configuration for a customer portal.',
|
|
62044
|
+
operationId: 'seamCustomerV1PortalsUpdatePost',
|
|
62045
|
+
requestBody: {
|
|
62046
|
+
content: {
|
|
62047
|
+
'application/json': {
|
|
62048
|
+
schema: {
|
|
62049
|
+
properties: {
|
|
62050
|
+
customer_portal_id: {
|
|
62051
|
+
description: 'ID of the customer portal to update.',
|
|
62052
|
+
format: 'uuid',
|
|
62053
|
+
type: 'string',
|
|
62054
|
+
},
|
|
62055
|
+
portal_configuration: {
|
|
62056
|
+
description: 'Partial portal configuration to merge with the existing configuration.',
|
|
62057
|
+
properties: {
|
|
62058
|
+
customer_resources_filters: {
|
|
62059
|
+
description: 'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',
|
|
62060
|
+
items: {
|
|
62061
|
+
properties: {
|
|
62062
|
+
field: {
|
|
62063
|
+
description: 'The custom_metadata field name to filter on.',
|
|
62064
|
+
pattern: '^[a-zA-Z_]\\w*$',
|
|
62065
|
+
type: 'string',
|
|
62066
|
+
},
|
|
62067
|
+
operation: {
|
|
62068
|
+
description: "The comparison operation. Currently only '=' is supported.",
|
|
62069
|
+
enum: ['='],
|
|
62070
|
+
type: 'string',
|
|
62071
|
+
},
|
|
62072
|
+
value: {
|
|
62073
|
+
description: 'The value to compare against.',
|
|
62074
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
62075
|
+
},
|
|
62076
|
+
},
|
|
62077
|
+
required: ['field', 'operation', 'value'],
|
|
62078
|
+
type: 'object',
|
|
62079
|
+
},
|
|
62080
|
+
type: 'array',
|
|
62081
|
+
},
|
|
62082
|
+
customization_profile_id: {
|
|
62083
|
+
description: 'The ID of the customization profile to use for the portal.',
|
|
62084
|
+
format: 'uuid',
|
|
62085
|
+
type: 'string',
|
|
62086
|
+
},
|
|
62087
|
+
deep_link: {
|
|
62088
|
+
description: 'Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.',
|
|
62089
|
+
properties: {
|
|
62090
|
+
resource_key: { type: 'string' },
|
|
62091
|
+
resource_type: {
|
|
62092
|
+
enum: ['reservation', 'space'],
|
|
62093
|
+
type: 'string',
|
|
62094
|
+
},
|
|
62095
|
+
},
|
|
62096
|
+
required: ['resource_type', 'resource_key'],
|
|
62097
|
+
type: 'object',
|
|
62098
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
62099
|
+
},
|
|
62100
|
+
exclude_locale_picker: {
|
|
62101
|
+
default: false,
|
|
62102
|
+
description: 'Whether to exclude the option to select a locale within the portal UI.',
|
|
62103
|
+
type: 'boolean',
|
|
62104
|
+
},
|
|
62105
|
+
features: {
|
|
62106
|
+
default: {},
|
|
62107
|
+
properties: {
|
|
62108
|
+
configure: {
|
|
62109
|
+
default: {},
|
|
62110
|
+
description: 'Configuration for the configure feature.',
|
|
62111
|
+
properties: {
|
|
62112
|
+
allow_access_automation_rule_customization: {
|
|
62113
|
+
default: false,
|
|
62114
|
+
description: 'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
62115
|
+
type: 'boolean',
|
|
62116
|
+
},
|
|
62117
|
+
allow_climate_automation_rule_customization: {
|
|
62118
|
+
default: false,
|
|
62119
|
+
description: 'Indicates whether the customer can customize the climate automation rules for their properties.',
|
|
62120
|
+
type: 'boolean',
|
|
62121
|
+
},
|
|
62122
|
+
allow_instant_key_customization: {
|
|
62123
|
+
default: false,
|
|
62124
|
+
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
62125
|
+
type: 'boolean',
|
|
62126
|
+
},
|
|
62127
|
+
exclude: {
|
|
62128
|
+
default: false,
|
|
62129
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
62130
|
+
type: 'boolean',
|
|
62131
|
+
},
|
|
62132
|
+
},
|
|
62133
|
+
type: 'object',
|
|
62134
|
+
},
|
|
62135
|
+
connect: {
|
|
62136
|
+
default: {},
|
|
62137
|
+
description: 'Configuration for the connect accounts feature.',
|
|
62138
|
+
properties: {
|
|
62139
|
+
accepted_providers: {
|
|
62140
|
+
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
62141
|
+
items: { type: 'string' },
|
|
62142
|
+
type: 'array',
|
|
62143
|
+
},
|
|
62144
|
+
exclude: {
|
|
62145
|
+
default: false,
|
|
62146
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
62147
|
+
type: 'boolean',
|
|
62148
|
+
},
|
|
62149
|
+
excluded_providers: {
|
|
62150
|
+
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.',
|
|
62151
|
+
items: { type: 'string' },
|
|
62152
|
+
type: 'array',
|
|
62153
|
+
},
|
|
62154
|
+
},
|
|
62155
|
+
type: 'object',
|
|
62156
|
+
},
|
|
62157
|
+
manage: {
|
|
62158
|
+
default: {},
|
|
62159
|
+
description: 'Configuration for the manage feature.',
|
|
62160
|
+
properties: {
|
|
62161
|
+
events: {
|
|
62162
|
+
description: 'Configuration for event type filtering in the manage feature.',
|
|
62163
|
+
properties: {
|
|
62164
|
+
allowed_events: {
|
|
62165
|
+
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.',
|
|
62166
|
+
items: { type: 'string' },
|
|
62167
|
+
type: 'array',
|
|
62168
|
+
},
|
|
62169
|
+
default_events: {
|
|
62170
|
+
description: 'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
|
|
62171
|
+
items: { type: 'string' },
|
|
62172
|
+
type: 'array',
|
|
62173
|
+
},
|
|
62174
|
+
},
|
|
62175
|
+
type: 'object',
|
|
62176
|
+
},
|
|
62177
|
+
exclude: {
|
|
62178
|
+
default: false,
|
|
62179
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
62180
|
+
type: 'boolean',
|
|
62181
|
+
},
|
|
62182
|
+
exclude_reservation_management: {
|
|
62183
|
+
default: false,
|
|
62184
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
62185
|
+
type: 'boolean',
|
|
62186
|
+
},
|
|
62187
|
+
exclude_reservation_technical_details: {
|
|
62188
|
+
default: false,
|
|
62189
|
+
description: 'Indicates whether to exclude technical details from reservation views.',
|
|
62190
|
+
type: 'boolean',
|
|
62191
|
+
},
|
|
62192
|
+
exclude_staff_management: {
|
|
62193
|
+
default: false,
|
|
62194
|
+
description: 'Indicates whether the customer can manage staff for their properties.',
|
|
62195
|
+
type: 'boolean',
|
|
62196
|
+
},
|
|
62197
|
+
},
|
|
62198
|
+
type: 'object',
|
|
62199
|
+
},
|
|
62200
|
+
manage_devices: {
|
|
62201
|
+
default: {},
|
|
62202
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
62203
|
+
properties: {
|
|
62204
|
+
exclude: {
|
|
62205
|
+
default: false,
|
|
62206
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
62207
|
+
type: 'boolean',
|
|
62208
|
+
},
|
|
62209
|
+
},
|
|
62210
|
+
type: 'object',
|
|
62211
|
+
},
|
|
62212
|
+
organize: {
|
|
62213
|
+
default: {},
|
|
62214
|
+
description: 'Configuration for the organize feature.',
|
|
62215
|
+
properties: {
|
|
62216
|
+
exclude: {
|
|
62217
|
+
default: false,
|
|
62218
|
+
description: 'Whether to exclude this feature from the portal.',
|
|
62219
|
+
type: 'boolean',
|
|
62220
|
+
},
|
|
62221
|
+
},
|
|
62222
|
+
type: 'object',
|
|
62223
|
+
},
|
|
62224
|
+
},
|
|
62225
|
+
type: 'object',
|
|
62226
|
+
},
|
|
62227
|
+
is_embedded: {
|
|
62228
|
+
default: false,
|
|
62229
|
+
description: 'Whether the portal is embedded in another application.',
|
|
62230
|
+
type: 'boolean',
|
|
62231
|
+
},
|
|
62232
|
+
landing_page: {
|
|
62233
|
+
description: 'Configuration for the landing page when the portal loads.',
|
|
62234
|
+
properties: {
|
|
62235
|
+
manage: {
|
|
62236
|
+
oneOf: [
|
|
62237
|
+
{
|
|
62238
|
+
oneOf: [
|
|
62239
|
+
{
|
|
62240
|
+
properties: {
|
|
62241
|
+
space_key: { type: 'string' },
|
|
62242
|
+
},
|
|
62243
|
+
required: ['space_key'],
|
|
62244
|
+
type: 'object',
|
|
62245
|
+
},
|
|
62246
|
+
{
|
|
62247
|
+
properties: {
|
|
62248
|
+
property_key: { type: 'string' },
|
|
62249
|
+
},
|
|
62250
|
+
required: ['property_key'],
|
|
62251
|
+
type: 'object',
|
|
62252
|
+
},
|
|
62253
|
+
{
|
|
62254
|
+
properties: {
|
|
62255
|
+
room_key: { type: 'string' },
|
|
62256
|
+
},
|
|
62257
|
+
required: ['room_key'],
|
|
62258
|
+
type: 'object',
|
|
62259
|
+
},
|
|
62260
|
+
{
|
|
62261
|
+
properties: {
|
|
62262
|
+
common_area_key: { type: 'string' },
|
|
62263
|
+
},
|
|
62264
|
+
required: ['common_area_key'],
|
|
62265
|
+
type: 'object',
|
|
62266
|
+
},
|
|
62267
|
+
{
|
|
62268
|
+
properties: {
|
|
62269
|
+
unit_key: { type: 'string' },
|
|
62270
|
+
},
|
|
62271
|
+
required: ['unit_key'],
|
|
62272
|
+
type: 'object',
|
|
62273
|
+
},
|
|
62274
|
+
{
|
|
62275
|
+
properties: {
|
|
62276
|
+
facility_key: { type: 'string' },
|
|
62277
|
+
},
|
|
62278
|
+
required: ['facility_key'],
|
|
62279
|
+
type: 'object',
|
|
62280
|
+
},
|
|
62281
|
+
{
|
|
62282
|
+
properties: {
|
|
62283
|
+
building_key: { type: 'string' },
|
|
62284
|
+
},
|
|
62285
|
+
required: ['building_key'],
|
|
62286
|
+
type: 'object',
|
|
62287
|
+
},
|
|
62288
|
+
{
|
|
62289
|
+
properties: {
|
|
62290
|
+
listing_key: { type: 'string' },
|
|
62291
|
+
},
|
|
62292
|
+
required: ['listing_key'],
|
|
62293
|
+
type: 'object',
|
|
62294
|
+
},
|
|
62295
|
+
{
|
|
62296
|
+
properties: {
|
|
62297
|
+
property_listing_key: { type: 'string' },
|
|
62298
|
+
},
|
|
62299
|
+
required: ['property_listing_key'],
|
|
62300
|
+
type: 'object',
|
|
62301
|
+
},
|
|
62302
|
+
{
|
|
62303
|
+
properties: {
|
|
62304
|
+
site_key: { type: 'string' },
|
|
62305
|
+
},
|
|
62306
|
+
required: ['site_key'],
|
|
62307
|
+
type: 'object',
|
|
62308
|
+
},
|
|
62309
|
+
],
|
|
62310
|
+
},
|
|
62311
|
+
{
|
|
62312
|
+
oneOf: [
|
|
62313
|
+
{
|
|
62314
|
+
properties: {
|
|
62315
|
+
reservation_key: { type: 'string' },
|
|
62316
|
+
},
|
|
62317
|
+
required: ['reservation_key'],
|
|
62318
|
+
type: 'object',
|
|
62319
|
+
},
|
|
62320
|
+
{
|
|
62321
|
+
properties: {
|
|
62322
|
+
booking_key: { type: 'string' },
|
|
62323
|
+
},
|
|
62324
|
+
required: ['booking_key'],
|
|
62325
|
+
type: 'object',
|
|
62326
|
+
},
|
|
62327
|
+
{
|
|
62328
|
+
properties: {
|
|
62329
|
+
access_grant_key: { type: 'string' },
|
|
62330
|
+
},
|
|
62331
|
+
required: ['access_grant_key'],
|
|
62332
|
+
type: 'object',
|
|
62333
|
+
},
|
|
62334
|
+
],
|
|
62335
|
+
},
|
|
62336
|
+
],
|
|
62337
|
+
},
|
|
62338
|
+
},
|
|
62339
|
+
type: 'object',
|
|
62340
|
+
},
|
|
62341
|
+
locale: {
|
|
62342
|
+
description: 'The locale to use for the portal.',
|
|
62343
|
+
enum: ['en-US', 'pt-PT', 'fr-FR', 'it-IT', 'es-ES'],
|
|
62344
|
+
type: 'string',
|
|
62345
|
+
},
|
|
62346
|
+
navigation_mode: {
|
|
62347
|
+
default: 'full',
|
|
62348
|
+
description: "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.",
|
|
62349
|
+
enum: ['full', 'restricted'],
|
|
62350
|
+
type: 'string',
|
|
62351
|
+
},
|
|
62352
|
+
},
|
|
62353
|
+
type: 'object',
|
|
62354
|
+
},
|
|
62355
|
+
},
|
|
62356
|
+
required: ['customer_portal_id', 'portal_configuration'],
|
|
62357
|
+
type: 'object',
|
|
62358
|
+
},
|
|
62359
|
+
},
|
|
62360
|
+
},
|
|
62361
|
+
},
|
|
62362
|
+
responses: {
|
|
62363
|
+
200: {
|
|
62364
|
+
content: {
|
|
62365
|
+
'application/json': {
|
|
62366
|
+
schema: {
|
|
62367
|
+
properties: { ok: { type: 'boolean' } },
|
|
62368
|
+
required: ['ok'],
|
|
62369
|
+
type: 'object',
|
|
62370
|
+
},
|
|
62371
|
+
},
|
|
62372
|
+
},
|
|
62373
|
+
description: 'OK',
|
|
62374
|
+
},
|
|
62375
|
+
400: { description: 'Bad Request' },
|
|
62376
|
+
401: { description: 'Unauthorized' },
|
|
62377
|
+
},
|
|
62378
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
62379
|
+
summary: '/seam/customer/v1/portals/update',
|
|
62380
|
+
tags: [],
|
|
62381
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
|
|
62382
|
+
'x-fern-sdk-method-name': 'update',
|
|
62383
|
+
'x-response-key': null,
|
|
62384
|
+
'x-title': 'Update Customer Portal Configuration',
|
|
62385
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
62386
|
+
},
|
|
62387
|
+
},
|
|
61657
62388
|
'/seam/customer/v1/reservations/get': {
|
|
61658
62389
|
get: {
|
|
61659
62390
|
description: 'Returns a single reservation for a specific customer by reservation ID.',
|