@seamapi/types 1.750.0 → 1.751.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.750.0",
3
+ "version": "1.751.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -37,6 +37,12 @@ export const acs_entrance_capability_flags = z.object({
37
37
  .describe(
38
38
  'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
39
39
  ),
40
+ can_unlock_with_cloud_key: z
41
+ .boolean()
42
+ .optional()
43
+ .describe(
44
+ 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
45
+ ),
40
46
  })
41
47
 
42
48
  export const acs_entrance = z
@@ -3874,6 +3874,11 @@ export default {
3874
3874
  'Indicates whether the ACS entrance can be unlocked with card credentials.',
3875
3875
  type: 'boolean',
3876
3876
  },
3877
+ can_unlock_with_cloud_key: {
3878
+ description:
3879
+ 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
3880
+ type: 'boolean',
3881
+ },
3877
3882
  can_unlock_with_code: {
3878
3883
  description:
3879
3884
  'Indicates whether the ACS entrance can be unlocked with pin codes.',
@@ -24094,6 +24099,11 @@ export default {
24094
24099
  'Indicates whether the ACS entrance can be unlocked with card credentials.',
24095
24100
  type: 'boolean',
24096
24101
  },
24102
+ can_unlock_with_cloud_key: {
24103
+ description:
24104
+ 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
24105
+ type: 'boolean',
24106
+ },
24097
24107
  can_unlock_with_code: {
24098
24108
  description:
24099
24109
  'Indicates whether the ACS entrance can be unlocked with pin codes.',
@@ -44201,6 +44211,70 @@ export default {
44201
44211
  'x-title': 'List Credentials with Access to an Entrance',
44202
44212
  },
44203
44213
  },
44214
+ '/acs/entrances/unlock': {
44215
+ post: {
44216
+ description:
44217
+ 'Remotely unlocks a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.',
44218
+ operationId: 'acsEntrancesUnlockPost',
44219
+ requestBody: {
44220
+ content: {
44221
+ 'application/json': {
44222
+ schema: {
44223
+ properties: {
44224
+ acs_credential_id: {
44225
+ description:
44226
+ 'ID of the cloud_key credential to use for the unlock operation.',
44227
+ format: 'uuid',
44228
+ type: 'string',
44229
+ },
44230
+ acs_entrance_id: {
44231
+ description: 'ID of the entrance to unlock.',
44232
+ format: 'uuid',
44233
+ type: 'string',
44234
+ },
44235
+ },
44236
+ required: ['acs_entrance_id', 'acs_credential_id'],
44237
+ type: 'object',
44238
+ },
44239
+ },
44240
+ },
44241
+ },
44242
+ responses: {
44243
+ 200: {
44244
+ content: {
44245
+ 'application/json': {
44246
+ schema: {
44247
+ properties: {
44248
+ action_attempt: {
44249
+ $ref: '#/components/schemas/action_attempt',
44250
+ },
44251
+ ok: { type: 'boolean' },
44252
+ },
44253
+ required: ['action_attempt', 'ok'],
44254
+ type: 'object',
44255
+ },
44256
+ },
44257
+ },
44258
+ description: 'OK',
44259
+ },
44260
+ 400: { description: 'Bad Request' },
44261
+ 401: { description: 'Unauthorized' },
44262
+ },
44263
+ security: [
44264
+ { pat_with_workspace: [] },
44265
+ { console_session_with_workspace: [] },
44266
+ { api_key: [] },
44267
+ ],
44268
+ summary: '/acs/entrances/unlock',
44269
+ tags: ['/acs'],
44270
+ 'x-action-attempt-type': 'UNLOCK_DOOR',
44271
+ 'x-fern-sdk-group-name': ['acs', 'entrances'],
44272
+ 'x-fern-sdk-method-name': 'unlock',
44273
+ 'x-fern-sdk-return-value': 'action_attempt',
44274
+ 'x-response-key': 'action_attempt',
44275
+ 'x-title': 'Unlock an Entrance',
44276
+ },
44277
+ },
44204
44278
  '/acs/systems/get': {
44205
44279
  get: {
44206
44280
  description: