npm - @seamapi/types - Versions diffs - 1.1118.0 → 1.1120.0 - Mend

@seamapi/types 1.1118.0 → 1.1120.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/package.json CHANGED Viewed

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts CHANGED Viewed

@@ -154,7 +154,17 @@ const requested_code_unavailable = common_access_grant_warning
     device_id: z
       .string()
       .uuid()
-      .describe('ID of the device where the requested code was unavailable.'),
+      .optional()
+      .describe(
+        'ID of the device where the requested code was unavailable. Present when the code was set directly on a device.',
+      ),
+    access_method_id: z
+      .string()
+      .uuid()
+      .optional()
+      .describe(
+        'ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.',
+      ),
     original_code: z
       .string()
       .describe('The originally requested PIN code that was unavailable.'),
@@ -163,7 +173,7 @@ const requested_code_unavailable = common_access_grant_warning
       .describe('The new PIN code that was assigned instead.'),
   })
   .describe(
-    'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
+    'Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.',
   )
 const device_does_not_support_access_codes = common_access_grant_warning
@@ -228,6 +238,10 @@ const _access_grant_warning_map = z.object({
     .record(z.string().uuid(), requested_code_unavailable)
     .optional()
     .nullable(),
+  requested_code_unavailable_by_access_method: z
+    .record(z.string().uuid(), requested_code_unavailable)
+    .optional()
+    .nullable(),
   device_does_not_support_access_codes: z
     .record(z.string().uuid(), device_does_not_support_access_codes)
     .optional()

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

@@ -81,6 +81,20 @@ const user_identity_missing_phone_number_warning = common_access_method_warning
     "Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.",
   )
+const requested_code_unavailable_warning = common_access_method_warning
+  .extend({
+    warning_code: z
+      .literal('requested_code_unavailable')
+      .describe(warning_code_description),
+    original_code: z
+      .string()
+      .describe('The originally requested PIN code that could not be used.'),
+    new_code: z.string().describe('The PIN code that was assigned instead.'),
+  })
+  .describe(
+    "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
+  )
 const access_method_warning = z
   .discriminatedUnion('warning_code', [
     being_deleted,
@@ -89,6 +103,7 @@ const access_method_warning = z
     delay_in_issuing_warning,
     user_identity_missing_email_address_warning,
     user_identity_missing_phone_number_warning,
+    requested_code_unavailable_warning,
   ])
   .describe(
     'Warning associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
@@ -106,6 +121,9 @@ const _access_method_warning_map = z.object({
   user_identity_missing_phone_number: user_identity_missing_phone_number_warning
     .optional()
     .nullable(),
+  requested_code_unavailable: requested_code_unavailable_warning
+    .optional()
+    .nullable(),
 })
 export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>

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

@@ -2287,8 +2287,14 @@ const openapi: OpenAPISpec = {
                 },
                 {
                   description:
-                    'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
+                    'Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.',
                   properties: {
+                    access_method_id: {
+                      description:
+                        'ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the warning.',
@@ -2297,7 +2303,7 @@ const openapi: OpenAPISpec = {
                     },
                     device_id: {
                       description:
-                        'ID of the device where the requested code was unavailable.',
+                        'ID of the device where the requested code was unavailable. Present when the code was set directly on a device.',
                       format: 'uuid',
                       type: 'string',
                     },
@@ -2327,7 +2333,6 @@ const openapi: OpenAPISpec = {
                     'created_at',
                     'message',
                     'warning_code',
-                    'device_id',
                     'original_code',
                     'new_code',
                   ],
@@ -2973,6 +2978,46 @@ const openapi: OpenAPISpec = {
                   required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    new_code: {
+                      description: 'The PIN code that was assigned instead.',
+                      type: 'string',
+                    },
+                    original_code: {
+                      description:
+                        'The originally requested PIN code that could not be used.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['requested_code_unavailable'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'warning_code',
+                    'original_code',
+                    'new_code',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -10507,6 +10552,47 @@ const openapi: OpenAPISpec = {
                           required: ['created_at', 'message', 'warning_code'],
                           type: 'object',
                         },
+                        {
+                          description:
+                            "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
+                          properties: {
+                            created_at: {
+                              description:
+                                'Date and time at which Seam created the warning.',
+                              format: 'date-time',
+                              type: 'string',
+                            },
+                            message: {
+                              description:
+                                'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                              type: 'string',
+                            },
+                            new_code: {
+                              description:
+                                'The PIN code that was assigned instead.',
+                              type: 'string',
+                            },
+                            original_code: {
+                              description:
+                                'The originally requested PIN code that could not be used.',
+                              type: 'string',
+                            },
+                            warning_code: {
+                              description:
+                                'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                              enum: ['requested_code_unavailable'],
+                              type: 'string',
+                            },
+                          },
+                          required: [
+                            'created_at',
+                            'message',
+                            'warning_code',
+                            'original_code',
+                            'new_code',
+                          ],
+                          type: 'object',
+                        },
                       ],
                     },
                     type: 'array',
@@ -36880,8 +36966,14 @@ const openapi: OpenAPISpec = {
                 },
                 {
                   description:
-                    'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
+                    'Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.',
                   properties: {
+                    access_method_id: {
+                      description:
+                        'ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
                     created_at: {
                       description:
                         'Date and time at which Seam created the warning.',
@@ -36890,7 +36982,7 @@ const openapi: OpenAPISpec = {
                     },
                     device_id: {
                       description:
-                        'ID of the device where the requested code was unavailable.',
+                        'ID of the device where the requested code was unavailable. Present when the code was set directly on a device.',
                       format: 'uuid',
                       type: 'string',
                     },
@@ -36920,7 +37012,6 @@ const openapi: OpenAPISpec = {
                     'created_at',
                     'message',
                     'warning_code',
-                    'device_id',
                     'original_code',
                     'new_code',
                   ],
@@ -37547,6 +37638,46 @@ const openapi: OpenAPISpec = {
                   required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    new_code: {
+                      description: 'The PIN code that was assigned instead.',
+                      type: 'string',
+                    },
+                    original_code: {
+                      description:
+                        'The originally requested PIN code that could not be used.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['requested_code_unavailable'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'warning_code',
+                    'original_code',
+                    'new_code',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -63095,6 +63226,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 +63625,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 +65080,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 +65496,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',
                               },
                             },