@seamapi/types 1.1117.0 → 1.1119.0

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

@@ -91309,7 +91309,11 @@ export type Routes = {
                         method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
                         card_count_on_reservation_create?: number | undefined;
                         instant_key_max_use_count?: number | undefined;
+                        /**
+                         * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                         prefer_guest_phone_last4_as_code?: boolean | undefined;
+                        /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                        prefer_guest_phone_last_digits_as_code?: boolean | undefined;
                         allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
                         access_starts_minutes_before_reservation?: number | undefined;
                         access_ends_minutes_after_reservation?: number | undefined;
@@ -91435,7 +91439,11 @@ export type Routes = {
                         method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
                         card_count_on_reservation_create?: number | undefined;
                         instant_key_max_use_count?: number | undefined;
+                        /**
+                         * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                         prefer_guest_phone_last4_as_code?: boolean | undefined;
+                        /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                        prefer_guest_phone_last_digits_as_code?: boolean | undefined;
                         allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
                         access_starts_minutes_before_reservation?: number | undefined;
                         access_ends_minutes_after_reservation?: number | undefined;
@@ -91889,7 +91897,11 @@ export type Routes = {
                             method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
                             card_count_on_reservation_create?: number | undefined;
                             instant_key_max_use_count?: number | undefined;
+                            /**
+                             * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                             prefer_guest_phone_last4_as_code?: boolean | undefined;
+                            /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                            prefer_guest_phone_last_digits_as_code?: boolean | undefined;
                             allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
                             access_starts_minutes_before_reservation?: number | undefined;
                             access_ends_minutes_after_reservation?: number | undefined;
@@ -92014,7 +92026,11 @@ export type Routes = {
                         method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
                         card_count_on_reservation_create?: number | undefined;
                         instant_key_max_use_count?: number | undefined;
+                        /**
+                         * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                         prefer_guest_phone_last4_as_code?: boolean | undefined;
+                        /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                        prefer_guest_phone_last_digits_as_code?: boolean | undefined;
                         allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
                         access_starts_minutes_before_reservation?: number | undefined;
                         access_ends_minutes_after_reservation?: number | undefined;
@@ -97286,25 +97302,6 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
-    '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
-        route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result';
-        method: 'POST';
-        queryParams: {};
-        jsonBody: {
-            acs_credential_id: string;
-            unlock_attempted_at: string;
-        };
-        commonParams: {};
-        formData: {};
-        jsonResponse: {
-            unlock_result: {
-                status: 'granted' | 'denied' | 'pending' | 'failed';
-                acs_entrance_id?: string | undefined;
-                occurred_at?: string | undefined;
-            };
-        };
-        maxDuration: undefined;
-    };
     '/seam/mobile_sdk/v1/acs/credentials/list': {
         route: '/seam/mobile_sdk/v1/acs/credentials/list';
         method: 'GET' | 'POST';

package/package.json

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

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

@@ -63095,6 +63095,14 @@ const openapi: OpenAPISpec = {
                                   type: 'string',
                                 },
                                 prefer_guest_phone_last4_as_code: {
+                                  deprecated: true,
+                                  type: 'boolean',
+                                  'x-deprecated':
+                                    'Use `prefer_guest_phone_last_digits_as_code`.',
+                                },
+                                prefer_guest_phone_last_digits_as_code: {
+                                  description:
+                                    "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
                                   type: 'boolean',
                                 },
                               },
@@ -63486,6 +63494,14 @@ const openapi: OpenAPISpec = {
                                 type: 'string',
                               },
                               prefer_guest_phone_last4_as_code: {
+                                deprecated: true,
+                                type: 'boolean',
+                                'x-deprecated':
+                                  'Use `prefer_guest_phone_last_digits_as_code`.',
+                              },
+                              prefer_guest_phone_last_digits_as_code: {
+                                description:
+                                  "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
                                 type: 'boolean',
                               },
                             },
@@ -64933,6 +64949,14 @@ const openapi: OpenAPISpec = {
                                       type: 'string',
                                     },
                                     prefer_guest_phone_last4_as_code: {
+                                      deprecated: true,
+                                      type: 'boolean',
+                                      'x-deprecated':
+                                        'Use `prefer_guest_phone_last_digits_as_code`.',
+                                    },
+                                    prefer_guest_phone_last_digits_as_code: {
+                                      description:
+                                        "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
                                       type: 'boolean',
                                     },
                                   },
@@ -65341,6 +65365,14 @@ const openapi: OpenAPISpec = {
                                 type: 'string',
                               },
                               prefer_guest_phone_last4_as_code: {
+                                deprecated: true,
+                                type: 'boolean',
+                                'x-deprecated':
+                                  'Use `prefer_guest_phone_last_digits_as_code`.',
+                              },
+                              prefer_guest_phone_last_digits_as_code: {
+                                description:
+                                  "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
                                 type: 'boolean',
                               },
                             },
@@ -69400,72 +69432,6 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Seam support agent only.',
       },
     },
-    '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
-      post: {
-        description:
-          "Returns the lock's decision for a mobile key unlock attempt, read from the access system's event feed. Returns `pending` until the access system reports the attempt, and `failed` if it hasn't within 30 seconds of the attempt.",
-        operationId: 'seamMobileSdkV1AcsCredentialsGetUnlockResultPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  acs_credential_id: { format: 'uuid', type: 'string' },
-                  unlock_attempted_at: { format: 'date-time', type: 'string' },
-                },
-                required: ['acs_credential_id', 'unlock_attempted_at'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          '200': {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    ok: { type: 'boolean' },
-                    unlock_result: {
-                      properties: {
-                        acs_entrance_id: { format: 'uuid', type: 'string' },
-                        occurred_at: { format: 'date-time', type: 'string' },
-                        status: {
-                          enum: ['granted', 'denied', 'pending', 'failed'],
-                          type: 'string',
-                        },
-                      },
-                      required: ['status'],
-                      type: 'object',
-                    },
-                  },
-                  required: ['unlock_result', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          '400': { description: 'Bad Request' },
-          '401': { description: 'Unauthorized' },
-        },
-        security: [{ client_session: [] }],
-        summary: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result',
-        tags: ['/acs'],
-        'x-fern-sdk-group-name': [
-          'seam',
-          'mobile_sdk',
-          'v1',
-          'acs',
-          'credentials',
-        ],
-        'x-fern-sdk-method-name': 'get_unlock_result',
-        'x-fern-sdk-return-value': 'unlock_result',
-        'x-response-key': 'unlock_result',
-        'x-title': 'Get Unlock Result',
-        'x-undocumented': 'Mobile SDK only.',
-      },
-    },
     '/seam/mobile_sdk/v1/acs/credentials/list': {
       get: {
         description:

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

@@ -109032,7 +109032,11 @@ export type Routes = {
                       | 'all_available'
                     card_count_on_reservation_create?: number | undefined
                     instant_key_max_use_count?: number | undefined
+                    /**
+                     * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                     prefer_guest_phone_last4_as_code?: boolean | undefined
+                    /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                    prefer_guest_phone_last_digits_as_code?: boolean | undefined
                     allow_shared_email_and_phone_across_user_identities?:
                       boolean | undefined
                     access_starts_minutes_before_reservation?:
@@ -109205,7 +109209,11 @@ export type Routes = {
                       | 'all_available'
                     card_count_on_reservation_create?: number | undefined
                     instant_key_max_use_count?: number | undefined
+                    /**
+                     * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                     prefer_guest_phone_last4_as_code?: boolean | undefined
+                    /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                    prefer_guest_phone_last_digits_as_code?: boolean | undefined
                     allow_shared_email_and_phone_across_user_identities?:
                       boolean | undefined
                     access_starts_minutes_before_reservation?:
@@ -109736,7 +109744,12 @@ export type Routes = {
                         | 'all_available'
                       card_count_on_reservation_create?: number | undefined
                       instant_key_max_use_count?: number | undefined
+                      /**
+                       * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                       prefer_guest_phone_last4_as_code?: boolean | undefined
+                      /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                      prefer_guest_phone_last_digits_as_code?:
+                        boolean | undefined
                       allow_shared_email_and_phone_across_user_identities?:
                         boolean | undefined
                       access_starts_minutes_before_reservation?:
@@ -109909,7 +109922,11 @@ export type Routes = {
                       | 'all_available'
                     card_count_on_reservation_create?: number | undefined
                     instant_key_max_use_count?: number | undefined
+                    /**
+                     * @deprecated Use `prefer_guest_phone_last_digits_as_code`.*/
                     prefer_guest_phone_last4_as_code?: boolean | undefined
+                    /** Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code. */
+                    prefer_guest_phone_last_digits_as_code?: boolean | undefined
                     allow_shared_email_and_phone_across_user_identities?:
                       boolean | undefined
                     access_starts_minutes_before_reservation?:
@@ -116096,25 +116113,6 @@ export type Routes = {
     }
     maxDuration: undefined
   }
-  '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result': {
-    route: '/seam/mobile_sdk/v1/acs/credentials/get_unlock_result'
-    method: 'POST'
-    queryParams: {}
-    jsonBody: {
-      acs_credential_id: string
-      unlock_attempted_at: string
-    }
-    commonParams: {}
-    formData: {}
-    jsonResponse: {
-      unlock_result: {
-        status: 'granted' | 'denied' | 'pending' | 'failed'
-        acs_entrance_id?: string | undefined
-        occurred_at?: string | undefined
-      }
-    }
-    maxDuration: undefined
-  }
   '/seam/mobile_sdk/v1/acs/credentials/list': {
     route: '/seam/mobile_sdk/v1/acs/credentials/list'
     method: 'GET' | 'POST'