@seamapi/types 1.768.1 → 1.770.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 (35) hide show
  1. package/dist/connect.cjs +159 -35
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +834 -90
  4. package/dist/index.cjs +159 -35
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.d.ts +10 -10
  7. package/lib/seam/connect/models/access-grants/access-method.d.ts +6 -6
  8. package/lib/seam/connect/models/access-grants/access-method.js +2 -2
  9. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  10. package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
  11. package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
  12. package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
  13. package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -6
  14. package/lib/seam/connect/models/acs/acs-entrance.js +4 -4
  15. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  16. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +60 -0
  17. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +30 -0
  18. package/lib/seam/connect/models/action-attempts/encode-credential.js +22 -0
  19. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -1
  20. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +30 -0
  21. package/lib/seam/connect/models/action-attempts/scan-credential.js +22 -0
  22. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -1
  23. package/lib/seam/connect/models/batch.d.ts +101 -17
  24. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -16
  25. package/lib/seam/connect/openapi.js +110 -26
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +662 -62
  28. package/package.json +1 -1
  29. package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -2
  30. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +2 -2
  31. package/src/lib/seam/connect/models/acs/acs-entrance.ts +4 -4
  32. package/src/lib/seam/connect/models/action-attempts/encode-credential.ts +34 -0
  33. package/src/lib/seam/connect/models/action-attempts/scan-credential.ts +34 -0
  34. package/src/lib/seam/connect/openapi.ts +122 -26
  35. package/src/lib/seam/connect/route-types.ts +782 -62
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.768.1",
3
+ "version": "1.770.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/access-grants/access-method.ts CHANGED
@@ -220,9 +220,9 @@ export const access_method = z.object({
220
220
  access_method_id: z.string().uuid().describe('ID of the access method.'),
221
221
  display_name: z.string().describe('Display name of the access method.'),
222
222
  mode: z
223
- .enum(['code', 'card', 'mobile_key'])
223
+ .enum(['code', 'card', 'mobile_key', 'cloud_key'])
224
224
  .describe(
225
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
225
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
226
226
  ),
227
227
  created_at: z
228
228
  .string()
package/src/lib/seam/connect/models/access-grants/requested-access-method.ts CHANGED
@@ -3,9 +3,9 @@ import { z } from 'zod'
3
3
  export const requested_access_method = z.object({
4
4
  display_name: z.string().describe('Display name of the access method.'),
5
5
  mode: z
6
- .enum(['code', 'card', 'mobile_key'])
6
+ .enum(['code', 'card', 'mobile_key', 'cloud_key'])
7
7
  .describe(
8
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
8
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
9
9
  ),
10
10
  code: z
11
11
  .string()
package/src/lib/seam/connect/models/acs/acs-entrance.ts CHANGED
@@ -31,17 +31,17 @@ export const acs_entrance_capability_flags = z.object({
31
31
  .describe(
32
32
  'Indicates whether the ACS entrance can be unlocked with pin codes.',
33
33
  ),
34
- can_belong_to_reservation: z
34
+ can_unlock_with_cloud_key: z
35
35
  .boolean()
36
36
  .optional()
37
37
  .describe(
38
- 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
38
+ 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
39
39
  ),
40
- can_unlock_with_cloud_key: z
40
+ can_belong_to_reservation: z
41
41
  .boolean()
42
42
  .optional()
43
43
  .describe(
44
- 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
44
+ 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
45
45
  ),
46
46
  })
47
47
 
package/src/lib/seam/connect/models/action-attempts/encode-credential.ts CHANGED
@@ -75,12 +75,46 @@ const encoder_not_online_error = z
75
75
  })
76
76
  .describe('Error to indicate that the encoder is not online.')
77
77
 
78
+ const encoder_timeout_error = z
79
+ .object({
80
+ type: z
81
+ .literal('encoder_timeout_error')
82
+ .describe(
83
+ 'Error type to indicate that communication with the encoder timed out.',
84
+ ),
85
+ message: z
86
+ .string()
87
+ .describe(
88
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
89
+ ),
90
+ })
91
+ .describe('Error to indicate that communication with the encoder timed out.')
92
+
93
+ const bridge_disconnected_error = z
94
+ .object({
95
+ type: z
96
+ .literal('bridge_disconnected')
97
+ .describe(
98
+ 'Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
99
+ ),
100
+ message: z
101
+ .string()
102
+ .describe(
103
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
104
+ ),
105
+ })
106
+ .describe(
107
+ 'Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
108
+ )
109
+
78
110
  const error = z.union([
79
111
  ...common_action_attempt_errors,
80
112
  no_credential_on_encoder_error,
81
113
  incompatible_card_format_error,
82
114
  credential_cannot_be_reissued,
83
115
  encoder_not_online_error,
116
+ encoder_timeout_error,
117
+ bridge_disconnected_error,
84
118
  ])
85
119
 
86
120
  const result = acs_credential
package/src/lib/seam/connect/models/action-attempts/scan-credential.ts CHANGED
@@ -44,10 +44,44 @@ const encoder_not_online_error = z
44
44
  })
