@seamapi/types 1.874.0 → 1.876.0

package/lib/seam/connect/route-types.d.ts

@@ -15492,6 +15492,133 @@ export type Routes = {
         jsonResponse: {};
         maxDuration: undefined;
     };
+    '/access_methods/assign_card': {
+        route: '/access_methods/assign_card';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the card-mode `access_method` to assign the card to. */
+            access_method_id: string;
+            /** Card number of the card credential to assign. */
+            card_number: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
+            access_method: {
+                /** ID of the Seam workspace associated with the access method. */
+                workspace_id: string;
+                /** ID of the access method. */
+                access_method_id: string;
+                /** Display name of the access method. */
+                display_name: string;
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
+                mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
+                /** Date and time at which the access method was created. */
+                created_at: string;
+                /** Date and time at which the access method was issued. */
+                issued_at: string | null;
+                /** Indicates whether the access method has been issued. */
+                is_issued: boolean;
+                /** URL of the Instant Key for mobile key access methods. */
+                instant_key_url?: string | undefined;
+                /** Token of the client session associated with the access method. */
+                client_session_token?: string | undefined;
+                /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+                is_encoding_required?: boolean | undefined;
+                /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
+                is_ready_for_encoding?: boolean | undefined;
+                /** The actual PIN code for code access methods. */
+                code?: (string | null) | undefined;
+                /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+                warnings: ({
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'updating_access_times';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'pulled_backup_access_code';
+                    /** ID of the original access method from which this backup access method was split, if applicable. */
+                    original_access_method_id?: string | undefined;
+                })[];
+                /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
+                    mutation_code: 'provisioning_access';
+                    /** Previous device configuration. */
+                    from: {
+                        /** Previous device IDs where access was provisioned. */
+                        device_ids: string[];
+                    };
+                    /** New device configuration. */
+                    to: {
+                        /** New device IDs where access is being provisioned. */
+                        device_ids: string[];
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
+                    mutation_code: 'revoking_access';
+                    /** Previous device configuration. */
+                    from: {
+                        /** Previous device IDs where access existed. */
+                        device_ids: string[];
+                    };
+                    /** New device configuration. */
+                    to: {
+                        /** New device IDs where access should remain. */
+                        device_ids: string[];
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
+                    mutation_code: 'updating_access_times';
+                    /** Previous access time configuration. */
+                    from: {
+                        /** Previous start time for access. */
+                        starts_at: string | null;
+                        /** Previous end time for access. */
+                        ends_at: string | null;
+                    };
+                    /** New access time configuration. */
+                    to: {
+                        /** New start time for access. */
+                        starts_at: string | null;
+                        /** New end time for access. */
+                        ends_at: string | null;
+                    };
+                })[];
+                /** ID of the customization profile associated with the access method. */
+                customization_profile_id?: string | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/access_methods/delete': {
         route: '/access_methods/delete';
         method: 'DELETE' | 'POST';

package/package.json

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

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

@@ -33378,7 +33378,7 @@ const openapi: OpenAPISpec = {
     '/access_codes/create': {
       post: {
         description:
-          'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
+          'Creates a new [access code](https://docs.seam.co/latest/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.',
         operationId: 'accessCodesCreatePost',
         requestBody: {
           content: {
@@ -36400,7 +36400,8 @@ const openapi: OpenAPISpec = {
     },
     '/access_grants/create': {
       post: {
-        description: 'Creates a new Access Grant.',
+        description:
+          'Creates a new [Access Grant](https://docs.seam.co/latest/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.',
         operationId: 'accessGrantsCreatePost',
         requestBody: {
           content: {
@@ -40693,6 +40694,69 @@ const openapi: OpenAPISpec = {
         'x-title': 'Update an Access Grant',
       },
     },
+    '/access_methods/assign_card': {
+      post: {
+        description:
+          'Assigns an existing card credential to a card-mode access method, identified by `card_number`.',
+        operationId: 'accessMethodsAssignCardPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_method_id: {
+                    description:
+                      'ID of the card-mode `access_method` to assign the card to.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  card_number: {
+                    description:
+                      'Card number of the card credential to assign.',
+                    type: 'string',
+                  },
+                },
+                required: ['access_method_id', 'card_number'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_method: {
+                      $ref: '#/components/schemas/access_method',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['access_method', '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/assign_card',
+        tags: [],
+        'x-fern-sdk-group-name': ['access_methods'],
+        'x-fern-sdk-method-name': 'assign_card',
+        'x-fern-sdk-return-value': 'access_method',
+        'x-response-key': 'access_method',
+        'x-title': 'Assign a Card to an Access Method',
+      },
+    },
     '/access_methods/delete': {
       delete: {
         description: 'Deletes an access method.',
@@ -44727,7 +44791,7 @@ const openapi: OpenAPISpec = {
     '/acs/credentials/create': {
       post: {
         description:
-          'Creates a new [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+          'Creates a new [credential](https://docs.seam.co/latest/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.',
         operationId: 'acsCredentialsCreatePost',
         requestBody: {
           content: {

package/src/lib/seam/connect/route-types.ts

@@ -17800,6 +17800,141 @@ export type Routes = {
     jsonResponse: {}
     maxDuration: undefined
   }
+  '/access_methods/assign_card': {
+    route: '/access_methods/assign_card'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the card-mode `access_method` to assign the card to. */
+      access_method_id: string
+      /** Card number of the card credential to assign. */
+      card_number: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
+      access_method: {
+        /** ID of the Seam workspace associated with the access method. */
+        workspace_id: string
+        /** ID of the access method. */
+        access_method_id: string
+        /** Display name of the access method. */
+        display_name: string
+        /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
+        mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
+        /** Date and time at which the access method was created. */
+        created_at: string
+        /** Date and time at which the access method was issued. */
+        issued_at: string | null
+        /** Indicates whether the access method has been issued. */
+        is_issued: boolean
+        /** URL of the Instant Key for mobile key access methods. */
+        instant_key_url?: string | undefined
+        /** Token of the client session associated with the access method. */
+        client_session_token?: string | undefined
+        /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+        is_encoding_required?: boolean | undefined
+        /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
+        is_ready_for_encoding?: boolean | undefined
+        /** The actual PIN code for code access methods. */
+        code?: (string | null) | undefined
+        /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+        warnings: (
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'being_deleted'
+            }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'updating_access_times'
+            }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'pulled_backup_access_code'
+              /** ID of the original access method from which this backup access method was split, if applicable. */
+              original_access_method_id?: string | undefined
+            }
+        )[]
+        /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
+        pending_mutations: (
+          | {
+              /** Date and time at which the mutation was created. */
+              created_at: string
+              /** Detailed description of the mutation. */
+              message: string
+              /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
+              mutation_code: 'provisioning_access'
+              /** Previous device configuration. */
+              from: {
+                /** Previous device IDs where access was provisioned. */
+                device_ids: string[]
+              }
+              /** New device configuration. */
+              to: {
+                /** New device IDs where access is being provisioned. */
+                device_ids: string[]
+              }
+            }
+          | {
+              /** Date and time at which the mutation was created. */
+              created_at: string
+              /** Detailed description of the mutation. */
+              message: string
+              /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
+              mutation_code: 'revoking_access'
+              /** Previous device configuration. */
+              from: {
+                /** Previous device IDs where access existed. */
+                device_ids: string[]
+              }
+              /** New device configuration. */
+              to: {
+                /** New device IDs where access should remain. */
+                device_ids: string[]
+              }
+            }
+          | {
+              /** Date and time at which the mutation was created. */
+              created_at: string
+              /** Detailed description of the mutation. */
+              message: string
+              /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
+              mutation_code: 'updating_access_times'
+              /** Previous access time configuration. */
+              from: {
+                /** Previous start time for access. */
+                starts_at: string | null
+                /** Previous end time for access. */
+                ends_at: string | null
+              }
+              /** New access time configuration. */
+              to: {
+                /** New start time for access. */
+                starts_at: string | null
+                /** New end time for access. */
+                ends_at: string | null
+              }
+            }
+        )[]
+        /** ID of the customization profile associated with the access method. */
+        customization_profile_id?: string | undefined
+      }
+    }
+    maxDuration: undefined
+  }
   '/access_methods/delete': {
     route: '/access_methods/delete'
     method: 'DELETE' | 'POST'