@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
|
@@ -2690,6 +2690,43 @@ export default {
|
|
|
2690
2690
|
],
|
|
2691
2691
|
type: 'object',
|
|
2692
2692
|
},
|
|
2693
|
+
{
|
|
2694
|
+
description: 'A scheduled user membership change is pending for this access group.',
|
|
2695
|
+
properties: {
|
|
2696
|
+
acs_user_id: {
|
|
2697
|
+
description: 'ID of the user involved in the scheduled change.',
|
|
2698
|
+
format: 'uuid',
|
|
2699
|
+
type: 'string',
|
|
2700
|
+
},
|
|
2701
|
+
created_at: {
|
|
2702
|
+
description: 'Date and time at which the mutation was created.',
|
|
2703
|
+
format: 'date-time',
|
|
2704
|
+
type: 'string',
|
|
2705
|
+
},
|
|
2706
|
+
message: {
|
|
2707
|
+
description: 'Detailed description of the mutation.',
|
|
2708
|
+
type: 'string',
|
|
2709
|
+
},
|
|
2710
|
+
mutation_code: {
|
|
2711
|
+
description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
2712
|
+
enum: ['deferring_user_membership_update'],
|
|
2713
|
+
type: 'string',
|
|
2714
|
+
},
|
|
2715
|
+
variant: {
|
|
2716
|
+
description: 'Whether the user is scheduled to be added to or removed from this access group.',
|
|
2717
|
+
enum: ['adding', 'removing'],
|
|
2718
|
+
type: 'string',
|
|
2719
|
+
},
|
|
2720
|
+
},
|
|
2721
|
+
required: [
|
|
2722
|
+
'created_at',
|
|
2723
|
+
'message',
|
|
2724
|
+
'mutation_code',
|
|
2725
|
+
'acs_user_id',
|
|
2726
|
+
'variant',
|
|
2727
|
+
],
|
|
2728
|
+
type: 'object',
|
|
2729
|
+
},
|
|
2693
2730
|
],
|
|
2694
2731
|
},
|
|
2695
2732
|
type: 'array',
|
|
@@ -4455,6 +4492,43 @@ export default {
|
|
|
4455
4492
|
],
|
|
4456
4493
|
type: 'object',
|
|
4457
4494
|
},
|
|
4495
|
+
{
|
|
4496
|
+
description: 'A scheduled access group membership change is pending for this user.',
|
|
4497
|
+
properties: {
|
|
4498
|
+
acs_access_group_id: {
|
|
4499
|
+
description: 'ID of the access group involved in the scheduled change.',
|
|
4500
|
+
format: 'uuid',
|
|
4501
|
+
type: 'string',
|
|
4502
|
+
},
|
|
4503
|
+
created_at: {
|
|
4504
|
+
description: 'Date and time at which the mutation was created.',
|
|
4505
|
+
format: 'date-time',
|
|
4506
|
+
type: 'string',
|
|
4507
|
+
},
|
|
4508
|
+
message: {
|
|
4509
|
+
description: 'Detailed description of the mutation.',
|
|
4510
|
+
type: 'string',
|
|
4511
|
+
},
|
|
4512
|
+
mutation_code: {
|
|
4513
|
+
description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
4514
|
+
enum: ['deferring_group_membership_update'],
|
|
4515
|
+
type: 'string',
|
|
4516
|
+
},
|
|
4517
|
+
variant: {
|
|
4518
|
+
description: 'Whether the user is scheduled to be added to or removed from the access group.',
|
|
4519
|
+
enum: ['adding', 'removing'],
|
|
4520
|
+
type: 'string',
|
|
4521
|
+
},
|
|
4522
|
+
},
|
|
4523
|
+
required: [
|
|
4524
|
+
'created_at',
|
|
4525
|
+
'message',
|
|
4526
|
+
'mutation_code',
|
|
4527
|
+
'acs_access_group_id',
|
|
4528
|
+
'variant',
|
|
4529
|
+
],
|
|
4530
|
+
type: 'object',
|
|
4531
|
+
},
|
|
4458
4532
|
],
|
|
4459
4533
|
},
|
|
4460
4534
|
type: 'array',
|
|
@@ -24355,6 +24429,43 @@ export default {
|
|
|
24355
24429
|
],
|
|
24356
24430
|
type: 'object',
|
|
24357
24431
|
},
|
|
24432
|
+
{
|
|
24433
|
+
description: 'A scheduled user membership change is pending for this access group.',
|
|
24434
|
+
properties: {
|
|
24435
|
+
acs_user_id: {
|
|
24436
|
+
description: 'ID of the user involved in the scheduled change.',
|
|
24437
|
+
format: 'uuid',
|
|
24438
|
+
type: 'string',
|
|
24439
|
+
},
|
|
24440
|
+
created_at: {
|
|
24441
|
+
description: 'Date and time at which the mutation was created.',
|
|
24442
|
+
format: 'date-time',
|
|
24443
|
+
type: 'string',
|
|
24444
|
+
},
|
|
24445
|
+
message: {
|
|
24446
|
+
description: 'Detailed description of the mutation.',
|
|
24447
|
+
type: 'string',
|
|
24448
|
+
},
|
|
24449
|
+
mutation_code: {
|
|
24450
|
+
description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
24451
|
+
enum: ['deferring_user_membership_update'],
|
|
24452
|
+
type: 'string',
|
|
24453
|
+
},
|
|
24454
|
+
variant: {
|
|
24455
|
+
description: 'Whether the user is scheduled to be added to or removed from this access group.',
|
|
24456
|
+
enum: ['adding', 'removing'],
|
|
24457
|
+
type: 'string',
|
|
24458
|
+
},
|
|
24459
|
+
},
|
|
24460
|
+
required: [
|
|
24461
|
+
'created_at',
|
|
24462
|
+
'message',
|
|
24463
|
+
'mutation_code',
|
|
24464
|
+
'acs_user_id',
|
|
24465
|
+
'variant',
|
|
24466
|
+
],
|
|
24467
|
+
type: 'object',
|
|
24468
|
+
},
|
|
24358
24469
|
],
|
|
24359
24470
|
},
|
|
24360
24471
|
type: 'array',
|
|
@@ -25320,6 +25431,43 @@ export default {
|
|
|
25320
25431
|
],
|
|
25321
25432
|
type: 'object',
|
|
25322
25433
|
},
|
|
25434
|
+
{
|
|
25435
|
+
description: 'A scheduled access group membership change is pending for this user.',
|
|
25436
|
+
properties: {
|
|
25437
|
+
acs_access_group_id: {
|
|
25438
|
+
description: 'ID of the access group involved in the scheduled change.',
|
|
25439
|
+
format: 'uuid',
|
|
25440
|
+
type: 'string',
|
|
25441
|
+
},
|
|
25442
|
+
created_at: {
|
|
25443
|
+
description: 'Date and time at which the mutation was created.',
|
|
25444
|
+
format: 'date-time',
|
|
25445
|
+
type: 'string',
|
|
25446
|
+
},
|
|
25447
|
+
message: {
|
|
25448
|
+
description: 'Detailed description of the mutation.',
|
|
25449
|
+
type: 'string',
|
|
25450
|
+
},
|
|
25451
|
+
mutation_code: {
|
|
25452
|
+
description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
25453
|
+
enum: ['deferring_group_membership_update'],
|
|
25454
|
+
type: 'string',
|
|
25455
|
+
},
|
|
25456
|
+
variant: {
|
|
25457
|
+
description: 'Whether the user is scheduled to be added to or removed from the access group.',
|
|
25458
|
+
enum: ['adding', 'removing'],
|
|
25459
|
+
type: 'string',
|
|
25460
|
+
},
|
|
25461
|
+
},
|
|
25462
|
+
required: [
|
|
25463
|
+
'created_at',
|
|
25464
|
+
'message',
|
|
25465
|
+
'mutation_code',
|
|
25466
|
+
'acs_access_group_id',
|
|
25467
|
+
'variant',
|
|
25468
|
+
],
|
|
25469
|
+
type: 'object',
|
|
25470
|
+
},
|
|
25323
25471
|
],
|
|
25324
25472
|
},
|
|
25325
25473
|
type: 'array',
|
|
@@ -57696,6 +57844,1220 @@ export default {
|
|
|
57696
57844
|
'x-undocumented': 'Internal endpoint for Console.',
|
|
57697
57845
|
},
|
|
57698
57846
|
},
|
|
57847
|
+
'/seam/customer/v1/customers/automations/get': {
|
|
57848
|
+
get: {
|
|
57849
|
+
description: 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
57850
|
+
operationId: 'seamCustomerV1CustomersAutomationsGetGet',
|
|
57851
|
+
parameters: [
|
|
57852
|
+
{
|
|
57853
|
+
in: 'query',
|
|
57854
|
+
name: 'customer_key',
|
|
57855
|
+
required: true,
|
|
57856
|
+
schema: { description: 'Key of the customer.', type: 'string' },
|
|
57857
|
+
},
|
|
57858
|
+
],
|
|
57859
|
+
responses: {
|
|
57860
|
+
200: {
|
|
57861
|
+
content: {
|
|
57862
|
+
'application/json': {
|
|
57863
|
+
schema: {
|
|
57864
|
+
properties: {
|
|
57865
|
+
automation: {
|
|
57866
|
+
properties: {
|
|
57867
|
+
access_rules: {
|
|
57868
|
+
properties: {
|
|
57869
|
+
reservation_created: {
|
|
57870
|
+
properties: {
|
|
57871
|
+
config: {
|
|
57872
|
+
properties: {
|
|
57873
|
+
access_methods: {
|
|
57874
|
+
items: {
|
|
57875
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
57876
|
+
type: 'string',
|
|
57877
|
+
},
|
|
57878
|
+
minItems: 1,
|
|
57879
|
+
type: 'array',
|
|
57880
|
+
},
|
|
57881
|
+
card_count_on_reservation_create: {
|
|
57882
|
+
minimum: 0,
|
|
57883
|
+
type: 'integer',
|
|
57884
|
+
},
|
|
57885
|
+
code_count_on_reservation_create: {
|
|
57886
|
+
minimum: 0,
|
|
57887
|
+
type: 'integer',
|
|
57888
|
+
},
|
|
57889
|
+
instant_key_max_use_count: {
|
|
57890
|
+
minimum: 1,
|
|
57891
|
+
type: 'integer',
|
|
57892
|
+
},
|
|
57893
|
+
method_issuance_strategy: {
|
|
57894
|
+
enum: [
|
|
57895
|
+
'first_available',
|
|
57896
|
+
'first_two_available',
|
|
57897
|
+
'all_available',
|
|
57898
|
+
],
|
|
57899
|
+
type: 'string',
|
|
57900
|
+
},
|
|
57901
|
+
},
|
|
57902
|
+
required: [
|
|
57903
|
+
'access_methods',
|
|
57904
|
+
'method_issuance_strategy',
|
|
57905
|
+
],
|
|
57906
|
+
type: 'object',
|
|
57907
|
+
},
|
|
57908
|
+
rule: {
|
|
57909
|
+
enum: ['reservation_created'],
|
|
57910
|
+
type: 'string',
|
|
57911
|
+
},
|
|
57912
|
+
},
|
|
57913
|
+
required: ['rule', 'config'],
|
|
57914
|
+
type: 'object',
|
|
57915
|
+
},
|
|
57916
|
+
reservation_deleted: {
|
|
57917
|
+
properties: {
|
|
57918
|
+
config: {
|
|
57919
|
+
$ref: '#/components/schemas/access_code',
|
|
57920
|
+
},
|
|
57921
|
+
rule: {
|
|
57922
|
+
enum: ['reservation_deleted'],
|
|
57923
|
+
type: 'string',
|
|
57924
|
+
},
|
|
57925
|
+
},
|
|
57926
|
+
required: ['rule'],
|
|
57927
|
+
type: 'object',
|
|
57928
|
+
},
|
|
57929
|
+
reservation_spaces_updated: {
|
|
57930
|
+
properties: {
|
|
57931
|
+
config: {
|
|
57932
|
+
$ref: '#/components/schemas/access_code',
|
|
57933
|
+
},
|
|
57934
|
+
rule: {
|
|
57935
|
+
enum: ['reservation_spaces_updated'],
|
|
57936
|
+
type: 'string',
|
|
57937
|
+
},
|
|
57938
|
+
},
|
|
57939
|
+
required: ['rule'],
|
|
57940
|
+
type: 'object',
|
|
57941
|
+
},
|
|
57942
|
+
reservation_time_updated: {
|
|
57943
|
+
properties: {
|
|
57944
|
+
config: {
|
|
57945
|
+
$ref: '#/components/schemas/access_code',
|
|
57946
|
+
},
|
|
57947
|
+
rule: {
|
|
57948
|
+
enum: ['reservation_time_updated'],
|
|
57949
|
+
type: 'string',
|
|
57950
|
+
},
|
|
57951
|
+
},
|
|
57952
|
+
required: ['rule'],
|
|
57953
|
+
type: 'object',
|
|
57954
|
+
},
|
|
57955
|
+
space_name_updated: {
|
|
57956
|
+
properties: {
|
|
57957
|
+
config: {
|
|
57958
|
+
$ref: '#/components/schemas/access_code',
|
|
57959
|
+
},
|
|
57960
|
+
rule: {
|
|
57961
|
+
enum: ['space_name_updated'],
|
|
57962
|
+
type: 'string',
|
|
57963
|
+
},
|
|
57964
|
+
},
|
|
57965
|
+
required: ['rule'],
|
|
57966
|
+
type: 'object',
|
|
57967
|
+
},
|
|
57968
|
+
staff_member_created: {
|
|
57969
|
+
properties: {
|
|
57970
|
+
config: {
|
|
57971
|
+
$ref: '#/components/schemas/access_code',
|
|
57972
|
+
},
|
|
57973
|
+
rule: {
|
|
57974
|
+
enum: ['staff_member_created'],
|
|
57975
|
+
type: 'string',
|
|
57976
|
+
},
|
|
57977
|
+
},
|
|
57978
|
+
required: ['rule', 'config'],
|
|
57979
|
+
type: 'object',
|
|
57980
|
+
},
|
|
57981
|
+
staff_member_name_updated: {
|
|
57982
|
+
properties: {
|
|
57983
|
+
config: {
|
|
57984
|
+
$ref: '#/components/schemas/access_code',
|
|
57985
|
+
},
|
|
57986
|
+
rule: {
|
|
57987
|
+
enum: ['staff_member_name_updated'],
|
|
57988
|
+
type: 'string',
|
|
57989
|
+
},
|
|
57990
|
+
},
|
|
57991
|
+
required: ['rule'],
|
|
57992
|
+
type: 'object',
|
|
57993
|
+
},
|
|
57994
|
+
user_identity_name_updated: {
|
|
57995
|
+
properties: {
|
|
57996
|
+
config: {
|
|
57997
|
+
$ref: '#/components/schemas/access_code',
|
|
57998
|
+
},
|
|
57999
|
+
rule: {
|
|
58000
|
+
enum: ['user_identity_name_updated'],
|
|
58001
|
+
type: 'string',
|
|
58002
|
+
},
|
|
58003
|
+
},
|
|
58004
|
+
required: ['rule'],
|
|
58005
|
+
type: 'object',
|
|
58006
|
+
},
|
|
58007
|
+
},
|
|
58008
|
+
type: 'object',
|
|
58009
|
+
},
|
|
58010
|
+
climate_rules: {
|
|
58011
|
+
properties: {
|
|
58012
|
+
rules: {
|
|
58013
|
+
properties: {
|
|
58014
|
+
reservation_created: {
|
|
58015
|
+
properties: {
|
|
58016
|
+
automated_occupied_preset: {
|
|
58017
|
+
properties: {
|
|
58018
|
+
cooling_set_point_celsius: {
|
|
58019
|
+
format: 'float',
|
|
58020
|
+
type: 'number',
|
|
58021
|
+
},
|
|
58022
|
+
cooling_set_point_fahrenheit: {
|
|
58023
|
+
format: 'float',
|
|
58024
|
+
type: 'number',
|
|
58025
|
+
},
|
|
58026
|
+
fan_mode: {
|
|
58027
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58028
|
+
type: 'string',
|
|
58029
|
+
},
|
|
58030
|
+
heating_set_point_celsius: {
|
|
58031
|
+
format: 'float',
|
|
58032
|
+
type: 'number',
|
|
58033
|
+
},
|
|
58034
|
+
heating_set_point_fahrenheit: {
|
|
58035
|
+
format: 'float',
|
|
58036
|
+
type: 'number',
|
|
58037
|
+
},
|
|
58038
|
+
is_override_allowed: {
|
|
58039
|
+
type: 'boolean',
|
|
58040
|
+
},
|
|
58041
|
+
max_override_period_minutes: {
|
|
58042
|
+
format: 'float',
|
|
58043
|
+
type: 'number',
|
|
58044
|
+
},
|
|
58045
|
+
mode: {
|
|
58046
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58047
|
+
type: 'string',
|
|
58048
|
+
},
|
|
58049
|
+
},
|
|
58050
|
+
required: [
|
|
58051
|
+
'mode',
|
|
58052
|
+
'fan_mode',
|
|
58053
|
+
'is_override_allowed',
|
|
58054
|
+
'max_override_period_minutes',
|
|
58055
|
+
],
|
|
58056
|
+
type: 'object',
|
|
58057
|
+
},
|
|
58058
|
+
automated_unoccupied_preset: {
|
|
58059
|
+
properties: {
|
|
58060
|
+
cooling_set_point_celsius: {
|
|
58061
|
+
format: 'float',
|
|
58062
|
+
type: 'number',
|
|
58063
|
+
},
|
|
58064
|
+
cooling_set_point_fahrenheit: {
|
|
58065
|
+
format: 'float',
|
|
58066
|
+
type: 'number',
|
|
58067
|
+
},
|
|
58068
|
+
fan_mode: {
|
|
58069
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58070
|
+
type: 'string',
|
|
58071
|
+
},
|
|
58072
|
+
heating_set_point_celsius: {
|
|
58073
|
+
format: 'float',
|
|
58074
|
+
type: 'number',
|
|
58075
|
+
},
|
|
58076
|
+
heating_set_point_fahrenheit: {
|
|
58077
|
+
format: 'float',
|
|
58078
|
+
type: 'number',
|
|
58079
|
+
},
|
|
58080
|
+
is_override_allowed: {
|
|
58081
|
+
type: 'boolean',
|
|
58082
|
+
},
|
|
58083
|
+
max_override_period_minutes: {
|
|
58084
|
+
format: 'float',
|
|
58085
|
+
type: 'number',
|
|
58086
|
+
},
|
|
58087
|
+
mode: {
|
|
58088
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58089
|
+
type: 'string',
|
|
58090
|
+
},
|
|
58091
|
+
},
|
|
58092
|
+
required: [
|
|
58093
|
+
'mode',
|
|
58094
|
+
'fan_mode',
|
|
58095
|
+
'is_override_allowed',
|
|
58096
|
+
'max_override_period_minutes',
|
|
58097
|
+
],
|
|
58098
|
+
type: 'object',
|
|
58099
|
+
},
|
|
58100
|
+
occupied_preset_key: { type: 'string' },
|
|
58101
|
+
precondition_minutes_before_reservation: {
|
|
58102
|
+
format: 'float',
|
|
58103
|
+
type: 'number',
|
|
58104
|
+
},
|
|
58105
|
+
unoccupied_preset_key: { type: 'string' },
|
|
58106
|
+
},
|
|
58107
|
+
type: 'object',
|
|
58108
|
+
},
|
|
58109
|
+
reservation_deleted: {
|
|
58110
|
+
$ref: '#/components/schemas/access_code',
|
|
58111
|
+
},
|
|
58112
|
+
reservation_time_updated: {
|
|
58113
|
+
$ref: '#/components/schemas/access_code',
|
|
58114
|
+
},
|
|
58115
|
+
},
|
|
58116
|
+
type: 'object',
|
|
58117
|
+
},
|
|
58118
|
+
},
|
|
58119
|
+
required: ['rules'],
|
|
58120
|
+
type: 'object',
|
|
58121
|
+
},
|
|
58122
|
+
},
|
|
58123
|
+
type: 'object',
|
|
58124
|
+
},
|
|
58125
|
+
ok: { type: 'boolean' },
|
|
58126
|
+
},
|
|
58127
|
+
required: ['automation', 'ok'],
|
|
58128
|
+
type: 'object',
|
|
58129
|
+
},
|
|
58130
|
+
},
|
|
58131
|
+
},
|
|
58132
|
+
description: 'OK',
|
|
58133
|
+
},
|
|
58134
|
+
400: { description: 'Bad Request' },
|
|
58135
|
+
401: { description: 'Unauthorized' },
|
|
58136
|
+
},
|
|
58137
|
+
security: [
|
|
58138
|
+
{ pat_with_workspace: [] },
|
|
58139
|
+
{ console_session_with_workspace: [] },
|
|
58140
|
+
{ api_key: [] },
|
|
58141
|
+
],
|
|
58142
|
+
summary: '/seam/customer/v1/customers/automations/get',
|
|
58143
|
+
tags: [],
|
|
58144
|
+
'x-fern-sdk-group-name': [
|
|
58145
|
+
'seam',
|
|
58146
|
+
'customer',
|
|
58147
|
+
'v1',
|
|
58148
|
+
'customers',
|
|
58149
|
+
'automations',
|
|
58150
|
+
],
|
|
58151
|
+
'x-fern-sdk-method-name': 'get',
|
|
58152
|
+
'x-fern-sdk-return-value': 'automation',
|
|
58153
|
+
'x-response-key': 'automation',
|
|
58154
|
+
'x-title': 'Get Customer Automation Configuration',
|
|
58155
|
+
},
|
|
58156
|
+
post: {
|
|
58157
|
+
description: 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
|
|
58158
|
+
operationId: 'seamCustomerV1CustomersAutomationsGetPost',
|
|
58159
|
+
requestBody: {
|
|
58160
|
+
content: {
|
|
58161
|
+
'application/json': {
|
|
58162
|
+
schema: {
|
|
58163
|
+
properties: {
|
|
58164
|
+
customer_key: {
|
|
58165
|
+
description: 'Key of the customer.',
|
|
58166
|
+
type: 'string',
|
|
58167
|
+
},
|
|
58168
|
+
},
|
|
58169
|
+
required: ['customer_key'],
|
|
58170
|
+
type: 'object',
|
|
58171
|
+
},
|
|
58172
|
+
},
|
|
58173
|
+
},
|
|
58174
|
+
},
|
|
58175
|
+
responses: {
|
|
58176
|
+
200: {
|
|
58177
|
+
content: {
|
|
58178
|
+
'application/json': {
|
|
58179
|
+
schema: {
|
|
58180
|
+
properties: {
|
|
58181
|
+
automation: {
|
|
58182
|
+
properties: {
|
|
58183
|
+
access_rules: {
|
|
58184
|
+
properties: {
|
|
58185
|
+
reservation_created: {
|
|
58186
|
+
properties: {
|
|
58187
|
+
config: {
|
|
58188
|
+
properties: {
|
|
58189
|
+
access_methods: {
|
|
58190
|
+
items: {
|
|
58191
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
58192
|
+
type: 'string',
|
|
58193
|
+
},
|
|
58194
|
+
minItems: 1,
|
|
58195
|
+
type: 'array',
|
|
58196
|
+
},
|
|
58197
|
+
card_count_on_reservation_create: {
|
|
58198
|
+
minimum: 0,
|
|
58199
|
+
type: 'integer',
|
|
58200
|
+
},
|
|
58201
|
+
code_count_on_reservation_create: {
|
|
58202
|
+
minimum: 0,
|
|
58203
|
+
type: 'integer',
|
|
58204
|
+
},
|
|
58205
|
+
instant_key_max_use_count: {
|
|
58206
|
+
minimum: 1,
|
|
58207
|
+
type: 'integer',
|
|
58208
|
+
},
|
|
58209
|
+
method_issuance_strategy: {
|
|
58210
|
+
enum: [
|
|
58211
|
+
'first_available',
|
|
58212
|
+
'first_two_available',
|
|
58213
|
+
'all_available',
|
|
58214
|
+
],
|
|
58215
|
+
type: 'string',
|
|
58216
|
+
},
|
|
58217
|
+
},
|
|
58218
|
+
required: [
|
|
58219
|
+
'access_methods',
|
|
58220
|
+
'method_issuance_strategy',
|
|
58221
|
+
],
|
|
58222
|
+
type: 'object',
|
|
58223
|
+
},
|
|
58224
|
+
rule: {
|
|
58225
|
+
enum: ['reservation_created'],
|
|
58226
|
+
type: 'string',
|
|
58227
|
+
},
|
|
58228
|
+
},
|
|
58229
|
+
required: ['rule', 'config'],
|
|
58230
|
+
type: 'object',
|
|
58231
|
+
},
|
|
58232
|
+
reservation_deleted: {
|
|
58233
|
+
properties: {
|
|
58234
|
+
config: {
|
|
58235
|
+
$ref: '#/components/schemas/access_code',
|
|
58236
|
+
},
|
|
58237
|
+
rule: {
|
|
58238
|
+
enum: ['reservation_deleted'],
|
|
58239
|
+
type: 'string',
|
|
58240
|
+
},
|
|
58241
|
+
},
|
|
58242
|
+
required: ['rule'],
|
|
58243
|
+
type: 'object',
|
|
58244
|
+
},
|
|
58245
|
+
reservation_spaces_updated: {
|
|
58246
|
+
properties: {
|
|
58247
|
+
config: {
|
|
58248
|
+
$ref: '#/components/schemas/access_code',
|
|
58249
|
+
},
|
|
58250
|
+
rule: {
|
|
58251
|
+
enum: ['reservation_spaces_updated'],
|
|
58252
|
+
type: 'string',
|
|
58253
|
+
},
|
|
58254
|
+
},
|
|
58255
|
+
required: ['rule'],
|
|
58256
|
+
type: 'object',
|
|
58257
|
+
},
|
|
58258
|
+
reservation_time_updated: {
|
|
58259
|
+
properties: {
|
|
58260
|
+
config: {
|
|
58261
|
+
$ref: '#/components/schemas/access_code',
|
|
58262
|
+
},
|
|
58263
|
+
rule: {
|
|
58264
|
+
enum: ['reservation_time_updated'],
|
|
58265
|
+
type: 'string',
|
|
58266
|
+
},
|
|
58267
|
+
},
|
|
58268
|
+
required: ['rule'],
|
|
58269
|
+
type: 'object',
|
|
58270
|
+
},
|
|
58271
|
+
space_name_updated: {
|
|
58272
|
+
properties: {
|
|
58273
|
+
config: {
|
|
58274
|
+
$ref: '#/components/schemas/access_code',
|
|
58275
|
+
},
|
|
58276
|
+
rule: {
|
|
58277
|
+
enum: ['space_name_updated'],
|
|
58278
|
+
type: 'string',
|
|
58279
|
+
},
|
|
58280
|
+
},
|
|
58281
|
+
required: ['rule'],
|
|
58282
|
+
type: 'object',
|
|
58283
|
+
},
|
|
58284
|
+
staff_member_created: {
|
|
58285
|
+
properties: {
|
|
58286
|
+
config: {
|
|
58287
|
+
$ref: '#/components/schemas/access_code',
|
|
58288
|
+
},
|
|
58289
|
+
rule: {
|
|
58290
|
+
enum: ['staff_member_created'],
|
|
58291
|
+
type: 'string',
|
|
58292
|
+
},
|
|
58293
|
+
},
|
|
58294
|
+
required: ['rule', 'config'],
|
|
58295
|
+
type: 'object',
|
|
58296
|
+
},
|
|
58297
|
+
staff_member_name_updated: {
|
|
58298
|
+
properties: {
|
|
58299
|
+
config: {
|
|
58300
|
+
$ref: '#/components/schemas/access_code',
|
|
58301
|
+
},
|
|
58302
|
+
rule: {
|
|
58303
|
+
enum: ['staff_member_name_updated'],
|
|
58304
|
+
type: 'string',
|
|
58305
|
+
},
|
|
58306
|
+
},
|
|
58307
|
+
required: ['rule'],
|
|
58308
|
+
type: 'object',
|
|
58309
|
+
},
|
|
58310
|
+
user_identity_name_updated: {
|
|
58311
|
+
properties: {
|
|
58312
|
+
config: {
|
|
58313
|
+
$ref: '#/components/schemas/access_code',
|
|
58314
|
+
},
|
|
58315
|
+
rule: {
|
|
58316
|
+
enum: ['user_identity_name_updated'],
|
|
58317
|
+
type: 'string',
|
|
58318
|
+
},
|
|
58319
|
+
},
|
|
58320
|
+
required: ['rule'],
|
|
58321
|
+
type: 'object',
|
|
58322
|
+
},
|
|
58323
|
+
},
|
|
58324
|
+
type: 'object',
|
|
58325
|
+
},
|
|
58326
|
+
climate_rules: {
|
|
58327
|
+
properties: {
|
|
58328
|
+
rules: {
|
|
58329
|
+
properties: {
|
|
58330
|
+
reservation_created: {
|
|
58331
|
+
properties: {
|
|
58332
|
+
automated_occupied_preset: {
|
|
58333
|
+
properties: {
|
|
58334
|
+
cooling_set_point_celsius: {
|
|
58335
|
+
format: 'float',
|
|
58336
|
+
type: 'number',
|
|
58337
|
+
},
|
|
58338
|
+
cooling_set_point_fahrenheit: {
|
|
58339
|
+
format: 'float',
|
|
58340
|
+
type: 'number',
|
|
58341
|
+
},
|
|
58342
|
+
fan_mode: {
|
|
58343
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58344
|
+
type: 'string',
|
|
58345
|
+
},
|
|
58346
|
+
heating_set_point_celsius: {
|
|
58347
|
+
format: 'float',
|
|
58348
|
+
type: 'number',
|
|
58349
|
+
},
|
|
58350
|
+
heating_set_point_fahrenheit: {
|
|
58351
|
+
format: 'float',
|
|
58352
|
+
type: 'number',
|
|
58353
|
+
},
|
|
58354
|
+
is_override_allowed: {
|
|
58355
|
+
type: 'boolean',
|
|
58356
|
+
},
|
|
58357
|
+
max_override_period_minutes: {
|
|
58358
|
+
format: 'float',
|
|
58359
|
+
type: 'number',
|
|
58360
|
+
},
|
|
58361
|
+
mode: {
|
|
58362
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58363
|
+
type: 'string',
|
|
58364
|
+
},
|
|
58365
|
+
},
|
|
58366
|
+
required: [
|
|
58367
|
+
'mode',
|
|
58368
|
+
'fan_mode',
|
|
58369
|
+
'is_override_allowed',
|
|
58370
|
+
'max_override_period_minutes',
|
|
58371
|
+
],
|
|
58372
|
+
type: 'object',
|
|
58373
|
+
},
|
|
58374
|
+
automated_unoccupied_preset: {
|
|
58375
|
+
properties: {
|
|
58376
|
+
cooling_set_point_celsius: {
|
|
58377
|
+
format: 'float',
|
|
58378
|
+
type: 'number',
|
|
58379
|
+
},
|
|
58380
|
+
cooling_set_point_fahrenheit: {
|
|
58381
|
+
format: 'float',
|
|
58382
|
+
type: 'number',
|
|
58383
|
+
},
|
|
58384
|
+
fan_mode: {
|
|
58385
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58386
|
+
type: 'string',
|
|
58387
|
+
},
|
|
58388
|
+
heating_set_point_celsius: {
|
|
58389
|
+
format: 'float',
|
|
58390
|
+
type: 'number',
|
|
58391
|
+
},
|
|
58392
|
+
heating_set_point_fahrenheit: {
|
|
58393
|
+
format: 'float',
|
|
58394
|
+
type: 'number',
|
|
58395
|
+
},
|
|
58396
|
+
is_override_allowed: {
|
|
58397
|
+
type: 'boolean',
|
|
58398
|
+
},
|
|
58399
|
+
max_override_period_minutes: {
|
|
58400
|
+
format: 'float',
|
|
58401
|
+
type: 'number',
|
|
58402
|
+
},
|
|
58403
|
+
mode: {
|
|
58404
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58405
|
+
type: 'string',
|
|
58406
|
+
},
|
|
58407
|
+
},
|
|
58408
|
+
required: [
|
|
58409
|
+
'mode',
|
|
58410
|
+
'fan_mode',
|
|
58411
|
+
'is_override_allowed',
|
|
58412
|
+
'max_override_period_minutes',
|
|
58413
|
+
],
|
|
58414
|
+
type: 'object',
|
|
58415
|
+
},
|
|
58416
|
+
occupied_preset_key: { type: 'string' },
|
|
58417
|
+
precondition_minutes_before_reservation: {
|
|
58418
|
+
format: 'float',
|
|
58419
|
+
type: 'number',
|
|
58420
|
+
},
|
|
58421
|
+
unoccupied_preset_key: { type: 'string' },
|
|
58422
|
+
},
|
|
58423
|
+
type: 'object',
|
|
58424
|
+
},
|
|
58425
|
+
reservation_deleted: {
|
|
58426
|
+
$ref: '#/components/schemas/access_code',
|
|
58427
|
+
},
|
|
58428
|
+
reservation_time_updated: {
|
|
58429
|
+
$ref: '#/components/schemas/access_code',
|
|
58430
|
+
},
|
|
58431
|
+
},
|
|
58432
|
+
type: 'object',
|
|
58433
|
+
},
|
|
58434
|
+
},
|
|
58435
|
+
required: ['rules'],
|
|
58436
|
+
type: 'object',
|
|
58437
|
+
},
|
|
58438
|
+
},
|
|
58439
|
+
type: 'object',
|
|
58440
|
+
},
|
|
58441
|
+
ok: { type: 'boolean' },
|
|
58442
|
+
},
|
|
58443
|
+
required: ['automation', 'ok'],
|
|
58444
|
+
type: 'object',
|
|
58445
|
+
},
|
|
58446
|
+
},
|
|
58447
|
+
},
|
|
58448
|
+
description: 'OK',
|
|
58449
|
+
},
|
|
58450
|
+
400: { description: 'Bad Request' },
|
|
58451
|
+
401: { description: 'Unauthorized' },
|
|
58452
|
+
},
|
|
58453
|
+
security: [
|
|
58454
|
+
{ pat_with_workspace: [] },
|
|
58455
|
+
{ console_session_with_workspace: [] },
|
|
58456
|
+
{ api_key: [] },
|
|
58457
|
+
],
|
|
58458
|
+
summary: '/seam/customer/v1/customers/automations/get',
|
|
58459
|
+
tags: [],
|
|
58460
|
+
'x-fern-sdk-group-name': [
|
|
58461
|
+
'seam',
|
|
58462
|
+
'customer',
|
|
58463
|
+
'v1',
|
|
58464
|
+
'customers',
|
|
58465
|
+
'automations',
|
|
58466
|
+
],
|
|
58467
|
+
'x-fern-sdk-method-name': 'get',
|
|
58468
|
+
'x-fern-sdk-return-value': 'automation',
|
|
58469
|
+
'x-response-key': 'automation',
|
|
58470
|
+
'x-title': 'Get Customer Automation Configuration',
|
|
58471
|
+
},
|
|
58472
|
+
},
|
|
58473
|
+
'/seam/customer/v1/customers/automations/update': {
|
|
58474
|
+
patch: {
|
|
58475
|
+
description: 'Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.',
|
|
58476
|
+
operationId: 'seamCustomerV1CustomersAutomationsUpdatePatch',
|
|
58477
|
+
requestBody: {
|
|
58478
|
+
content: {
|
|
58479
|
+
'application/json': {
|
|
58480
|
+
schema: {
|
|
58481
|
+
properties: {
|
|
58482
|
+
access_rules: {
|
|
58483
|
+
description: 'Access automation rules configuration.',
|
|
58484
|
+
properties: {
|
|
58485
|
+
reservation_created: {
|
|
58486
|
+
properties: {
|
|
58487
|
+
config: {
|
|
58488
|
+
properties: {
|
|
58489
|
+
access_methods: {
|
|
58490
|
+
items: {
|
|
58491
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
58492
|
+
type: 'string',
|
|
58493
|
+
},
|
|
58494
|
+
minItems: 1,
|
|
58495
|
+
type: 'array',
|
|
58496
|
+
},
|
|
58497
|
+
card_count_on_reservation_create: {
|
|
58498
|
+
minimum: 0,
|
|
58499
|
+
type: 'integer',
|
|
58500
|
+
},
|
|
58501
|
+
code_count_on_reservation_create: {
|
|
58502
|
+
minimum: 0,
|
|
58503
|
+
type: 'integer',
|
|
58504
|
+
},
|
|
58505
|
+
instant_key_max_use_count: {
|
|
58506
|
+
minimum: 1,
|
|
58507
|
+
type: 'integer',
|
|
58508
|
+
},
|
|
58509
|
+
method_issuance_strategy: {
|
|
58510
|
+
enum: [
|
|
58511
|
+
'first_available',
|
|
58512
|
+
'first_two_available',
|
|
58513
|
+
'all_available',
|
|
58514
|
+
],
|
|
58515
|
+
type: 'string',
|
|
58516
|
+
},
|
|
58517
|
+
},
|
|
58518
|
+
required: [
|
|
58519
|
+
'access_methods',
|
|
58520
|
+
'method_issuance_strategy',
|
|
58521
|
+
],
|
|
58522
|
+
type: 'object',
|
|
58523
|
+
},
|
|
58524
|
+
rule: {
|
|
58525
|
+
enum: ['reservation_created'],
|
|
58526
|
+
type: 'string',
|
|
58527
|
+
},
|
|
58528
|
+
},
|
|
58529
|
+
required: ['rule', 'config'],
|
|
58530
|
+
type: 'object',
|
|
58531
|
+
},
|
|
58532
|
+
reservation_deleted: {
|
|
58533
|
+
properties: {
|
|
58534
|
+
config: { properties: {}, type: 'object' },
|
|
58535
|
+
rule: {
|
|
58536
|
+
enum: ['reservation_deleted'],
|
|
58537
|
+
type: 'string',
|
|
58538
|
+
},
|
|
58539
|
+
},
|
|
58540
|
+
required: ['rule'],
|
|
58541
|
+
type: 'object',
|
|
58542
|
+
},
|
|
58543
|
+
reservation_spaces_updated: {
|
|
58544
|
+
properties: {
|
|
58545
|
+
config: { properties: {}, type: 'object' },
|
|
58546
|
+
rule: {
|
|
58547
|
+
enum: ['reservation_spaces_updated'],
|
|
58548
|
+
type: 'string',
|
|
58549
|
+
},
|
|
58550
|
+
},
|
|
58551
|
+
required: ['rule'],
|
|
58552
|
+
type: 'object',
|
|
58553
|
+
},
|
|
58554
|
+
reservation_time_updated: {
|
|
58555
|
+
properties: {
|
|
58556
|
+
config: { properties: {}, type: 'object' },
|
|
58557
|
+
rule: {
|
|
58558
|
+
enum: ['reservation_time_updated'],
|
|
58559
|
+
type: 'string',
|
|
58560
|
+
},
|
|
58561
|
+
},
|
|
58562
|
+
required: ['rule'],
|
|
58563
|
+
type: 'object',
|
|
58564
|
+
},
|
|
58565
|
+
space_name_updated: {
|
|
58566
|
+
properties: {
|
|
58567
|
+
config: { properties: {}, type: 'object' },
|
|
58568
|
+
rule: {
|
|
58569
|
+
enum: ['space_name_updated'],
|
|
58570
|
+
type: 'string',
|
|
58571
|
+
},
|
|
58572
|
+
},
|
|
58573
|
+
required: ['rule'],
|
|
58574
|
+
type: 'object',
|
|
58575
|
+
},
|
|
58576
|
+
staff_member_created: {
|
|
58577
|
+
properties: {
|
|
58578
|
+
config: { properties: {}, type: 'object' },
|
|
58579
|
+
rule: {
|
|
58580
|
+
enum: ['staff_member_created'],
|
|
58581
|
+
type: 'string',
|
|
58582
|
+
},
|
|
58583
|
+
},
|
|
58584
|
+
required: ['rule', 'config'],
|
|
58585
|
+
type: 'object',
|
|
58586
|
+
},
|
|
58587
|
+
staff_member_name_updated: {
|
|
58588
|
+
properties: {
|
|
58589
|
+
config: { properties: {}, type: 'object' },
|
|
58590
|
+
rule: {
|
|
58591
|
+
enum: ['staff_member_name_updated'],
|
|
58592
|
+
type: 'string',
|
|
58593
|
+
},
|
|
58594
|
+
},
|
|
58595
|
+
required: ['rule'],
|
|
58596
|
+
type: 'object',
|
|
58597
|
+
},
|
|
58598
|
+
user_identity_name_updated: {
|
|
58599
|
+
properties: {
|
|
58600
|
+
config: { properties: {}, type: 'object' },
|
|
58601
|
+
rule: {
|
|
58602
|
+
enum: ['user_identity_name_updated'],
|
|
58603
|
+
type: 'string',
|
|
58604
|
+
},
|
|
58605
|
+
},
|
|
58606
|
+
required: ['rule'],
|
|
58607
|
+
type: 'object',
|
|
58608
|
+
},
|
|
58609
|
+
},
|
|
58610
|
+
type: 'object',
|
|
58611
|
+
},
|
|
58612
|
+
climate_rules: {
|
|
58613
|
+
description: 'Climate automation rules configuration.',
|
|
58614
|
+
properties: {
|
|
58615
|
+
rules: {
|
|
58616
|
+
properties: {
|
|
58617
|
+
reservation_created: {
|
|
58618
|
+
properties: {
|
|
58619
|
+
automated_occupied_preset: {
|
|
58620
|
+
properties: {
|
|
58621
|
+
cooling_set_point_celsius: {
|
|
58622
|
+
format: 'float',
|
|
58623
|
+
type: 'number',
|
|
58624
|
+
},
|
|
58625
|
+
cooling_set_point_fahrenheit: {
|
|
58626
|
+
format: 'float',
|
|
58627
|
+
type: 'number',
|
|
58628
|
+
},
|
|
58629
|
+
fan_mode: {
|
|
58630
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58631
|
+
type: 'string',
|
|
58632
|
+
},
|
|
58633
|
+
heating_set_point_celsius: {
|
|
58634
|
+
format: 'float',
|
|
58635
|
+
type: 'number',
|
|
58636
|
+
},
|
|
58637
|
+
heating_set_point_fahrenheit: {
|
|
58638
|
+
format: 'float',
|
|
58639
|
+
type: 'number',
|
|
58640
|
+
},
|
|
58641
|
+
is_override_allowed: { type: 'boolean' },
|
|
58642
|
+
max_override_period_minutes: {
|
|
58643
|
+
format: 'float',
|
|
58644
|
+
type: 'number',
|
|
58645
|
+
},
|
|
58646
|
+
mode: {
|
|
58647
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58648
|
+
type: 'string',
|
|
58649
|
+
},
|
|
58650
|
+
},
|
|
58651
|
+
required: [
|
|
58652
|
+
'mode',
|
|
58653
|
+
'fan_mode',
|
|
58654
|
+
'is_override_allowed',
|
|
58655
|
+
'max_override_period_minutes',
|
|
58656
|
+
],
|
|
58657
|
+
type: 'object',
|
|
58658
|
+
},
|
|
58659
|
+
automated_unoccupied_preset: {
|
|
58660
|
+
properties: {
|
|
58661
|
+
cooling_set_point_celsius: {
|
|
58662
|
+
format: 'float',
|
|
58663
|
+
type: 'number',
|
|
58664
|
+
},
|
|
58665
|
+
cooling_set_point_fahrenheit: {
|
|
58666
|
+
format: 'float',
|
|
58667
|
+
type: 'number',
|
|
58668
|
+
},
|
|
58669
|
+
fan_mode: {
|
|
58670
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58671
|
+
type: 'string',
|
|
58672
|
+
},
|
|
58673
|
+
heating_set_point_celsius: {
|
|
58674
|
+
format: 'float',
|
|
58675
|
+
type: 'number',
|
|
58676
|
+
},
|
|
58677
|
+
heating_set_point_fahrenheit: {
|
|
58678
|
+
format: 'float',
|
|
58679
|
+
type: 'number',
|
|
58680
|
+
},
|
|
58681
|
+
is_override_allowed: { type: 'boolean' },
|
|
58682
|
+
max_override_period_minutes: {
|
|
58683
|
+
format: 'float',
|
|
58684
|
+
type: 'number',
|
|
58685
|
+
},
|
|
58686
|
+
mode: {
|
|
58687
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58688
|
+
type: 'string',
|
|
58689
|
+
},
|
|
58690
|
+
},
|
|
58691
|
+
required: [
|
|
58692
|
+
'mode',
|
|
58693
|
+
'fan_mode',
|
|
58694
|
+
'is_override_allowed',
|
|
58695
|
+
'max_override_period_minutes',
|
|
58696
|
+
],
|
|
58697
|
+
type: 'object',
|
|
58698
|
+
},
|
|
58699
|
+
occupied_preset_key: { type: 'string' },
|
|
58700
|
+
precondition_minutes_before_reservation: {
|
|
58701
|
+
format: 'float',
|
|
58702
|
+
type: 'number',
|
|
58703
|
+
},
|
|
58704
|
+
unoccupied_preset_key: { type: 'string' },
|
|
58705
|
+
},
|
|
58706
|
+
type: 'object',
|
|
58707
|
+
},
|
|
58708
|
+
reservation_deleted: {
|
|
58709
|
+
properties: {},
|
|
58710
|
+
type: 'object',
|
|
58711
|
+
},
|
|
58712
|
+
reservation_time_updated: {
|
|
58713
|
+
properties: {},
|
|
58714
|
+
type: 'object',
|
|
58715
|
+
},
|
|
58716
|
+
},
|
|
58717
|
+
type: 'object',
|
|
58718
|
+
},
|
|
58719
|
+
},
|
|
58720
|
+
type: 'object',
|
|
58721
|
+
},
|
|
58722
|
+
customer_key: {
|
|
58723
|
+
description: 'Key of the customer.',
|
|
58724
|
+
type: 'string',
|
|
58725
|
+
},
|
|
58726
|
+
},
|
|
58727
|
+
required: ['customer_key'],
|
|
58728
|
+
type: 'object',
|
|
58729
|
+
},
|
|
58730
|
+
},
|
|
58731
|
+
},
|
|
58732
|
+
},
|
|
58733
|
+
responses: {
|
|
58734
|
+
200: {
|
|
58735
|
+
content: {
|
|
58736
|
+
'application/json': {
|
|
58737
|
+
schema: {
|
|
58738
|
+
properties: { ok: { type: 'boolean' } },
|
|
58739
|
+
required: ['ok'],
|
|
58740
|
+
type: 'object',
|
|
58741
|
+
},
|
|
58742
|
+
},
|
|
58743
|
+
},
|
|
58744
|
+
description: 'OK',
|
|
58745
|
+
},
|
|
58746
|
+
400: { description: 'Bad Request' },
|
|
58747
|
+
401: { description: 'Unauthorized' },
|
|
58748
|
+
},
|
|
58749
|
+
security: [
|
|
58750
|
+
{ pat_with_workspace: [] },
|
|
58751
|
+
{ console_session_with_workspace: [] },
|
|
58752
|
+
{ api_key: [] },
|
|
58753
|
+
],
|
|
58754
|
+
summary: '/seam/customer/v1/customers/automations/update',
|
|
58755
|
+
tags: [],
|
|
58756
|
+
'x-fern-sdk-group-name': [
|
|
58757
|
+
'seam',
|
|
58758
|
+
'customer',
|
|
58759
|
+
'v1',
|
|
58760
|
+
'customers',
|
|
58761
|
+
'automations',
|
|
58762
|
+
],
|
|
58763
|
+
'x-fern-sdk-method-name': 'update',
|
|
58764
|
+
'x-response-key': null,
|
|
58765
|
+
'x-title': 'Update Customer Automation Configuration',
|
|
58766
|
+
},
|
|
58767
|
+
post: {
|
|
58768
|
+
description: 'Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.',
|
|
58769
|
+
operationId: 'seamCustomerV1CustomersAutomationsUpdatePost',
|
|
58770
|
+
requestBody: {
|
|
58771
|
+
content: {
|
|
58772
|
+
'application/json': {
|
|
58773
|
+
schema: {
|
|
58774
|
+
properties: {
|
|
58775
|
+
access_rules: {
|
|
58776
|
+
description: 'Access automation rules configuration.',
|
|
58777
|
+
properties: {
|
|
58778
|
+
reservation_created: {
|
|
58779
|
+
properties: {
|
|
58780
|
+
config: {
|
|
58781
|
+
properties: {
|
|
58782
|
+
access_methods: {
|
|
58783
|
+
items: {
|
|
58784
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
58785
|
+
type: 'string',
|
|
58786
|
+
},
|
|
58787
|
+
minItems: 1,
|
|
58788
|
+
type: 'array',
|
|
58789
|
+
},
|
|
58790
|
+
card_count_on_reservation_create: {
|
|
58791
|
+
minimum: 0,
|
|
58792
|
+
type: 'integer',
|
|
58793
|
+
},
|
|
58794
|
+
code_count_on_reservation_create: {
|
|
58795
|
+
minimum: 0,
|
|
58796
|
+
type: 'integer',
|
|
58797
|
+
},
|
|
58798
|
+
instant_key_max_use_count: {
|
|
58799
|
+
minimum: 1,
|
|
58800
|
+
type: 'integer',
|
|
58801
|
+
},
|
|
58802
|
+
method_issuance_strategy: {
|
|
58803
|
+
enum: [
|
|
58804
|
+
'first_available',
|
|
58805
|
+
'first_two_available',
|
|
58806
|
+
'all_available',
|
|
58807
|
+
],
|
|
58808
|
+
type: 'string',
|
|
58809
|
+
},
|
|
58810
|
+
},
|
|
58811
|
+
required: [
|
|
58812
|
+
'access_methods',
|
|
58813
|
+
'method_issuance_strategy',
|
|
58814
|
+
],
|
|
58815
|
+
type: 'object',
|
|
58816
|
+
},
|
|
58817
|
+
rule: {
|
|
58818
|
+
enum: ['reservation_created'],
|
|
58819
|
+
type: 'string',
|
|
58820
|
+
},
|
|
58821
|
+
},
|
|
58822
|
+
required: ['rule', 'config'],
|
|
58823
|
+
type: 'object',
|
|
58824
|
+
},
|
|
58825
|
+
reservation_deleted: {
|
|
58826
|
+
properties: {
|
|
58827
|
+
config: { properties: {}, type: 'object' },
|
|
58828
|
+
rule: {
|
|
58829
|
+
enum: ['reservation_deleted'],
|
|
58830
|
+
type: 'string',
|
|
58831
|
+
},
|
|
58832
|
+
},
|
|
58833
|
+
required: ['rule'],
|
|
58834
|
+
type: 'object',
|
|
58835
|
+
},
|
|
58836
|
+
reservation_spaces_updated: {
|
|
58837
|
+
properties: {
|
|
58838
|
+
config: { properties: {}, type: 'object' },
|
|
58839
|
+
rule: {
|
|
58840
|
+
enum: ['reservation_spaces_updated'],
|
|
58841
|
+
type: 'string',
|
|
58842
|
+
},
|
|
58843
|
+
},
|
|
58844
|
+
required: ['rule'],
|
|
58845
|
+
type: 'object',
|
|
58846
|
+
},
|
|
58847
|
+
reservation_time_updated: {
|
|
58848
|
+
properties: {
|
|
58849
|
+
config: { properties: {}, type: 'object' },
|
|
58850
|
+
rule: {
|
|
58851
|
+
enum: ['reservation_time_updated'],
|
|
58852
|
+
type: 'string',
|
|
58853
|
+
},
|
|
58854
|
+
},
|
|
58855
|
+
required: ['rule'],
|
|
58856
|
+
type: 'object',
|
|
58857
|
+
},
|
|
58858
|
+
space_name_updated: {
|
|
58859
|
+
properties: {
|
|
58860
|
+
config: { properties: {}, type: 'object' },
|
|
58861
|
+
rule: {
|
|
58862
|
+
enum: ['space_name_updated'],
|
|
58863
|
+
type: 'string',
|
|
58864
|
+
},
|
|
58865
|
+
},
|
|
58866
|
+
required: ['rule'],
|
|
58867
|
+
type: 'object',
|
|
58868
|
+
},
|
|
58869
|
+
staff_member_created: {
|
|
58870
|
+
properties: {
|
|
58871
|
+
config: { properties: {}, type: 'object' },
|
|
58872
|
+
rule: {
|
|
58873
|
+
enum: ['staff_member_created'],
|
|
58874
|
+
type: 'string',
|
|
58875
|
+
},
|
|
58876
|
+
},
|
|
58877
|
+
required: ['rule', 'config'],
|
|
58878
|
+
type: 'object',
|
|
58879
|
+
},
|
|
58880
|
+
staff_member_name_updated: {
|
|
58881
|
+
properties: {
|
|
58882
|
+
config: { properties: {}, type: 'object' },
|
|
58883
|
+
rule: {
|
|
58884
|
+
enum: ['staff_member_name_updated'],
|
|
58885
|
+
type: 'string',
|
|
58886
|
+
},
|
|
58887
|
+
},
|
|
58888
|
+
required: ['rule'],
|
|
58889
|
+
type: 'object',
|
|
58890
|
+
},
|
|
58891
|
+
user_identity_name_updated: {
|
|
58892
|
+
properties: {
|
|
58893
|
+
config: { properties: {}, type: 'object' },
|
|
58894
|
+
rule: {
|
|
58895
|
+
enum: ['user_identity_name_updated'],
|
|
58896
|
+
type: 'string',
|
|
58897
|
+
},
|
|
58898
|
+
},
|
|
58899
|
+
required: ['rule'],
|
|
58900
|
+
type: 'object',
|
|
58901
|
+
},
|
|
58902
|
+
},
|
|
58903
|
+
type: 'object',
|
|
58904
|
+
},
|
|
58905
|
+
climate_rules: {
|
|
58906
|
+
description: 'Climate automation rules configuration.',
|
|
58907
|
+
properties: {
|
|
58908
|
+
rules: {
|
|
58909
|
+
properties: {
|
|
58910
|
+
reservation_created: {
|
|
58911
|
+
properties: {
|
|
58912
|
+
automated_occupied_preset: {
|
|
58913
|
+
properties: {
|
|
58914
|
+
cooling_set_point_celsius: {
|
|
58915
|
+
format: 'float',
|
|
58916
|
+
type: 'number',
|
|
58917
|
+
},
|
|
58918
|
+
cooling_set_point_fahrenheit: {
|
|
58919
|
+
format: 'float',
|
|
58920
|
+
type: 'number',
|
|
58921
|
+
},
|
|
58922
|
+
fan_mode: {
|
|
58923
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58924
|
+
type: 'string',
|
|
58925
|
+
},
|
|
58926
|
+
heating_set_point_celsius: {
|
|
58927
|
+
format: 'float',
|
|
58928
|
+
type: 'number',
|
|
58929
|
+
},
|
|
58930
|
+
heating_set_point_fahrenheit: {
|
|
58931
|
+
format: 'float',
|
|
58932
|
+
type: 'number',
|
|
58933
|
+
},
|
|
58934
|
+
is_override_allowed: { type: 'boolean' },
|
|
58935
|
+
max_override_period_minutes: {
|
|
58936
|
+
format: 'float',
|
|
58937
|
+
type: 'number',
|
|
58938
|
+
},
|
|
58939
|
+
mode: {
|
|
58940
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58941
|
+
type: 'string',
|
|
58942
|
+
},
|
|
58943
|
+
},
|
|
58944
|
+
required: [
|
|
58945
|
+
'mode',
|
|
58946
|
+
'fan_mode',
|
|
58947
|
+
'is_override_allowed',
|
|
58948
|
+
'max_override_period_minutes',
|
|
58949
|
+
],
|
|
58950
|
+
type: 'object',
|
|
58951
|
+
},
|
|
58952
|
+
automated_unoccupied_preset: {
|
|
58953
|
+
properties: {
|
|
58954
|
+
cooling_set_point_celsius: {
|
|
58955
|
+
format: 'float',
|
|
58956
|
+
type: 'number',
|
|
58957
|
+
},
|
|
58958
|
+
cooling_set_point_fahrenheit: {
|
|
58959
|
+
format: 'float',
|
|
58960
|
+
type: 'number',
|
|
58961
|
+
},
|
|
58962
|
+
fan_mode: {
|
|
58963
|
+
enum: ['on', 'auto', 'circulate'],
|
|
58964
|
+
type: 'string',
|
|
58965
|
+
},
|
|
58966
|
+
heating_set_point_celsius: {
|
|
58967
|
+
format: 'float',
|
|
58968
|
+
type: 'number',
|
|
58969
|
+
},
|
|
58970
|
+
heating_set_point_fahrenheit: {
|
|
58971
|
+
format: 'float',
|
|
58972
|
+
type: 'number',
|
|
58973
|
+
},
|
|
58974
|
+
is_override_allowed: { type: 'boolean' },
|
|
58975
|
+
max_override_period_minutes: {
|
|
58976
|
+
format: 'float',
|
|
58977
|
+
type: 'number',
|
|
58978
|
+
},
|
|
58979
|
+
mode: {
|
|
58980
|
+
enum: ['heat', 'cool', 'auto'],
|
|
58981
|
+
type: 'string',
|
|
58982
|
+
},
|
|
58983
|
+
},
|
|
58984
|
+
required: [
|
|
58985
|
+
'mode',
|
|
58986
|
+
'fan_mode',
|
|
58987
|
+
'is_override_allowed',
|
|
58988
|
+
'max_override_period_minutes',
|
|
58989
|
+
],
|
|
58990
|
+
type: 'object',
|
|
58991
|
+
},
|
|
58992
|
+
occupied_preset_key: { type: 'string' },
|
|
58993
|
+
precondition_minutes_before_reservation: {
|
|
58994
|
+
format: 'float',
|
|
58995
|
+
type: 'number',
|
|
58996
|
+
},
|
|
58997
|
+
unoccupied_preset_key: { type: 'string' },
|
|
58998
|
+
},
|
|
58999
|
+
type: 'object',
|
|
59000
|
+
},
|
|
59001
|
+
reservation_deleted: {
|
|
59002
|
+
properties: {},
|
|
59003
|
+
type: 'object',
|
|
59004
|
+
},
|
|
59005
|
+
reservation_time_updated: {
|
|
59006
|
+
properties: {},
|
|
59007
|
+
type: 'object',
|
|
59008
|
+
},
|
|
59009
|
+
},
|
|
59010
|
+
type: 'object',
|
|
59011
|
+
},
|
|
59012
|
+
},
|
|
59013
|
+
type: 'object',
|
|
59014
|
+
},
|
|
59015
|
+
customer_key: {
|
|
59016
|
+
description: 'Key of the customer.',
|
|
59017
|
+
type: 'string',
|
|
59018
|
+
},
|
|
59019
|
+
},
|
|
59020
|
+
required: ['customer_key'],
|
|
59021
|
+
type: 'object',
|
|
59022
|
+
},
|
|
59023
|
+
},
|
|
59024
|
+
},
|
|
59025
|
+
},
|
|
59026
|
+
responses: {
|
|
59027
|
+
200: {
|
|
59028
|
+
content: {
|
|
59029
|
+
'application/json': {
|
|
59030
|
+
schema: {
|
|
59031
|
+
properties: { ok: { type: 'boolean' } },
|
|
59032
|
+
required: ['ok'],
|
|
59033
|
+
type: 'object',
|
|
59034
|
+
},
|
|
59035
|
+
},
|
|
59036
|
+
},
|
|
59037
|
+
description: 'OK',
|
|
59038
|
+
},
|
|
59039
|
+
400: { description: 'Bad Request' },
|
|
59040
|
+
401: { description: 'Unauthorized' },
|
|
59041
|
+
},
|
|
59042
|
+
security: [
|
|
59043
|
+
{ pat_with_workspace: [] },
|
|
59044
|
+
{ console_session_with_workspace: [] },
|
|
59045
|
+
{ api_key: [] },
|
|
59046
|
+
],
|
|
59047
|
+
summary: '/seam/customer/v1/customers/automations/update',
|
|
59048
|
+
tags: [],
|
|
59049
|
+
'x-fern-sdk-group-name': [
|
|
59050
|
+
'seam',
|
|
59051
|
+
'customer',
|
|
59052
|
+
'v1',
|
|
59053
|
+
'customers',
|
|
59054
|
+
'automations',
|
|
59055
|
+
],
|
|
59056
|
+
'x-fern-sdk-method-name': 'update',
|
|
59057
|
+
'x-response-key': null,
|
|
59058
|
+
'x-title': 'Update Customer Automation Configuration',
|
|
59059
|
+
},
|
|
59060
|
+
},
|
|
57699
59061
|
'/seam/customer/v1/customers/list': {
|
|
57700
59062
|
get: {
|
|
57701
59063
|
description: 'Returns a list of all customers within the workspace.',
|