@seamapi/types 1.618.0 → 1.620.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.
@@ -20938,10 +20938,34 @@ export default {
20938
20938
  staff_member: {
20939
20939
  description: 'Represents a staff member for a specific customer.',
20940
20940
  properties: {
20941
+ building_keys: {
20942
+ description:
20943
+ 'List of unique identifiers for the buildings the staff member is associated with.',
20944
+ items: { type: 'string' },
20945
+ type: 'array',
20946
+ },
20947
+ common_area_keys: {
20948
+ description:
20949
+ 'List of unique identifiers for the common areas the staff member is associated with.',
20950
+ items: { type: 'string' },
20951
+ type: 'array',
20952
+ },
20941
20953
  email_address: {
20942
20954
  description: 'Email address associated with the user identity.',
20943
20955
  type: 'string',
20944
20956
  },
20957
+ facility_keys: {
20958
+ description:
20959
+ 'List of unique identifiers for the facilities the staff member is associated with.',
20960
+ items: { type: 'string' },
20961
+ type: 'array',
20962
+ },
20963
+ listing_keys: {
20964
+ description:
20965
+ 'List of unique identifiers for the listings the staff member is associated with.',
20966
+ items: { type: 'string' },
20967
+ type: 'array',
20968
+ },
20945
20969
  name: {
20946
20970
  description: 'Your display name for this user identity resource.',
20947
20971
  type: 'string',
@@ -20950,18 +20974,48 @@ export default {
20950
20974
  description: 'Phone number associated with the user identity.',
20951
20975
  type: 'string',
20952
20976
  },
20977
+ property_keys: {
20978
+ description:
20979
+ 'List of unique identifiers for the properties the staff member is associated with.',
20980
+ items: { type: 'string' },
20981
+ type: 'array',
20982
+ },
20983
+ property_listing_keys: {
20984
+ description:
20985
+ 'List of unique identifiers for the property listings the staff member is associated with.',
20986
+ items: { type: 'string' },
20987
+ type: 'array',
20988
+ },
20989
+ room_keys: {
20990
+ description:
20991
+ 'List of unique identifiers for the rooms the staff member is associated with.',
20992
+ items: { type: 'string' },
20993
+ type: 'array',
20994
+ },
20953
20995
  site_keys: {
20954
20996
  description:
20955
20997
  'List of unique identifiers for the sites the staff member is associated with.',
20956
20998
  items: { type: 'string' },
20957
20999
  type: 'array',
20958
21000
  },
21001
+ space_keys: {
21002
+ description:
21003
+ 'List of unique identifiers for the spaces the staff member is associated with.',
21004
+ items: { type: 'string' },
21005
+ type: 'array',
21006
+ },
20959
21007
  staff_member_key: {
20960
21008
  description: 'Your unique identifier for the staff.',
20961
21009
  type: 'string',
20962
21010
  },
21011
+ unit_keys: {
21012
+ description:
21013
+ 'List of unique identifiers for the units the staff member is associated with.',
21014
+ items: { type: 'string' },
21015
+ type: 'array',
21016
+ },
20963
21017
  },
20964
- required: ['name', 'staff_member_key', 'site_keys'],
21018
+ required: ['name', 'staff_member_key'],
20965
21019
  type: 'object',
20966
21020
  'x-route-path': '/seam/customer/v1/staff_members',
20967
21021
  },
@@ -41878,11 +41932,35 @@ export default {
41878
41932
  description:
41879
41933
  'Represents a staff member for a specific customer.',
41880
41934
  properties: {
41935
+ building_keys: {
41936
+ description:
41937
+ 'List of unique identifiers for the buildings the staff member is associated with.',
41938
+ items: { type: 'string' },
41939
+ type: 'array',
41940
+ },
41941
+ common_area_keys: {
41942
+ description:
41943
+ 'List of unique identifiers for the common areas the staff member is associated with.',
41944
+ items: { type: 'string' },
41945
+ type: 'array',
41946
+ },
41881
41947
  email_address: {
41882
41948
  description:
41883
41949
  'Email address associated with the user identity.',
41884
41950
  type: 'string',
41885
41951
  },
41952
+ facility_keys: {
41953
+ description:
41954
+ 'List of unique identifiers for the facilities the staff member is associated with.',
41955
+ items: { type: 'string' },
41956
+ type: 'array',
41957
+ },
41958
+ listing_keys: {
41959
+ description:
41960
+ 'List of unique identifiers for the listings the staff member is associated with.',
41961
+ items: { type: 'string' },
41962
+ type: 'array',
41963
+ },
41886
41964
  name: {
41887
41965
  description:
41888
41966
  'Your display name for this user identity resource.',
@@ -41893,23 +41971,49 @@ export default {
41893
41971
  'Phone number associated with the user identity.',
41894
41972
  type: 'string',
41895
41973
  },
41974
+ property_keys: {
41975
+ description:
41976
+ 'List of unique identifiers for the properties the staff member is associated with.',
41977
+ items: { type: 'string' },
41978
+ type: 'array',
41979
+ },
41980
+ property_listing_keys: {
41981
+ description:
41982
+ 'List of unique identifiers for the property listings the staff member is associated with.',
41983
+ items: { type: 'string' },
41984
+ type: 'array',
41985
+ },
41986
+ room_keys: {
41987
+ description:
41988
+ 'List of unique identifiers for the rooms the staff member is associated with.',
41989
+ items: { type: 'string' },
41990
+ type: 'array',
41991
+ },
41896
41992
  site_keys: {
41897
41993
  description:
41898
41994
  'List of unique identifiers for the sites the staff member is associated with.',
41899
41995
  items: { type: 'string' },
41900
41996
  type: 'array',
41901
41997
  },
41998
+ space_keys: {
41999
+ description:
42000
+ 'List of unique identifiers for the spaces the staff member is associated with.',
42001
+ items: { type: 'string' },
42002
+ type: 'array',
42003
+ },
41902
42004
  staff_member_key: {
41903
42005
  description:
41904
42006
  'Your unique identifier for the staff.',
41905
42007
  type: 'string',
41906
42008
  },
42009
+ unit_keys: {
42010
+ description:
42011
+ 'List of unique identifiers for the units the staff member is associated with.',
42012
+ items: { type: 'string' },
42013
+ type: 'array',
42014
+ },
41907
42015
  },
41908
- required: [
41909
- 'name',
41910
- 'staff_member_key',
41911
- 'site_keys',
41912
- ],
42016
+ required: ['name', 'staff_member_key'],
41913
42017
  type: 'object',
41914
42018
  'x-route-path': '/seam/customer/v1/staff_members',
41915
42019
  },
@@ -43018,11 +43122,35 @@ export default {
43018
43122
  description:
43019
43123
  'Represents a staff member for a specific customer.',
43020
43124
  properties: {
43125
+ building_keys: {
43126
+ description:
43127
+ 'List of unique identifiers for the buildings the staff member is associated with.',
43128
+ items: { type: 'string' },
43129
+ type: 'array',
43130
+ },
43131
+ common_area_keys: {
43132
+ description:
43133
+ 'List of unique identifiers for the common areas the staff member is associated with.',
43134
+ items: { type: 'string' },
43135
+ type: 'array',
43136
+ },
43021
43137
  email_address: {
43022
43138
  description:
43023
43139
  'Email address associated with the user identity.',
43024
43140
  type: 'string',
43025
43141
  },
43142
+ facility_keys: {
43143
+ description:
43144
+ 'List of unique identifiers for the facilities the staff member is associated with.',
43145
+ items: { type: 'string' },
43146
+ type: 'array',
43147
+ },
43148
+ listing_keys: {
43149
+ description:
43150
+ 'List of unique identifiers for the listings the staff member is associated with.',
43151
+ items: { type: 'string' },
43152
+ type: 'array',
43153
+ },
43026
43154
  name: {
43027
43155
  description:
43028
43156
  'Your display name for this user identity resource.',
@@ -43033,18 +43161,48 @@ export default {
43033
43161
  'Phone number associated with the user identity.',
43034
43162
  type: 'string',
43035
43163
  },
43164
+ property_keys: {
43165
+ description:
43166
+ 'List of unique identifiers for the properties the staff member is associated with.',
43167
+ items: { type: 'string' },
43168
+ type: 'array',
43169
+ },
43170
+ property_listing_keys: {
43171
+ description:
43172
+ 'List of unique identifiers for the property listings the staff member is associated with.',
43173
+ items: { type: 'string' },
43174
+ type: 'array',
43175
+ },
43176
+ room_keys: {
43177
+ description:
43178
+ 'List of unique identifiers for the rooms the staff member is associated with.',
43179
+ items: { type: 'string' },
43180
+ type: 'array',
43181
+ },
43036
43182
  site_keys: {
43037
43183
  description:
43038
43184
  'List of unique identifiers for the sites the staff member is associated with.',
43039
43185
  items: { type: 'string' },
43040
43186
  type: 'array',
43041
43187
  },
43188
+ space_keys: {
43189
+ description:
43190
+ 'List of unique identifiers for the spaces the staff member is associated with.',
43191
+ items: { type: 'string' },
43192
+ type: 'array',
43193
+ },
43042
43194
  staff_member_key: {
43043
43195
  description: 'Your unique identifier for the staff.',
43044
43196
  type: 'string',
43045
43197
  },
43198
+ unit_keys: {
43199
+ description:
43200
+ 'List of unique identifiers for the units the staff member is associated with.',
43201
+ items: { type: 'string' },
43202
+ type: 'array',
43203
+ },
43046
43204
  },
43047
- required: ['name', 'staff_member_key', 'site_keys'],
43205
+ required: ['name', 'staff_member_key'],
43048
43206
  type: 'object',
43049
43207
  'x-route-path': '/seam/customer/v1/staff_members',
43050
43208
  },
@@ -51459,6 +51617,69 @@ export default {
51459
51617
  },
51460
51618
  type: 'object',
51461
51619
  },
51620
+ climate_rules: {
51621
+ properties: {
51622
+ rules: {
51623
+ properties: {
51624
+ delete_on_reservation_end: {
51625
+ properties: { enabled: { type: 'boolean' } },
51626
+ required: ['enabled'],
51627
+ type: 'object',
51628
+ },
51629
+ reservation_created: {
51630
+ properties: {
51631
+ enabled: { type: 'boolean' },
51632
+ fallback_preset: {
51633
+ properties: {
51634
+ fan_mode: {
51635
+ enum: ['on', 'auto', 'circulate'],
51636
+ type: 'string',
51637
+ },
51638
+ is_override_allowed: { type: 'boolean' },
51639
+ mode: {
51640
+ enum: ['heat', 'cool', 'auto'],
51641
+ type: 'string',
51642
+ },
51643
+ override_period_minutes: {
51644
+ format: 'float',
51645
+ type: 'number',
51646
+ },
51647
+ temperature: {
51648
+ format: 'float',
51649
+ type: 'number',
51650
+ },
51651
+ temperature_unit: {
51652
+ enum: ['celsius', 'fahrenheit'],
51653
+ type: 'string',
51654
+ },
51655
+ },
51656
+ required: [
51657
+ 'mode',
51658
+ 'temperature',
51659
+ 'temperature_unit',
51660
+ 'fan_mode',
51661
+ 'is_override_allowed',
51662
+ 'override_period_minutes',
51663
+ ],
51664
+ type: 'object',
51665
+ },
51666
+ occupied_preset_key: { type: 'string' },
51667
+ },
51668
+ required: ['enabled'],
51669
+ type: 'object',
51670
+ },
51671
+ update_on_time_change: {
51672
+ properties: { enabled: { type: 'boolean' } },
51673
+ required: ['enabled'],
51674
+ type: 'object',
51675
+ },
51676
+ },
51677
+ type: 'object',
51678
+ },
51679
+ },
51680
+ required: ['rules'],
51681
+ type: 'object',
51682
+ },
51462
51683
  ok: { type: 'boolean' },
51463
51684
  },
51464
51685
  required: ['ok'],
@@ -51586,6 +51807,69 @@ export default {
51586
51807
  },
51587
51808
  type: 'object',
51588
51809
  },
51810
+ climate_rules: {
51811
+ properties: {
51812
+ rules: {
51813
+ properties: {
51814
+ delete_on_reservation_end: {
51815
+ properties: { enabled: { type: 'boolean' } },
51816
+ required: ['enabled'],
51817
+ type: 'object',
51818
+ },
51819
+ reservation_created: {
51820
+ properties: {
51821
+ enabled: { type: 'boolean' },
51822
+ fallback_preset: {
51823
+ properties: {
51824
+ fan_mode: {
51825
+ enum: ['on', 'auto', 'circulate'],
51826
+ type: 'string',
51827
+ },
51828
+ is_override_allowed: { type: 'boolean' },
51829
+ mode: {
51830
+ enum: ['heat', 'cool', 'auto'],
51831
+ type: 'string',
51832
+ },
51833
+ override_period_minutes: {
51834
+ format: 'float',
51835
+ type: 'number',
51836
+ },
51837
+ temperature: {
51838
+ format: 'float',
51839
+ type: 'number',
51840
+ },
51841
+ temperature_unit: {
51842
+ enum: ['celsius', 'fahrenheit'],
51843
+ type: 'string',
51844
+ },
51845
+ },
51846
+ required: [
51847
+ 'mode',
51848
+ 'temperature',
51849
+ 'temperature_unit',
51850
+ 'fan_mode',
51851
+ 'is_override_allowed',
51852
+ 'override_period_minutes',
51853
+ ],
51854
+ type: 'object',
51855
+ },
51856
+ occupied_preset_key: { type: 'string' },
51857
+ },
51858
+ required: ['enabled'],
51859
+ type: 'object',
51860
+ },
51861
+ update_on_time_change: {
51862
+ properties: { enabled: { type: 'boolean' } },
51863
+ required: ['enabled'],
51864
+ type: 'object',
51865
+ },
51866
+ },
51867
+ type: 'object',
51868
+ },
51869
+ },
51870
+ required: ['rules'],
51871
+ type: 'object',
51872
+ },
51589
51873
  ok: { type: 'boolean' },
51590
51874
  },
