@seamapi/types 1.358.0 → 1.359.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.
Files changed (35) hide show
  1. package/dist/connect.cjs +467 -10
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2286 -812
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +100 -0
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +100 -0
  7. package/lib/seam/connect/models/acs/acs-access-group.d.ts +14 -14
  8. package/lib/seam/connect/models/acs/acs-credential.d.ts +74 -74
  9. package/lib/seam/connect/models/acs/acs-encoder.d.ts +8 -8
  10. package/lib/seam/connect/models/acs/acs-system.d.ts +72 -72
  11. package/lib/seam/connect/models/acs/acs-user.d.ts +104 -104
  12. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +168 -168
  13. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +72 -72
  14. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +96 -96
  15. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +2 -2
  16. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +634 -21
  17. package/lib/seam/connect/models/connected-accounts/connected-account.js +56 -0
  18. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  19. package/lib/seam/connect/models/devices/device-metadata.d.ts +24 -24
  20. package/lib/seam/connect/models/devices/device.d.ts +146 -46
  21. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +127 -27
  22. package/lib/seam/connect/models/events/access-codes.d.ts +68 -68
  23. package/lib/seam/connect/models/events/connect-webviews.d.ts +4 -4
  24. package/lib/seam/connect/models/events/connected-accounts.d.ts +28 -28
  25. package/lib/seam/connect/models/events/devices.d.ts +128 -128
  26. package/lib/seam/connect/models/events/seam-event.d.ts +114 -114
  27. package/lib/seam/connect/openapi.d.ts +366 -4
  28. package/lib/seam/connect/openapi.js +415 -2
  29. package/lib/seam/connect/openapi.js.map +1 -1
  30. package/lib/seam/connect/route-types.d.ts +567 -0
  31. package/package.json +1 -1
  32. package/src/lib/seam/connect/model-types.ts +0 -2
  33. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +77 -2
  34. package/src/lib/seam/connect/openapi.ts +445 -2
  35. package/src/lib/seam/connect/route-types.ts +597 -0
