@seamapi/types 1.246.0 → 1.247.1

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.
@@ -735,6 +735,8 @@ export default {
735
735
  acs_user: {
736
736
  properties: {
737
737
  access_schedule: {
738
+ description:
739
+ "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
738
740
  properties: {
739
741
  ends_at: { format: 'date-time', type: 'string' },
740
742
  starts_at: { format: 'date-time', type: 'string' },
@@ -742,18 +744,39 @@ export default {
742
744
  required: ['starts_at', 'ends_at'],
743
745
  type: 'object',
744
746
  },
745
- acs_system_id: { format: 'uuid', type: 'string' },
746
- acs_user_id: { format: 'uuid', type: 'string' },
747
- created_at: { format: 'date-time', type: 'string' },
748
- display_name: { type: 'string' },
747
+ acs_system_id: {
748
+ description:
749
+ 'ID of the access control system that contains the `acs_user`.',
750
+ format: 'uuid',
751
+ type: 'string',
752
+ },
753
+ acs_user_id: {
754
+ description: 'ID of the `acs_user`.',
755
+ format: 'uuid',
756
+ type: 'string',
757
+ },
758
+ created_at: {
759
+ description: 'Date and time at which the `acs_user` was created.',
760
+ format: 'date-time',
761
+ type: 'string',
762
+ },
763
+ display_name: {
764
+ description: 'Display name for the `acs_user`.',
765
+ type: 'string',
766
+ },
749
767
  email: {
750
768
  deprecated: true,
751
769
  format: 'email',
752
770
  type: 'string',
753
771
  'x-deprecated': 'use email_address.',
754
772
  },
755
- email_address: { format: 'email', type: 'string' },
773
+ email_address: {
774
+ description: 'Email address of the `acs_user`.',
775
+ format: 'email',
776
+ type: 'string',
777
+ },
756
778
  errors: {
779
+ description: 'Errors associated with the `acs_user`.',
757
780
  items: {
758
781
  description: 'Error associated with the `acs_user`.',
759
782
  oneOf: [
@@ -877,6 +900,7 @@ export default {
877
900
  type: 'array',
878
901
  },
879
902
  external_type: {
903
+ description: 'Brand-specific terminology for the `acs_user` type.',
880
904
  enum: [
881
905
  'pti_user',
882
906
  'brivo_user',
@@ -886,22 +910,61 @@ export default {
886
910
  ],
887
911
  type: 'string',
888
912
  },
889
- external_type_display_name: { type: 'string' },
890
- full_name: { type: 'string' },
913
+ external_type_display_name: {
914
+ description:
915
+ 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
916
+ type: 'string',
917
+ },
918
+ full_name: {
919
+ description: 'Full name of the `acs_user`.',
920
+ type: 'string',
921
+ },
891
922
  hid_acs_system_id: { format: 'uuid', type: 'string' },
892
- is_latest_desired_state_synced_with_provider: { type: 'boolean' },
923
+ is_latest_desired_state_synced_with_provider: {
924
+ type: 'boolean',
925
+ 'x-undocumented': 'Only used internally.',
926
+ },
893
927
  is_managed: { enum: [true], type: 'boolean' },
894
- is_suspended: { type: 'boolean' },
928
+ is_suspended: {
929
+ description:
930
+ 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
931
+ type: 'boolean',
932
+ },
895
933
  latest_desired_state_synced_with_provider_at: {
896
934
  format: 'date-time',
897
935
  type: 'string',
936
+ 'x-undocumented': 'Only used internally.',
937
+ },
938
+ phone_number: {
939
+ description:
940
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
941
+ type: 'string',
942
+ },
943
+ user_identity_email_address: {
944
+ description:
945
+ 'Email address of the user identity associated with the `acs_user`.',
946
+ nullable: true,
947
+ type: 'string',
948
+ },
949
+ user_identity_full_name: {
950
+ description:
951
+ 'Full name of the user identity associated with the `acs_user`.',
952
+ nullable: true,
953
+ type: 'string',
954
+ },
955
+ user_identity_id: {
956
+ description:
957
+ 'ID of the user identity associated with the `acs_user`.',
958
+ type: 'string',
959
+ },
960
+ user_identity_phone_number: {
961
+ description:
962
+ 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
963
+ nullable: true,
964
+ type: 'string',
898
965
  },
899
- phone_number: { type: 'string' },
900
- user_identity_email_address: { nullable: true, type: 'string' },
901
- user_identity_full_name: { nullable: true, type: 'string' },
902
- user_identity_id: { type: 'string' },
903
- user_identity_phone_number: { nullable: true, type: 'string' },
904
966
  warnings: {
967
+ description: 'Warnings associated with the `acs_user`.',
905
968
  items: {
906
969
  description: 'Warning associated with the `acs_user`.',
907
970
  oneOf: [
@@ -934,7 +997,12 @@ export default {
934
997
  },
935
998
  type: 'array',
936
999
  },
937
- workspace_id: { format: 'uuid', type: 'string' },
1000
+ workspace_id: {
1001
+ description:
1002
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
1003
+ format: 'uuid',
1004
+ type: 'string',
1005
+ },
938
1006
  },
939
1007
  required: [
940
1008
  'acs_user_id',
@@ -7677,9 +7745,20 @@ export default {
7677
7745
  type: 'string',
7678
7746
  'x-deprecated': 'use email_address.',
7679
7747
  },
7680
- email_address: { format: 'email', type: 'string' },
7681
- full_name: { type: 'string' },
7682
- phone_number: { type: 'string' },
7748
+ email_address: {
7749
+ description: 'Email address of the `acs_user`.',
7750
+ format: 'email',
7751
+ type: 'string',
7752
+ },
7753
+ full_name: {
7754
+ description: 'Full name of the `acs_user`.',
7755
+ type: 'string',
7756
+ },
7757
+ phone_number: {
7758
+ description:
7759
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
7760
+ type: 'string',
7761
+ },
7683
7762
  user_identity_id: {
7684
7763
  description:
7685
7764
  'ID of the user identity with which to associate the new `acs_user`.',
@@ -8145,20 +8224,49 @@ export default {
8145
8224
  acs_user: {
8146
8225
  properties: {
8147
8226
  access_schedule: {
8148
- $ref: '#/components/schemas/thermostat_schedule',
8227
+ description:
8228
+ "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
8229
+ properties: {
8230
+ ends_at: { format: 'date-time', type: 'string' },
8231
+ starts_at: { format: 'date-time', type: 'string' },
8232
+ },
8233
+ required: ['starts_at', 'ends_at'],
8234
+ type: 'object',
8235
+ },
8236
+ acs_system_id: {
8237
+ description:
8238
+ 'ID of the access control system that contains the `acs_user`.',
8239
+ format: 'uuid',
8240
+ type: 'string',
8241
+ },
8242
+ acs_user_id: {
8243
+ description: 'ID of the `acs_user`.',
8244
+ format: 'uuid',
8245
+ type: 'string',
8246
+ },
8247
+ created_at: {
8248
+ description:
8249
+ 'Date and time at which the `acs_user` was created.',
8250
+ format: 'date-time',
8251
+ type: 'string',
8252
+ },
8253
+ display_name: {
8254
+ description: 'Display name for the `acs_user`.',
8255
+ type: 'string',
8149
8256
  },
8150
- acs_system_id: { format: 'uuid', type: 'string' },
8151
- acs_user_id: { format: 'uuid', type: 'string' },
8152
- created_at: { format: 'date-time', type: 'string' },
8153
- display_name: { type: 'string' },
8154
8257
  email: {
8155
8258
  deprecated: true,
8156
8259
  format: 'email',
8157
8260
  type: 'string',
8158
8261
  'x-deprecated': 'use email_address.',
8159
8262
  },
8160
- email_address: { format: 'email', type: 'string' },
8263
+ email_address: {
8264
+ description: 'Email address of the `acs_user`.',
8265
+ format: 'email',
8266
+ type: 'string',
8267
+ },
8161
8268
  errors: {
8269
+ description: 'Errors associated with the `acs_user`.',
8162
8270
  items: {
8163
8271
  description:
8164
8272
  'Error associated with the `acs_user`.',
@@ -8305,6 +8413,8 @@ export default {
8305
8413
  type: 'array',
8306
8414
  },
8307
8415
  external_type: {
8416
+ description:
8417
+ 'Brand-specific terminology for the `acs_user` type.',
8308
8418
  enum: [
8309
8419
  'pti_user',
8310
8420
  'brivo_user',
@@ -8314,33 +8424,62 @@ export default {
8314
8424
  ],
8315
8425
  type: 'string',
8316
8426
  },
8317
- external_type_display_name: { type: 'string' },
8318
- full_name: { type: 'string' },
8427
+ external_type_display_name: {
8428
+ description:
8429
+ 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
8430
+ type: 'string',
8431
+ },
8432
+ full_name: {
8433
+ description: 'Full name of the `acs_user`.',
8434
+ type: 'string',
8435
+ },
8319
8436
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8320
8437
  is_latest_desired_state_synced_with_provider: {
8321
8438
  type: 'boolean',
8439
+ 'x-undocumented': 'Only used internally.',
8322
8440
  },
8323
8441
  is_managed: { enum: [false], type: 'boolean' },
8324
- is_suspended: { type: 'boolean' },
8442
+ is_suspended: {
8443
+ description:
8444
+ 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
8445
+ type: 'boolean',
8446
+ },
8325
8447
  latest_desired_state_synced_with_provider_at: {
8326
8448
  format: 'date-time',
8327
8449
  type: 'string',
8450
+ 'x-undocumented': 'Only used internally.',
8451
+ },
8452
+ phone_number: {
8453
+ description:
8454
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8455
+ type: 'string',
8328
8456
  },
8329
- phone_number: { type: 'string' },
8330
8457
  user_identity_email_address: {
8458
+ description:
8459
+ 'Email address of the user identity associated with the `acs_user`.',
8331
8460
  nullable: true,
8332
8461
  type: 'string',
8333
8462
  },
8334
8463
  user_identity_full_name: {
8464
+ description:
8465
+ 'Full name of the user identity associated with the `acs_user`.',
8335
8466
  nullable: true,
8336
8467
  type: 'string',
8337
8468
  },
8338
- user_identity_id: { type: 'string' },
8469
+ user_identity_id: {
8470
+ description:
8471
+ 'ID of the user identity associated with the `acs_user`.',
8472
+ type: 'string',
8473
+ },
8339
8474
  user_identity_phone_number: {
8475
+ description:
8476
+ 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
8340
8477
  nullable: true,
8341
8478
  type: 'string',
8342
8479
  },
8343
8480
  warnings: {
8481
+ description:
8482
+ 'Warnings associated with the `acs_user`.',
8344
8483
  items: {
8345
8484
  description:
8346
8485
  'Warning associated with the `acs_user`.',
@@ -8391,7 +8530,12 @@ export default {
8391
8530
  },
8392
8531
  type: 'array',
8393
8532
  },
8394
- workspace_id: { format: 'uuid', type: 'string' },
8533
+ workspace_id: {
8534
+ description:
8535
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
8536
+ format: 'uuid',
8537
+ type: 'string',
8538
+ },
8395
8539
  },
8396
8540
  required: [
8397
8541
  'acs_user_id',
@@ -8460,20 +8604,53 @@ export default {
8460
8604
  items: {
8461
8605
  properties: {
8462
8606
  access_schedule: {
8463
- $ref: '#/components/schemas/thermostat_schedule',
8607
+ description:
8608
+ "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
8609
+ properties: {
8610
+ ends_at: { format: 'date-time', type: 'string' },
8611
+ starts_at: {
8612
+ format: 'date-time',
8613
+ type: 'string',
8614
+ },
8615
+ },
8616
+ required: ['starts_at', 'ends_at'],
8617
+ type: 'object',
8618
+ },
8619
+ acs_system_id: {
8620
+ description:
8621
+ 'ID of the access control system that contains the `acs_user`.',
8622
+ format: 'uuid',
8623
+ type: 'string',
8624
+ },
8625
+ acs_user_id: {
8626
+ description: 'ID of the `acs_user`.',
8627
+ format: 'uuid',
8628
+ type: 'string',
8629
+ },
8630
+ created_at: {
8631
+ description:
8632
+ 'Date and time at which the `acs_user` was created.',
8633
+ format: 'date-time',
8634
+ type: 'string',
8635
+ },
8636
+ display_name: {
8637
+ description: 'Display name for the `acs_user`.',
8638
+ type: 'string',
8464
8639
  },
8465
- acs_system_id: { format: 'uuid', type: 'string' },
8466
- acs_user_id: { format: 'uuid', type: 'string' },
8467
- created_at: { format: 'date-time', type: 'string' },
8468
- display_name: { type: 'string' },
8469
8640
  email: {
8470
8641
  deprecated: true,
8471
8642
  format: 'email',
8472
8643
  type: 'string',
8473
8644
  'x-deprecated': 'use email_address.',
8474
8645
  },
8475
- email_address: { format: 'email', type: 'string' },
8646
+ email_address: {
8647
+ description: 'Email address of the `acs_user`.',
8648
+ format: 'email',
8649
+ type: 'string',
8650
+ },
8476
8651
  errors: {
8652
+ description:
8653
+ 'Errors associated with the `acs_user`.',
8477
8654
  items: {
8478
8655
  description:
8479
8656
  'Error associated with the `acs_user`.',
@@ -8620,6 +8797,8 @@ export default {
8620
8797
  type: 'array',
8621
8798
  },
8622
8799
  external_type: {
8800
+ description:
8801
+ 'Brand-specific terminology for the `acs_user` type.',
8623
8802
  enum: [
8624
8803
  'pti_user',
8625
8804
  'brivo_user',
@@ -8629,33 +8808,62 @@ export default {
8629
8808
  ],
8630
8809
  type: 'string',
8631
8810
  },
8632
- external_type_display_name: { type: 'string' },
8633
- full_name: { type: 'string' },
8811
+ external_type_display_name: {
8812
+ description:
8813
+ 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
8814
+ type: 'string',
8815
+ },
8816
+ full_name: {
8817
+ description: 'Full name of the `acs_user`.',
8818
+ type: 'string',
8819
+ },
8634
8820
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8635
8821
  is_latest_desired_state_synced_with_provider: {
8636
8822
  type: 'boolean',
8823
+ 'x-undocumented': 'Only used internally.',
8637
8824
  },
8638
8825
  is_managed: { enum: [false], type: 'boolean' },
8639
- is_suspended: { type: 'boolean' },
8826
+ is_suspended: {
8827
+ description:
8828
+ 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
8829
+ type: 'boolean',
8830
+ },
8640
8831
  latest_desired_state_synced_with_provider_at: {
8641
8832
  format: 'date-time',
8642
8833
  type: 'string',
8834
+ 'x-undocumented': 'Only used internally.',
8835
+ },
8836
+ phone_number: {
8837
+ description:
8838
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8839
+ type: 'string',
8643
8840
  },
8644
- phone_number: { type: 'string' },
8645
8841
  user_identity_email_address: {
8842
+ description:
8843
+ 'Email address of the user identity associated with the `acs_user`.',
8646
8844
  nullable: true,
8647
8845
  type: 'string',
8648
8846
  },
8649
8847
  user_identity_full_name: {
8848
+ description:
8849
+ 'Full name of the user identity associated with the `acs_user`.',
8650
8850
  nullable: true,
8651
8851
  type: 'string',
8652
8852
  },
8653
- user_identity_id: { type: 'string' },
8853
+ user_identity_id: {
8854
+ description:
8855
+ 'ID of the user identity associated with the `acs_user`.',
8856
+ type: 'string',
8857
+ },
8654
8858
  user_identity_phone_number: {
8859
+ description:
8860
+ 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
8655
8861
  nullable: true,
8656
8862
  type: 'string',
8657
8863
  },
8658
8864
  warnings: {
8865
+ description:
8866
+ 'Warnings associated with the `acs_user`.',
8659
8867
  items: {
8660
8868
  description:
8661
8869
  'Warning associated with the `acs_user`.',
@@ -8706,7 +8914,12 @@ export default {
8706
8914
  },
8707
8915
  type: 'array',
8708
8916
  },
8709
- workspace_id: { format: 'uuid', type: 'string' },
8917
+ workspace_id: {
8918
+ description:
8919
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
8920
+ format: 'uuid',
8921
+ type: 'string',
8922
+ },
8710
8923
  },
8711
8924
  required: [
8712
8925
  'acs_user_id',
@@ -8819,17 +9032,32 @@ export default {
8819
9032
  required: ['starts_at', 'ends_at'],
8820
9033
  type: 'object',
8821
9034
  },
8822
- acs_user_id: { format: 'uuid', type: 'string' },
9035
+ acs_user_id: {
9036
+ description: 'ID of the `acs_user`.',
9037
+ format: 'uuid',
9038
+ type: 'string',
9039
+ },
8823
9040
  email: {
8824
9041
  deprecated: true,
8825
9042
  format: 'email',
8826
9043
  type: 'string',
8827
9044
  'x-deprecated': 'use email_address.',
8828
9045
  },
8829
- email_address: { format: 'email', type: 'string' },
8830
- full_name: { type: 'string' },
9046
+ email_address: {
9047
+ description: 'Email address of the `acs_user`.',
9048
+ format: 'email',
9049
+ type: 'string',
9050
+ },
9051
+ full_name: {
9052
+ description: 'Full name of the `acs_user`.',
9053
+ type: 'string',
9054
+ },
8831
9055
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8832
- phone_number: { type: 'string' },
9056
+ phone_number: {
9057
+ description:
9058
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
9059
+ type: 'string',
9060
+ },
8833
9061
  },
8834
9062
  required: ['acs_user_id'],
8835
9063
  type: 'object',
@@ -8883,17 +9111,32 @@ export default {
8883
9111
  required: ['starts_at', 'ends_at'],
8884
9112
  type: 'object',
8885
9113
  },
8886
- acs_user_id: { format: 'uuid', type: 'string' },
9114
+ acs_user_id: {
9115
+ description: 'ID of the `acs_user`.',
9116
+ format: 'uuid',
9117
+ type: 'string',
9118
+ },
8887
9119
  email: {
8888
9120
  deprecated: true,
8889
9121
  format: 'email',
8890
9122
  type: 'string',
8891
9123
  'x-deprecated': 'use email_address.',
8892
9124
  },
8893
- email_address: { format: 'email', type: 'string' },
8894
- full_name: { type: 'string' },
9125
+ email_address: {
9126
+ description: 'Email address of the `acs_user`.',
9127
+ format: 'email',
9128
+ type: 'string',
9129
+ },
9130
+ full_name: {
9131
+ description: 'Full name of the `acs_user`.',
9132
+ type: 'string',
9133
+ },
8895
9134
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8896
- phone_number: { type: 'string' },
9135
+ phone_number: {
9136
+ description:
9137
+ 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
9138
+ type: 'string',
9139
+ },
8897
9140
  },
8898
9141
  required: ['acs_user_id'],
8899
9142
  type: 'object',
@@ -13625,13 +13868,8 @@ export default {
13625
13868
  content: {
13626
13869
  'application/json': {
13627
13870
  schema: {
13628
- properties: {
13629
- ok: { type: 'boolean' },
13630
- thermostat_schedule: {
13631
- $ref: '#/components/schemas/thermostat_schedule',
13632
- },
13633
- },
13634
- required: ['thermostat_schedule', 'ok'],
13871
+ properties: { ok: { type: 'boolean' } },
13872
+ required: ['ok'],
13635
13873
  type: 'object',
13636
13874
  },
13637
13875
  },
@@ -13676,13 +13914,8 @@ export default {
13676
13914
  content: {
13677
13915
  'application/json': {
13678
13916
  schema: {
13679
- properties: {
13680
- ok: { type: 'boolean' },
13681
- thermostat_schedule: {
13682
- $ref: '#/components/schemas/thermostat_schedule',
13683
- },
13684
- },
13685
- required: ['thermostat_schedule', 'ok'],
13917
+ properties: { ok: { type: 'boolean' } },
13918
+ required: ['ok'],
13686
13919
  type: 'object',
13687
13920
  },
13688
13921
  },
@@ -13855,13 +14088,8 @@ export default {
13855
14088
  content: {
13856
14089
  'application/json': {
13857
14090
  schema: {
13858
- properties: {
13859
- climate_preset: {
13860
- $ref: '#/components/schemas/climate_preset',
13861
- },
13862
- ok: { type: 'boolean' },
13863
- },
13864
- required: ['climate_preset', 'ok'],
14091
+ properties: { ok: { type: 'boolean' } },
14092
+ required: ['ok'],
13865
14093
  type: 'object',
13866
14094
  },
13867
14095
  },
@@ -13928,13 +14156,8 @@ export default {
13928
14156
  content: {
13929
14157
  'application/json': {
13930
14158
  schema: {
13931
- properties: {
13932
- climate_preset: {
13933
- $ref: '#/components/schemas/climate_preset',
13934
- },
13935
- ok: { type: 'boolean' },
13936
- },
13937
- required: ['climate_preset', 'ok'],
14159
+ properties: { ok: { type: 'boolean' } },
14160
+ required: ['ok'],
13938
14161
  type: 'object',
13939
14162
  },
13940
14163
  },