45
45
  .describe('Error to indicate that the encoder is not online.')
46
46
 
47
+ const encoder_timeout_error = z
48
+ .object({
49
+ type: z
50
+ .literal('encoder_timeout_error')
51
+ .describe(
52
+ 'Error type to indicate that communication with the encoder timed out.',
53
+ ),
54
+ message: z
55
+ .string()
56
+ .describe(
57
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
58
+ ),
59
+ })
60
+ .describe('Error to indicate that communication with the encoder timed out.')
61
+
62
+ const bridge_disconnected_error = z
63
+ .object({
64
+ type: z
65
+ .literal('bridge_disconnected')
66
+ .describe(
67
+ 'Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
68
+ ),
69
+ message: z
70
+ .string()
71
+ .describe(
72
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
73
+ ),
74
+ })
75
+ .describe(
76
+ 'Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
77
+ )
78
+
47
79
  const error = z.union([
48
80
  ...common_action_attempt_errors,
49
81
  no_credential_on_encoder_error,
50
82
  encoder_not_online_error,
83
+ encoder_timeout_error,
84
+ bridge_disconnected_error,
51
85
  ])
52
86
 
53
87
  const warning = z
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -2099,8 +2099,8 @@ export default {
2099
2099
  },
2100
2100
  mode: {
2101
2101
  description:
2102
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
2103
- enum: ['code', 'card', 'mobile_key'],
2102
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
2103
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
2104
2104
  type: 'string',
2105
2105
  },
2106
2106
  },
@@ -2432,8 +2432,8 @@ export default {
2432
2432
  },
2433
2433
  mode: {
2434
2434
  description:
2435
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
2436
- enum: ['code', 'card', 'mobile_key'],
2435
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
2436
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
2437
2437
  type: 'string',
2438
2438
  },
2439
2439
  pending_mutations: {
@@ -3906,7 +3906,7 @@ export default {
3906
3906
  },
3907
3907
  can_unlock_with_cloud_key: {
3908
3908
  description:
3909
- 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
3909
+ 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
3910
3910
  type: 'boolean',
3911
3911
  },
3912
3912
  can_unlock_with_code: {
@@ -6892,6 +6892,44 @@ export default {
6892
6892
  required: ['type', 'message'],
6893
6893
  type: 'object',
6894
6894
  },
6895
+ {
6896
+ description:
6897
+ 'Error to indicate that communication with the encoder timed out.',
6898
+ properties: {
6899
+ message: {
6900
+ description:
6901
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
6902
+ type: 'string',
6903
+ },
6904
+ type: {
6905
+ description:
6906
+ 'Error type to indicate that communication with the encoder timed out.',
6907
+ enum: ['encoder_timeout_error'],
6908
+ type: 'string',
6909
+ },
6910
+ },
6911
+ required: ['type', 'message'],
6912
+ type: 'object',
6913
+ },
6914
+ {
6915
+ description:
6916
+ 'Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
6917
+ properties: {
6918
+ message: {
6919
+ description:
6920
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
6921
+ type: 'string',
6922
+ },
6923
+ type: {
6924
+ description:
6925
+ 'Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
6926
+ enum: ['bridge_disconnected'],
6927
+ type: 'string',
6928
+ },
6929
+ },
6930
+ required: ['type', 'message'],
6931
+ type: 'object',
6932
+ },
6895
6933
  ],
6896
6934
  },
6897
6935
  result: {
@@ -8022,6 +8060,44 @@ export default {
8022
8060
  required: ['type', 'message'],
8023
8061
  type: 'object',
8024
8062
  },
8063
+ {
8064
+ description:
8065
+ 'Error to indicate that communication with the encoder timed out.',
8066
+ properties: {
8067
+ message: {
8068
+ description:
8069
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
8070
+ type: 'string',
8071
+ },
8072
+ type: {
8073
+ description:
8074
+ 'Error type to indicate that communication with the encoder timed out.',
8075
+ enum: ['encoder_timeout_error'],
8076
+ type: 'string',
8077
+ },
8078
+ },
8079
+ required: ['type', 'message'],
8080
+ type: 'object',
8081
+ },
8082
+ {
8083
+ description:
8084
+ 'Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
8085
+ properties: {
8086
+ message: {
8087
+ description:
8088
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
8089
+ type: 'string',
8090
+ },
8091
+ type: {
8092
+ description:
8093
+ 'Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system.',
8094
+ enum: ['bridge_disconnected'],
8095
+ type: 'string',
8096
+ },
8097
+ },
8098
+ required: ['type', 'message'],
8099
+ type: 'object',
8100
+ },
8025
8101
  ],
