@seamapi/types 1.592.0 → 1.594.0

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

@@ -11823,6 +11823,82 @@ export type Routes = {
             }[];
         };
     };
+    '/access_grants/request_access_methods': {
+        route: '/access_grants/request_access_methods';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the Access Grant to add access methods to. */
+            access_grant_id: string;
+            /** Array of requested access methods to add to the access grant. */
+            requested_access_methods: {
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key';
+                /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                code?: string | undefined;
+            }[];
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
+            access_grant: {
+                /** ID of the Seam workspace associated with the Access Grant. */
+                workspace_id: string;
+                /** ID of the Access Grant. */
+                access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
+                /** ID of user identity to which the Access Grant gives access. */
+                user_identity_id: string;
+                /**
+                 * @deprecated Use `space_ids`.*/
+                location_ids: string[];
+                /** IDs of the spaces to which the Access Grant gives access. */
+                space_ids: string[];
+                /** Access methods that the user requested for the Access Grant. */
+                requested_access_methods: {
+                    /** Display name of the access method. */
+                    display_name: string;
+                    /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                    mode: 'code' | 'card' | 'mobile_key';
+                    /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+                    code?: string | undefined;
+                    /** Date and time at which the requested access method was added to the Access Grant. */
+                    created_at: string;
+                    /** IDs of the access methods created for the requested access method. */
+                    created_access_method_ids: string[];
+                }[];
+                /** IDs of the access methods created for the Access Grant. */
+                access_method_ids: string[];
+                /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                client_session_token?: string | undefined;
+                /** Name of the Access Grant. If not provided, the display name will be computed. */
+                name: string | null;
+                /** Display name of the Access Grant. */
+                display_name: string;
+                /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                instant_key_url?: string | undefined;
+                /** Date and time at which the Access Grant was created. */
+                created_at: string;
+                /** Date and time at which the Access Grant starts. */
+                starts_at: string;
+                /** Date and time at which the Access Grant ends. */
+                ends_at: string | null;
+                /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+                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';
+                }[];
+                /** ID of the customization profile associated with the Access Grant. */
+                customization_profile_id?: string | undefined;
+            };
+        };
+    };
     '/access_grants/unmanaged/get': {
         route: '/access_grants/unmanaged/get';
         method: 'GET' | 'POST';
@@ -58646,6 +58722,45 @@ export type Routes = {
             };
         };
     };
+    '/seam/customer/v1/spaces/list': {
+        route: '/seam/customer/v1/spaces/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
+            search?: string | undefined;
+            /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
+            connected_account_id?: string | undefined;
+            /** Filter spaces by space_key. */
+            space_key?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            spaces: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
+                workspace_id: string;
+                /** Unique key for the space within the workspace. */
+                space_key?: string | undefined;
+                /** Name of the space. */
+                name: string;
+                /** Display name for the space. */
+                display_name: string;
+                /** Date and time at which the space was created. */
+                created_at: string;
+                /** Number of devices in the space. */
+                device_count: number;
+                /** Number of entrances in the space. */
+                acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            }[];
+        };
+    };
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
         route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
         method: 'POST';

package/package.json

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

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

@@ -29115,6 +29115,90 @@ export default {
         'x-title': 'List Access Grants',
       },
     },
