@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.
Files changed (13) hide show
  1. package/dist/connect.cjs +309 -100
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +244 -44
  4. package/lib/seam/connect/models/acs/acs-user.js +72 -20
  5. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +95 -14
  7. package/lib/seam/connect/openapi.js +261 -78
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +149 -30
  10. package/package.json +1 -1
  11. package/src/lib/seam/connect/models/acs/acs-user.ts +90 -20
  12. package/src/lib/seam/connect/openapi.ts +301 -78
  13. package/src/lib/seam/connect/route-types.ts +149 -30
package/lib/seam/connect/openapi.js CHANGED
@@ -686,6 +686,7 @@ export default {
686
686
  acs_user: {
687
687
  properties: {
688
688
  access_schedule: {
689
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
689
690
  properties: {
690
691
  ends_at: { format: 'date-time', type: 'string' },
691
692
  starts_at: { format: 'date-time', type: 'string' },
@@ -693,18 +694,38 @@ export default {
693
694
  required: ['starts_at', 'ends_at'],
694
695
  type: 'object',
695
696
  },
696
- acs_system_id: { format: 'uuid', type: 'string' },
697
- acs_user_id: { format: 'uuid', type: 'string' },
698
- created_at: { format: 'date-time', type: 'string' },
699
- display_name: { type: 'string' },
697
+ acs_system_id: {
698
+ description: 'ID of the access control system that contains the `acs_user`.',
699
+ format: 'uuid',
700
+ type: 'string',
701
+ },
702
+ acs_user_id: {
703
+ description: 'ID of the `acs_user`.',
704
+ format: 'uuid',
705
+ type: 'string',
706
+ },
707
+ created_at: {
708
+ description: 'Date and time at which the `acs_user` was created.',
709
+ format: 'date-time',
710
+ type: 'string',
711
+ },
712
+ display_name: {
713
+ description: 'Display name for the `acs_user`.',
714
+ type: 'string',
715
+ },
700
716
  email: {
701
717
  deprecated: true,
702
718
  format: 'email',
703
719
  type: 'string',
704
720
  'x-deprecated': 'use email_address.',
705
721
  },
706
- email_address: { format: 'email', type: 'string' },
722
+ email_address: {
723
+ description: 'Email address of the `acs_user`.',
724
+ format: 'email',
725
+ type: 'string',
726
+ },
707
727
  errors: {
728
+ description: 'Errors associated with the `acs_user`.',
708
729
  items: {
709
730
  description: 'Error associated with the `acs_user`.',
710
731
  oneOf: [
@@ -813,6 +834,7 @@ export default {
813
834
  type: 'array',
814
835
  },
815
836
  external_type: {
837
+ description: 'Brand-specific terminology for the `acs_user` type.',
816
838
  enum: [
817
839
  'pti_user',
818
840
  'brivo_user',
@@ -822,22 +844,54 @@ export default {
822
844
  ],
823
845
  type: 'string',
824
846
  },
825
- external_type_display_name: { type: 'string' },
826
- full_name: { type: 'string' },
847
+ external_type_display_name: {
848
+ description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
849
+ type: 'string',
850
+ },
851
+ full_name: {
852
+ description: 'Full name of the `acs_user`.',
853
+ type: 'string',
854
+ },
827
855
  hid_acs_system_id: { format: 'uuid', type: 'string' },
828
- is_latest_desired_state_synced_with_provider: { type: 'boolean' },
856
+ is_latest_desired_state_synced_with_provider: {
857
+ type: 'boolean',
858
+ 'x-undocumented': 'Only used internally.',
859
+ },
829
860
  is_managed: { enum: [true], type: 'boolean' },
830
- is_suspended: { type: 'boolean' },
861
+ is_suspended: {
862
+ description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
863
+ type: 'boolean',
864
+ },
831
865
  latest_desired_state_synced_with_provider_at: {
832
866
  format: 'date-time',
833
867
  type: 'string',
868
+ 'x-undocumented': 'Only used internally.',
869
+ },
870
+ phone_number: {
871
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
872
+ type: 'string',
873
+ },
874
+ user_identity_email_address: {
875
+ description: 'Email address of the user identity associated with the `acs_user`.',
876
+ nullable: true,
877
+ type: 'string',
878
+ },
879
+ user_identity_full_name: {
880
+ description: 'Full name of the user identity associated with the `acs_user`.',
881
+ nullable: true,
882
+ type: 'string',
883
+ },
884
+ user_identity_id: {
885
+ description: 'ID of the user identity associated with the `acs_user`.',
886
+ type: 'string',
887
+ },
888
+ user_identity_phone_number: {
889
+ description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
890
+ nullable: true,
891
+ type: 'string',
834
892
  },
835
- phone_number: { type: 'string' },
836
- user_identity_email_address: { nullable: true, type: 'string' },
837
- user_identity_full_name: { nullable: true, type: 'string' },
838
- user_identity_id: { type: 'string' },
839
- user_identity_phone_number: { nullable: true, type: 'string' },
840
893
  warnings: {
894
+ description: 'Warnings associated with the `acs_user`.',
841
895
  items: {
842
896
  description: 'Warning associated with the `acs_user`.',
843
897
  oneOf: [
@@ -868,7 +922,11 @@ export default {
868
922
  },
869
923
  type: 'array',
870
924
  },
871
- workspace_id: { format: 'uuid', type: 'string' },
925
+ workspace_id: {
926
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
927
+ format: 'uuid',
928
+ type: 'string',
929
+ },
872
930
  },
873
931
  required: [
874
932
  'acs_user_id',
@@ -7535,9 +7593,19 @@ export default {
7535
7593
  type: 'string',
7536
7594
  'x-deprecated': 'use email_address.',
7537
7595
  },
7538
- email_address: { format: 'email', type: 'string' },
7539
- full_name: { type: 'string' },
7540
- phone_number: { type: 'string' },
7596
+ email_address: {
7597
+ description: 'Email address of the `acs_user`.',
7598
+ format: 'email',
7599
+ type: 'string',
7600
+ },
7601
+ full_name: {
7602
+ description: 'Full name of the `acs_user`.',
7603
+ type: 'string',
7604
+ },
7605
+ phone_number: {
7606
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
7607
+ type: 'string',
7608
+ },
7541
7609
  user_identity_id: {
7542
7610
  description: 'ID of the user identity with which to associate the new `acs_user`.',
7543
7611
  format: 'uuid',
@@ -7991,20 +8059,46 @@ export default {
7991
8059
  acs_user: {
7992
8060
  properties: {
7993
8061
  access_schedule: {
7994
- $ref: '#/components/schemas/thermostat_schedule',
8062
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
8063
+ properties: {
8064
+ ends_at: { format: 'date-time', type: 'string' },
8065
+ starts_at: { format: 'date-time', type: 'string' },
8066
+ },
8067
+ required: ['starts_at', 'ends_at'],
8068
+ type: 'object',
8069
+ },
8070
+ acs_system_id: {
8071
+ description: 'ID of the access control system that contains the `acs_user`.',
8072
+ format: 'uuid',
8073
+ type: 'string',
8074
+ },
8075
+ acs_user_id: {
8076
+ description: 'ID of the `acs_user`.',
8077
+ format: 'uuid',
8078
+ type: 'string',
8079
+ },
8080
+ created_at: {
8081
+ description: 'Date and time at which the `acs_user` was created.',
8082
+ format: 'date-time',
8083
+ type: 'string',
8084
+ },
8085
+ display_name: {
8086
+ description: 'Display name for the `acs_user`.',
8087
+ type: 'string',
7995
8088
  },
7996
- acs_system_id: { format: 'uuid', type: 'string' },
7997
- acs_user_id: { format: 'uuid', type: 'string' },
7998
- created_at: { format: 'date-time', type: 'string' },
7999
- display_name: { type: 'string' },
8000
8089
  email: {
8001
8090
  deprecated: true,
8002
8091
  format: 'email',
8003
8092
  type: 'string',
8004
8093
  'x-deprecated': 'use email_address.',
8005
8094
  },
8006
- email_address: { format: 'email', type: 'string' },
8095
+ email_address: {
8096
+ description: 'Email address of the `acs_user`.',
8097
+ format: 'email',
8098
+ type: 'string',
8099
+ },
8007
8100
  errors: {
8101
+ description: 'Errors associated with the `acs_user`.',
8008
8102
  items: {
8009
8103
  description: 'Error associated with the `acs_user`.',
8010
8104
  oneOf: [
@@ -8135,6 +8229,7 @@ export default {
8135
8229
  type: 'array',
8136
8230
  },
8137
8231
  external_type: {
8232
+ description: 'Brand-specific terminology for the `acs_user` type.',
8138
8233
  enum: [
8139
8234
  'pti_user',
8140
8235
  'brivo_user',
@@ -8144,33 +8239,54 @@ export default {
8144
8239
  ],
8145
8240
  type: 'string',
8146
8241
  },
8147
- external_type_display_name: { type: 'string' },
8148
- full_name: { type: 'string' },
8242
+ external_type_display_name: {
8243
+ description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
8244
+ type: 'string',
8245
+ },
8246
+ full_name: {
8247
+ description: 'Full name of the `acs_user`.',
8248
+ type: 'string',
8249
+ },
8149
8250
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8150
8251
  is_latest_desired_state_synced_with_provider: {
8151
8252
  type: 'boolean',
8253
+ 'x-undocumented': 'Only used internally.',
8152
8254
  },
8153
8255
  is_managed: { enum: [false], type: 'boolean' },
8154
- is_suspended: { type: 'boolean' },
8256
+ is_suspended: {
8257
+ description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
8258
+ type: 'boolean',
8259
+ },
8155
8260
  latest_desired_state_synced_with_provider_at: {
8156
8261
  format: 'date-time',
8157
8262
  type: 'string',
8263
+ 'x-undocumented': 'Only used internally.',
8264
+ },
8265
+ phone_number: {
8266
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8267
+ type: 'string',
8158
8268
  },
8159
- phone_number: { type: 'string' },
8160
8269
  user_identity_email_address: {
8270
+ description: 'Email address of the user identity associated with the `acs_user`.',
8161
8271
  nullable: true,
8162
8272
  type: 'string',
8163
8273
  },
8164
8274
  user_identity_full_name: {
8275
+ description: 'Full name of the user identity associated with the `acs_user`.',
8165
8276
  nullable: true,
8166
8277
  type: 'string',
8167
8278
  },
8168
- user_identity_id: { type: 'string' },
8279
+ user_identity_id: {
8280
+ description: 'ID of the user identity associated with the `acs_user`.',
8281
+ type: 'string',
8282
+ },
8169
8283
  user_identity_phone_number: {
8284
+ description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
8170
8285
  nullable: true,
8171
8286
  type: 'string',
8172
8287
  },
8173
8288
  warnings: {
8289
+ description: 'Warnings associated with the `acs_user`.',
8174
8290
  items: {
8175
8291
  description: 'Warning associated with the `acs_user`.',
8176
8292
  oneOf: [
@@ -8218,7 +8334,11 @@ export default {
8218
8334
  },
8219
8335
  type: 'array',
8220
8336
  },
8221
- workspace_id: { format: 'uuid', type: 'string' },
8337
+ workspace_id: {
8338
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
8339
+ format: 'uuid',
8340
+ type: 'string',
8341
+ },
8222
8342
  },
8223
8343
  required: [
8224
8344
  'acs_user_id',
@@ -8287,20 +8407,49 @@ export default {
8287
8407
  items: {
8288
8408
  properties: {
8289
8409
  access_schedule: {
8290
- $ref: '#/components/schemas/thermostat_schedule',
8410
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
8411
+ properties: {
8412
+ ends_at: { format: 'date-time', type: 'string' },
8413
+ starts_at: {
8414
+ format: 'date-time',
8415
+ type: 'string',
8416
+ },
8417
+ },
8418
+ required: ['starts_at', 'ends_at'],
8419
+ type: 'object',
8420
+ },
8421
+ acs_system_id: {
8422
+ description: 'ID of the access control system that contains the `acs_user`.',
8423
+ format: 'uuid',
8424
+ type: 'string',
8425
+ },
8426
+ acs_user_id: {
8427
+ description: 'ID of the `acs_user`.',
8428
+ format: 'uuid',
8429
+ type: 'string',
8430
+ },
8431
+ created_at: {
8432
+ description: 'Date and time at which the `acs_user` was created.',
8433
+ format: 'date-time',
8434
+ type: 'string',
8435
+ },
8436
+ display_name: {
8437
+ description: 'Display name for the `acs_user`.',
8438
+ type: 'string',
8291
8439
  },
8292
- acs_system_id: { format: 'uuid', type: 'string' },
8293
- acs_user_id: { format: 'uuid', type: 'string' },
8294
- created_at: { format: 'date-time', type: 'string' },
8295
- display_name: { type: 'string' },
8296
8440
  email: {
8297
8441
  deprecated: true,
8298
8442
  format: 'email',
8299
8443
  type: 'string',
8300
8444
  'x-deprecated': 'use email_address.',
8301
8445
  },
8302
- email_address: { format: 'email', type: 'string' },
8446
+ email_address: {
8447
+ description: 'Email address of the `acs_user`.',
8448
+ format: 'email',
8449
+ type: 'string',
8450
+ },
8303
8451
  errors: {
8452
+ description: 'Errors associated with the `acs_user`.',
8304
8453
  items: {
8305
8454
  description: 'Error associated with the `acs_user`.',
8306
8455
  oneOf: [
@@ -8431,6 +8580,7 @@ export default {
8431
8580
  type: 'array',
8432
8581
  },
8433
8582
  external_type: {
8583
+ description: 'Brand-specific terminology for the `acs_user` type.',
8434
8584
  enum: [
8435
8585
  'pti_user',
8436
8586
  'brivo_user',
@@ -8440,33 +8590,54 @@ export default {
8440
8590
  ],
8441
8591
  type: 'string',
8442
8592
  },
8443
- external_type_display_name: { type: 'string' },
8444
- full_name: { type: 'string' },
8593
+ external_type_display_name: {
8594
+ description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
8595
+ type: 'string',
8596
+ },
8597
+ full_name: {
8598
+ description: 'Full name of the `acs_user`.',
8599
+ type: 'string',
8600
+ },
8445
8601
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8446
8602
  is_latest_desired_state_synced_with_provider: {
8447
8603
  type: 'boolean',
8604
+ 'x-undocumented': 'Only used internally.',
8448
8605
  },
8449
8606
  is_managed: { enum: [false], type: 'boolean' },
8450
- is_suspended: { type: 'boolean' },
8607
+ is_suspended: {
8608
+ description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
8609
+ type: 'boolean',
8610
+ },
8451
8611
  latest_desired_state_synced_with_provider_at: {
8452
8612
  format: 'date-time',
8453
8613
  type: 'string',
8614
+ 'x-undocumented': 'Only used internally.',
8615
+ },
8616
+ phone_number: {
8617
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8618
+ type: 'string',
8454
8619
  },
8455
- phone_number: { type: 'string' },
8456
8620
  user_identity_email_address: {
8621
+ description: 'Email address of the user identity associated with the `acs_user`.',
8457
8622
  nullable: true,
8458
8623
  type: 'string',
8459
8624
  },
8460
8625
  user_identity_full_name: {
8626
+ description: 'Full name of the user identity associated with the `acs_user`.',
8461
8627
  nullable: true,
8462
8628
  type: 'string',
8463
8629
  },
8464
- user_identity_id: { type: 'string' },
8630
+ user_identity_id: {
8631
+ description: 'ID of the user identity associated with the `acs_user`.',
8632
+ type: 'string',
8633
+ },
8465
8634
  user_identity_phone_number: {
8635
+ description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
8466
8636
  nullable: true,
8467
8637
  type: 'string',
8468
8638
  },
8469
8639
  warnings: {
8640
+ description: 'Warnings associated with the `acs_user`.',
8470
8641
  items: {
8471
8642
  description: 'Warning associated with the `acs_user`.',
8472
8643
  oneOf: [
@@ -8514,7 +8685,11 @@ export default {
8514
8685
  },
8515
8686
  type: 'array',
8516
8687
  },
8517
- workspace_id: { format: 'uuid', type: 'string' },
8688
+ workspace_id: {
8689
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
8690
+ format: 'uuid',
8691
+ type: 'string',
8692
+ },
8518
8693
  },
8519
8694
  required: [
8520
8695
  'acs_user_id',
@@ -8624,17 +8799,31 @@ export default {
8624
8799
  required: ['starts_at', 'ends_at'],
8625
8800
  type: 'object',
8626
8801
  },
8627
- acs_user_id: { format: 'uuid', type: 'string' },
8802
+ acs_user_id: {
8803
+ description: 'ID of the `acs_user`.',
8804
+ format: 'uuid',
8805
+ type: 'string',
8806
+ },
8628
8807
  email: {
8629
8808
  deprecated: true,
8630
8809
  format: 'email',
8631
8810
  type: 'string',
8632
8811
  'x-deprecated': 'use email_address.',
8633
8812
  },
8634
- email_address: { format: 'email', type: 'string' },
8635
- full_name: { type: 'string' },
8813
+ email_address: {
8814
+ description: 'Email address of the `acs_user`.',
8815
+ format: 'email',
8816
+ type: 'string',
8817
+ },
8818
+ full_name: {
8819
+ description: 'Full name of the `acs_user`.',
8820
+ type: 'string',
8821
+ },
8636
8822
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8637
- phone_number: { type: 'string' },
8823
+ phone_number: {
8824
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8825
+ type: 'string',
8826
+ },
8638
8827
  },
8639
8828
  required: ['acs_user_id'],
8640
8829
  type: 'object',
@@ -8686,17 +8875,31 @@ export default {
8686
8875
  required: ['starts_at', 'ends_at'],
8687
8876
  type: 'object',
8688
8877
  },
8689
- acs_user_id: { format: 'uuid', type: 'string' },
8878
+ acs_user_id: {
8879
+ description: 'ID of the `acs_user`.',
8880
+ format: 'uuid',
8881
+ type: 'string',
8882
+ },
8690
8883
  email: {
8691
8884
  deprecated: true,
8692
8885
  format: 'email',
8693
8886
  type: 'string',
8694
8887
  'x-deprecated': 'use email_address.',
8695
8888
  },
8696
- email_address: { format: 'email', type: 'string' },
8697
- full_name: { type: 'string' },
8889
+ email_address: {
8890
+ description: 'Email address of the `acs_user`.',
8891
+ format: 'email',
8892
+ type: 'string',
8893
+ },
8894
+ full_name: {
8895
+ description: 'Full name of the `acs_user`.',
8896
+ type: 'string',
8897
+ },
8698
8898
  hid_acs_system_id: { format: 'uuid', type: 'string' },
8699
- phone_number: { type: 'string' },
8899
+ phone_number: {
8900
+ description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
8901
+ type: 'string',
8902
+ },
8700
8903
  },
8701
8904
  required: ['acs_user_id'],
8702
8905
  type: 'object',
@@ -13419,13 +13622,8 @@ export default {
13419
13622
  content: {
13420
13623
  'application/json': {
13421
13624
  schema: {
13422
- properties: {
13423
- ok: { type: 'boolean' },
13424
- thermostat_schedule: {
13425
- $ref: '#/components/schemas/thermostat_schedule',
13426
- },
13427
- },
13428
- required: ['thermostat_schedule', 'ok'],
13625
+ properties: { ok: { type: 'boolean' } },
13626
+ required: ['ok'],
13429
13627
  type: 'object',
13430
13628
  },
13431
13629
  },
@@ -13470,13 +13668,8 @@ export default {
13470
13668
  content: {
13471
13669
  'application/json': {
13472
13670
  schema: {
13473
- properties: {
13474
- ok: { type: 'boolean' },
13475
- thermostat_schedule: {
13476
- $ref: '#/components/schemas/thermostat_schedule',
13477
- },
13478
- },
13479
- required: ['thermostat_schedule', 'ok'],
13671
+ properties: { ok: { type: 'boolean' } },
13672
+ required: ['ok'],
13480
13673
  type: 'object',
13481
13674
  },
13482
13675
  },
@@ -13649,13 +13842,8 @@ export default {
13649
13842
  content: {
13650
13843
  'application/json': {
13651
13844
  schema: {
13652
- properties: {
13653
- climate_preset: {
13654
- $ref: '#/components/schemas/climate_preset',
13655
- },
13656
- ok: { type: 'boolean' },
13657
- },
13658
- required: ['climate_preset', 'ok'],
13845
+ properties: { ok: { type: 'boolean' } },
13846
+ required: ['ok'],
13659
13847
  type: 'object',
13660
13848
  },
13661
13849
  },
@@ -13722,13 +13910,8 @@ export default {
13722
13910
  content: {
13723
13911
  'application/json': {
13724
13912
  schema: {
13725
- properties: {
13726
- climate_preset: {
13727
- $ref: '#/components/schemas/climate_preset',
13728
- },
13729
- ok: { type: 'boolean' },
13730
- },
13731
- required: ['climate_preset', 'ok'],
13913
+ properties: { ok: { type: 'boolean' } },
13914
+ required: ['ok'],
13732
13915
  type: 'object',
13733
13916
  },
13734
13917
  },