@seamapi/types 1.519.0 → 1.521.0

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

@@ -23709,21 +23709,20 @@ export type Routes = {
         method: 'GET' | 'POST';
         queryParams: {};
         jsonBody: {};
-        commonParams: {
+        commonParams: ({
             /** ID of the access system for which you want to retrieve all encoders. */
             acs_system_id: string;
-            /** Number of encoders to return. */
-            limit?: number;
         } | {
             /** IDs of the access systems for which you want to retrieve all encoders. */
             acs_system_ids: string[];
-            /** Number of encoders to return. */
-            limit?: number;
         } | {
             /** IDs of the encoders that you want to retrieve. */
             acs_encoder_ids: string[];
+        }) & {
             /** Number of encoders to return. */
             limit?: number;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: (string | undefined) | null;
         };
         formData: {};
         jsonResponse: {
@@ -23750,6 +23749,15 @@ export type Routes = {
                 /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 display_name: string;
             }[];
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
         };
     };
     '/acs/encoders/scan_credential': {
@@ -31115,6 +31123,8 @@ export type Routes = {
                     starts_at?: string | undefined;
                     /** Ending date and time for the access grant. */
                     ends_at?: string | undefined;
+                    /** Preferred PIN code to use when creating access for this reservation. */
+                    preferred_code?: string | undefined;
                     /** Your unique identifier for the reservation. */
                     reservation_key: string;
                     /** Guest key associated with the access grant. */
@@ -31152,6 +31162,8 @@ export type Routes = {
                     starts_at?: string | undefined;
                     /** Ending date and time for the access grant. */
                     ends_at?: string | undefined;
+                    /** Preferred PIN code to use when creating access for this reservation. */
+                    preferred_code?: string | undefined;
                     /** Your unique identifier for the booking. */
                     booking_key: string;
                     /** Guest key associated with the access grant. */
@@ -31189,6 +31201,8 @@ export type Routes = {
                     starts_at?: string | undefined;
                     /** Ending date and time for the access grant. */
                     ends_at?: string | undefined;
+                    /** Preferred PIN code to use when creating access for this reservation. */
+                    preferred_code?: string | undefined;
                     /** Your unique identifier for the access grant. */
                     access_grant_key: string;
                     /** Guest key associated with the access grant. */
@@ -31419,6 +31433,8 @@ export type Routes = {
                 starts_at?: string | undefined;
                 /** Ending date and time for the access grant. */
                 ends_at?: string | undefined;
+                /** Preferred PIN code to use when creating access for this reservation. */
+                preferred_code?: string | undefined;
                 /** Your unique identifier for the reservation. */
                 reservation_key: string;
                 /** Guest key associated with the access grant. */
@@ -31456,6 +31472,8 @@ export type Routes = {
                 starts_at?: string | undefined;
                 /** Ending date and time for the access grant. */
                 ends_at?: string | undefined;
+                /** Preferred PIN code to use when creating access for this reservation. */
+                preferred_code?: string | undefined;
                 /** Your unique identifier for the booking. */
                 booking_key: string;
                 /** Guest key associated with the access grant. */
@@ -31493,6 +31511,8 @@ export type Routes = {
                 starts_at?: string | undefined;
                 /** Ending date and time for the access grant. */
                 ends_at?: string | undefined;
+                /** Preferred PIN code to use when creating access for this reservation. */
+                preferred_code?: string | undefined;
                 /** Your unique identifier for the access grant. */
                 access_grant_key: string;
                 /** Guest key associated with the access grant. */

package/package.json

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

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

@@ -14,6 +14,12 @@ const base_access_grant_resource = z.object({
     .string()
     .optional()
     .describe('Ending date and time for the access grant.'),
+  preferred_code: z
+    .string()
+    .optional()
+    .describe(
+      'Preferred PIN code to use when creating access for this reservation.',
+    ),
 })
 
 // User identity key reference - allows any user identity key alias

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

@@ -32543,8 +32543,9 @@ export default {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['acs_encoders', 'ok'],
+                  required: ['acs_encoders', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -32575,59 +32576,62 @@ export default {
           content: {
             'application/json': {
               schema: {
-                oneOf: [
+                allOf: [
                   {
-                    properties: {
-                      acs_system_id: {
-                        description:
-                          'ID of the access system for which you want to retrieve all encoders.',
-                        format: 'uuid',
-                        type: 'string',
+                    oneOf: [
+                      {
+                        properties: {
+                          acs_system_id: {
+                            description:
+                              'ID of the access system for which you want to retrieve all encoders.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                        },
+                        required: ['acs_system_id'],
+                        type: 'object',
                       },
-                      limit: {
-                        default: 500,
-                        description: 'Number of encoders to return.',
-                        format: 'float',
-                        type: 'number',
+                      {
+                        properties: {
+                          acs_system_ids: {
+                            description:
+                              'IDs of the access systems for which you want to retrieve all encoders.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
+                        },
+                        required: ['acs_system_ids'],
+                        type: 'object',
                       },
-                    },
-                    required: ['acs_system_id'],
-                    type: 'object',
+                      {
+                        properties: {
+                          acs_encoder_ids: {
+                            description:
+                              'IDs of the encoders that you want to retrieve.',
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
+                        },
+                        required: ['acs_encoder_ids'],
+                        type: 'object',
+                      },
+                    ],
                   },
                   {
                     properties: {
-                      acs_system_ids: {
-                        description:
-                          'IDs of the access systems for which you want to retrieve all encoders.',
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                      },
                       limit: {
                         default: 500,
                         description: 'Number of encoders to return.',
                         format: 'float',
                         type: 'number',
                       },
-                    },
-                    required: ['acs_system_ids'],
-                    type: 'object',
-                  },
-                  {
-                    properties: {
-                      acs_encoder_ids: {
+                      page_cursor: {
                         description:
-                          'IDs of the encoders that you want to retrieve.',
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                      },
-                      limit: {
-                        default: 500,
-                        description: 'Number of encoders to return.',
-                        format: 'float',
-                        type: 'number',
+                          "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                        nullable: true,
+                        type: 'string',
                       },
                     },
-                    required: ['acs_encoder_ids'],
                     type: 'object',
                   },
                 ],
@@ -32646,8 +32650,9 @@ export default {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
-                  required: ['acs_encoders', 'ok'],
+                  required: ['acs_encoders', 'pagination', 'ok'],
                   type: 'object',
                 },
               },
@@ -38408,6 +38413,11 @@ export default {
                                     'Your name for this access grant resource.',
                                   type: 'string',
                                 },
+                                preferred_code: {
+                                  description:
+                                    'Preferred PIN code to use when creating access for this reservation.',
+                                  type: 'string',
+                                },
                                 property_keys: {
                                   description:
                                     'Property keys associated with the access grant.',
@@ -38511,6 +38521,11 @@ export default {
                                     'Your name for this access grant resource.',
                                   type: 'string',
                                 },
+                                preferred_code: {
+                                  description:
+                                    'Preferred PIN code to use when creating access for this reservation.',
+                                  type: 'string',
+                                },
                                 property_keys: {
                                   description:
                                     'Property keys associated with the access grant.',
@@ -38765,6 +38780,11 @@ export default {
                                     'Your name for this access grant resource.',
                                   type: 'string',
                                 },
+                                preferred_code: {
+                                  description:
+                                    'Preferred PIN code to use when creating access for this reservation.',
+                                  type: 'string',
+                                },
                                 property_keys: {
                                   description:
                                     'Property keys associated with the access grant.',
@@ -39426,6 +39446,11 @@ export default {
                             'Your name for this access grant resource.',
                           type: 'string',
                         },
+                        preferred_code: {
+                          description:
+                            'Preferred PIN code to use when creating access for this reservation.',
+                          type: 'string',
+                        },
                         property_keys: {
                           description:
                             'Property keys associated with the access grant.',
@@ -39529,6 +39554,11 @@ export default {
                             'Your name for this access grant resource.',
                           type: 'string',
                         },
+                        preferred_code: {
+                          description:
+                            'Preferred PIN code to use when creating access for this reservation.',
+                          type: 'string',
+                        },
                         property_keys: {
                           description:
                             'Property keys associated with the access grant.',
@@ -39780,6 +39810,11 @@ export default {
                             'Your name for this access grant resource.',
                           type: 'string',
                         },
+                        preferred_code: {
+                          description:
+                            'Preferred PIN code to use when creating access for this reservation.',
+                          type: 'string',
+                        },
                         property_keys: {
                           description:
                             'Property keys associated with the access grant.',

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

@@ -27543,25 +27543,25 @@ export type Routes = {
     method: 'GET' | 'POST'
     queryParams: {}
     jsonBody: {}
-    commonParams:
+    commonParams: (
       | {
           /** ID of the access system for which you want to retrieve all encoders. */
           acs_system_id: string
-          /** Number of encoders to return. */
-          limit?: number
         }
       | {
           /** IDs of the access systems for which you want to retrieve all encoders. */
           acs_system_ids: string[]
-          /** Number of encoders to return. */
-          limit?: number
         }
       | {
           /** IDs of the encoders that you want to retrieve. */
           acs_encoder_ids: string[]
-          /** Number of encoders to return. */
-          limit?: number
         }
+    ) & {
+      /** Number of encoders to return. */
+      limit?: number
+      /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+      page_cursor?: (string | undefined) | null
+    }
     formData: {}
     jsonResponse: {
       acs_encoders: {
@@ -27587,6 +27587,15 @@ export type Routes = {
         /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
         display_name: string
       }[]
+      /** Information about the current page of results. */
+      pagination: {
+        /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+        next_page_cursor: string | null
+        /** Indicates whether there is another page of results after this one. */
+        has_next_page: boolean
+        /** URL to get the next page of results. */
+        next_page_url: string | null
+      }
     }
   }
   '/acs/encoders/scan_credential': {
@@ -36099,6 +36108,8 @@ export type Routes = {
                   starts_at?: string | undefined
                   /** Ending date and time for the access grant. */
                   ends_at?: string | undefined
+                  /** Preferred PIN code to use when creating access for this reservation. */
+                  preferred_code?: string | undefined
                   /** Your unique identifier for the reservation. */
                   reservation_key: string
                   /** Guest key associated with the access grant. */
@@ -36138,6 +36149,8 @@ export type Routes = {
                   starts_at?: string | undefined
                   /** Ending date and time for the access grant. */
                   ends_at?: string | undefined
+                  /** Preferred PIN code to use when creating access for this reservation. */
+                  preferred_code?: string | undefined
                   /** Your unique identifier for the booking. */
                   booking_key: string
                   /** Guest key associated with the access grant. */
@@ -36177,6 +36190,8 @@ export type Routes = {
                   starts_at?: string | undefined
                   /** Ending date and time for the access grant. */
                   ends_at?: string | undefined
+                  /** Preferred PIN code to use when creating access for this reservation. */
+                  preferred_code?: string | undefined
                   /** Your unique identifier for the access grant. */
                   access_grant_key: string
                   /** Guest key associated with the access grant. */
@@ -36438,6 +36453,8 @@ export type Routes = {
             starts_at?: string | undefined
             /** Ending date and time for the access grant. */
             ends_at?: string | undefined
+            /** Preferred PIN code to use when creating access for this reservation. */
+            preferred_code?: string | undefined
             /** Your unique identifier for the reservation. */
             reservation_key: string
             /** Guest key associated with the access grant. */
@@ -36477,6 +36494,8 @@ export type Routes = {
             starts_at?: string | undefined
             /** Ending date and time for the access grant. */
             ends_at?: string | undefined
+            /** Preferred PIN code to use when creating access for this reservation. */
+            preferred_code?: string | undefined
             /** Your unique identifier for the booking. */
             booking_key: string
             /** Guest key associated with the access grant. */
@@ -36516,6 +36535,8 @@ export type Routes = {
             starts_at?: string | undefined
             /** Ending date and time for the access grant. */
             ends_at?: string | undefined
+            /** Preferred PIN code to use when creating access for this reservation. */
+            preferred_code?: string | undefined
             /** Your unique identifier for the access grant. */
             access_grant_key: string
             /** Guest key associated with the access grant. */