+    '/access_grants/request_access_methods': {
+      post: {
+        description:
+          'Adds additional requested access methods to an existing Access Grant.',
+        operationId: 'accessGrantsRequestAccessMethodsPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_grant_id: {
+                    description:
+                      'ID of the Access Grant to add access methods to.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  requested_access_methods: {
+                    description:
+                      'Array of requested access methods to add to the access grant.',
+                    items: {
+                      properties: {
+                        code: {
+                          description:
+                            "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
+                          maxLength: 9,
+                          minLength: 4,
+                          pattern: '^\\d+$',
+                          type: 'string',
+                        },
+                        mode: {
+                          description:
+                            'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
+                          enum: ['code', 'card', 'mobile_key'],
+                          type: 'string',
+                        },
+                      },
+                      required: ['mode'],
+                      type: 'object',
+                    },
+                    minItems: 1,
+                    type: 'array',
+                  },
+                },
+                required: ['access_grant_id', 'requested_access_methods'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    access_grant: { $ref: '#/components/schemas/access_grant' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['access_grant', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+          { client_session_with_customer: [] },
+        ],
+        summary: '/access_grants/request_access_methods',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['access_grants'],
+        'x-fern-sdk-method-name': 'request_access_methods',
+        'x-fern-sdk-return-value': 'access_grant',
+        'x-response-key': 'access_grant',
+        'x-title': 'Add Requested Access Methods to Access Grant',
+      },
+    },
     '/access_grants/unmanaged/get': {
       get: {
         description:
@@ -52865,6 +52949,139 @@ export default {
         'x-title': 'Create a Space',
       },
     },
+    '/seam/customer/v1/spaces/list': {
+      get: {
+        description: 'Returns a list of all spaces.',
+        operationId: 'seamCustomerV1SpacesListGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'search',
+            schema: {
+              description:
+                'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
+              minLength: 1,
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'connected_account_id',
+            schema: {
+              description:
+                'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
+              format: 'uuid',
+              type: 'string',
+              'x-draft': 'Needs review.',
+              'x-undocumented': 'Only used internally.',
+            },
+          },
+          {
+            in: 'query',
+            name: 'space_key',
+            schema: {
+              description: 'Filter spaces by space_key.',
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    spaces: {
+                      items: { $ref: '#/components/schemas/space' },
+                      type: 'array',
+                    },
+                  },
+                  required: ['spaces', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/spaces/list',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'spaces',
+        'x-response-key': 'spaces',
+        'x-title': 'List Spaces',
+      },
+      post: {
+        description: 'Returns a list of all spaces.',
+        operationId: 'seamCustomerV1SpacesListPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  connected_account_id: {
+                    description:
+                      'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
+                    format: 'uuid',
+                    type: 'string',
+                    'x-draft': 'Needs review.',
+                    'x-undocumented': 'Only used internally.',
+                  },
+                  search: {
+                    description:
+                      'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                  space_key: {
+                    description: 'Filter spaces by space_key.',
+                    type: 'string',
+                  },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    spaces: {
+                      items: { $ref: '#/components/schemas/space' },
+                      type: 'array',
+                    },
+                  },
+                  required: ['spaces', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/spaces/list',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'spaces',
+        'x-response-key': 'spaces',
+        'x-title': 'List Spaces',
+      },
+    },
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
       post: {
         description:

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

@@ -13551,6 +13551,82 @@ export type Routes = {
       }[]
     }
   }
+  '/access_grants/request_access_methods': {
+    route: '/access_grants/request_access_methods'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the Access Grant to add access methods to. */
+      access_grant_id: string
+      /** Array of requested access methods to add to the access grant. */
+      requested_access_methods: {
+        /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+        mode: 'code' | 'card' | 'mobile_key'
+        /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+        code?: string | undefined
+      }[]
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
+      access_grant: {
+        /** ID of the Seam workspace associated with the Access Grant. */
+        workspace_id: string
+        /** ID of the Access Grant. */
+        access_grant_id: string
+        /** Unique key for the access grant within the workspace. */
+        access_grant_key?: string | undefined
+        /** ID of user identity to which the Access Grant gives access. */
+        user_identity_id: string
+        /**
+         * @deprecated Use `space_ids`.*/
+        location_ids: string[]
+        /** IDs of the spaces to which the Access Grant gives access. */
+        space_ids: string[]
+        /** Access methods that the user requested for the Access Grant. */
+        requested_access_methods: {
+          /** Display name of the access method. */
+          display_name: string
+          /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+          mode: 'code' | 'card' | 'mobile_key'
+          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+          code?: string | undefined
+          /** Date and time at which the requested access method was added to the Access Grant. */
+          created_at: string
+          /** IDs of the access methods created for the requested access method. */
+          created_access_method_ids: string[]
+        }[]
+        /** IDs of the access methods created for the Access Grant. */
+        access_method_ids: string[]
+        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+        client_session_token?: string | undefined
+        /** Name of the Access Grant. If not provided, the display name will be computed. */
+        name: string | null
+        /** Display name of the Access Grant. */
+        display_name: string
+        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+        instant_key_url?: string | undefined
+        /** Date and time at which the Access Grant was created. */
+        created_at: string
+        /** Date and time at which the Access Grant starts. */
+        starts_at: string
+        /** Date and time at which the Access Grant ends. */
+        ends_at: string | null
+        /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+        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'
+        }[]
+        /** ID of the customization profile associated with the Access Grant. */
+        customization_profile_id?: string | undefined
+      }
+    }
+  }
   '/access_grants/unmanaged/get': {
     route: '/access_grants/unmanaged/get'
     method: 'GET' | 'POST'
@@ -69895,6 +69971,45 @@ export type Routes = {
       }
     }
   }
+  '/seam/customer/v1/spaces/list': {
+    route: '/seam/customer/v1/spaces/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
+      search?: string | undefined
+      /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
+      connected_account_id?: string | undefined
+      /** Filter spaces by space_key. */
+      space_key?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      spaces: {
+        /** ID of the space. */
+        space_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
+        workspace_id: string
+        /** Unique key for the space within the workspace. */
+        space_key?: string | undefined
+        /** Name of the space. */
+        name: string
+        /** Display name for the space. */
+        display_name: string
+        /** Date and time at which the space was created. */
+        created_at: string
+        /** Number of devices in the space. */
+        device_count: number
+        /** Number of entrances in the space. */
+        acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
+      }[]
+    }
+  }
   '/seam/instant_key/v1/client_sessions/exchange_short_code': {
     route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
     method: 'POST'