@seamapi/types 1.883.0 → 1.885.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.
package/dist/index.cjs CHANGED
@@ -1568,6 +1568,14 @@ var hub_required_for_additional_capabilities = common_device_warning.extend({
1568
1568
  ---
1569
1569
  Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.
1570
1570
  `);
1571
+ var provider_issue = common_device_warning.extend({
1572
+ warning_code: zod.z.literal("provider_issue").describe(warning_code_description2)
1573
+ }).describe(`
1574
+ ---
1575
+ variant_group_key: access_codes
1576
+ ---
1577
+ Indicates a provider-specific issue that may affect device functionality.
1578
+ `);
1571
1579
  var keynest_unsupported_locker = common_device_warning.extend({
1572
1580
  warning_code: zod.z.literal("keynest_unsupported_locker").describe(warning_code_description2)
1573
1581
  }).describe(`
@@ -1633,6 +1641,7 @@ var device_warning = zod.z.discriminatedUnion("warning_code", [
1633
1641
  ultraloq_time_zone_unknown,
1634
1642
  two_n_device_missing_timezone,
1635
1643
  hub_required_for_additional_capabilities,
1644
+ provider_issue,
1636
1645
  keynest_unsupported_locker,
1637
1646
  accessory_keypad_setup_required,
1638
1647
  unreliable_online_status,
@@ -1663,6 +1672,7 @@ zod.z.object({
1663
1672
  ultraloq_time_zone_unknown: ultraloq_time_zone_unknown.optional().nullable(),
1664
1673
  two_n_device_missing_timezone: two_n_device_missing_timezone.optional().nullable(),
1665
1674
  hub_required_for_additional_capabilities: hub_required_for_additional_capabilities.optional().nullable(),
1675
+ provider_issue: provider_issue.optional().nullable(),
1666
1676
  keynest_unsupported_locker: keynest_unsupported_locker.optional().nullable(),
1667
1677
  accessory_keypad_setup_required: accessory_keypad_setup_required.optional().nullable(),
1668
1678
  unreliable_online_status: unreliable_online_status.optional().nullable(),
@@ -2316,7 +2326,7 @@ var common_access_code_error = zod.z.object({
2316
2326
  created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the error.")
2317
2327
  });
2318
2328
  var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
2319
- var provider_issue = common_access_code_error.extend({
2329
+ var provider_issue2 = common_access_code_error.extend({
2320
2330
  error_code: zod.z.literal("provider_issue").describe(error_code_description3)
2321
2331
  }).describe(
2322
2332
  "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details."
@@ -2501,7 +2511,7 @@ var replaced_by_newer_access_code = common_access_code_error.extend({
2501
2511
  "This access code was overridden on the device by a newer access code programmed to the same slot."
2502
2512
  );
2503
2513
  var access_code_error = zod.z.discriminatedUnion("error_code", [
2504
- provider_issue,
2514
+ provider_issue2,
2505
2515
  smartthings_failed_to_set_access_code_error,
2506
2516
  smartthings_failed_to_set_after_multiple_retries,
2507
2517
  failed_to_set_on_device,
@@ -2528,7 +2538,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
2528
2538
  "Errors associated with the [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes)."
2529
2539
  );
2530
2540
  zod.z.object({
2531
- provider_issue: provider_issue.optional().nullable(),
2541
+ provider_issue: provider_issue2.optional().nullable(),
2532
2542
  smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_error.optional().nullable(),
2533
2543
  smartthings_failed_to_set_after_multiple_retries: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
2534
2544
  failed_to_set_on_device: failed_to_set_on_device.optional().nullable(),
@@ -4676,7 +4686,7 @@ var activate_climate_preset_action_attempt = zod.z.discriminatedUnion(
4676
4686
  ]
4677
4687
  );
4678
4688
  var action_type2 = zod.z.literal("ASSIGN_CREDENTIAL").describe(
4679
- "Action attempt to track the status of assigning an existing credential to an access method."
4689
+ "Action attempt to track the status of assigning a pre-registered card credential to an access method."
4680
4690
  );
4681
4691
  var credential_not_found_error = zod.z.object({
4682
4692
  type: zod.z.literal("credential_not_found").describe(
@@ -4691,7 +4701,7 @@ var error2 = zod.z.union([
4691
4701
  credential_not_found_error
4692
4702
  ]);
4693
4703
  var result2 = access_method.describe(
4694
- "Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential."
4704
+ "Result of assigning a credential. If successful, includes the updated access method with the assigned credential."
4695
4705
  );
4696
4706
  var assign_credential_action_attempt = zod.z.discriminatedUnion("status", [
4697
4707
  common_pending_action_attempt.extend({
@@ -15693,7 +15703,7 @@ var openapi = {
15693
15703
  type: "string"
15694
15704
  },
15695
15705
  action_type: {
15696
- description: "Action attempt to track the status of assigning an existing credential to an access method.",
15706
+ description: "Action attempt to track the status of assigning a pre-registered card credential to an access method.",
15697
15707
  enum: ["ASSIGN_CREDENTIAL"],
15698
15708
  type: "string"
15699
15709
  },
@@ -15725,7 +15735,7 @@ var openapi = {
15725
15735
  type: "string"
15726
15736
  },
15727
15737
  action_type: {
15728
- description: "Action attempt to track the status of assigning an existing credential to an access method.",
15738
+ description: "Action attempt to track the status of assigning a pre-registered card credential to an access method.",
15729
15739
  enum: ["ASSIGN_CREDENTIAL"],
15730
15740
  type: "string"
15731
15741
  },
@@ -15734,7 +15744,7 @@ var openapi = {
15734
15744
  nullable: true
15735
15745
  },
15736
15746
  result: {
15737
- description: "Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential.",
15747
+ description: "Result of assigning a credential. If successful, includes the updated access method with the assigned credential.",
15738
15748
  properties: {
15739
15749
  access_method_id: {
15740
15750
  description: "ID of the access method.",
@@ -16093,7 +16103,7 @@ var openapi = {
16093
16103
  type: "string"
16094
16104
  },
16095
16105
  action_type: {
16096
- description: "Action attempt to track the status of assigning an existing credential to an access method.",
16106
+ description: "Action attempt to track the status of assigning a pre-registered card credential to an access method.",
16097
16107
  enum: ["ASSIGN_CREDENTIAL"],
16098
16108
  type: "string"
16099
16109
  },
@@ -22421,6 +22431,28 @@ var openapi = {
22421
22431
  type: "object",
22422
22432
  "x-variant-group-key": "locks"
22423
22433
  },
22434
+ {
22435
+ description: "Indicates a provider-specific issue that may affect device functionality.",
22436
+ properties: {
22437
+ created_at: {
22438
+ description: "Date and time at which Seam created the warning.",
22439
+ format: "date-time",
22440
+ type: "string"
22441
+ },
22442
+ message: {
22443
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
22444
+ type: "string"
22445
+ },
22446
+ warning_code: {
22447
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
22448
+ enum: ["provider_issue"],
22449
+ type: "string"
22450
+ }
22451
+ },
22452
+ required: ["message", "created_at", "warning_code"],
22453
+ type: "object",
22454
+ "x-variant-group-key": "access_codes"
22455
+ },
22424
22456
  {
22425
22457
  description: "Indicates that the key is in a locker that does not support the access codes API.",
22426
22458
  properties: {
@@ -37104,6 +37136,28 @@ var openapi = {
37104
37136
  type: "object",
37105
37137
  "x-variant-group-key": "locks"
37106
37138
  },
37139
+ {
37140
+ description: "Indicates a provider-specific issue that may affect device functionality.",
37141
+ properties: {
37142
+ created_at: {
37143
+ description: "Date and time at which Seam created the warning.",
37144
+ format: "date-time",
37145
+ type: "string"
37146
+ },
37147
+ message: {
37148
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
37149
+ type: "string"
37150
+ },
37151
+ warning_code: {
37152
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
37153
+ enum: ["provider_issue"],
37154
+ type: "string"
37155
+ }
37156
+ },
37157
+ required: ["message", "created_at", "warning_code"],
37158
+ type: "object",
37159
+ "x-variant-group-key": "access_codes"
37160
+ },
37107
37161
  {
37108
37162
  description: "Indicates that the key is in a locker that does not support the access codes API.",
37109
37163
  properties: {
@@ -44300,7 +44354,7 @@ var openapi = {
44300
44354
  },
44301
44355
  "/access_methods/assign_card": {
44302
44356
  post: {
44303
- description: "Assigns a pre-registered card credential to a card-mode access method, identified by `card_number`. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be issued.",
44357
+ description: "Assigns a pre-registered card credential, identified by `card_number`, to a card-mode access method. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be used for access. Assigning a card credential also triggers issuance of the access method.",
44304
44358
  operationId: "accessMethodsAssignCardPost",
44305
44359
  requestBody: {
44306
44360
  content: {