@seamapi/types 1.738.0 → 1.740.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 +1391 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2600 -532
- package/dist/index.cjs +1391 -3
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +62 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +53 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +19 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +62 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +53 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +19 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +172 -0
- package/lib/seam/connect/openapi.d.ts +1664 -241
- package/lib/seam/connect/openapi.js +1362 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +349 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +26 -0
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +26 -0
- package/src/lib/seam/connect/openapi.ts +1386 -0
- package/src/lib/seam/connect/route-types.ts +429 -0
|
@@ -3054,6 +3054,48 @@ export default {
|
|
|
3054
3054
|
],
|
|
3055
3055
|
type: 'object',
|
|
3056
3056
|
},
|
|
3057
|
+
{
|
|
3058
|
+
description:
|
|
3059
|
+
'A scheduled user membership change is pending for this access group.',
|
|
3060
|
+
properties: {
|
|
3061
|
+
acs_user_id: {
|
|
3062
|
+
description:
|
|
3063
|
+
'ID of the user involved in the scheduled change.',
|
|
3064
|
+
format: 'uuid',
|
|
3065
|
+
type: 'string',
|
|
3066
|
+
},
|
|
3067
|
+
created_at: {
|
|
3068
|
+
description:
|
|
3069
|
+
'Date and time at which the mutation was created.',
|
|
3070
|
+
format: 'date-time',
|
|
3071
|
+
type: 'string',
|
|
3072
|
+
},
|
|
3073
|
+
message: {
|
|
3074
|
+
description: 'Detailed description of the mutation.',
|
|
3075
|
+
type: 'string',
|
|
3076
|
+
},
|
|
3077
|
+
mutation_code: {
|
|
3078
|
+
description:
|
|
3079
|
+
'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
3080
|
+
enum: ['deferring_user_membership_update'],
|
|
3081
|
+
type: 'string',
|
|
3082
|
+
},
|
|
3083
|
+
variant: {
|
|
3084
|
+
description:
|
|
3085
|
+
'Whether the user is scheduled to be added to or removed from this access group.',
|
|
3086
|
+
enum: ['adding', 'removing'],
|
|
3087
|
+
type: 'string',
|
|
3088
|
+
},
|
|
3089
|
+
},
|
|
3090
|
+
required: [
|
|
3091
|
+
'created_at',
|
|
3092
|
+
'message',
|
|
3093
|
+
'mutation_code',
|
|
3094
|
+
'acs_user_id',
|
|
3095
|
+
'variant',
|
|
3096
|
+
],
|
|
3097
|
+
type: 'object',
|
|
3098
|
+
},
|
|
3057
3099
|
],
|
|
3058
3100
|
},
|
|
3059
3101
|
type: 'array',
|
|
@@ -5060,6 +5102,48 @@ export default {
|
|
|
5060
5102
|
],
|
|
5061
5103
|
type: 'object',
|
|
5062
5104
|
},
|
|
5105
|
+
{
|
|
5106
|
+
description:
|
|
5107
|
+
'A scheduled access group membership change is pending for this user.',
|
|
5108
|
+
properties: {
|
|
5109
|
+
acs_access_group_id: {
|
|
5110
|
+
description:
|
|
5111
|
+
'ID of the access group involved in the scheduled change.',
|
|
5112
|
+
format: 'uuid',
|
|
5113
|
+
type: 'string',
|
|
5114
|
+
},
|
|
5115
|
+
created_at: {
|
|
5116
|
+
description:
|
|
5117
|
+
'Date and time at which the mutation was created.',
|
|
5118
|
+
format: 'date-time',
|
|
5119
|
+
type: 'string',
|
|
5120
|
+
},
|
|
5121
|
+
message: {
|
|
5122
|
+
description: 'Detailed description of the mutation.',
|
|
5123
|
+
type: 'string',
|
|
5124
|
+
},
|
|
5125
|
+
mutation_code: {
|
|
5126
|
+
description:
|
|
5127
|
+
'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
5128
|
+
enum: ['deferring_group_membership_update'],
|
|
5129
|
+
type: 'string',
|
|
5130
|
+
},
|
|
5131
|
+
variant: {
|
|
5132
|
+
description:
|
|
5133
|
+
'Whether the user is scheduled to be added to or removed from the access group.',
|
|
5134
|
+
enum: ['adding', 'removing'],
|
|
5135
|
+
type: 'string',
|
|
5136
|
+
},
|
|
5137
|
+
},
|
|
5138
|
+
required: [
|
|
5139
|
+
'created_at',
|
|
5140
|
+
'message',
|
|
5141
|
+
'mutation_code',
|
|
5142
|
+
'acs_access_group_id',
|
|
5143
|
+
'variant',
|
|
5144
|
+
],
|
|
5145
|
+
type: 'object',
|
|
5146
|
+
},
|
|
5063
5147
|
],
|
|
5064
5148
|
},
|
|
5065
5149
|
type: 'array',
|
|
@@ -27151,6 +27235,48 @@ export default {
|
|
|
27151
27235
|
],
|
|
27152
27236
|
type: 'object',
|
|
27153
27237
|
},
|
|
27238
|
+
{
|
|
27239
|
+
description:
|
|
27240
|
+
'A scheduled user membership change is pending for this access group.',
|
|
27241
|
+
properties: {
|
|
27242
|
+
acs_user_id: {
|
|
27243
|
+
description:
|
|
27244
|
+
'ID of the user involved in the scheduled change.',
|
|
27245
|
+
format: 'uuid',
|
|
27246
|
+
type: 'string',
|
|
27247
|
+
},
|
|
27248
|
+
created_at: {
|
|
27249
|
+
description:
|
|
27250
|
+
'Date and time at which the mutation was created.',
|
|
27251
|
+
format: 'date-time',
|
|
27252
|
+
type: 'string',
|
|
27253
|
+
},
|
|
27254
|
+
message: {
|
|
27255
|
+
description: 'Detailed description of the mutation.',
|
|
27256
|
+
type: 'string',
|
|
27257
|
+
},
|
|
27258
|
+
mutation_code: {
|
|
27259
|
+
description:
|
|
27260
|
+
'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
27261
|
+
enum: ['deferring_user_membership_update'],
|
|
27262
|
+
type: 'string',
|
|
27263
|
+
},
|
|
27264
|
+
variant: {
|
|
27265
|
+
description:
|
|
27266
|
+
'Whether the user is scheduled to be added to or removed from this access group.',
|
|
27267
|
+
enum: ['adding', 'removing'],
|
|
27268
|
+
type: 'string',
|
|
27269
|
+
},
|
|
27270
|
+
},
|
|
27271
|
+
required: [
|
|
27272
|
+
'created_at',
|
|
27273
|
+
'message',
|
|
27274
|
+
'mutation_code',
|
|
27275
|
+
'acs_user_id',
|
|
27276
|
+
'variant',
|
|
27277
|
+
],
|
|
27278
|
+
type: 'object',
|
|
27279
|
+
},
|
|
27154
27280
|
],
|
|
27155
27281
|
},
|
|
27156
27282
|
type: 'array',
|
|
@@ -28248,6 +28374,48 @@ export default {
|
|
|
28248
28374
|
],
|
|
28249
28375
|
type: 'object',
|
|
28250
28376
|
},
|
|
28377
|
+
{
|
|
28378
|
+
description:
|
|
28379
|
+
'A scheduled access group membership change is pending for this user.',
|
|
28380
|
+
properties: {
|
|
28381
|
+
acs_access_group_id: {
|
|
28382
|
+
description:
|
|
28383
|
+
'ID of the access group involved in the scheduled change.',
|
|
28384
|
+
format: 'uuid',
|
|
28385
|
+
type: 'string',
|
|
28386
|
+
},
|
|
28387
|
+
created_at: {
|
|
28388
|
+
description:
|
|
28389
|
+
'Date and time at which the mutation was created.',
|
|
28390
|
+
format: 'date-time',
|
|
28391
|
+
type: 'string',
|
|
28392
|
+
},
|
|
28393
|
+
message: {
|
|
28394
|
+
description: 'Detailed description of the mutation.',
|
|
28395
|
+
type: 'string',
|
|
28396
|
+
},
|
|
28397
|
+
mutation_code: {
|
|
28398
|
+
description:
|
|
28399
|
+
'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
28400
|
+
enum: ['deferring_group_membership_update'],
|
|
28401
|
+
type: 'string',
|
|
28402
|
+
},
|
|
28403
|
+
variant: {
|
|
28404
|
+
description:
|
|
28405
|
+
'Whether the user is scheduled to be added to or removed from the access group.',
|
|
28406
|
+
enum: ['adding', 'removing'],
|
|
28407
|
+
type: 'string',
|
|
28408
|
+
},
|
|
28409
|
+
},
|
|
28410
|
+
required: [
|
|
28411
|
+
'created_at',
|
|
28412
|
+
'message',
|
|
28413
|
+
'mutation_code',
|
|
28414
|
+
'acs_access_group_id',
|
|
28415
|
+
'variant',
|
|
28416
|
+
],
|
|
28417
|
+
type: 'object',
|
|
28418
|
+
},
|
|
28251
28419
|
],
|
|
28252
28420
|
},
|
|
28253
28421
|
type: 'array',
|
|
@@ -62784,6 +62952,1224 @@ export default {
|
|
|
62784
62952
|
'x-undocumented': 'Internal endpoint for Console.',
|
|
62785
62953
|
},
|
|
62786
62954
|
},
|
|
62955
|
+
'/seam/customer/v1/customers/automations/get': {
|
|
62956
|
+
get: {
|
|
62957
|
+
description:
|
|
62958
|
+
'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
62959
|
+
operationId: 'seamCustomerV1CustomersAutomationsGetGet',
|
|
62960
|
+
parameters: [
|
|
62961
|
+
{
|
|
62962
|
+
in: 'query',
|
|
62963
|
+
name: 'customer_key',
|
|
62964
|
+
required: true,
|
|
62965
|
+
schema: { description: 'Key of the customer.', type: 'string' },
|
|
62966
|
+
},
|
|
62967
|
+
],
|
|
62968
|
+
responses: {
|
|
62969
|
+
200: {
|
|
62970
|
+
content: {
|
|
62971
|
+
'application/json': {
|
|
62972
|
+
schema: {
|
|
62973
|
+
properties: {
|
|
62974
|
+
automation: {
|
|
62975
|
+
properties: {
|
|
62976
|
+
access_rules: {
|
|
62977
|
+
properties: {
|
|
62978
|
+
reservation_created: {
|
|
62979
|
+
properties: {
|
|
62980
|
+
config: {
|
|
62981
|
+
properties: {
|
|
62982
|
+
access_methods: {
|
|
62983
|
+
items: {
|
|
62984
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
62985
|
+
type: 'string',
|
|
62986
|
+
},
|
|
62987
|
+
minItems: 1,
|
|
62988
|
+
type: 'array',
|
|
62989
|
+
},
|
|
62990
|
+
card_count_on_reservation_create: {
|
|
62991
|
+
minimum: 0,
|
|
62992
|
+
type: 'integer',
|
|
62993
|
+
},
|
|
62994
|
+
code_count_on_reservation_create: {
|
|
62995
|
+
minimum: 0,
|
|
62996
|
+
type: 'integer',
|
|
62997
|
+
},
|
|
62998
|
+
instant_key_max_use_count: {
|
|
62999
|
+
minimum: 1,
|
|
63000
|
+
type: 'integer',
|
|
63001
|
+
},
|
|
63002
|
+
method_issuance_strategy: {
|
|
63003
|
+
enum: [
|
|
63004
|
+
'first_available',
|
|
63005
|
+
'first_two_available',
|
|
63006
|
+
'all_available',
|
|
63007
|
+
],
|
|
63008
|
+
type: 'string',
|
|
63009
|
+
},
|
|
63010
|
+
},
|
|
63011
|
+
required: [
|
|
63012
|
+
'access_methods',
|
|
63013
|
+
'method_issuance_strategy',
|
|
63014
|
+
],
|
|
63015
|
+
type: 'object',
|
|
63016
|
+
},
|
|
63017
|
+
rule: {
|
|
63018
|
+
enum: ['reservation_created'],
|
|
63019
|
+
type: 'string',
|
|
63020
|
+
},
|
|
63021
|
+
},
|
|
63022
|
+
required: ['rule', 'config'],
|
|
63023
|
+
type: 'object',
|
|
63024
|
+
},
|
|
63025
|
+
reservation_deleted: {
|
|
63026
|
+
properties: {
|
|
63027
|
+
config: {
|
|
63028
|
+
$ref: '#/components/schemas/access_code',
|
|
63029
|
+
},
|
|
63030
|
+
rule: {
|
|
63031
|
+
enum: ['reservation_deleted'],
|
|
63032
|
+
type: 'string',
|
|
63033
|
+
},
|
|
63034
|
+
},
|
|
63035
|
+
required: ['rule'],
|
|
63036
|
+
type: 'object',
|
|
63037
|
+
},
|
|
63038
|
+
reservation_spaces_updated: {
|
|
63039
|
+
properties: {
|
|
63040
|
+
config: {
|
|
63041
|
+
$ref: '#/components/schemas/access_code',
|
|
63042
|
+
},
|
|
63043
|
+
rule: {
|
|
63044
|
+
enum: ['reservation_spaces_updated'],
|
|
63045
|
+
type: 'string',
|
|
63046
|
+
},
|
|
63047
|
+
},
|
|
63048
|
+
required: ['rule'],
|
|
63049
|
+
type: 'object',
|
|
63050
|
+
},
|
|
63051
|
+
reservation_time_updated: {
|
|
63052
|
+
properties: {
|
|
63053
|
+
config: {
|
|
63054
|
+
$ref: '#/components/schemas/access_code',
|
|
63055
|
+
},
|
|
63056
|
+
rule: {
|
|
63057
|
+
enum: ['reservation_time_updated'],
|
|
63058
|
+
type: 'string',
|
|
63059
|
+
},
|
|
63060
|
+
},
|
|
63061
|
+
required: ['rule'],
|
|
63062
|
+
type: 'object',
|
|
63063
|
+
},
|
|
63064
|
+
space_name_updated: {
|
|
63065
|
+
properties: {
|
|
63066
|
+
config: {
|
|
63067
|
+
$ref: '#/components/schemas/access_code',
|
|
63068
|
+
},
|
|
63069
|
+
rule: {
|
|
63070
|
+
enum: ['space_name_updated'],
|
|
63071
|
+
type: 'string',
|
|
63072
|
+
},
|
|
63073
|
+
},
|
|
63074
|
+
required: ['rule'],
|
|
63075
|
+
type: 'object',
|
|
63076
|
+
},
|
|
63077
|
+
staff_member_created: {
|
|
63078
|
+
properties: {
|
|
63079
|
+
config: {
|
|
63080
|
+
$ref: '#/components/schemas/access_code',
|
|
63081
|
+
},
|
|
63082
|
+
rule: {
|
|
63083
|
+
enum: ['staff_member_created'],
|
|
63084
|
+
type: 'string',
|
|
63085
|
+
},
|
|
63086
|
+
},
|
|
63087
|
+
required: ['rule', 'config'],
|
|
63088
|
+
type: 'object',
|
|
63089
|
+
},
|
|
63090
|
+
staff_member_name_updated: {
|
|
63091
|
+
properties: {
|
|
63092
|
+
config: {
|
|
63093
|
+
$ref: '#/components/schemas/access_code',
|
|
63094
|
+
},
|
|
63095
|
+
rule: {
|
|
63096
|
+
enum: ['staff_member_name_updated'],
|
|
63097
|
+
type: 'string',
|
|
63098
|
+
},
|
|
63099
|
+
},
|
|
63100
|
+
required: ['rule'],
|
|
63101
|
+
type: 'object',
|
|
63102
|
+
},
|
|
63103
|
+
user_identity_name_updated: {
|
|
63104
|
+
properties: {
|
|
63105
|
+
config: {
|
|
63106
|
+
$ref: '#/components/schemas/access_code',
|
|
63107
|
+
},
|
|
63108
|
+
rule: {
|
|
63109
|
+
enum: ['user_identity_name_updated'],
|
|
63110
|
+
type: 'string',
|
|
63111
|
+
},
|
|
63112
|
+
},
|
|
63113
|
+
required: ['rule'],
|
|
63114
|
+
type: 'object',
|
|
63115
|
+
},
|
|
63116
|
+
},
|
|
63117
|
+
type: 'object',
|
|
63118
|
+
},
|
|
63119
|
+
climate_rules: {
|
|
63120
|
+
properties: {
|
|
63121
|
+
rules: {
|
|
63122
|
+
properties: {
|
|
63123
|
+
reservation_created: {
|
|
63124
|
+
properties: {
|
|
63125
|
+
automated_occupied_preset: {
|
|
63126
|
+
properties: {
|
|
63127
|
+
cooling_set_point_celsius: {
|
|
63128
|
+
format: 'float',
|
|
63129
|
+
type: 'number',
|
|
63130
|
+
},
|
|
63131
|
+
cooling_set_point_fahrenheit: {
|
|
63132
|
+
format: 'float',
|
|
63133
|
+
type: 'number',
|
|
63134
|
+
},
|
|
63135
|
+
fan_mode: {
|
|
63136
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63137
|
+
type: 'string',
|
|
63138
|
+
},
|
|
63139
|
+
heating_set_point_celsius: {
|
|
63140
|
+
format: 'float',
|
|
63141
|
+
type: 'number',
|
|
63142
|
+
},
|
|
63143
|
+
heating_set_point_fahrenheit: {
|
|
63144
|
+
format: 'float',
|
|
63145
|
+
type: 'number',
|
|
63146
|
+
},
|
|
63147
|
+
is_override_allowed: {
|
|
63148
|
+
type: 'boolean',
|
|
63149
|
+
},
|
|
63150
|
+
max_override_period_minutes: {
|
|
63151
|
+
format: 'float',
|
|
63152
|
+
type: 'number',
|
|
63153
|
+
},
|
|
63154
|
+
mode: {
|
|
63155
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63156
|
+
type: 'string',
|
|
63157
|
+
},
|
|
63158
|
+
},
|
|
63159
|
+
required: [
|
|
63160
|
+
'mode',
|
|
63161
|
+
'fan_mode',
|
|
63162
|
+
'is_override_allowed',
|
|
63163
|
+
'max_override_period_minutes',
|
|
63164
|
+
],
|
|
63165
|
+
type: 'object',
|
|
63166
|
+
},
|
|
63167
|
+
automated_unoccupied_preset: {
|
|
63168
|
+
properties: {
|
|
63169
|
+
cooling_set_point_celsius: {
|
|
63170
|
+
format: 'float',
|
|
63171
|
+
type: 'number',
|
|
63172
|
+
},
|
|
63173
|
+
cooling_set_point_fahrenheit: {
|
|
63174
|
+
format: 'float',
|
|
63175
|
+
type: 'number',
|
|
63176
|
+
},
|
|
63177
|
+
fan_mode: {
|
|
63178
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63179
|
+
type: 'string',
|
|
63180
|
+
},
|
|
63181
|
+
heating_set_point_celsius: {
|
|
63182
|
+
format: 'float',
|
|
63183
|
+
type: 'number',
|
|
63184
|
+
},
|
|
63185
|
+
heating_set_point_fahrenheit: {
|
|
63186
|
+
format: 'float',
|
|
63187
|
+
type: 'number',
|
|
63188
|
+
},
|
|
63189
|
+
is_override_allowed: {
|
|
63190
|
+
type: 'boolean',
|
|
63191
|
+
},
|
|
63192
|
+
max_override_period_minutes: {
|
|
63193
|
+
format: 'float',
|
|
63194
|
+
type: 'number',
|
|
63195
|
+
},
|
|
63196
|
+
mode: {
|
|
63197
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63198
|
+
type: 'string',
|
|
63199
|
+
},
|
|
63200
|
+
},
|
|
63201
|
+
required: [
|
|
63202
|
+
'mode',
|
|
63203
|
+
'fan_mode',
|
|
63204
|
+
'is_override_allowed',
|
|
63205
|
+
'max_override_period_minutes',
|
|
63206
|
+
],
|
|
63207
|
+
type: 'object',
|
|
63208
|
+
},
|
|
63209
|
+
occupied_preset_key: { type: 'string' },
|
|
63210
|
+
precondition_minutes_before_reservation: {
|
|
63211
|
+
format: 'float',
|
|
63212
|
+
type: 'number',
|
|
63213
|
+
},
|
|
63214
|
+
unoccupied_preset_key: { type: 'string' },
|
|
63215
|
+
},
|
|
63216
|
+
type: 'object',
|
|
63217
|
+
},
|
|
63218
|
+
reservation_deleted: {
|
|
63219
|
+
$ref: '#/components/schemas/access_code',
|
|
63220
|
+
},
|
|
63221
|
+
reservation_time_updated: {
|
|
63222
|
+
$ref: '#/components/schemas/access_code',
|
|
63223
|
+
},
|
|
63224
|
+
},
|
|
63225
|
+
type: 'object',
|
|
63226
|
+
},
|
|
63227
|
+
},
|
|
63228
|
+
required: ['rules'],
|
|
63229
|
+
type: 'object',
|
|
63230
|
+
},
|
|
63231
|
+
},
|
|
63232
|
+
type: 'object',
|
|
63233
|
+
},
|
|
63234
|
+
ok: { type: 'boolean' },
|
|
63235
|
+
},
|
|
63236
|
+
required: ['automation', 'ok'],
|
|
63237
|
+
type: 'object',
|
|
63238
|
+
},
|
|
63239
|
+
},
|
|
63240
|
+
},
|
|
63241
|
+
description: 'OK',
|
|
63242
|
+
},
|
|
63243
|
+
400: { description: 'Bad Request' },
|
|
63244
|
+
401: { description: 'Unauthorized' },
|
|
63245
|
+
},
|
|
63246
|
+
security: [
|
|
63247
|
+
{ pat_with_workspace: [] },
|
|
63248
|
+
{ console_session_with_workspace: [] },
|
|
63249
|
+
{ api_key: [] },
|
|
63250
|
+
],
|
|
63251
|
+
summary: '/seam/customer/v1/customers/automations/get',
|
|
63252
|
+
tags: [],
|
|
63253
|
+
'x-fern-sdk-group-name': [
|
|
63254
|
+
'seam',
|
|
63255
|
+
'customer',
|
|
63256
|
+
'v1',
|
|
63257
|
+
'customers',
|
|
63258
|
+
'automations',
|
|
63259
|
+
],
|
|
63260
|
+
'x-fern-sdk-method-name': 'get',
|
|
63261
|
+
'x-fern-sdk-return-value': 'automation',
|
|
63262
|
+
'x-response-key': 'automation',
|
|
63263
|
+
'x-title': 'Get Customer Automation Configuration',
|
|
63264
|
+
},
|
|
63265
|
+
post: {
|
|
63266
|
+
description:
|
|
63267
|
+
'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
63268
|
+
operationId: 'seamCustomerV1CustomersAutomationsGetPost',
|
|
63269
|
+
requestBody: {
|
|
63270
|
+
content: {
|
|
63271
|
+
'application/json': {
|
|
63272
|
+
schema: {
|
|
63273
|
+
properties: {
|
|
63274
|
+
customer_key: {
|
|
63275
|
+
description: 'Key of the customer.',
|
|
63276
|
+
type: 'string',
|
|
63277
|
+
},
|
|
63278
|
+
},
|
|
63279
|
+
required: ['customer_key'],
|
|
63280
|
+
type: 'object',
|
|
63281
|
+
},
|
|
63282
|
+
},
|
|
63283
|
+
},
|
|
63284
|
+
},
|
|
63285
|
+
responses: {
|
|
63286
|
+
200: {
|
|
63287
|
+
content: {
|
|
63288
|
+
'application/json': {
|
|
63289
|
+
schema: {
|
|
63290
|
+
properties: {
|
|
63291
|
+
automation: {
|
|
63292
|
+
properties: {
|
|
63293
|
+
access_rules: {
|
|
63294
|
+
properties: {
|
|
63295
|
+
reservation_created: {
|
|
63296
|
+
properties: {
|
|
63297
|
+
config: {
|
|
63298
|
+
properties: {
|
|
63299
|
+
access_methods: {
|
|
63300
|
+
items: {
|
|
63301
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
63302
|
+
type: 'string',
|
|
63303
|
+
},
|
|
63304
|
+
minItems: 1,
|
|
63305
|
+
type: 'array',
|
|
63306
|
+
},
|
|
63307
|
+
card_count_on_reservation_create: {
|
|
63308
|
+
minimum: 0,
|
|
63309
|
+
type: 'integer',
|
|
63310
|
+
},
|
|
63311
|
+
code_count_on_reservation_create: {
|
|
63312
|
+
minimum: 0,
|
|
63313
|
+
type: 'integer',
|
|
63314
|
+
},
|
|
63315
|
+
instant_key_max_use_count: {
|
|
63316
|
+
minimum: 1,
|
|
63317
|
+
type: 'integer',
|
|
63318
|
+
},
|
|
63319
|
+
method_issuance_strategy: {
|
|
63320
|
+
enum: [
|
|
63321
|
+
'first_available',
|
|
63322
|
+
'first_two_available',
|
|
63323
|
+
'all_available',
|
|
63324
|
+
],
|
|
63325
|
+
type: 'string',
|
|
63326
|
+
},
|
|
63327
|
+
},
|
|
63328
|
+
required: [
|
|
63329
|
+
'access_methods',
|
|
63330
|
+
'method_issuance_strategy',
|
|
63331
|
+
],
|
|
63332
|
+
type: 'object',
|
|
63333
|
+
},
|
|
63334
|
+
rule: {
|
|
63335
|
+
enum: ['reservation_created'],
|
|
63336
|
+
type: 'string',
|
|
63337
|
+
},
|
|
63338
|
+
},
|
|
63339
|
+
required: ['rule', 'config'],
|
|
63340
|
+
type: 'object',
|
|
63341
|
+
},
|
|
63342
|
+
reservation_deleted: {
|
|
63343
|
+
properties: {
|
|
63344
|
+
config: {
|
|
63345
|
+
$ref: '#/components/schemas/access_code',
|
|
63346
|
+
},
|
|
63347
|
+
rule: {
|
|
63348
|
+
enum: ['reservation_deleted'],
|
|
63349
|
+
type: 'string',
|
|
63350
|
+
},
|
|
63351
|
+
},
|
|
63352
|
+
required: ['rule'],
|
|
63353
|
+
type: 'object',
|
|
63354
|
+
},
|
|
63355
|
+
reservation_spaces_updated: {
|
|
63356
|
+
properties: {
|
|
63357
|
+
config: {
|
|
63358
|
+
$ref: '#/components/schemas/access_code',
|
|
63359
|
+
},
|
|
63360
|
+
rule: {
|
|
63361
|
+
enum: ['reservation_spaces_updated'],
|
|
63362
|
+
type: 'string',
|
|
63363
|
+
},
|
|
63364
|
+
},
|
|
63365
|
+
required: ['rule'],
|
|
63366
|
+
type: 'object',
|
|
63367
|
+
},
|
|
63368
|
+
reservation_time_updated: {
|
|
63369
|
+
properties: {
|
|
63370
|
+
config: {
|
|
63371
|
+
$ref: '#/components/schemas/access_code',
|
|
63372
|
+
},
|
|
63373
|
+
rule: {
|
|
63374
|
+
enum: ['reservation_time_updated'],
|
|
63375
|
+
type: 'string',
|
|
63376
|
+
},
|
|
63377
|
+
},
|
|
63378
|
+
required: ['rule'],
|
|
63379
|
+
type: 'object',
|
|
63380
|
+
},
|
|
63381
|
+
space_name_updated: {
|
|
63382
|
+
properties: {
|
|
63383
|
+
config: {
|
|
63384
|
+
$ref: '#/components/schemas/access_code',
|
|
63385
|
+
},
|
|
63386
|
+
rule: {
|
|
63387
|
+
enum: ['space_name_updated'],
|
|
63388
|
+
type: 'string',
|
|
63389
|
+
},
|
|
63390
|
+
},
|
|
63391
|
+
required: ['rule'],
|
|
63392
|
+
type: 'object',
|
|
63393
|
+
},
|
|
63394
|
+
staff_member_created: {
|
|
63395
|
+
properties: {
|
|
63396
|
+
config: {
|
|
63397
|
+
$ref: '#/components/schemas/access_code',
|
|
63398
|
+
},
|
|
63399
|
+
rule: {
|
|
63400
|
+
enum: ['staff_member_created'],
|
|
63401
|
+
type: 'string',
|
|
63402
|
+
},
|
|
63403
|
+
},
|
|
63404
|
+
required: ['rule', 'config'],
|
|
63405
|
+
type: 'object',
|
|
63406
|
+
},
|
|
63407
|
+
staff_member_name_updated: {
|
|
63408
|
+
properties: {
|
|
63409
|
+
config: {
|
|
63410
|
+
$ref: '#/components/schemas/access_code',
|
|
63411
|
+
},
|
|
63412
|
+
rule: {
|
|
63413
|
+
enum: ['staff_member_name_updated'],
|
|
63414
|
+
type: 'string',
|
|
63415
|
+
},
|
|
63416
|
+
},
|
|
63417
|
+
required: ['rule'],
|
|
63418
|
+
type: 'object',
|
|
63419
|
+
},
|
|
63420
|
+
user_identity_name_updated: {
|
|
63421
|
+
properties: {
|
|
63422
|
+
config: {
|
|
63423
|
+
$ref: '#/components/schemas/access_code',
|
|
63424
|
+
},
|
|
63425
|
+
rule: {
|
|
63426
|
+
enum: ['user_identity_name_updated'],
|
|
63427
|
+
type: 'string',
|
|
63428
|
+
},
|
|
63429
|
+
},
|
|
63430
|
+
required: ['rule'],
|
|
63431
|
+
type: 'object',
|
|
63432
|
+
},
|
|
63433
|
+
},
|
|
63434
|
+
type: 'object',
|
|
63435
|
+
},
|
|
63436
|
+
climate_rules: {
|
|
63437
|
+
properties: {
|
|
63438
|
+
rules: {
|
|
63439
|
+
properties: {
|
|
63440
|
+
reservation_created: {
|
|
63441
|
+
properties: {
|
|
63442
|
+
automated_occupied_preset: {
|
|
63443
|
+
properties: {
|
|
63444
|
+
cooling_set_point_celsius: {
|
|
63445
|
+
format: 'float',
|
|
63446
|
+
type: 'number',
|
|
63447
|
+
},
|
|
63448
|
+
cooling_set_point_fahrenheit: {
|
|
63449
|
+
format: 'float',
|
|
63450
|
+
type: 'number',
|
|
63451
|
+
},
|
|
63452
|
+
fan_mode: {
|
|
63453
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63454
|
+
type: 'string',
|
|
63455
|
+
},
|
|
63456
|
+
heating_set_point_celsius: {
|
|
63457
|
+
format: 'float',
|
|
63458
|
+
type: 'number',
|
|
63459
|
+
},
|
|
63460
|
+
heating_set_point_fahrenheit: {
|
|
63461
|
+
format: 'float',
|
|
63462
|
+
type: 'number',
|
|
63463
|
+
},
|
|
63464
|
+
is_override_allowed: {
|
|
63465
|
+
type: 'boolean',
|
|
63466
|
+
},
|
|
63467
|
+
max_override_period_minutes: {
|
|
63468
|
+
format: 'float',
|
|
63469
|
+
type: 'number',
|
|
63470
|
+
},
|
|
63471
|
+
mode: {
|
|
63472
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63473
|
+
type: 'string',
|
|
63474
|
+
},
|
|
63475
|
+
},
|
|
63476
|
+
required: [
|
|
63477
|
+
'mode',
|
|
63478
|
+
'fan_mode',
|
|
63479
|
+
'is_override_allowed',
|
|
63480
|
+
'max_override_period_minutes',
|
|
63481
|
+
],
|
|
63482
|
+
type: 'object',
|
|
63483
|
+
},
|
|
63484
|
+
automated_unoccupied_preset: {
|
|
63485
|
+
properties: {
|
|
63486
|
+
cooling_set_point_celsius: {
|
|
63487
|
+
format: 'float',
|
|
63488
|
+
type: 'number',
|
|
63489
|
+
},
|
|
63490
|
+
cooling_set_point_fahrenheit: {
|
|
63491
|
+
format: 'float',
|
|
63492
|
+
type: 'number',
|
|
63493
|
+
},
|
|
63494
|
+
fan_mode: {
|
|
63495
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63496
|
+
type: 'string',
|
|
63497
|
+
},
|
|
63498
|
+
heating_set_point_celsius: {
|
|
63499
|
+
format: 'float',
|
|
63500
|
+
type: 'number',
|
|
63501
|
+
},
|
|
63502
|
+
heating_set_point_fahrenheit: {
|
|
63503
|
+
format: 'float',
|
|
63504
|
+
type: 'number',
|
|
63505
|
+
},
|
|
63506
|
+
is_override_allowed: {
|
|
63507
|
+
type: 'boolean',
|
|
63508
|
+
},
|
|
63509
|
+
max_override_period_minutes: {
|
|
63510
|
+
format: 'float',
|
|
63511
|
+
type: 'number',
|
|
63512
|
+
},
|
|
63513
|
+
mode: {
|
|
63514
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63515
|
+
type: 'string',
|
|
63516
|
+
},
|
|
63517
|
+
},
|
|
63518
|
+
required: [
|
|
63519
|
+
'mode',
|
|
63520
|
+
'fan_mode',
|
|
63521
|
+
'is_override_allowed',
|
|
63522
|
+
'max_override_period_minutes',
|
|
63523
|
+
],
|
|
63524
|
+
type: 'object',
|
|
63525
|
+
},
|
|
63526
|
+
occupied_preset_key: { type: 'string' },
|
|
63527
|
+
precondition_minutes_before_reservation: {
|
|
63528
|
+
format: 'float',
|
|
63529
|
+
type: 'number',
|
|
63530
|
+
},
|
|
63531
|
+
unoccupied_preset_key: { type: 'string' },
|
|
63532
|
+
},
|
|
63533
|
+
type: 'object',
|
|
63534
|
+
},
|
|
63535
|
+
reservation_deleted: {
|
|
63536
|
+
$ref: '#/components/schemas/access_code',
|
|
63537
|
+
},
|
|
63538
|
+
reservation_time_updated: {
|
|
63539
|
+
$ref: '#/components/schemas/access_code',
|
|
63540
|
+
},
|
|
63541
|
+
},
|
|
63542
|
+
type: 'object',
|
|
63543
|
+
},
|
|
63544
|
+
},
|
|
63545
|
+
required: ['rules'],
|
|
63546
|
+
type: 'object',
|
|
63547
|
+
},
|
|
63548
|
+
},
|
|
63549
|
+
type: 'object',
|
|
63550
|
+
},
|
|
63551
|
+
ok: { type: 'boolean' },
|
|
63552
|
+
},
|
|
63553
|
+
required: ['automation', 'ok'],
|
|
63554
|
+
type: 'object',
|
|
63555
|
+
},
|
|
63556
|
+
},
|
|
63557
|
+
},
|
|
63558
|
+
description: 'OK',
|
|
63559
|
+
},
|
|
63560
|
+
400: { description: 'Bad Request' },
|
|
63561
|
+
401: { description: 'Unauthorized' },
|
|
63562
|
+
},
|
|
63563
|
+
security: [
|
|
63564
|
+
{ pat_with_workspace: [] },
|
|
63565
|
+
{ console_session_with_workspace: [] },
|
|
63566
|
+
{ api_key: [] },
|
|
63567
|
+
],
|
|
63568
|
+
summary: '/seam/customer/v1/customers/automations/get',
|
|
63569
|
+
tags: [],
|
|
63570
|
+
'x-fern-sdk-group-name': [
|
|
63571
|
+
'seam',
|
|
63572
|
+
'customer',
|
|
63573
|
+
'v1',
|
|
63574
|
+
'customers',
|
|
63575
|
+
'automations',
|
|
63576
|
+
],
|
|
63577
|
+
'x-fern-sdk-method-name': 'get',
|
|
63578
|
+
'x-fern-sdk-return-value': 'automation',
|
|
63579
|
+
'x-response-key': 'automation',
|
|
63580
|
+
'x-title': 'Get Customer Automation Configuration',
|
|
63581
|
+
},
|
|
63582
|
+
},
|
|
63583
|
+
'/seam/customer/v1/customers/automations/update': {
|
|
63584
|
+
patch: {
|
|
63585
|
+
description:
|
|
63586
|
+
'Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.',
|
|
63587
|
+
operationId: 'seamCustomerV1CustomersAutomationsUpdatePatch',
|
|
63588
|
+
requestBody: {
|
|
63589
|
+
content: {
|
|
63590
|
+
'application/json': {
|
|
63591
|
+
schema: {
|
|
63592
|
+
properties: {
|
|
63593
|
+
access_rules: {
|
|
63594
|
+
description: 'Access automation rules configuration.',
|
|
63595
|
+
properties: {
|
|
63596
|
+
reservation_created: {
|
|
63597
|
+
properties: {
|
|
63598
|
+
config: {
|
|
63599
|
+
properties: {
|
|
63600
|
+
access_methods: {
|
|
63601
|
+
items: {
|
|
63602
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
63603
|
+
type: 'string',
|
|
63604
|
+
},
|
|
63605
|
+
minItems: 1,
|
|
63606
|
+
type: 'array',
|
|
63607
|
+
},
|
|
63608
|
+
card_count_on_reservation_create: {
|
|
63609
|
+
minimum: 0,
|
|
63610
|
+
type: 'integer',
|
|
63611
|
+
},
|
|
63612
|
+
code_count_on_reservation_create: {
|
|
63613
|
+
minimum: 0,
|
|
63614
|
+
type: 'integer',
|
|
63615
|
+
},
|
|
63616
|
+
instant_key_max_use_count: {
|
|
63617
|
+
minimum: 1,
|
|
63618
|
+
type: 'integer',
|
|
63619
|
+
},
|
|
63620
|
+
method_issuance_strategy: {
|
|
63621
|
+
enum: [
|
|
63622
|
+
'first_available',
|
|
63623
|
+
'first_two_available',
|
|
63624
|
+
'all_available',
|
|
63625
|
+
],
|
|
63626
|
+
type: 'string',
|
|
63627
|
+
},
|
|
63628
|
+
},
|
|
63629
|
+
required: [
|
|
63630
|
+
'access_methods',
|
|
63631
|
+
'method_issuance_strategy',
|
|
63632
|
+
],
|
|
63633
|
+
type: 'object',
|
|
63634
|
+
},
|
|
63635
|
+
rule: {
|
|
63636
|
+
enum: ['reservation_created'],
|
|
63637
|
+
type: 'string',
|
|
63638
|
+
},
|
|
63639
|
+
},
|
|
63640
|
+
required: ['rule', 'config'],
|
|
63641
|
+
type: 'object',
|
|
63642
|
+
},
|
|
63643
|
+
reservation_deleted: {
|
|
63644
|
+
properties: {
|
|
63645
|
+
config: { properties: {}, type: 'object' },
|
|
63646
|
+
rule: {
|
|
63647
|
+
enum: ['reservation_deleted'],
|
|
63648
|
+
type: 'string',
|
|
63649
|
+
},
|
|
63650
|
+
},
|
|
63651
|
+
required: ['rule'],
|
|
63652
|
+
type: 'object',
|
|
63653
|
+
},
|
|
63654
|
+
reservation_spaces_updated: {
|
|
63655
|
+
properties: {
|
|
63656
|
+
config: { properties: {}, type: 'object' },
|
|
63657
|
+
rule: {
|
|
63658
|
+
enum: ['reservation_spaces_updated'],
|
|
63659
|
+
type: 'string',
|
|
63660
|
+
},
|
|
63661
|
+
},
|
|
63662
|
+
required: ['rule'],
|
|
63663
|
+
type: 'object',
|
|
63664
|
+
},
|
|
63665
|
+
reservation_time_updated: {
|
|
63666
|
+
properties: {
|
|
63667
|
+
config: { properties: {}, type: 'object' },
|
|
63668
|
+
rule: {
|
|
63669
|
+
enum: ['reservation_time_updated'],
|
|
63670
|
+
type: 'string',
|
|
63671
|
+
},
|
|
63672
|
+
},
|
|
63673
|
+
required: ['rule'],
|
|
63674
|
+
type: 'object',
|
|
63675
|
+
},
|
|
63676
|
+
space_name_updated: {
|
|
63677
|
+
properties: {
|
|
63678
|
+
config: { properties: {}, type: 'object' },
|
|
63679
|
+
rule: {
|
|
63680
|
+
enum: ['space_name_updated'],
|
|
63681
|
+
type: 'string',
|
|
63682
|
+
},
|
|
63683
|
+
},
|
|
63684
|
+
required: ['rule'],
|
|
63685
|
+
type: 'object',
|
|
63686
|
+
},
|
|
63687
|
+
staff_member_created: {
|
|
63688
|
+
properties: {
|
|
63689
|
+
config: { properties: {}, type: 'object' },
|
|
63690
|
+
rule: {
|
|
63691
|
+
enum: ['staff_member_created'],
|
|
63692
|
+
type: 'string',
|
|
63693
|
+
},
|
|
63694
|
+
},
|
|
63695
|
+
required: ['rule', 'config'],
|
|
63696
|
+
type: 'object',
|
|
63697
|
+
},
|
|
63698
|
+
staff_member_name_updated: {
|
|
63699
|
+
properties: {
|
|
63700
|
+
config: { properties: {}, type: 'object' },
|
|
63701
|
+
rule: {
|
|
63702
|
+
enum: ['staff_member_name_updated'],
|
|
63703
|
+
type: 'string',
|
|
63704
|
+
},
|
|
63705
|
+
},
|
|
63706
|
+
required: ['rule'],
|
|
63707
|
+
type: 'object',
|
|
63708
|
+
},
|
|
63709
|
+
user_identity_name_updated: {
|
|
63710
|
+
properties: {
|
|
63711
|
+
config: { properties: {}, type: 'object' },
|
|
63712
|
+
rule: {
|
|
63713
|
+
enum: ['user_identity_name_updated'],
|
|
63714
|
+
type: 'string',
|
|
63715
|
+
},
|
|
63716
|
+
},
|
|
63717
|
+
required: ['rule'],
|
|
63718
|
+
type: 'object',
|
|
63719
|
+
},
|
|
63720
|
+
},
|
|
63721
|
+
type: 'object',
|
|
63722
|
+
},
|
|
63723
|
+
climate_rules: {
|
|
63724
|
+
description: 'Climate automation rules configuration.',
|
|
63725
|
+
properties: {
|
|
63726
|
+
rules: {
|
|
63727
|
+
properties: {
|
|
63728
|
+
reservation_created: {
|
|
63729
|
+
properties: {
|
|
63730
|
+
automated_occupied_preset: {
|
|
63731
|
+
properties: {
|
|
63732
|
+
cooling_set_point_celsius: {
|
|
63733
|
+
format: 'float',
|
|
63734
|
+
type: 'number',
|
|
63735
|
+
},
|
|
63736
|
+
cooling_set_point_fahrenheit: {
|
|
63737
|
+
format: 'float',
|
|
63738
|
+
type: 'number',
|
|
63739
|
+
},
|
|
63740
|
+
fan_mode: {
|
|
63741
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63742
|
+
type: 'string',
|
|
63743
|
+
},
|
|
63744
|
+
heating_set_point_celsius: {
|
|
63745
|
+
format: 'float',
|
|
63746
|
+
type: 'number',
|
|
63747
|
+
},
|
|
63748
|
+
heating_set_point_fahrenheit: {
|
|
63749
|
+
format: 'float',
|
|
63750
|
+
type: 'number',
|
|
63751
|
+
},
|
|
63752
|
+
is_override_allowed: { type: 'boolean' },
|
|
63753
|
+
max_override_period_minutes: {
|
|
63754
|
+
format: 'float',
|
|
63755
|
+
type: 'number',
|
|
63756
|
+
},
|
|
63757
|
+
mode: {
|
|
63758
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63759
|
+
type: 'string',
|
|
63760
|
+
},
|
|
63761
|
+
},
|
|
63762
|
+
required: [
|
|
63763
|
+
'mode',
|
|
63764
|
+
'fan_mode',
|
|
63765
|
+
'is_override_allowed',
|
|
63766
|
+
'max_override_period_minutes',
|
|
63767
|
+
],
|
|
63768
|
+
type: 'object',
|
|
63769
|
+
},
|
|
63770
|
+
automated_unoccupied_preset: {
|
|
63771
|
+
properties: {
|
|
63772
|
+
cooling_set_point_celsius: {
|
|
63773
|
+
format: 'float',
|
|
63774
|
+
type: 'number',
|
|
63775
|
+
},
|
|
63776
|
+
cooling_set_point_fahrenheit: {
|
|
63777
|
+
format: 'float',
|
|
63778
|
+
type: 'number',
|
|
63779
|
+
},
|
|
63780
|
+
fan_mode: {
|
|
63781
|
+
enum: ['on', 'auto', 'circulate'],
|
|
63782
|
+
type: 'string',
|
|
63783
|
+
},
|
|
63784
|
+
heating_set_point_celsius: {
|
|
63785
|
+
format: 'float',
|
|
63786
|
+
type: 'number',
|
|
63787
|
+
},
|
|
63788
|
+
heating_set_point_fahrenheit: {
|
|
63789
|
+
format: 'float',
|
|
63790
|
+
type: 'number',
|
|
63791
|
+
},
|
|
63792
|
+
is_override_allowed: { type: 'boolean' },
|
|
63793
|
+
max_override_period_minutes: {
|
|
63794
|
+
format: 'float',
|
|
63795
|
+
type: 'number',
|
|
63796
|
+
},
|
|
63797
|
+
mode: {
|
|
63798
|
+
enum: ['heat', 'cool', 'auto'],
|
|
63799
|
+
type: 'string',
|
|
63800
|
+
},
|
|
63801
|
+
},
|
|
63802
|
+
required: [
|
|
63803
|
+
'mode',
|
|
63804
|
+
'fan_mode',
|
|
63805
|
+
'is_override_allowed',
|
|
63806
|
+
'max_override_period_minutes',
|
|
63807
|
+
],
|
|
63808
|
+
type: 'object',
|
|
63809
|
+
},
|
|
63810
|
+
occupied_preset_key: { type: 'string' },
|
|
63811
|
+
precondition_minutes_before_reservation: {
|
|
63812
|
+
format: 'float',
|
|
63813
|
+
type: 'number',
|
|
63814
|
+
},
|
|
63815
|
+
unoccupied_preset_key: { type: 'string' },
|
|
63816
|
+
},
|
|
63817
|
+
type: 'object',
|
|
63818
|
+
},
|
|
63819
|
+
reservation_deleted: {
|
|
63820
|
+
properties: {},
|
|
63821
|
+
type: 'object',
|
|
63822
|
+
},
|
|
63823
|
+
reservation_time_updated: {
|
|
63824
|
+
properties: {},
|
|
63825
|
+
type: 'object',
|
|
63826
|
+
},
|
|
63827
|
+
},
|
|
63828
|
+
type: 'object',
|
|
63829
|
+
},
|
|
63830
|
+
},
|
|
63831
|
+
type: 'object',
|
|
63832
|
+
},
|
|
63833
|
+
customer_key: {
|
|
63834
|
+
description: 'Key of the customer.',
|
|
63835
|
+
type: 'string',
|
|
63836
|
+
},
|
|
63837
|
+
},
|
|
63838
|
+
required: ['customer_key'],
|
|
63839
|
+
type: 'object',
|
|
63840
|
+
},
|
|
63841
|
+
},
|
|
63842
|
+
},
|
|
63843
|
+
},
|
|
63844
|
+
responses: {
|
|
63845
|
+
200: {
|
|
63846
|
+
content: {
|
|
63847
|
+
'application/json': {
|
|
63848
|
+
schema: {
|
|
63849
|
+
properties: { ok: { type: 'boolean' } },
|
|
63850
|
+
required: ['ok'],
|
|
63851
|
+
type: 'object',
|
|
63852
|
+
},
|
|
63853
|
+
},
|
|
63854
|
+
},
|
|
63855
|
+
description: 'OK',
|
|
63856
|
+
},
|
|
63857
|
+
400: { description: 'Bad Request' },
|
|
63858
|
+
401: { description: 'Unauthorized' },
|
|
63859
|
+
},
|
|
63860
|
+
security: [
|
|
63861
|
+
{ pat_with_workspace: [] },
|
|
63862
|
+
{ console_session_with_workspace: [] },
|
|
63863
|
+
{ api_key: [] },
|
|
63864
|
+
],
|
|
63865
|
+
summary: '/seam/customer/v1/customers/automations/update',
|
|
63866
|
+
tags: [],
|
|
63867
|
+
'x-fern-sdk-group-name': [
|
|
63868
|
+
'seam',
|
|
63869
|
+
'customer',
|
|
63870
|
+
'v1',
|
|
63871
|
+
'customers',
|
|
63872
|
+
'automations',
|
|
63873
|
+
],
|
|
63874
|
+
'x-fern-sdk-method-name': 'update',
|
|
63875
|
+
'x-response-key': null,
|
|
63876
|
+
'x-title': 'Update Customer Automation Configuration',
|
|
63877
|
+
},
|
|
63878
|
+
post: {
|
|
63879
|
+
description:
|
|
63880
|
+
'Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.',
|
|
63881
|
+
operationId: 'seamCustomerV1CustomersAutomationsUpdatePost',
|
|
63882
|
+
requestBody: {
|
|
63883
|
+
content: {
|
|
63884
|
+
'application/json': {
|
|
63885
|
+
schema: {
|
|
63886
|
+
properties: {
|
|
63887
|
+
access_rules: {
|
|
63888
|
+
description: 'Access automation rules configuration.',
|
|
63889
|
+
properties: {
|
|
63890
|
+
reservation_created: {
|
|
63891
|
+
properties: {
|
|
63892
|
+
config: {
|
|
63893
|
+
properties: {
|
|
63894
|
+
access_methods: {
|
|
63895
|
+
items: {
|
|
63896
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
63897
|
+
type: 'string',
|
|
63898
|
+
},
|
|
63899
|
+
minItems: 1,
|
|
63900
|
+
type: 'array',
|
|
63901
|
+
},
|
|
63902
|
+
card_count_on_reservation_create: {
|
|
63903
|
+
minimum: 0,
|
|
63904
|
+
type: 'integer',
|
|
63905
|
+
},
|
|
63906
|
+
code_count_on_reservation_create: {
|
|
63907
|
+
minimum: 0,
|
|
63908
|
+
type: 'integer',
|
|
63909
|
+
},
|
|
63910
|
+
instant_key_max_use_count: {
|
|
63911
|
+
minimum: 1,
|
|
63912
|
+
type: 'integer',
|
|
63913
|
+
},
|
|
63914
|
+
method_issuance_strategy: {
|
|
63915
|
+
enum: [
|
|
63916
|
+
'first_available',
|
|
63917
|
+
'first_two_available',
|
|
63918
|
+
'all_available',
|
|
63919
|
+
],
|
|
63920
|
+
type: 'string',
|
|
63921
|
+
},
|
|
63922
|
+
},
|
|
63923
|
+
required: [
|
|
63924
|
+
'access_methods',
|
|
63925
|
+
'method_issuance_strategy',
|
|
63926
|
+
],
|
|
63927
|
+
type: 'object',
|
|
63928
|
+
},
|
|
63929
|
+
rule: {
|
|
63930
|
+
enum: ['reservation_created'],
|
|
63931
|
+
type: 'string',
|
|
63932
|
+
},
|
|
63933
|
+
},
|
|
63934
|
+
required: ['rule', 'config'],
|
|
63935
|
+
type: 'object',
|
|
63936
|
+
},
|
|
63937
|
+
reservation_deleted: {
|
|
63938
|
+
properties: {
|
|
63939
|
+
config: { properties: {}, type: 'object' },
|
|
63940
|
+
rule: {
|
|
63941
|
+
enum: ['reservation_deleted'],
|
|
63942
|
+
type: 'string',
|
|
63943
|
+
},
|
|
63944
|
+
},
|
|
63945
|
+
required: ['rule'],
|
|
63946
|
+
type: 'object',
|
|
63947
|
+
},
|
|
63948
|
+
reservation_spaces_updated: {
|
|
63949
|
+
properties: {
|
|
63950
|
+
config: { properties: {}, type: 'object' },
|
|
63951
|
+
rule: {
|
|
63952
|
+
enum: ['reservation_spaces_updated'],
|
|
63953
|
+
type: 'string',
|
|
63954
|
+
},
|
|
63955
|
+
},
|
|
63956
|
+
required: ['rule'],
|
|
63957
|
+
type: 'object',
|
|
63958
|
+
},
|
|
63959
|
+
reservation_time_updated: {
|
|
63960
|
+
properties: {
|
|
63961
|
+
config: { properties: {}, type: 'object' },
|
|
63962
|
+
rule: {
|
|
63963
|
+
enum: ['reservation_time_updated'],
|
|
63964
|
+
type: 'string',
|
|
63965
|
+
},
|
|
63966
|
+
},
|
|
63967
|
+
required: ['rule'],
|
|
63968
|
+
type: 'object',
|
|
63969
|
+
},
|
|
63970
|
+
space_name_updated: {
|
|
63971
|
+
properties: {
|
|
63972
|
+
config: { properties: {}, type: 'object' },
|
|
63973
|
+
rule: {
|
|
63974
|
+
enum: ['space_name_updated'],
|
|
63975
|
+
type: 'string',
|
|
63976
|
+
},
|
|
63977
|
+
},
|
|
63978
|
+
required: ['rule'],
|
|
63979
|
+
type: 'object',
|
|
63980
|
+
},
|
|
63981
|
+
staff_member_created: {
|
|
63982
|
+
properties: {
|
|
63983
|
+
config: { properties: {}, type: 'object' },
|
|
63984
|
+
rule: {
|
|
63985
|
+
enum: ['staff_member_created'],
|
|
63986
|
+
type: 'string',
|
|
63987
|
+
},
|
|
63988
|
+
},
|
|
63989
|
+
required: ['rule', 'config'],
|
|
63990
|
+
type: 'object',
|
|
63991
|
+
},
|
|
63992
|
+
staff_member_name_updated: {
|
|
63993
|
+
properties: {
|
|
63994
|
+
config: { properties: {}, type: 'object' },
|
|
63995
|
+
rule: {
|
|
63996
|
+
enum: ['staff_member_name_updated'],
|
|
63997
|
+
type: 'string',
|
|
63998
|
+
},
|
|
63999
|
+
},
|
|
64000
|
+
required: ['rule'],
|
|
64001
|
+
type: 'object',
|
|
64002
|
+
},
|
|
64003
|
+
user_identity_name_updated: {
|
|
64004
|
+
properties: {
|
|
64005
|
+
config: { properties: {}, type: 'object' },
|
|
64006
|
+
rule: {
|
|
64007
|
+
enum: ['user_identity_name_updated'],
|
|
64008
|
+
type: 'string',
|
|
64009
|
+
},
|
|
64010
|
+
},
|
|
64011
|
+
required: ['rule'],
|
|
64012
|
+
type: 'object',
|
|
64013
|
+
},
|
|
64014
|
+
},
|
|
64015
|
+
type: 'object',
|
|
64016
|
+
},
|
|
64017
|
+
climate_rules: {
|
|
64018
|
+
description: 'Climate automation rules configuration.',
|
|
64019
|
+
properties: {
|
|
64020
|
+
rules: {
|
|
64021
|
+
properties: {
|
|
64022
|
+
reservation_created: {
|
|
64023
|
+
properties: {
|
|
64024
|
+
automated_occupied_preset: {
|
|
64025
|
+
properties: {
|
|
64026
|
+
cooling_set_point_celsius: {
|
|
64027
|
+
format: 'float',
|
|
64028
|
+
type: 'number',
|
|
64029
|
+
},
|
|
64030
|
+
cooling_set_point_fahrenheit: {
|
|
64031
|
+
format: 'float',
|
|
64032
|
+
type: 'number',
|
|
64033
|
+
},
|
|
64034
|
+
fan_mode: {
|
|
64035
|
+
enum: ['on', 'auto', 'circulate'],
|
|
64036
|
+
type: 'string',
|
|
64037
|
+
},
|
|
64038
|
+
heating_set_point_celsius: {
|
|
64039
|
+
format: 'float',
|
|
64040
|
+
type: 'number',
|
|
64041
|
+
},
|
|
64042
|
+
heating_set_point_fahrenheit: {
|
|
64043
|
+
format: 'float',
|
|
64044
|
+
type: 'number',
|
|
64045
|
+
},
|
|
64046
|
+
is_override_allowed: { type: 'boolean' },
|
|
64047
|
+
max_override_period_minutes: {
|
|
64048
|
+
format: 'float',
|
|
64049
|
+
type: 'number',
|
|
64050
|
+
},
|
|
64051
|
+
mode: {
|
|
64052
|
+
enum: ['heat', 'cool', 'auto'],
|
|
64053
|
+
type: 'string',
|
|
64054
|
+
},
|
|
64055
|
+
},
|
|
64056
|
+
required: [
|
|
64057
|
+
'mode',
|
|
64058
|
+
'fan_mode',
|
|
64059
|
+
'is_override_allowed',
|
|
64060
|
+
'max_override_period_minutes',
|
|
64061
|
+
],
|
|
64062
|
+
type: 'object',
|
|
64063
|
+
},
|
|
64064
|
+
automated_unoccupied_preset: {
|
|
64065
|
+
properties: {
|
|
64066
|
+
cooling_set_point_celsius: {
|
|
64067
|
+
format: 'float',
|
|
64068
|
+
type: 'number',
|
|
64069
|
+
},
|
|
64070
|
+
cooling_set_point_fahrenheit: {
|
|
64071
|
+
format: 'float',
|
|
64072
|
+
type: 'number',
|
|
64073
|
+
},
|
|
64074
|
+
fan_mode: {
|
|
64075
|
+
enum: ['on', 'auto', 'circulate'],
|
|
64076
|
+
type: 'string',
|
|
64077
|
+
},
|
|
64078
|
+
heating_set_point_celsius: {
|
|
64079
|
+
format: 'float',
|
|
64080
|
+
type: 'number',
|
|
64081
|
+
},
|
|
64082
|
+
heating_set_point_fahrenheit: {
|
|
64083
|
+
format: 'float',
|
|
64084
|
+
type: 'number',
|
|
64085
|
+
},
|
|
64086
|
+
is_override_allowed: { type: 'boolean' },
|
|
64087
|
+
max_override_period_minutes: {
|
|
64088
|
+
format: 'float',
|
|
64089
|
+
type: 'number',
|
|
64090
|
+
},
|
|
64091
|
+
mode: {
|
|
64092
|
+
enum: ['heat', 'cool', 'auto'],
|
|
64093
|
+
type: 'string',
|
|
64094
|
+
},
|
|
64095
|
+
},
|
|
64096
|
+
required: [
|
|
64097
|
+
'mode',
|
|
64098
|
+
'fan_mode',
|
|
64099
|
+
'is_override_allowed',
|
|
64100
|
+
'max_override_period_minutes',
|
|
64101
|
+
],
|
|
64102
|
+
type: 'object',
|
|
64103
|
+
},
|
|
64104
|
+
occupied_preset_key: { type: 'string' },
|
|
64105
|
+
precondition_minutes_before_reservation: {
|
|
64106
|
+
format: 'float',
|
|
64107
|
+
type: 'number',
|
|
64108
|
+
},
|
|
64109
|
+
unoccupied_preset_key: { type: 'string' },
|
|
64110
|
+
},
|
|
64111
|
+
type: 'object',
|
|
64112
|
+
},
|
|
64113
|
+
reservation_deleted: {
|
|
64114
|
+
properties: {},
|
|
64115
|
+
type: 'object',
|
|
64116
|
+
},
|
|
64117
|
+
reservation_time_updated: {
|
|
64118
|
+
properties: {},
|
|
64119
|
+
type: 'object',
|
|
64120
|
+
},
|
|
64121
|
+
},
|
|
64122
|
+
type: 'object',
|
|
64123
|
+
},
|
|
64124
|
+
},
|
|
64125
|
+
type: 'object',
|
|
64126
|
+
},
|
|
64127
|
+
customer_key: {
|
|
64128
|
+
description: 'Key of the customer.',
|
|
64129
|
+
type: 'string',
|
|
64130
|
+
},
|
|
64131
|
+
},
|
|
64132
|
+
required: ['customer_key'],
|
|
64133
|
+
type: 'object',
|
|
64134
|
+
},
|
|
64135
|
+
},
|
|
64136
|
+
},
|
|
64137
|
+
},
|
|
64138
|
+
responses: {
|
|
64139
|
+
200: {
|
|
64140
|
+
content: {
|
|
64141
|
+
'application/json': {
|
|
64142
|
+
schema: {
|
|
64143
|
+
properties: { ok: { type: 'boolean' } },
|
|
64144
|
+
required: ['ok'],
|
|
64145
|
+
type: 'object',
|
|
64146
|
+
},
|
|
64147
|
+
},
|
|
64148
|
+
},
|
|
64149
|
+
description: 'OK',
|
|
64150
|
+
},
|
|
64151
|
+
400: { description: 'Bad Request' },
|
|
64152
|
+
401: { description: 'Unauthorized' },
|
|
64153
|
+
},
|
|
64154
|
+
security: [
|
|
64155
|
+
{ pat_with_workspace: [] },
|
|
64156
|
+
{ console_session_with_workspace: [] },
|
|
64157
|
+
{ api_key: [] },
|
|
64158
|
+
],
|
|
64159
|
+
summary: '/seam/customer/v1/customers/automations/update',
|
|
64160
|
+
tags: [],
|
|
64161
|
+
'x-fern-sdk-group-name': [
|
|
64162
|
+
'seam',
|
|
64163
|
+
'customer',
|
|
64164
|
+
'v1',
|
|
64165
|
+
'customers',
|
|
64166
|
+
'automations',
|
|
64167
|
+
],
|
|
64168
|
+
'x-fern-sdk-method-name': 'update',
|
|
64169
|
+
'x-response-key': null,
|
|
64170
|
+
'x-title': 'Update Customer Automation Configuration',
|
|
64171
|
+
},
|
|
64172
|
+
},
|
|
62787
64173
|
'/seam/customer/v1/customers/list': {
|
|
62788
64174
|
get: {
|
|
62789
64175
|
description: 'Returns a list of all customers within the workspace.',
|