@seamapi/types 1.404.1 → 1.404.2

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 CHANGED
@@ -532,15 +532,21 @@ var custom_metadata = zod.z.record(zod.z.string(), zod.z.union([zod.z.string(),
532
532
  // src/lib/seam/connect/models/connected-accounts/connected-account.ts
533
533
  var common_connected_account_error = zod.z.object({
534
534
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
535
- message: zod.z.string(),
536
- is_connected_account_error: zod.z.boolean().optional(),
537
- is_bridge_error: zod.z.boolean().optional()
535
+ message: zod.z.string().describe(
536
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
537
+ ),
538
+ is_connected_account_error: zod.z.boolean().optional().describe(
539
+ "Indicates whether the error is related specifically to the connected account."
540
+ ),
541
+ is_bridge_error: zod.z.boolean().optional().describe("Indicates whether the error is related to Seam Bridge.")
538
542
  });
539
543
  var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
540
544
  var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
541
545
  var common_connected_account_warning = zod.z.object({
542
546
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
543
- message: zod.z.string()
547
+ message: zod.z.string().describe(
548
+ "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
549
+ )
544
550
  });
545
551
  var account_disconnected = common_connected_account_error.extend({
546
552
  error_code: zod.z.literal("account_disconnected").describe(error_code_description)
@@ -550,20 +556,35 @@ var invalid_credentials = common_connected_account_error.extend({
550
556
  }).describe("Credentials provided were invalid.");
551
557
  var bridge_disconnected = common_connected_account_error.extend({
552
558
  error_code: zod.z.literal("bridge_disconnected").describe(error_code_description)
553
- }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
554
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
559
+ }).describe(
560
+ "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)."
561
+ );
555
562
  var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
556
563
  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
557
564
  salto_ks_metadata: zod.z.object({
558
565
  sites: zod.z.array(
559
566
  zod.z.object({
560
- site_id: zod.z.string(),
561
- site_name: zod.z.string(),
562
- subscribed_site_user_count: zod.z.number().int().min(0),
563
- site_user_subscription_limit: zod.z.number().int().min(0)
564
- })
567
+ site_id: zod.z.string().describe(
568
+ "ID of a Salto site associated with the connected account that has an error."
569
+ ),
570
+ site_name: zod.z.string().describe(
571
+ "Name of a Salto site associated with the connected account that has an error."
572
+ ),
573
+ subscribed_site_user_count: zod.z.number().int().min(0).describe(
574
+ "Count of subscribed site users for a Salto site associated with the connected account that has an error."
575
+ ),
576
+ site_user_subscription_limit: zod.z.number().int().min(0).describe(
577
+ "Subscription limit of site users for a Salto site associated with the connected account that has an error."
578
+ )
579
+ }).describe(
580
+ "Salto site associated with the connected account that has an error."
581
+ )
582
+ ).describe(
583
+ "Salto sites associated with the connected account that has an error."
565
584
  )
566
- })
585
+ }).describe(
586
+ "Salto KS metadata associated with the connected account that has an error."
587
+ )
567
588
  }).describe(
568
589
  "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."
569
590
  );