@@ -480,6 +480,11 @@ export default {
480
480
  {
481
481
  description: 'Account is disconnected.',
482
482
  properties: {
483
+ created_at: {
484
+ description: 'Date and time at which Seam created the error.',
485
+ format: 'date-time',
486
+ type: 'string',
487
+ },
483
488
  error_code: {
484
489
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
485
490
  enum: ['account_disconnected'],
@@ -492,6 +497,7 @@ export default {
492
497
  message: { type: 'string' },
493
498
  },
494
499
  required: [
500
+ 'created_at',
495
501
  'message',
496
502
  'is_connected_account_error',
497
503
  'error_code',
@@ -501,6 +507,11 @@ export default {
501
507
  {
502
508
  description: 'Credentials provided were invalid.',
503
509
  properties: {
510
+ created_at: {
511
+ description: 'Date and time at which Seam created the error.',
512
+ format: 'date-time',
513
+ type: 'string',
514
+ },
504
515
  error_code: {
505
516
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
506
517
  enum: ['invalid_credentials'],
@@ -513,9 +524,68 @@ export default {
513
524
  message: { type: 'string' },
514
525
  },
515
526
  required: [
527
+ 'created_at',
528
+ 'message',
529
+ 'is_connected_account_error',
530
+ 'error_code',
531
+ ],
532
+ type: 'object',
533
+ },
534
+ {
535
+ description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
536
+ properties: {
537
+ created_at: {
538
+ description: 'Date and time at which Seam created the error.',
539
+ format: 'date-time',
540
+ type: 'string',
541
+ },
542
+ error_code: {
543
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
544
+ enum: ['salto_ks_subscription_limit_exceeded'],
545
+ type: 'string',
546
+ },
547
+ is_connected_account_error: {
548
+ enum: [true],
549
+ type: 'boolean',
550
+ },
551
+ message: { type: 'string' },
552
+ salto_ks_metadata: {
553
+ properties: {
554
+ sites: {
555
+ items: {
556
+ properties: {
557
+ site_id: { type: 'string' },
558
+ site_name: { type: 'string' },
559
+ site_user_subscription_limit: {
560
+ minimum: 0,
561
+ type: 'integer',
562
+ },
563
+ subscribed_site_user_count: {
564
+ minimum: 0,
565
+ type: 'integer',
566
+ },
567
+ },
568
+ required: [
569
+ 'site_id',
570
+ 'site_name',
571
+ 'subscribed_site_user_count',
572
+ 'site_user_subscription_limit',
573
+ ],
574
+ type: 'object',
575
+ },
576
+ type: 'array',
577
+ },
578
+ },
579
+ required: ['sites'],
580
+ type: 'object',
581
+ },
582
+ },
583
+ required: [
584
+ 'created_at',
516
585
  'message',
517
586
  'is_connected_account_error',
518
587
  'error_code',
588
+ 'salto_ks_metadata',
519
589
  ],
520
590
  type: 'object',
521
591
  },
@@ -4866,6 +4936,11 @@ export default {
4866
4936
  {
4867
4937
  description: 'Account is disconnected.',
4868
4938
  properties: {
4939
+ created_at: {
4940
+ description: 'Date and time at which Seam created the error.',
4941
+ format: 'date-time',
4942
+ type: 'string',
4943
+ },
4869
4944
  error_code: {
4870
4945
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4871
4946
  enum: ['account_disconnected'],
@@ -4878,6 +4953,7 @@ export default {
4878
4953
  message: { type: 'string' },
4879
4954
  },
4880
4955
  required: [
4956
+ 'created_at',
4881
4957
  'message',
4882
4958
  'is_connected_account_error',
4883
4959
  'error_code',
@@ -4887,6 +4963,11 @@ export default {
4887
4963
  {
4888
4964
  description: 'Credentials provided were invalid.',
4889
4965
  properties: {
4966
+ created_at: {
4967
+ description: 'Date and time at which Seam created the error.',
4968
+ format: 'date-time',
4969
+ type: 'string',
4970
+ },
4890
4971
  error_code: {
4891
4972
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4892
4973
  enum: ['invalid_credentials'],
@@ -4899,9 +4980,68 @@ export default {
4899
4980
  message: { type: 'string' },
4900
4981
  },
4901
4982
  required: [
4983
+ 'created_at',
4984
+ 'message',
4985
+ 'is_connected_account_error',
4986
+ 'error_code',
4987
+ ],
4988
+ type: 'object',
4989
+ },
4990
+ {
4991
+ description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
4992
+ properties: {
4993
+ created_at: {
4994
+ description: 'Date and time at which Seam created the error.',
4995
+ format: 'date-time',
4996
+ type: 'string',
4997
+ },
4998
+ error_code: {
4999
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5000
+ enum: ['salto_ks_subscription_limit_exceeded'],
5001
+ type: 'string',
5002
+ },
5003
+ is_connected_account_error: {
5004
+ enum: [true],
5005
+ type: 'boolean',
5006
+ },
5007
+ message: { type: 'string' },
5008
+ salto_ks_metadata: {
5009
+ properties: {
5010
+ sites: {
5011
+ items: {
5012
+ properties: {
5013
+ site_id: { type: 'string' },
5014
+ site_name: { type: 'string' },
5015
+ site_user_subscription_limit: {
5016
+ minimum: 0,
5017
+ type: 'integer',
5018
+ },
5019
+ subscribed_site_user_count: {
5020
+ minimum: 0,
5021
+ type: 'integer',
5022
+ },
5023
+ },
5024
+ required: [
5025
+ 'site_id',
5026
+ 'site_name',
5027
+ 'subscribed_site_user_count',
5028
+ 'site_user_subscription_limit',
5029
+ ],
5030
+ type: 'object',
5031
+ },
5032
+ type: 'array',
5033
+ },
5034
+ },
5035
+ required: ['sites'],
5036
+ type: 'object',
5037
+ },
5038
+ },
5039
+ required: [
5040
+ 'created_at',
4902
5041
  'message',
4903
5042
  'is_connected_account_error',
4904
5043
  'error_code',
5044
+ 'salto_ks_metadata',
4905
5045
  ],
4906
5046
  type: 'object',
4907
5047
  },
@@ -4927,6 +5067,11 @@ export default {
4927
5067
  {
4928
5068
  description: 'Scheduled downtime for account planned.',
4929
5069
  properties: {
5070
+ created_at: {
5071
+ description: 'Date and time at which Seam created the warning.',
5072
+ format: 'date-time',
5073
+ type: 'string',
5074
+ },
4930
5075
  message: { type: 'string' },
4931
5076
  warning_code: {
4932
5077
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
@@ -4934,12 +5079,17 @@ export default {
4934
5079
  type: 'string',
4935
5080
  },
4936
5081
  },
4937
- required: ['message', 'warning_code'],
5082
+ required: ['created_at', 'message', 'warning_code'],
4938
5083
  type: 'object',
4939
5084
  },
4940
5085
  {
4941
5086
  description: 'An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.',
4942
5087
  properties: {
5088
+ created_at: {
5089
+ description: 'Date and time at which Seam created the warning.',
5090
+ format: 'date-time',
5091
+ type: 'string',
5092
+ },
4943
5093
  message: { type: 'string' },
4944
5094
  warning_code: {
4945
5095
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
@@ -4947,7 +5097,60 @@ export default {
4947
5097
  type: 'string',
4948
5098
  },
4949
5099
  },
4950
- required: ['message', 'warning_code'],
5100
+ required: ['created_at', 'message', 'warning_code'],
5101
+ type: 'object',
5102
+ },
5103
+ {
5104
+ description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
5105
+ properties: {
5106
+ created_at: {
5107
+ description: 'Date and time at which Seam created the warning.',
5108
+ format: 'date-time',
5109
+ type: 'string',
5110
+ },
5111
+ message: { type: 'string' },
5112
+ salto_ks_metadata: {
5113
+ properties: {
5114
+ sites: {
5115
+ items: {
5116
+ properties: {
5117
+ site_id: { type: 'string' },
5118
+ site_name: { type: 'string' },
5119
+ site_user_subscription_limit: {
5120
+ minimum: 0,
5121
+ type: 'integer',
5122
+ },
5123
+ subscribed_site_user_count: {
5124
+ minimum: 0,
5125
+ type: 'integer',
5126
+ },
5127
+ },
5128
+ required: [
5129
+ 'site_id',
5130
+ 'site_name',
5131
+ 'site_user_subscription_limit',
5132
+ 'subscribed_site_user_count',
5133
+ ],
5134
+ type: 'object',
5135
+ },
5136
+ type: 'array',
5137
+ },
5138
+ },
5139
+ required: ['sites'],
5140
+ type: 'object',
5141
+ },
5142
+ warning_code: {
5143
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5144
+ enum: ['salto_ks_subscription_limit_almost_reached'],
5145
+ type: 'string',
5146
+ },
5147
+ },
5148
+ required: [
5149
+ 'created_at',
5150
+ 'message',
5151
+ 'warning_code',
5152
+ 'salto_ks_metadata',
5153
+ ],
4951
5154
  type: 'object',
4952
5155
  },
4953
5156
  ],
@@ -5249,6 +5452,11 @@ export default {
5249
5452
  {
5250
5453
  description: 'Account is disconnected.',
5251
5454
  properties: {
5455
+ created_at: {
5456
+ description: 'Date and time at which Seam created the error.',
5457
+ format: 'date-time',
5458
+ type: 'string',
5459
+ },
5252
5460
  error_code: {
5253
5461
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5254
5462
  enum: ['account_disconnected'],
@@ -5261,6 +5469,7 @@ export default {
5261
5469
  message: { type: 'string' },
5262
5470
  },
5263
5471
  required: [
5472
+ 'created_at',
5264
5473
  'message',
5265
5474
  'is_connected_account_error',
5266
5475
  'error_code',
@@ -5270,6 +5479,11 @@ export default {
5270
5479
  {
5271
5480
  description: 'Credentials provided were invalid.',
5272
5481
  properties: {
5482
+ created_at: {
5483
+ description: 'Date and time at which Seam created the error.',
5484
+ format: 'date-time',
5485
+ type: 'string',
5486
+ },
5273
5487
  error_code: {
5274
5488
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5275
5489
  enum: ['invalid_credentials'],
@@ -5282,9 +5496,68 @@ export default {
5282
5496
  message: { type: 'string' },
5283
5497
  },
5284
5498
  required: [
5499
+ 'created_at',
5500
+ 'message',
5501
+ 'is_connected_account_error',
5502
+ 'error_code',
5503
+ ],
5504
+ type: 'object',
5505
+ },
5506
+ {
5507
+ description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
5508
+ properties: {
5509
+ created_at: {
5510
+ description: 'Date and time at which Seam created the error.',
5511
+ format: 'date-time',
5512
+ type: 'string',
5513
+ },
5514
+ error_code: {
5515
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5516
+ enum: ['salto_ks_subscription_limit_exceeded'],
5517
+ type: 'string',
5518
+ },
5519
+ is_connected_account_error: {
5520
+ enum: [true],
5521
+ type: 'boolean',
5522
+ },
5523
+ message: { type: 'string' },
5524
+ salto_ks_metadata: {
5525
+ properties: {
5526
+ sites: {
5527
+ items: {
5528
+ properties: {
5529
+ site_id: { type: 'string' },
5530
+ site_name: { type: 'string' },
5531
+ site_user_subscription_limit: {
5532
+ minimum: 0,
5533
+ type: 'integer',
5534
+ },
5535
+ subscribed_site_user_count: {
5536
+ minimum: 0,
5537
+ type: 'integer',
5538
+ },
5539
+ },
5540
+ required: [
5541
+ 'site_id',
5542
+ 'site_name',
5543
+ 'subscribed_site_user_count',
5544
+ 'site_user_subscription_limit',
5545
+ ],
5546
+ type: 'object',
5547
+ },
5548
+ type: 'array',
5549
+ },
5550
+ },
5551
+ required: ['sites'],
5552
+ type: 'object',
5553
+ },
5554
+ },
5555
+ required: [
5556
+ 'created_at',
5285
5557
  'message',
5286
5558
  'is_connected_account_error',
5287
5559
  'error_code',
5560
+ 'salto_ks_metadata',
5288
5561
  ],
5289
5562
  type: 'object',
5290
5563
  },
@@ -11663,6 +11936,11 @@ export default {
11663
11936
  {
11664
11937
  description: 'Account is disconnected.',
11665
11938
  properties: {
11939
+ created_at: {
11940
+ description: 'Date and time at which Seam created the error.',
11941
+ format: 'date-time',
11942
+ type: 'string',
11943
+ },
11666
11944
  error_code: {
11667
11945
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11668
11946
  enum: ['account_disconnected'],
@@ -11675,6 +11953,7 @@ export default {
11675
11953
  message: { type: 'string' },
11676
11954
  },
11677
11955
  required: [
11956
+ 'created_at',
11678
11957
  'message',
11679
11958
  'is_connected_account_error',
11680
11959
  'error_code',
@@ -11684,6 +11963,11 @@ export default {
11684
11963
  {
11685
11964
  description: 'Credentials provided were invalid.',
11686
11965
  properties: {
11966
+ created_at: {
11967
+ description: 'Date and time at which Seam created the error.',
11968
+ format: 'date-time',
11969
+ type: 'string',
11970
+ },
11687
11971
  error_code: {
11688
11972
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11689
11973
  enum: ['invalid_credentials'],
@@ -11696,12 +11980,71 @@ export default {
11696
11980
  message: { type: 'string' },
11697
11981
  },
11698
11982
  required: [
11983
+ 'created_at',
11699
11984
  'message',
11700
11985
  'is_connected_account_error',
11701
11986
  'error_code',
11702
11987
  ],
11703
11988
  type: 'object',
11704
11989
  },
11990
+ {
11991
+ description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
11992
+ properties: {
11993
+ created_at: {
11994
+ description: 'Date and time at which Seam created the error.',
11995
+ format: 'date-time',
11996
+ type: 'string',
11997
+ },
11998
+ error_code: {
11999
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12000
+ enum: ['salto_ks_subscription_limit_exceeded'],
12001
+ type: 'string',
12002
+ },
12003
+ is_connected_account_error: {
12004
+ enum: [true],
12005
+ type: 'boolean',
12006
+ },
12007
+ message: { type: 'string' },
12008
+ salto_ks_metadata: {
12009
+ properties: {
12010
+ sites: {
12011
+ items: {
12012
+ properties: {
12013
+ site_id: { type: 'string' },
12014
+ site_name: { type: 'string' },
12015
+ site_user_subscription_limit: {
12016
+ minimum: 0,
12017
+ type: 'integer',
12018
+ },
12019
+ subscribed_site_user_count: {
12020
+ minimum: 0,
12021
+ type: 'integer',
12022
+ },
12023
+ },
12024
+ required: [
12025
+ 'site_id',
12026
+ 'site_name',
12027
+ 'subscribed_site_user_count',
12028
+ 'site_user_subscription_limit',
12029
+ ],
12030
+ type: 'object',
12031
+ },
12032
+ type: 'array',
12033
+ },
12034
+ },
12035
+ required: ['sites'],
12036
+ type: 'object',
12037
+ },
12038
+ },
12039
+ required: [
12040
+ 'created_at',
12041
+ 'message',
12042
+ 'is_connected_account_error',
12043
+ 'error_code',
12044
+ 'salto_ks_metadata',
12045
+ ],
12046
+ type: 'object',
12047
+ },
11705
12048
  ],
11706
12049
  },
11707
12050
  type: 'array',
@@ -12866,6 +13209,11 @@ export default {
12866
13209
  {
12867
13210
  description: 'Account is disconnected.',
12868
13211
  properties: {
13212
+ created_at: {
13213
+ description: 'Date and time at which Seam created the error.',
13214
+ format: 'date-time',
13215
+ type: 'string',
13216
+ },
12869
13217
  error_code: {
12870
13218
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12871
13219
  enum: ['account_disconnected'],
@@ -12878,6 +13226,7 @@ export default {
12878
13226
  message: { type: 'string' },
12879
13227
  },
12880
13228
  required: [
13229
+ 'created_at',
12881
13230
  'message',
12882
13231
  'is_connected_account_error',
12883
13232
  'error_code',
@@ -12887,6 +13236,11 @@ export default {
12887
13236
  {
12888
13237
  description: 'Credentials provided were invalid.',
12889
13238
  properties: {
13239
+ created_at: {
13240
+ description: 'Date and time at which Seam created the error.',
13241
+ format: 'date-time',
13242
+ type: 'string',
13243
+ },
12890
13244
  error_code: {
12891
13245
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12892
13246
  enum: ['invalid_credentials'],
@@ -12899,9 +13253,68 @@ export default {
12899
13253
  message: { type: 'string' },
12900
13254
  },
12901
13255
  required: [
13256
+ 'created_at',
13257
+ 'message',
13258
+ 'is_connected_account_error',
13259
+ 'error_code',
13260
+ ],
13261
+ type: 'object',
13262
+ },
13263
+ {
13264
+ description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
13265
+ properties: {
13266
+ created_at: {
13267
+ description: 'Date and time at which Seam created the error.',
13268
+ format: 'date-time',
13269
+ type: 'string',
13270
+ },
13271
+ error_code: {
13272
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13273
+ enum: ['salto_ks_subscription_limit_exceeded'],
13274
+ type: 'string',
13275
+ },
13276
+ is_connected_account_error: {
13277
+ enum: [true],
13278
+ type: 'boolean',
13279
+ },
13280
+ message: { type: 'string' },
13281
+ salto_ks_metadata: {
13282
+ properties: {
13283
+ sites: {
13284
+ items: {
13285
+ properties: {
13286
+ site_id: { type: 'string' },
13287
+ site_name: { type: 'string' },
13288
+ site_user_subscription_limit: {
13289
+ minimum: 0,
13290
+ type: 'integer',
13291
+ },
13292
+ subscribed_site_user_count: {
13293
+ minimum: 0,
13294
+ type: 'integer',
13295
+ },
13296
+ },
13297
+ required: [
13298
+ 'site_id',
13299
+ 'site_name',
13300
+ 'subscribed_site_user_count',
13301
+ 'site_user_subscription_limit',
13302
+ ],
13303
+ type: 'object',
13304
+ },
13305
+ type: 'array',
13306
+ },
13307
+ },
13308
+ required: ['sites'],
13309
+ type: 'object',
13310
+ },
13311
+ },
13312
+ required: [
13313
+ 'created_at',
12902
13314
  'message',
12903
13315
  'is_connected_account_error',
12904
13316
  'error_code',
13317
+ 'salto_ks_metadata',
12905
13318
  ],
12906
13319
  type: 'object',
12907
13320
  },