@seamapi/types 1.426.0 → 1.428.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.426.0",
+  "version": "1.428.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -27,6 +27,13 @@ export const access_grant = z.object({
     .array(z.string().uuid())
     .describe('IDs of the access methods created for the access grant.'),
   display_name: z.string().describe('Display name of the access grant.'),
+  instant_key_url: z
+    .string()
+    .url()
+    .optional()
+    .describe(
+      'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
+    ),
   created_at: z
     .string()
     .datetime()

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -23,13 +23,14 @@ export const access_method = z.object({
     .describe('Date and time at which the access method was issued.'),
   instant_key_url: z
     .string()
+    .url()
     .optional()
     .describe('URL of the Instant Key for mobile key access methods.'),
-  is_card_encoding_required: z
+  is_encoding_required: z
     .boolean()
     .optional()
     .describe(
-      'Indicates whether card encoding is required for plastic card access methods.',
+      'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
     ),
 }).describe(`
   ---

package/src/lib/seam/connect/models/action-attempts/action-attempt.ts

@@ -2,7 +2,6 @@ import { z } from 'zod'
 
 import { activate_climate_preset_action_attempt } from './activate-climate-preset.js'
 import { deprecated_action_attempts } from './deprecated.js'
-import { encode_access_method_action_attempt } from './encode-access-method.js'
 import { encode_credential_action_attempt } from './encode-credential.js'
 import { lock_door_action_attempt } from './lock-door.js'
 import { push_thermostat_programs_action_attempt } from './push-thermostat-programs.js'
@@ -18,7 +17,6 @@ export const action_attempt = z.union([
   ...lock_door_action_attempt.options,
   ...unlock_door_action_attempt.options,
   ...scan_credential_action_attempt.options,
-  ...encode_access_method_action_attempt.options,
   ...encode_credential_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_fan_mode_action_attempt.options,
@@ -33,7 +31,7 @@ export const action_attempt = z.union([
   route_path: /action_attempts
   ---
   Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
-  
+
   When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
 
   See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).

package/src/lib/seam/connect/openapi.ts

@@ -1842,6 +1842,12 @@ export default {
             format: 'date-time',
             type: 'string',
           },
+          instant_key_url: {
+            description:
+              'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
+            format: 'uri',
+            type: 'string',
+          },
           location_ids: {
             deprecated: true,
             items: { format: 'uuid', type: 'string' },
@@ -1947,11 +1953,12 @@ export default {
           instant_key_url: {
             description:
               'URL of the Instant Key for mobile key access methods.',
+            format: 'uri',
             type: 'string',
           },
-          is_card_encoding_required: {
+          is_encoding_required: {
             description:
-              'Indicates whether card encoding is required for plastic card access methods.',
+              'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
             type: 'boolean',
           },
           issued_at: {
@@ -5506,259 +5513,6 @@ export default {
             ],
             type: 'object',
           },
-          {
-            description:
-              'Encoding access method data from the physical encoder onto a card is pending.',
-            properties: {
-              action_attempt_id: {
-                description: 'ID of the action attempt.',
-                format: 'uuid',
-                type: 'string',
-              },
-              action_type: {
-                description:
-                  'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
-                enum: ['ENCODE_ACCESS_METHOD'],
-                type: 'string',
-              },
-              error: {
-                description:
-                  'Errors associated with the action attempt. Null for pending action attempts.',
-                nullable: true,
-              },
-              result: {
-                description:
-                  'Result of the action attempt. Null for pending action attempts.',
-                nullable: true,
-              },
-              status: { enum: ['pending'], type: 'string' },
-            },
-            required: [
-              'action_attempt_id',
-              'status',
-              'result',
-              'error',
-              'action_type',
-            ],
-            type: 'object',
-          },
-          {
-            description:
-              'Encoding access method data from the physical encoder onto a card succeeded.',
-            properties: {
-              action_attempt_id: {
-                description: 'ID of the action attempt.',
-                format: 'uuid',
-                type: 'string',
-              },
-              action_type: {
-                description:
-                  'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
-                enum: ['ENCODE_ACCESS_METHOD'],
-                type: 'string',
-              },
-              error: {
-                description:
-                  'Errors associated with the action attempt. Null for successful action attempts.',
-                nullable: true,
-              },
-              result: {
-                description:
-                  'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
-                properties: {
-                  access_method_id: {
-                    description: 'ID of the access method.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                  created_at: {
-                    description:
-                      'Date and time at which the access method was created.',
-                    format: 'date-time',
-                    type: 'string',
-                  },
-                  display_name: {
-                    description: 'Display name of the access method.',
-                    type: 'string',
-                  },
-                  instant_key_url: {
-                    description:
-                      'URL of the Instant Key for mobile key access methods.',
-                    type: 'string',
-                  },
-                  is_card_encoding_required: {
-                    description:
-                      'Indicates whether card encoding is required for plastic card access methods.',
-                    type: 'boolean',
-                  },
-                  issued_at: {
-                    description:
-                      'Date and time at which the access method was issued.',
-                    format: 'date-time',
-                    type: 'string',
-                  },
-                  mode: {
-                    description:
-                      'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
-                    enum: ['code', 'card', 'mobile_key'],
-                    type: 'string',
-                  },
-                  workspace_id: {
-                    description:
-                      'ID of the Seam workspace associated with the access method.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: [
-                  'workspace_id',
-                  'access_method_id',
-                  'display_name',
-                  'mode',
-                  'created_at',
-                ],
-                type: 'object',
-              },
-              status: { enum: ['success'], type: 'string' },
-            },
-            required: [
-              'action_attempt_id',
-              'status',
-              'error',
-              'action_type',
-              'result',
-            ],
-            type: 'object',
-          },
-          {
-            description:
-              'Encoding access method data from the physical encoder onto a card failed.',
-            properties: {
-              action_attempt_id: {
-                description: 'ID of the action attempt.',
-                format: 'uuid',
-                type: 'string',
-              },
-              action_type: {
-                description:
-                  'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
-                enum: ['ENCODE_ACCESS_METHOD'],
-                type: 'string',
-              },
-              error: {
-                oneOf: [
-                  {
-                    description:
-                      "Error that doesn't fit into other specific error categories.",
-                    properties: {
-                      message: {
-                        description:
-                          'Message for the error associated with the action attempt.',
-                        type: 'string',
-                      },
-                      type: {
-                        description:
-                          'Type of the error associated with the action attempt.',
-                        enum: ['uncategorized_error'],
-                        type: 'string',
-                      },
-                    },
-                    required: ['type', 'message'],
-                    type: 'object',
-                  },
-                  {
-                    description: 'Error to indicate an expired action attempt.',
-                    properties: {
-                      message: {
-                        description:
-                          'Message for the error associated with the action attempt.',
-                        type: 'string',
-                      },
-                      type: {
-                        description:
-                          'Type of the error associated with the action attempt.',
-                        enum: ['action_attempt_expired'],
-                        type: 'string',
-                      },
-                    },
-                    required: ['type', 'message'],
-                    type: 'object',
-                  },
-                  {
-                    description:
-                      'Error to indicate that there is no credential on the encoder.',
-                    properties: {
-                      message: {
-                        description:
-                          'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
-                        type: 'string',
-                      },
-                      type: {
-                        description:
-                          'Error type to indicate that there is no credential on the encoder.',
-                        enum: ['no_credential_on_encoder'],
-                        type: 'string',
-                      },
-                    },
-                    required: ['type', 'message'],
-                    type: 'object',
-                  },
-                  {
-                    description:
-                      'Error to indicate an incompatible card format.',
-                    properties: {
-                      message: {
-                        description:
-                          'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
-                        type: 'string',
-                      },
-                      type: {
-                        description:
-                          'Error type to indicate an incompatible card format.',
-                        enum: ['incompatible_card_format'],
-                        type: 'string',
-                      },
-                    },
-                    required: ['type', 'message'],
-                    type: 'object',
-                  },
-                  {
-                    description:
-                      'Error to indicate that the affected credential cannot be reissued.',
-                    properties: {
-                      message: {
-                        description:
-                          'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
-                        type: 'string',
-                      },
-                      type: {
-                        description:
-                          'Error type to indicate that the affected credential cannot be reissued.',
-                        enum: ['credential_cannot_be_reissued'],
-                        type: 'string',
-                      },
-                    },
-                    required: ['type', 'message'],
-                    type: 'object',
-                  },
-                ],
-              },
-              result: {
-                description:
-                  'Result of the action attempt. Null for failed action attempts.',
-                nullable: true,
-              },
-              status: { enum: ['error'], type: 'string' },
-            },
-            required: [
-              'action_attempt_id',
-              'status',
-              'result',
-              'action_type',
-              'error',
-            ],
-            type: 'object',
-          },
           {
             description:
               'Encoding credential data from the physical encoder onto a card is pending.',
@@ -27384,6 +27138,71 @@ export default {
         'x-title': 'Delete an Access Method',
       },
     },
+    '/access_methods/encode': {
+      post: {
+        description:
+          'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
+        operationId: 'accessMethodsEncodePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_method_id: {
+                    description:
+                      'ID of the `access_method` to encode onto a card.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  acs_encoder_id: {
+                    description:
+                      'ID of the `acs_encoder` to use to encode the `acs_credential`.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['acs_encoder_id', 'access_method_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: '#/components/schemas/action_attempt',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['action_attempt', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/access_methods/encode',
+        tags: [],
+        'x-action-attempt-type': 'ENCODE_CREDENTIAL',
+        'x-fern-sdk-group-name': ['access_methods'],
+        'x-fern-sdk-method-name': 'encode',
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
+        'x-title': 'Encode an Access Method',
+      },
+    },
     '/access_methods/get': {
       get: {
         description: 'Get an access method.',
@@ -30208,11 +30027,11 @@ export default {
         'x-title': 'Update a Credential',
       },
     },
-    '/acs/encoders/encode_access_method': {
+    '/acs/encoders/encode_credential': {
       post: {
         description:
-          'Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
-        operationId: 'acsEncodersEncodeAccessMethodPost',
+          'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`',
+        operationId: 'acsEncodersEncodeCredentialPost',
         requestBody: {
           content: {
             'application/json': {
@@ -30224,65 +30043,6 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
-                  acs_encoder_id: {
-                    description:
-                      'ID of the `acs_encoder` to use to encode the `access_method`.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['acs_encoder_id', 'access_method_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    action_attempt: {
-                      $ref: '#/components/schemas/action_attempt',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['action_attempt', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-        ],
-        summary: '/acs/encoders/encode_access_method',
-        tags: ['/acs'],
-        'x-action-attempt-type': 'ENCODE_ACCESS_METHOD',
-        'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'encode_access_method',
-        'x-fern-sdk-return-value': 'action_attempt',
-        'x-response-key': 'action_attempt',
-        'x-title': 'Encode an Access Method',
-      },
-    },
-    '/acs/encoders/encode_credential': {
-      post: {
-        description:
-          'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
-        operationId: 'acsEncodersEncodeCredentialPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
                   acs_credential_id: {
                     description:
                       'ID of the `acs_credential` to encode onto a card.',
@@ -30296,7 +30056,7 @@ export default {
                     type: 'string',
                   },
                 },
-                required: ['acs_encoder_id', 'acs_credential_id'],
+                required: ['acs_encoder_id'],
                 type: 'object',
               },
             },