51591
51875
  required: ['ok'],
@@ -51707,6 +51991,69 @@ export default {
51707
51991
  },
51708
51992
  type: 'object',
51709
51993
  },
51994
+ climate_rules: {
51995
+ description: 'Climate automation rules configuration.',
51996
+ properties: {
51997
+ rules: {
51998
+ properties: {
51999
+ delete_on_reservation_end: {
52000
+ properties: { enabled: { type: 'boolean' } },
52001
+ required: ['enabled'],
52002
+ type: 'object',
52003
+ },
52004
+ reservation_created: {
52005
+ properties: {
52006
+ enabled: { type: 'boolean' },
52007
+ fallback_preset: {
52008
+ properties: {
52009
+ fan_mode: {
52010
+ enum: ['on', 'auto', 'circulate'],
52011
+ type: 'string',
52012
+ },
52013
+ is_override_allowed: { type: 'boolean' },
52014
+ mode: {
52015
+ enum: ['heat', 'cool', 'auto'],
52016
+ type: 'string',
52017
+ },
52018
+ override_period_minutes: {
52019
+ format: 'float',
52020
+ type: 'number',
52021
+ },
52022
+ temperature: {
52023
+ format: 'float',
52024
+ type: 'number',
52025
+ },
52026
+ temperature_unit: {
52027
+ enum: ['celsius', 'fahrenheit'],
52028
+ type: 'string',
52029
+ },
52030
+ },
52031
+ required: [
52032
+ 'mode',
52033
+ 'temperature',
52034
+ 'temperature_unit',
52035
+ 'fan_mode',
52036
+ 'is_override_allowed',
52037
+ 'override_period_minutes',
52038
+ ],
52039
+ type: 'object',
52040
+ },
52041
+ occupied_preset_key: { type: 'string' },
52042
+ },
52043
+ required: ['enabled'],
52044
+ type: 'object',
52045
+ },
52046
+ update_on_time_change: {
52047
+ properties: { enabled: { type: 'boolean' } },
52048
+ required: ['enabled'],
52049
+ type: 'object',
52050
+ },
52051
+ },
52052
+ type: 'object',
52053
+ },
52054
+ },
52055
+ type: 'object',
52056
+ },
51710
52057
  },