@@ -582,52 +603,78 @@ zod.z.object({
582
603
  var unknown_issue_with_connected_account = common_connected_account_warning.extend({
583
604
  warning_code: zod.z.literal("unknown_issue_with_connected_account").describe(warning_code_description)
584
605
  }).describe(
585
- "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."
606
+ "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account."
586
607
  );
587
608
  var scheduled_maintenance_window = common_connected_account_warning.extend({
588
609
  warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
589
- }).describe("Scheduled downtime for account planned.");
610
+ }).describe("Scheduled downtime planned for the connected account.");
590
611
  var salto_ks_subscription_limit_almost_reached = common_connected_account_warning.extend({
591
612
  warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description),
592
613
  salto_ks_metadata: zod.z.object({
593
614
  sites: zod.z.array(
594
615
  zod.z.object({
595
- site_id: zod.z.string(),
596
- site_name: zod.z.string(),
597
- site_user_subscription_limit: zod.z.number().int().min(0),
598
- subscribed_site_user_count: zod.z.number().int().min(0)
599
- })
616
+ site_id: zod.z.string().describe(
617
+ "ID of a Salto site associated with the connected account that has a warning."
618
+ ),
619
+ site_name: zod.z.string().describe(
620
+ "Name of a Salto site associated with the connected account that has a warning."
621
+ ),
622
+ site_user_subscription_limit: zod.z.number().int().min(0).describe(
623
+ "Subscription limit of site users for a Salto site associated with the connected account that has a warning."
624
+ ),
625
+ subscribed_site_user_count: zod.z.number().int().min(0).describe(
626
+ "Count of subscribed site users for a Salto site associated with the connected account that has a warning."
627
+ )
628
+ }).describe(
629
+ "Salto site associated with the connected account that has a warning."
630
+ )
631
+ ).describe(
632
+ "Salto sites associated with the connected account that has a warning."
600
633
  )
601
- })
634
+ }).describe(
635
+ "Salto KS metadata associated with the connected account that has a warning."
636
+ )
602
637
  }).describe(
603
- "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."
638
+ "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site."
604
639
  );
605
640
  var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
606
641
  scheduled_maintenance_window,
607
642
  unknown_issue_with_connected_account,
608
643
  salto_ks_subscription_limit_almost_reached
609
- ]).describe("Warning associated with the `connected_account`.");
644
+ ]).describe("Warning associated with the connected account.");
610
645
  zod.z.object({
611
646
  scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
612
647
  unknown_issue_with_connected_account: unknown_issue_with_connected_account.nullable().optional(),
613
648
  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional()
614
649
  });
615
650
  var connected_account = zod.z.object({
616
- connected_account_id: zod.z.string().uuid().optional(),
617
- created_at: zod.z.string().datetime().optional(),
651
+ connected_account_id: zod.z.string().uuid().optional().describe("Unique identifier for the connected account."),
652
+ created_at: zod.z.string().datetime().optional().describe("Date and time at which the connected account was created."),
618
653
  user_identifier: zod.z.object({
619
- username: zod.z.string().optional(),
620
- api_url: zod.z.string().optional(),
621
- email: zod.z.string().optional(),
622
- phone: zod.z.string().optional(),
623
- exclusive: zod.z.boolean().optional()
624
- }).optional(),
625
- account_type: zod.z.string().optional(),
626
- account_type_display_name: zod.z.string(),
627
- errors: zod.z.array(connected_account_error),
628
- warnings: zod.z.array(connected_account_warning),
654
+ username: zod.z.string().optional().describe(
655
+ "Username of the user identifier associated with the connected account."
656
+ ),
657
+ api_url: zod.z.string().optional().describe(
658
+ "API URL for the user identifier associated with the connected account."
659
+ ),
660
+ email: zod.z.string().optional().describe(
661
+ "Email address of the user identifier associated with the connected account."
662
+ ),
663
+ phone: zod.z.string().optional().describe(
664
+ "Phone number of the user identifier associated with the connected account."
665
+ ),
666
+ exclusive: zod.z.boolean().optional().describe(
667
+ "Indicates whether the user identifier associated with the connected account is exclusive."
668
+ )
669
+ }).optional().describe("User identifier associated with the connected account."),
670
+ account_type: zod.z.string().optional().describe("Type of connected account."),
671
+ account_type_display_name: zod.z.string().describe("Display name for the connected account type."),
672
+ errors: zod.z.array(connected_account_error).describe("Errors associated with the connected account."),
673
+ warnings: zod.z.array(connected_account_warning).describe("Warnings associated with the connected account."),
629
674
  custom_metadata,
