@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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.883.0",
3
+ "version": "1.885.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -11,7 +11,7 @@ import {
11
11
  const action_type = z
12
12
  .literal('ASSIGN_CREDENTIAL')
13
13
  .describe(
14
- 'Action attempt to track the status of assigning an existing credential to an access method.',
14
+ 'Action attempt to track the status of assigning a pre-registered card credential to an access method.',
15
15
  )
16
16
 
17
17
  const credential_not_found_error = z
@@ -35,7 +35,7 @@ const error = z.union([
35
35
  ])
36
36
 
37
37
  const result = access_method.describe(
38
- 'Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential.',
38
+ 'Result of assigning a credential. If successful, includes the updated access method with the assigned credential.',
39
39
  )
40
40
 
41
41
  export const assign_credential_action_attempt = z.discriminatedUnion('status', [
@@ -470,6 +470,15 @@ const hub_required_for_additional_capabilities = common_device_warning.extend({
470
470
  Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.
471
471
  `)
472
472
 
473
+ const provider_issue = common_device_warning.extend({
474
+ warning_code: z.literal('provider_issue').describe(warning_code_description),
475
+ }).describe(`
476
+ ---
477
+ variant_group_key: access_codes
478
+ ---
479
+ Indicates a provider-specific issue that may affect device functionality.
480
+ `)
481
+
473
482
  const keynest_unsupported_locker = common_device_warning.extend({
474
483
  warning_code: z
475
484
  .literal('keynest_unsupported_locker')
@@ -556,6 +565,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
556
565
  ultraloq_time_zone_unknown,
557
566
  two_n_device_missing_timezone,
558
567
  hub_required_for_additional_capabilities,
568
+ provider_issue,
559
569
  keynest_unsupported_locker,
560
570
  accessory_keypad_setup_required,
561
571
  unreliable_online_status,
@@ -612,6 +622,7 @@ export const device_warning_map = z.object({
612
622
  .nullable(),
613
623
  hub_required_for_additional_capabilities:
614
624
  hub_required_for_additional_capabilities.optional().nullable(),
625
+ provider_issue: provider_issue.optional().nullable(),
615
626
  keynest_unsupported_locker: keynest_unsupported_locker.optional().nullable(),
616
627
  accessory_keypad_setup_required: accessory_keypad_setup_required
617
628
  .optional()
@@ -9609,7 +9609,7 @@ const openapi: OpenAPISpec = {
9609
9609
  },
9610
9610
  action_type: {
9611
9611
  description:
9612
- 'Action attempt to track the status of assigning an existing credential to an access method.',
9612
+ 'Action attempt to track the status of assigning a pre-registered card credential to an access method.',
9613
9613
  enum: ['ASSIGN_CREDENTIAL'],
9614
9614
  type: 'string',
9615
9615
  },
@@ -9645,7 +9645,7 @@ const openapi: OpenAPISpec = {
9645
9645
  },
9646
9646
  action_type: {
9647
9647
  description:
9648
- 'Action attempt to track the status of assigning an existing credential to an access method.',
9648
+ 'Action attempt to track the status of assigning a pre-registered card credential to an access method.',
9649
9649
  enum: ['ASSIGN_CREDENTIAL'],
9650
9650
  type: 'string',
9651
9651
  },
@@ -9656,7 +9656,7 @@ const openapi: OpenAPISpec = {
9656
9656
  },
9657
9657
  result: {
9658
9658
  description:
9659
- 'Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential.',
9659
+ 'Result of assigning a credential. If successful, includes the updated access method with the assigned credential.',
9660
9660
  properties: {
9661
9661
  access_method_id: {
9662
9662
  description: 'ID of the access method.',
@@ -10062,7 +10062,7 @@ const openapi: OpenAPISpec = {
10062
10062
  },
10063
10063
  action_type: {
10064
10064
  description:
10065
- 'Action attempt to track the status of assigning an existing credential to an access method.',
10065
+ 'Action attempt to track the status of assigning a pre-registered card credential to an access method.',
10066
10066
  enum: ['ASSIGN_CREDENTIAL'],
10067
10067
  type: 'string',
10068
10068
  },
@@ -17086,6 +17086,32 @@ const openapi: OpenAPISpec = {
17086
17086
  type: 'object',
17087
17087
  'x-variant-group-key': 'locks',
17088
17088
  },
17089
+ {
17090
+ description:
17091
+ 'Indicates a provider-specific issue that may affect device functionality.',
17092
+ properties: {
17093
+ created_at: {
17094
+ description:
17095
+ 'Date and time at which Seam created the warning.',
17096
+ format: 'date-time',
17097
+ type: 'string',
17098
+ },
17099
+ message: {
17100
+ description:
17101
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
17102
+ type: 'string',
17103
+ },
17104
+ warning_code: {
17105
+ description:
17106
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
17107
+ enum: ['provider_issue'],
17108
+ type: 'string',
17109
+ },
17110
+ },
17111
+ required: ['message', 'created_at', 'warning_code'],
17112
+ type: 'object',
17113
+ 'x-variant-group-key': 'access_codes',
17114
+ },
17089
17115
  {
17090
17116
  description:
17091
17117
  'Indicates that the key is in a locker that does not support the access codes API.',
@@ -33374,6 +33400,32 @@ const openapi: OpenAPISpec = {
33374
33400
  type: 'object',
33375
33401
  'x-variant-group-key': 'locks',
33376
33402
  },
33403
+ {
33404
+ description:
33405
+ 'Indicates a provider-specific issue that may affect device functionality.',
33406
+ properties: {
33407
+ created_at: {
33408
+ description:
33409
+ 'Date and time at which Seam created the warning.',
33410
+ format: 'date-time',
33411
+ type: 'string',
33412
+ },
33413
+ message: {
33414
+ description:
33415
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
33416
+ type: 'string',
33417
+ },
33418
+ warning_code: {
33419
+ description:
33420
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
33421
+ enum: ['provider_issue'],
33422
+ type: 'string',
33423
+ },
33424
+ },
33425
+ required: ['message', 'created_at', 'warning_code'],
33426
+ type: 'object',
33427
+ 'x-variant-group-key': 'access_codes',
33428
+ },
33377
33429
  {
33378
33430
  description:
33379
33431
  'Indicates that the key is in a locker that does not support the access codes API.',
@@ -41252,7 +41304,7 @@ const openapi: OpenAPISpec = {
41252
41304
  '/access_methods/assign_card': {
41253
41305
  post: {
41254
41306
  description:
41255
- '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.',
41307
+ '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.',
41256
41308
  operationId: 'accessMethodsAssignCardPost',
41257
41309
  requestBody: {
41258
41310
  content: {