51711
52058
  type: 'object',
51712
52059
  },
@@ -51836,6 +52183,69 @@ export default {
51836
52183
  },
51837
52184
  type: 'object',
51838
52185
  },
52186
+ climate_rules: {
52187
+ description: 'Climate automation rules configuration.',
52188
+ properties: {
52189
+ rules: {
52190
+ properties: {
52191
+ delete_on_reservation_end: {
52192
+ properties: { enabled: { type: 'boolean' } },
52193
+ required: ['enabled'],
52194
+ type: 'object',
52195
+ },
52196
+ reservation_created: {
52197
+ properties: {
52198
+ enabled: { type: 'boolean' },
52199
+ fallback_preset: {
52200
+ properties: {
52201
+ fan_mode: {
52202
+ enum: ['on', 'auto', 'circulate'],
52203
+ type: 'string',
52204
+ },
52205
+ is_override_allowed: { type: 'boolean' },
52206
+ mode: {
52207
+ enum: ['heat', 'cool', 'auto'],
52208
+ type: 'string',
52209
+ },
52210
+ override_period_minutes: {
52211
+ format: 'float',
52212
+ type: 'number',
52213
+ },
52214
+ temperature: {
52215
+ format: 'float',
52216
+ type: 'number',
52217
+ },
52218
+ temperature_unit: {
52219
+ enum: ['celsius', 'fahrenheit'],
52220
+ type: 'string',
52221
+ },
52222
+ },
52223
+ required: [
52224
+ 'mode',
52225
+ 'temperature',
52226
+ 'temperature_unit',
52227
+ 'fan_mode',
52228
+ 'is_override_allowed',
52229
+ 'override_period_minutes',
52230
+ ],
52231
+ type: 'object',
52232
+ },
52233
+ occupied_preset_key: { type: 'string' },
52234
+ },
52235
+ required: ['enabled'],
52236
+ type: 'object',
52237
+ },
52238
+ update_on_time_change: {
52239
+ properties: { enabled: { type: 'boolean' } },
52240
+ required: ['enabled'],
52241
+ type: 'object',
52242
+ },
52243
+ },
52244
+ type: 'object',
52245
+ },
52246
+ },
52247
+ type: 'object',
52248
+ },
51839
52249
  },