630
- automatically_manage_new_devices: zod.z.boolean()
675
+ automatically_manage_new_devices: zod.z.boolean().describe(
676
+ "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
677
+ )
631
678
  }).describe(`
632
679
  ---
633
680
  route_path: /connected_accounts
@@ -5608,15 +5655,24 @@ var openapi_default = {
5608
5655
  enum: ["invalid_credentials"],
5609
5656
  type: "string"
5610
5657
  },
5611
- is_bridge_error: { type: "boolean" },
5612
- is_connected_account_error: { type: "boolean" },
5613
- message: { type: "string" }
5658
+ is_bridge_error: {
5659
+ description: "Indicates whether the error is related to Seam Bridge.",
5660
+ type: "boolean"
5661
+ },
5662
+ is_connected_account_error: {
5663
+ description: "Indicates whether the error is related specifically to the connected account.",
5664
+ type: "boolean"
5665
+ },
5666
+ message: {
5667
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
5668
+ type: "string"
5669
+ }
5614
5670
  },
5615
5671
  required: ["created_at", "message", "error_code"],
5616
5672
  type: "object"
5617
5673
  },
5618
5674
  {
5619
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5675
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5620
5676
  properties: {
5621
5677
  created_at: {
5622
5678
  description: "Date and time at which Seam created the error.",
@@ -5628,9 +5684,18 @@ var openapi_default = {
5628
5684
  enum: ["bridge_disconnected"],
5629
5685
  type: "string"
5630
5686
  },
5631
- is_bridge_error: { type: "boolean" },
5632
- is_connected_account_error: { type: "boolean" },
5633
- message: { type: "string" }
5687
+ is_bridge_error: {
5688
+ description: "Indicates whether the error is related to Seam Bridge.",
5689
+ type: "boolean"
5690
+ },
5691
+ is_connected_account_error: {
5692
+ description: "Indicates whether the error is related specifically to the connected account.",
5693
+ type: "boolean"
5694
+ },
5695
+ message: {
5696
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
5697
+ type: "string"
5698
+ }
5634
5699
  },
5635
5700
  required: ["created_at", "message", "error_code"],
5636
5701
  type: "object"
@@ -11201,11 +11266,28 @@ var openapi_default = {
11201
11266
  connected_account: {
11202
11267
  description: "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.",
11203
11268
  properties: {
11204
- account_type: { type: "string" },
11205
- account_type_display_name: { type: "string" },
11206
- automatically_manage_new_devices: { type: "boolean" },
11207
- connected_account_id: { format: "uuid", type: "string" },
11208
- created_at: { format: "date-time", type: "string" },
11269
+ account_type: {
11270
+ description: "Type of connected account.",
11271
+ type: "string"
11272
+ },
11273
+ account_type_display_name: {
11274
+ description: "Display name for the connected account type.",
11275
+ type: "string"
11276
+ },
11277
+ automatically_manage_new_devices: {
11278
+ description: "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
11279
+ type: "boolean"
11280
+ },
11281
+ connected_account_id: {
11282
+ description: "Unique identifier for the connected account.",
11283
+ format: "uuid",
11284
+ type: "string"
11285
+ },
11286
+ created_at: {
11287
+ description: "Date and time at which the connected account was created.",
11288
+ format: "date-time",
11289
+ type: "string"
11290
+ },
11209
11291
  custom_metadata: {
11210
11292
  additionalProperties: {
11211
11293
  oneOf: [{ type: "string" }, { type: "boolean" }]
@@ -11214,6 +11296,7 @@ var openapi_default = {
11214
11296
  type: "object"
11215
11297
  },
11216
11298
  errors: {
11299
+ description: "Errors associated with the connected account.",
11217
11300
  items: {
11218
11301
  discriminator: { propertyName: "error_code" },
11219
11302
  oneOf: [
@@ -11230,9 +11313,18 @@ var openapi_default = {
11230
11313
  enum: ["account_disconnected"],
11231
11314
  type: "string"
11232
11315
  },
11233
- is_bridge_error: { type: "boolean" },
11234
- is_connected_account_error: { type: "boolean" },
11235
- message: { type: "string" }
11316
+ is_bridge_error: {
11317
+ description: "Indicates whether the error is related to Seam Bridge.",
11318
+ type: "boolean"
11319
+ },
11320
+ is_connected_account_error: {
11321
+ description: "Indicates whether the error is related specifically to the connected account.",
11322
+ type: "boolean"
11323
+ },
11324
+ message: {
11325
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
11326
+ type: "string"
11327
+ }
11236
11328
  },
11237
11329
  required: ["created_at", "message", "error_code"],
11238
11330
  type: "object"
@@ -11250,15 +11342,24 @@ var openapi_default = {
11250
11342
  enum: ["invalid_credentials"],
11251
11343
  type: "string"
11252
11344
  },
11253
- is_bridge_error: { type: "boolean" },
11254
- is_connected_account_error: { type: "boolean" },
11255
- message: { type: "string" }
11345
+ is_bridge_error: {
11346
+ description: "Indicates whether the error is related to Seam Bridge.",
11347
+ type: "boolean"
11348
+ },
11349
+ is_connected_account_error: {
11350
+ description: "Indicates whether the error is related specifically to the connected account.",
11351
+ type: "boolean"
11352
+ },
11353
+ message: {
11354
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
11355
+ type: "string"
11356
+ }
11256
11357
  },
11257
11358
  required: ["created_at", "message", "error_code"],
11258
11359
  type: "object"
11259
11360
  },
11260
11361
  {
11261
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
11362
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
11262
11363
  properties: {
11263
11364
  created_at: {
11264
11365
  description: "Date and time at which Seam created the error.",
@@ -11270,9 +11371,18 @@ var openapi_default = {
11270
11371
  enum: ["bridge_disconnected"],
11271
11372
  type: "string"
11272
11373
  },
11273
- is_bridge_error: { type: "boolean" },
11274
- is_connected_account_error: { type: "boolean" },
11275
- message: { type: "string" }
11374
+ is_bridge_error: {
11375
+ description: "Indicates whether the error is related to Seam Bridge.",
11376
+ type: "boolean"
11377
+ },
11378
+ is_connected_account_error: {
11379
+ description: "Indicates whether the error is related specifically to the connected account.",
11380
+ type: "boolean"
11381
+ },
11382
+ message: {
11383
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
11384
+ type: "string"
11385
+ }
11276
11386
  },
11277
11387
  required: ["created_at", "message", "error_code"],
11278
11388
  type: "object"
@@ -11290,21 +11400,41 @@ var openapi_default = {
11290
11400
  enum: ["salto_ks_subscription_limit_exceeded"],
11291
11401
  type: "string"
11292
11402
  },
11293
- is_bridge_error: { type: "boolean" },
11294
- is_connected_account_error: { type: "boolean" },
11295
- message: { type: "string" },
11403
+ is_bridge_error: {
11404
+ description: "Indicates whether the error is related to Seam Bridge.",
11405
+ type: "boolean"
11406
+ },
11407
+ is_connected_account_error: {
11408
+ description: "Indicates whether the error is related specifically to the connected account.",
11409
+ type: "boolean"
11410
+ },
11411
+ message: {
11412
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
11413
+ type: "string"
11414
+ },
11296
11415
  salto_ks_metadata: {
11416
+ description: "Salto KS metadata associated with the connected account that has an error.",
11297
11417
  properties: {
11298
11418
  sites: {
11419
+ description: "Salto sites associated with the connected account that has an error.",
11299
11420
  items: {
11421
+ description: "Salto site associated with the connected account that has an error.",
11300
11422
  properties: {
11301
- site_id: { type: "string" },
11302
- site_name: { type: "string" },
11423
+ site_id: {
11424
+ description: "ID of a Salto site associated with the connected account that has an error.",
11425
+ type: "string"
11426
+ },
11427
+ site_name: {
11428
+ description: "Name of a Salto site associated with the connected account that has an error.",
11429
+ type: "string"
11430
+ },
11303
11431
  site_user_subscription_limit: {
11432
+ description: "Subscription limit of site users for a Salto site associated with the connected account that has an error.",
11304
11433
  minimum: 0,
11305
11434
  type: "integer"
11306
11435
  },
11307
11436
  subscribed_site_user_count: {
11437
+ description: "Count of subscribed site users for a Salto site associated with the connected account that has an error.",
11308
11438
  minimum: 0,
11309
11439
  type: "integer"
11310
11440
  }
@@ -11337,29 +11467,49 @@ var openapi_default = {
11337
11467
  type: "array"
11338
11468
  },
11339
11469
  user_identifier: {
11470
+ description: "User identifier associated with the connected account.",
11340
11471
  properties: {
11341
- api_url: { type: "string" },
11342
- email: { type: "string" },
11343
- exclusive: { type: "boolean" },
11344
- phone: { type: "string" },
11345
- username: { type: "string" }
11472
+ api_url: {
11473
+ description: "API URL for the user identifier associated with the connected account.",
11474
+ type: "string"
11475
+ },
11476
+ email: {
11477
+ description: "Email address of the user identifier associated with the connected account.",
11478
+ type: "string"
11479
+ },
11480
+ exclusive: {
11481
+ description: "Indicates whether the user identifier associated with the connected account is exclusive.",
11482
+ type: "boolean"
11483
+ },
11484
+ phone: {
11485
+ description: "Phone number of the user identifier associated with the connected account.",
11486
+ type: "string"
11487
+ },
11488
+ username: {
11489
+ description: "Username of the user identifier associated with the connected account.",
11490
+ type: "string"
11491
+ }
11346
11492
  },
11347
11493
  type: "object"
11348
11494
  },
11349
11495
  warnings: {
11496
+ description: "Warnings associated with the connected account.",
11350
11497
  items: {
11351
- description: "Warning associated with the `connected_account`.",
11498
+ description: "Warning associated with the connected account.",
11352
11499
  discriminator: { propertyName: "warning_code" },
11353
11500
  oneOf: [
11354
11501
  {
11355
- description: "Scheduled downtime for account planned.",
11502
+ description: "Scheduled downtime planned for the connected account.",
11356
11503
  properties: {
11357
11504
  created_at: {
11358
11505
  description: "Date and time at which Seam created the warning.",
11359
11506
  format: "date-time",
11360
11507
  type: "string"
11361
11508
  },
11362
- message: { type: "string" },
11509
+ message: {
11510
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
11511
+ type: "string"
11512
+ },
11363
11513
  warning_code: {
11364
11514
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
11365
11515
  enum: ["scheduled_maintenance_window"],
@@ -11370,14 +11520,17 @@ var openapi_default = {
11370
11520
  type: "object"
11371
11521
  },
11372
11522
  {
11373
- 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.",
11523
+ description: "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.",
11374
11524
  properties: {
11375
11525
  created_at: {
11376
11526
  description: "Date and time at which Seam created the warning.",
11377
11527
  format: "date-time",
11378
11528
  type: "string"
11379
11529
  },
11380
- message: { type: "string" },
11530
+ message: {
11531
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
11532
+ type: "string"
11533
+ },
11381
11534
  warning_code: {
11382
11535
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
11383
11536
  enum: ["unknown_issue_with_connected_account"],
@@ -11388,26 +11541,40 @@ var openapi_default = {
11388
11541
  type: "object"
11389
11542
  },
11390
11543
  {
11391
- 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.",
11544
+ description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.",
11392
11545
  properties: {
11393
11546
  created_at: {
11394
11547
  description: "Date and time at which Seam created the warning.",
11395
11548
  format: "date-time",
11396
11549
  type: "string"
11397
11550
  },
11398
- message: { type: "string" },
11551
+ message: {
11552
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
11553
+ type: "string"
11554
+ },
11399
11555
  salto_ks_metadata: {
11556
+ description: "Salto KS metadata associated with the connected account that has a warning.",
11400
11557
  properties: {
11401
11558
  sites: {
11559
+ description: "Salto sites associated with the connected account that has a warning.",
11402
11560
  items: {
11561
+ description: "Salto site associated with the connected account that has a warning.",
11403
11562
  properties: {
11404
- site_id: { type: "string" },
11405
- site_name: { type: "string" },
11563
+ site_id: {
11564
+ description: "ID of a Salto site associated with the connected account that has a warning.",
11565
+ type: "string"
11566
+ },
11567
+ site_name: {
11568
+ description: "Name of a Salto site associated with the connected account that has a warning.",
11569
+ type: "string"
11570
+ },
11406
11571
  site_user_subscription_limit: {
11572
+ description: "Subscription limit of site users for a Salto site associated with the connected account that has a warning.",
11407
11573
  minimum: 0,
11408
11574
  type: "integer"
11409
11575
  },
11410
11576
  subscribed_site_user_count: {
11577
+ description: "Count of subscribed site users for a Salto site associated with the connected account that has a warning.",
11411
11578
  minimum: 0,
11412
11579
  type: "integer"
11413
11580
  }
@@ -11855,15 +12022,24 @@ var openapi_default = {
11855
12022
  enum: ["invalid_credentials"],
11856
12023
  type: "string"
11857
12024
  },
11858
- is_bridge_error: { type: "boolean" },
11859
- is_connected_account_error: { type: "boolean" },
11860
- message: { type: "string" }
12025
+ is_bridge_error: {
12026
+ description: "Indicates whether the error is related to Seam Bridge.",
12027
+ type: "boolean"
12028
+ },
12029
+ is_connected_account_error: {
12030
+ description: "Indicates whether the error is related specifically to the connected account.",
12031
+ type: "boolean"
12032
+ },
12033
+ message: {
12034
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
12035
+ type: "string"
12036
+ }
11861
12037
  },
11862
12038
  required: ["created_at", "message", "error_code"],
11863
12039
  type: "object"
11864
12040
  },
11865
12041
  {
11866
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
12042
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
11867
12043
  properties: {
11868
12044
  created_at: {
11869
12045
  description: "Date and time at which Seam created the error.",
@@ -11875,9 +12051,18 @@ var openapi_default = {
11875
12051
  enum: ["bridge_disconnected"],
11876
12052
  type: "string"
11877
12053
  },
11878
- is_bridge_error: { type: "boolean" },
11879
- is_connected_account_error: { type: "boolean" },
11880
- message: { type: "string" }
12054
+ is_bridge_error: {
12055
+ description: "Indicates whether the error is related to Seam Bridge.",
12056
+ type: "boolean"
12057
+ },
12058
+ is_connected_account_error: {
12059
+ description: "Indicates whether the error is related specifically to the connected account.",
12060
+ type: "boolean"
12061
+ },
12062
+ message: {
12063
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
12064
+ type: "string"
12065
+ }
11881
12066
  },
11882
12067
  required: ["created_at", "message", "error_code"],
11883
12068
  type: "object"
@@ -20148,15 +20333,24 @@ var openapi_default = {
20148
20333
  enum: ["invalid_credentials"],
20149
20334
  type: "string"
20150
20335
  },
20151
- is_bridge_error: { type: "boolean" },
20152
- is_connected_account_error: { type: "boolean" },
20153
- message: { type: "string" }
20336
+ is_bridge_error: {
20337
+ description: "Indicates whether the error is related to Seam Bridge.",
20338
+ type: "boolean"
20339
+ },
20340
+ is_connected_account_error: {
20341
+ description: "Indicates whether the error is related specifically to the connected account.",
20342
+ type: "boolean"
20343
+ },
20344
+ message: {
20345
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
20346
+ type: "string"
20347
+ }
20154
20348
  },
20155
20349
  required: ["created_at", "message", "error_code"],
20156
20350
  type: "object"
20157
20351
  },
20158
20352
  {
20159
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
20353
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
20160
20354
  properties: {
20161
20355
  created_at: {
20162
20356
  description: "Date and time at which Seam created the error.",
@@ -20168,9 +20362,18 @@ var openapi_default = {
20168
20362
  enum: ["bridge_disconnected"],
20169
20363
  type: "string"
20170
20364
  },
20171
- is_bridge_error: { type: "boolean" },
20172
- is_connected_account_error: { type: "boolean" },
20173
- message: { type: "string" }
20365
+ is_bridge_error: {
20366
+ description: "Indicates whether the error is related to Seam Bridge.",
20367
+ type: "boolean"
20368
+ },
20369
+ is_connected_account_error: {
20370
+ description: "Indicates whether the error is related specifically to the connected account.",
20371
+ type: "boolean"
20372
+ },
20373
+ message: {
20374
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
20375
+ type: "string"
20376
+ }
20174
20377
  },
20175
20378
  required: ["created_at", "message", "error_code"],
20176
20379
  type: "object"
@@ -21870,15 +22073,24 @@ var openapi_default = {
21870
22073
  enum: ["invalid_credentials"],
21871
22074
  type: "string"
21872
22075
  },
21873
- is_bridge_error: { type: "boolean" },
21874
- is_connected_account_error: { type: "boolean" },
21875
- message: { type: "string" }
22076
+ is_bridge_error: {
22077
+ description: "Indicates whether the error is related to Seam Bridge.",
22078
+ type: "boolean"
22079
+ },
22080
+ is_connected_account_error: {
22081
+ description: "Indicates whether the error is related specifically to the connected account.",
22082
+ type: "boolean"
22083
+ },
22084
+ message: {
22085
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
22086
+ type: "string"
22087
+ }
21876
22088
  },
21877
22089
  required: ["created_at", "message", "error_code"],
21878
22090
  type: "object"
21879
22091
  },
21880
22092
  {
21881
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
22093
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
21882
22094
  properties: {
21883
22095
  created_at: {
21884
22096
  description: "Date and time at which Seam created the error.",
@@ -21890,9 +22102,18 @@ var openapi_default = {
21890
22102
  enum: ["bridge_disconnected"],
21891
22103
  type: "string"
21892
22104
  },
21893
- is_bridge_error: { type: "boolean" },
21894
- is_connected_account_error: { type: "boolean" },
21895
- message: { type: "string" }
22105
+ is_bridge_error: {
22106
+ description: "Indicates whether the error is related to Seam Bridge.",
22107
+ type: "boolean"
22108
+ },
22109
+ is_connected_account_error: {
22110
+ description: "Indicates whether the error is related specifically to the connected account.",
22111
+ type: "boolean"
22112
+ },
22113
+ message: {
22114
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
22115
+ type: "string"
22116
+ }
21896
22117
  },
21897
22118
  required: ["created_at", "message", "error_code"],
21898
22119
  type: "object"
@@ -27311,13 +27532,22 @@ var openapi_default = {
27311
27532
  "application/json": {
27312
27533
  schema: {
27313
27534
  properties: {
27535
+ acs_system_id: {
27536
+ description: "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.",
27537
+ format: "uuid",
27538
+ type: "string"
27539
+ },
27314
27540
  acs_user_id: {
27315
- description: "ID of the access system user that you want to delete.",
27541
+ description: "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id",
27542
+ format: "uuid",
27543
+ type: "string"
27544
+ },
27545
+ user_identity_id: {
27546
+ description: "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
27316
27547
  format: "uuid",
27317
27548
  type: "string"
27318
27549
  }
27319
27550
  },
27320
- required: ["acs_user_id"],
27321
27551
  type: "object"
27322
27552
  }
27323
27553
  }
@@ -27361,13 +27591,22 @@ var openapi_default = {
27361
27591
  "application/json": {
27362
27592
  schema: {
27363
27593
  properties: {
27594
+ acs_system_id: {
27595
+ description: "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.",
27596
+ format: "uuid",
27597
+ type: "string"
27598
+ },
27364
27599
  acs_user_id: {
27365
- description: "ID of the access system user that you want to get.",
27600
+ description: "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.",
27601
+ format: "uuid",
27602
+ type: "string"
27603
+ },
27604
+ user_identity_id: {
27605
+ description: "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.",
27366
27606
  format: "uuid",
27367
27607
  type: "string"
27368
27608
  }
27369
27609
  },
27370
- required: ["acs_user_id"],
27371
27610
  type: "object"
27372
27611
  }
27373
27612
  }
@@ -27635,13 +27874,22 @@ var openapi_default = {
27635
27874
  "application/json": {
27636
27875
  schema: {
27637
27876
  properties: {
27877
+ acs_system_id: {
27878
+ description: "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.",
27879
+ format: "uuid",
27880
+ type: "string"
27881
+ },
27638
27882
  acs_user_id: {
27639
- description: "ID of the access system user for whom you want to revoke access.",
27883
+ description: "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
27884
+ format: "uuid",
27885
+ type: "string"
27886
+ },
27887
+ user_identity_id: {
27888
+ description: "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
27640
27889
  format: "uuid",
27641
27890
  type: "string"
27642
27891
  }
27643
27892
  },
27644
- required: ["acs_user_id"],
27645
27893
  type: "object"
27646
27894
  }
27647
27895
  }
@@ -27685,13 +27933,22 @@ var openapi_default = {
27685
27933
  "application/json": {
27686
27934
  schema: {
27687
27935
  properties: {
27936
+ acs_system_id: {
27937
+ description: "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
27938
+ format: "uuid",
27939
+ type: "string"
27940
+ },
27688
27941
  acs_user_id: {
27689
- description: "ID of the access system user that you want to suspend.",
27942
+ description: "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
27943
+ format: "uuid",
27944
+ type: "string"
27945
+ },
27946
+ user_identity_id: {
27947
+ description: "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
27690
27948
  format: "uuid",
27691
27949
  type: "string"
27692
27950
  }
27693
27951
  },
27694
- required: ["acs_user_id"],
27695
27952
  type: "object"
27696
27953
  }
27697
27954
  }
@@ -27870,13 +28127,22 @@ var openapi_default = {
27870
28127
  "application/json": {
27871
28128
  schema: {
27872
28129
  properties: {
28130
+ acs_system_id: {
28131
+ description: "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.",
28132
+ format: "uuid",
28133
+ type: "string"
28134
+ },
27873
28135
  acs_user_id: {
27874
- description: "ID of the access system user that you want to unsuspend.",
28136
+ description: "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
28137
+ format: "uuid",
28138
+ type: "string"
28139
+ },
28140
+ user_identity_id: {
28141
+ description: "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
27875
28142
  format: "uuid",
27876
28143
  type: "string"
27877
28144
  }
27878
28145
  },
27879
- required: ["acs_user_id"],
27880
28146
  type: "object"
27881
28147
  }
27882
28148
  }
@@ -27938,8 +28204,13 @@ var openapi_default = {
27938
28204
  required: ["starts_at", "ends_at"],
27939
28205
  type: "object"
27940
28206
  },
28207
+ acs_system_id: {
28208
+ description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
28209
+ format: "uuid",
28210
+ type: "string"
28211
+ },
27941
28212
  acs_user_id: {
27942
- description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
28213
+ description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
27943
28214
  format: "uuid",
27944
28215
  type: "string"
27945
28216
  },
@@ -27963,9 +28234,13 @@ var openapi_default = {
27963
28234
  phone_number: {
27964
28235
  description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
27965
28236
  type: "string"
28237
+ },
28238
+ user_identity_id: {
28239
+ description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
28240
+ format: "uuid",
28241
+ type: "string"
27966
28242
  }
27967
28243
  },
27968
- required: ["acs_user_id"],
27969
28244
  type: "object"
27970
28245
  }
27971
28246
  }
@@ -28024,8 +28299,13 @@ var openapi_default = {
28024
28299
  required: ["starts_at", "ends_at"],
28025
28300
  type: "object"
28026
28301
  },
28302
+ acs_system_id: {
28303
+ description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
28304
+ format: "uuid",
28305
+ type: "string"
28306
+ },
28027
28307
  acs_user_id: {
28028
- description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
28308
+ description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
28029
28309
  format: "uuid",
28030
28310
  type: "string"
28031
28311
  },
@@ -28049,9 +28329,13 @@ var openapi_default = {
28049
28329
  phone_number: {
28050
28330
  description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
28051
28331
  type: "string"
28332
+ },
28333
+ user_identity_id: {
28334
+ description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
28335
+ format: "uuid",
28336
+ type: "string"
28052
28337
  }
28053
28338
  },
28054
- required: ["acs_user_id"],
28055
28339
  type: "object"
28056
28340
  }
28057
28341
  }