@seamapi/types 1.516.0 → 1.518.0

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

@@ -9995,6 +9995,8 @@ export type Routes = {
             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;
             }[];
             /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: string | undefined;
@@ -10026,6 +10028,8 @@ export type Routes = {
                     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. */
@@ -10099,6 +10103,8 @@ export type Routes = {
                     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. */
@@ -11774,6 +11780,8 @@ export type Routes = {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to list access grants. */
+            customer_key?: string | undefined;
             /** ID of user identity by which you want to filter the list of Access Grants. */
             user_identity_id?: string | undefined;
             /** ID of the access system by which you want to filter the list of Access Grants. */
@@ -11810,6 +11818,8 @@ export type Routes = {
                     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. */
@@ -17186,6 +17196,8 @@ export type Routes = {
                         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. */
@@ -36770,6 +36782,8 @@ export type Routes = {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to list events. */
+            customer_key?: string | undefined;
             /** Offset for the events that you want to list. */
             unstable_offset?: number | undefined;
             /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
@@ -36800,8 +36814,6 @@ export type Routes = {
             limit?: number;
             /** IDs of the events that you want to list. */
             event_ids?: string[] | undefined;
-            /** IDs of the customers for which you want to list events. */
-            customer_ids?: string[] | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -59711,6 +59723,8 @@ export type Routes = {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to list spaces. */
+            customer_key?: string | undefined;
             /** 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. */
@@ -78718,7 +78732,10 @@ export type Routes = {
         method: 'POST' | 'GET';
         queryParams: {};
         jsonBody: {};
-        commonParams: {};
+        commonParams: {
+            /** Customer key for which you want to list customization profiles. */
+            customer_key?: string | undefined;
+        };
         formData: {};
         jsonResponse: {
             customization_profiles: {
@@ -82772,6 +82789,8 @@ export type Routes = {
                         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. */

package/package.json

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

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

@@ -7,6 +7,15 @@ export const requested_access_method = z.object({
     .describe(
       'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
     ),
+  code: z
+    .string()
+    .min(4)
+    .max(9)
+    .regex(/^\d+$/, 'Must only contain digits')
+    .optional()
+    .describe(
+      "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
+    ),
   created_at: z
     .string()
     .datetime()

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

@@ -1889,6 +1889,14 @@ export default {
               'Access methods that the user requested for 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',
+                },
                 created_access_method_ids: {
                   description:
                     'IDs of the access methods created for the requested access method.',
@@ -27974,6 +27982,14 @@ export default {
                       requested_access_methods: {
                         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`.',
@@ -28511,6 +28527,15 @@ export default {
         description: 'Gets an Access Grant.',
         operationId: 'accessGrantsListGet',
         parameters: [
+          {
+            in: 'query',
+            name: 'customer_key',
+            schema: {
+              description:
+                'Customer key for which you want to list access grants.',
+              type: 'string',
+            },
+          },
           {
             in: 'query',
             name: 'user_identity_id',
@@ -28631,6 +28656,11 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
+                  customer_key: {
+                    description:
+                      'Customer key for which you want to list access grants.',
+                    type: 'string',
+                  },
                   location_id: {
                     deprecated: true,
                     format: 'uuid',
@@ -42742,6 +42772,14 @@ export default {
           'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.',
         operationId: 'eventsListGet',
         parameters: [
+          {
+            in: 'query',
+            name: 'customer_key',
+            schema: {
+              description: 'Customer key for which you want to list events.',
+              type: 'string',
+            },
+          },
           {
             in: 'query',
             name: 'unstable_offset',
@@ -43079,16 +43117,6 @@ export default {
               type: 'array',
             },
           },
-          {
-            in: 'query',
-            name: 'customer_ids',
-            schema: {
-              description:
-                'IDs of the customers for which you want to list events.',
-              items: { format: 'uuid', type: 'string' },
-              type: 'array',
-            },
-          },
         ],
         responses: {
           200: {
@@ -43185,11 +43213,10 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
-                  customer_ids: {
+                  customer_key: {
                     description:
-                      'IDs of the customers for which you want to list events.',
-                    items: { format: 'uuid', type: 'string' },
-                    type: 'array',
+                      'Customer key for which you want to list events.',
+                    type: 'string',
                   },
                   device_id: {
                     description:
@@ -50514,6 +50541,14 @@ export default {
         description: 'Returns a list of all spaces.',
         operationId: 'spacesListGet',
         parameters: [
+          {
+            in: 'query',
+            name: 'customer_key',
+            schema: {
+              description: 'Customer key for which you want to list spaces.',
+              type: 'string',
+            },
+          },
           {
             in: 'query',
             name: 'search',
@@ -50598,6 +50633,11 @@ export default {
                     'x-draft': 'Needs review.',
                     'x-undocumented': 'Only used internally.',
                   },
+                  customer_key: {
+                    description:
+                      'Customer key for which you want to list spaces.',
+                    type: 'string',
+                  },
                   search: {
                     description:
                       'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
@@ -57314,6 +57354,17 @@ export default {
       get: {
         description: 'Retrieves the customization profile for the workspace.',
         operationId: 'workspacesCustomizationProfilesListGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'customer_key',
+            schema: {
+              description:
+                'Customer key for which you want to list customization profiles.',
+              type: 'string',
+            },
+          },
+        ],
         responses: {
           200: {
             content: {
@@ -57356,6 +57407,22 @@ export default {
       post: {
         description: 'Retrieves the customization profile for the workspace.',
         operationId: 'workspacesCustomizationProfilesListPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  customer_key: {
+                    description:
+                      'Customer key for which you want to list customization profiles.',
+                    type: 'string',
+                  },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
         responses: {
           200: {
             content: {

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

@@ -11235,6 +11235,8 @@ export type Routes = {
       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
       }[]
       /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
       starts_at?: string | undefined
@@ -11266,6 +11268,8 @@ export type Routes = {
           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. */
@@ -11341,6 +11345,8 @@ export type Routes = {
           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. */
@@ -13479,6 +13485,8 @@ export type Routes = {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** Customer key for which you want to list access grants. */
+      customer_key?: string | undefined
       /** ID of user identity by which you want to filter the list of Access Grants. */
       user_identity_id?: string | undefined
       /** ID of the access system by which you want to filter the list of Access Grants. */
@@ -13515,6 +13523,8 @@ export type Routes = {
           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. */
@@ -19966,6 +19976,8 @@ export type Routes = {
                 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. */
@@ -43308,6 +43320,8 @@ export type Routes = {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** Customer key for which you want to list events. */
+      customer_key?: string | undefined
       /** Offset for the events that you want to list. */
       unstable_offset?: number | undefined
       /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
@@ -43524,8 +43538,6 @@ export type Routes = {
       limit?: number
       /** IDs of the events that you want to list. */
       event_ids?: string[] | undefined
-      /** IDs of the customers for which you want to list events. */
-      customer_ids?: string[] | undefined
     }
     formData: {}
     jsonResponse: {
@@ -71182,6 +71194,8 @@ export type Routes = {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** Customer key for which you want to list spaces. */
+      customer_key?: string | undefined
       /** 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. */
@@ -93574,7 +93588,10 @@ export type Routes = {
     method: 'POST' | 'GET'
     queryParams: {}
     jsonBody: {}
-    commonParams: {}
+    commonParams: {
+      /** Customer key for which you want to list customization profiles. */
+      customer_key?: string | undefined
+    }
     formData: {}
     jsonResponse: {
       customization_profiles: {
@@ -98518,6 +98535,8 @@ export type Routes = {
                 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. */