51840
52250
  type: 'object',
51841
52251
  },
@@ -54197,7 +54607,42 @@ export default {
54197
54607
  ok: { type: 'boolean' },
54198
54608
  pagination: { $ref: '#/components/schemas/pagination' },
54199
54609
  staff_members: {
54200
- items: { $ref: '#/components/schemas/staff_member' },
54610
+ items: {
54611
+ description:
54612
+ 'Represents a staff member for a specific customer.',
54613
+ properties: {
54614
+ email_address: {
54615
+ description:
54616
+ 'Email address associated with the user identity.',
54617
+ type: 'string',
54618
+ },
54619
+ name: {
54620
+ description:
54621
+ 'Your display name for this user identity resource.',
54622
+ type: 'string',
54623
+ },
54624
+ phone_number: {
54625
+ description:
54626
+ 'Phone number associated with the user identity.',
54627
+ type: 'string',
54628
+ },
54629
+ space_keys: {
54630
+ description:
54631
+ 'List of unique identifiers for the spaces the staff member is associated with.',
54632
+ items: { type: 'string' },
54633
+ type: 'array',
54634
+ },
54635
+ staff_member_key: {
54636
+ description:
54637
+ 'Your unique identifier for the staff.',
54638
+ type: 'string',
54639
+ },
54640
+ user_identity_id: { format: 'uuid', type: 'string' },
54641
+ },
54642
+ required: ['staff_member_key', 'name'],
54643
+ type: 'object',
54644
+ 'x-route-path': '/seam/customer/v1/staff_members',
54645
+ },
54201
54646
  type: 'array',
54202
54647
  },
54203
54648
  },