8026
8102
  },
8027
8103
  result: {
@@ -24291,7 +24367,7 @@ export default {
24291
24367
  },
24292
24368
  can_unlock_with_cloud_key: {
24293
24369
  description:
24294
- 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
24370
+ 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.',
24295
24371
  type: 'boolean',
24296
24372
  },
24297
24373
  can_unlock_with_code: {
@@ -34143,8 +34219,8 @@ export default {
34143
34219
  },
34144
34220
  mode: {
34145
34221
  description:
34146
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
34147
- enum: ['code', 'card', 'mobile_key'],
34222
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
34223
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
34148
34224
  type: 'string',
34149
34225
  },
34150
34226
  },
@@ -35019,8 +35095,8 @@ export default {
35019
35095
  },
35020
35096
  mode: {
35021
35097
  description:
35022
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35023
- enum: ['code', 'card', 'mobile_key'],
35098
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
35099
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
35024
35100
  type: 'string',
35025
35101
  },
35026
35102
  },
@@ -35377,8 +35453,13 @@ export default {
35377
35453
  },
35378
35454
  mode: {
35379
35455
  description:
35380
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35381
- enum: ['code', 'card', 'mobile_key'],
35456
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
35457
+ enum: [
35458
+ 'code',
35459
+ 'card',
35460
+ 'mobile_key',
35461
+ 'cloud_key',
35462
+ ],
35382
35463
  type: 'string',
35383
35464
  },
35384
35465
  },
@@ -35998,8 +36079,13 @@ export default {
35998
36079
  },
35999
36080
  mode: {
36000
36081
  description:
36001
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
36002
- enum: ['code', 'card', 'mobile_key'],
36082
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
36083
+ enum: [
36084
+ 'code',
36085
+ 'card',
36086
+ 'mobile_key',
36087
+ 'cloud_key',
36088
+ ],
36003
36089
  type: 'string',
36004
36090
  },
36005
36091
  },
@@ -36667,8 +36753,13 @@ export default {
36667
36753
  },
36668
36754
  mode: {
36669
36755
  description:
36670
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
36671
- enum: ['code', 'card', 'mobile_key'],
36756
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
36757
+ enum: [
36758
+ 'code',
36759
+ 'card',
36760
+ 'mobile_key',
36761
+ 'cloud_key',
36762
+ ],
36672
36763
  type: 'string',
36673
36764
  },
36674
36765
  },
@@ -37324,8 +37415,13 @@ export default {
37324
37415
  },
37325
37416
  mode: {
37326
37417
  description:
37327
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
37328
- enum: ['code', 'card', 'mobile_key'],
37418
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
37419
+ enum: [
37420
+ 'code',
37421
+ 'card',
37422
+ 'mobile_key',
37423
+ 'cloud_key',
37424
+ ],
37329
37425
  type: 'string',
37330
37426
  },
37331
37427
  },
@@ -38723,8 +38819,8 @@ export default {
38723
38819
  },
38724
38820
  mode: {
38725
38821
  description:
38726
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38727
- enum: ['code', 'card', 'mobile_key'],
38822
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
38823
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
38728
38824
  type: 'string',
38729
38825
  },
38730
38826
  pending_mutations: {
@@ -39168,8 +39264,8 @@ export default {
39168
39264
  },
39169
39265
  mode: {
39170
39266
  description:
39171
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
39172
- enum: ['code', 'card', 'mobile_key'],
39267
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
39268
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
39173
39269
  type: 'string',
39174
39270
  },
39175
39271
  pending_mutations: {
@@ -39645,8 +39741,8 @@ export default {
39645
39741
  },
39646
39742
  mode: {
39647
39743
  description:
39648
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
39649
- enum: ['code', 'card', 'mobile_key'],
39744
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
39745
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
39650
39746
  type: 'string',
39651
39747
  },
39652
39748
  pending_mutations: {
@@ -40114,8 +40210,8 @@ export default {
40114
40210
  },
40115
40211
  mode: {
40116
40212
  description:
40117
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
40118
- enum: ['code', 'card', 'mobile_key'],
40213
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
40214
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
40119
40215
  type: 'string',
40120
40216
  },
40121
40217
  pending_mutations: {