@seamapi/types 1.560.0 → 1.562.0

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

@@ -1547,6 +1547,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -2092,6 +2101,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -3891,6 +3909,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -4410,6 +4437,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -4935,6 +4971,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -5438,6 +5483,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -5974,6 +6028,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -7760,6 +7823,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -8257,6 +8329,15 @@ export type Routes = {
                     created_at?: string | undefined;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'dormakaba_oracode_no_valid_user_level';
+                } | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that this is an access code error. */
+                    is_access_code_error: true;
+                    /** Date and time at which Seam created the error. */
+                    created_at?: string | undefined;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'kwikset_insufficient_permissions';
                 } | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
@@ -19401,6 +19482,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'dormakaba_oracode_no_valid_user_level';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'kwikset_insufficient_permissions';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
@@ -19891,6 +19981,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'dormakaba_oracode_no_valid_user_level';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'kwikset_insufficient_permissions';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
@@ -58017,6 +58116,35 @@ export type Routes = {
             };
         };
     };
+    '/seam/customer/v1/reservations/get': {
+        route: '/seam/customer/v1/reservations/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the reservation to retrieve. */
+            reservation_id?: string | undefined;
+            /** Key of the reservation to retrieve. */
+            reservation_key?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            reservation: {
+                reservation_id: string;
+                reservation_key: string;
+                name: string | null;
+                starts_at: string | null;
+                ends_at: string | null;
+                created_at: string;
+                guest_name: string | null;
+                access_methods: {
+                    access_method_id: string;
+                    mode: string;
+                    is_issued: boolean;
+                }[];
+            };
+        };
+    };
     '/seam/customer/v1/reservations/list': {
         route: '/seam/customer/v1/reservations/list';
         method: 'GET' | 'POST';
@@ -58025,6 +58153,8 @@ export type Routes = {
         commonParams: {
             /** Filter reservations by space key. */
             space_key?: string | undefined;
+            /** Filter reservations by space ID (UUID). */
+            space_id?: string | undefined;
             /** Maximum number of records to return per page. */
             limit?: number;
             /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */
@@ -85858,6 +85988,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'dormakaba_oracode_no_valid_user_level';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'kwikset_insufficient_permissions';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
@@ -86348,6 +86487,15 @@ export type Routes = {
                         created_at?: string | undefined;
                         /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                         error_code: 'dormakaba_oracode_no_valid_user_level';
+                    } | {
+                        /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        /** Indicates that this is an access code error. */
+                        is_access_code_error: true;
+                        /** Date and time at which Seam created the error. */
+                        created_at?: string | undefined;
+                        /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                        error_code: 'kwikset_insufficient_permissions';
                     } | {
                         /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                         message: string;

package/package.json

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -122,6 +122,16 @@ const kwikset_unable_to_confirm_deletion = common_access_code_error
     'Unable to confirm the deletion of the access code on Kwikset device.',
   )
 
+const kwikset_insufficient_permissions = common_access_code_error
+  .extend({
+    error_code: z
+      .literal('kwikset_insufficient_permissions')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+  )
+
 const igloohome_offline_access_code_no_variance_available =
   common_access_code_error
     .extend({
@@ -254,6 +264,7 @@ const access_code_error = z
     wyze_duplicate_code_name,
     wyze_potential_duplicate_code,
     dormakaba_oracode_no_valid_user_level,
+    kwikset_insufficient_permissions,
   ])
   .describe(
     'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
@@ -292,6 +303,9 @@ const _access_code_error_map = z.object({
   kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion
     .optional()
     .nullable(),
+  kwikset_insufficient_permissions: kwikset_insufficient_permissions
+    .optional()
+    .nullable(),
   code_modified_external_to_seam_error: code_modified_external_to_seam_error
     .optional()
     .nullable(),

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

@@ -807,6 +807,37 @@ export default {
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['kwikset_insufficient_permissions'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'is_access_code_error', 'error_code'],
+                  type: 'object',
+                },
                 {
                   description: 'Indicates that the account is disconnected.',
                   properties: {
@@ -21663,6 +21694,37 @@ export default {
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['kwikset_insufficient_permissions'],
+                      type: 'string',
+                    },
+                    is_access_code_error: {
+                      description:
+                        'Indicates that this is an access code error.',
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'is_access_code_error', 'error_code'],
+                  type: 'object',
+                },
                 {
                   description: 'Indicates that the account is disconnected.',
                   properties: {
@@ -49837,6 +49899,179 @@ export default {
         'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
+    '/seam/customer/v1/reservations/get': {
+      get: {
+        description:
+          'Returns a single reservation for a specific customer by reservation ID.',
+        operationId: 'seamCustomerV1ReservationsGetGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'reservation_id',
+            schema: {
+              description: 'ID of the reservation to retrieve.',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'reservation_key',
+            schema: {
+              description: 'Key of the reservation to retrieve.',
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    reservation: {
+                      properties: {
+                        access_methods: {
+                          items: { $ref: '#/components/schemas/access_method' },
+                          type: 'array',
+                        },
+                        created_at: { format: 'date-time', type: 'string' },
+                        ends_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        guest_name: { nullable: true, type: 'string' },
+                        name: { nullable: true, type: 'string' },
+                        reservation_id: { format: 'uuid', type: 'string' },
+                        reservation_key: { type: 'string' },
+                        starts_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                      },
+                      required: [
+                        'reservation_id',
+                        'reservation_key',
+                        'name',
+                        'starts_at',
+                        'ends_at',
+                        'created_at',
+                        'guest_name',
+                        'access_methods',
+                      ],
+                      type: 'object',
+                    },
+                  },
+                  required: ['reservation', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/reservations/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'reservation',
+        'x-response-key': 'reservation',
+        'x-title': 'Get Reservation for Customer',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+      post: {
+        description:
+          'Returns a single reservation for a specific customer by reservation ID.',
+        operationId: 'seamCustomerV1ReservationsGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  reservation_id: {
+                    description: 'ID of the reservation to retrieve.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  reservation_key: {
+                    description: 'Key of the reservation to retrieve.',
+                    type: 'string',
+                  },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    reservation: {
+                      properties: {
+                        access_methods: {
+                          items: { $ref: '#/components/schemas/access_method' },
+                          type: 'array',
+                        },
+                        created_at: { format: 'date-time', type: 'string' },
+                        ends_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        guest_name: { nullable: true, type: 'string' },
+                        name: { nullable: true, type: 'string' },
+                        reservation_id: { format: 'uuid', type: 'string' },
+                        reservation_key: { type: 'string' },
+                        starts_at: {
+                          format: 'date-time',
+                          nullable: true,
+                          type: 'string',
+                        },
+                      },
+                      required: [
+                        'reservation_id',
+                        'reservation_key',
+                        'name',
+                        'starts_at',
+                        'ends_at',
+                        'created_at',
+                        'guest_name',
+                        'access_methods',
+                      ],
+                      type: 'object',
+                    },
+                  },
+                  required: ['reservation', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/reservations/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'reservation',
+        'x-response-key': 'reservation',
+        'x-title': 'Get Reservation for Customer',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+    },
     '/seam/customer/v1/reservations/list': {
       get: {
         description:
@@ -49851,6 +50086,15 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'space_id',
+            schema: {
+              description: 'Filter reservations by space ID (UUID).',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
           {
             in: 'query',
             name: 'limit',
@@ -49980,6 +50224,11 @@ export default {
                     nullable: true,
                     type: 'string',
                   },
+                  space_id: {
+                    description: 'Filter reservations by space ID (UUID).',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   space_key: {
                     description: 'Filter reservations by space key.',
                     type: 'string',