@@ -54274,7 +54719,42 @@ export default {
54274
54719
  ok: { type: 'boolean' },
54275
54720
  pagination: { $ref: '#/components/schemas/pagination' },
54276
54721
  staff_members: {
54277
- items: { $ref: '#/components/schemas/staff_member' },
54722
+ items: {
54723
+ description:
54724
+ 'Represents a staff member for a specific customer.',
54725
+ properties: {
54726
+ email_address: {
54727
+ description:
54728
+ 'Email address associated with the user identity.',
54729
+ type: 'string',
54730
+ },
54731
+ name: {
54732
+ description:
54733
+ 'Your display name for this user identity resource.',
54734
+ type: 'string',
54735
+ },
54736
+ phone_number: {
54737
+ description:
54738
+ 'Phone number associated with the user identity.',
54739
+ type: 'string',
54740
+ },
54741
+ space_keys: {
54742
+ description:
54743
+ 'List of unique identifiers for the spaces the staff member is associated with.',
54744
+ items: { type: 'string' },
54745
+ type: 'array',
54746
+ },
54747
+ staff_member_key: {
54748
+ description:
54749
+ 'Your unique identifier for the staff.',
54750
+ type: 'string',
54751
+ },
54752
+ user_identity_id: { format: 'uuid', type: 'string' },
54753
+ },
54754
+ required: ['staff_member_key', 'name'],
54755
+ type: 'object',
54756
+ 'x-route-path': '/seam/customer/v1/staff_members',
54757
+ },
54278
54758
  type: 'array',
54279
54759
  },
54280
54760
  },