@seamapi/types 1.1133.0 → 1.1135.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 (30) hide show
  1. package/lib/seam/connect/models/access-grants/access-method.d.ts +66 -0
  2. package/lib/seam/connect/models/access-grants/access-method.js +9 -0
  3. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  4. package/lib/seam/connect/models/acs/acs-credential.d.ts +66 -0
  5. package/lib/seam/connect/models/acs/acs-credential.js +9 -0
  6. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +190 -0
  8. package/lib/seam/connect/models/action-attempts/assign-credential.d.ts +29 -0
  9. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +58 -0
  10. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +74 -0
  11. package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.d.ts +29 -0
  12. package/lib/seam/connect/models/devices/device-metadata.d.ts +23 -0
  13. package/lib/seam/connect/models/devices/device-metadata.js +8 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  16. package/lib/seam/connect/models/devices/device-type.js +1 -0
  17. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.d.ts +36 -3
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +26 -3
  20. package/lib/seam/connect/models/phones/phone-session.d.ts +66 -0
  21. package/lib/seam/connect/openapi.js +268 -0
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +2197 -170
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/access-grants/access-method.ts +12 -0
  26. package/src/lib/seam/connect/models/acs/acs-credential.ts +12 -0
  27. package/src/lib/seam/connect/models/devices/device-metadata.ts +9 -0
  28. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  29. package/src/lib/seam/connect/openapi.ts +312 -0
  30. package/src/lib/seam/connect/route-types.ts +2362 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1133.0",
3
+ "version": "1.1135.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -95,6 +95,16 @@ const requested_code_unavailable_warning = common_access_method_warning
95
95
  "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.",
96
96
  )
97
97
 
98
+ const schedule_rounded_up_warning = common_access_method_warning
99
+ .extend({
100
+ warning_code: z
101
+ .literal('schedule_rounded_up')
102
+ .describe(warning_code_description),
103
+ })
104
+ .describe(
105
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
106
+ )
107
+
98
108
  const access_method_warning = z
99
109
  .discriminatedUnion('warning_code', [
100
110
  being_deleted,
@@ -104,6 +114,7 @@ const access_method_warning = z
104
114
  user_identity_missing_email_address_warning,
105
115
  user_identity_missing_phone_number_warning,
106
116
  requested_code_unavailable_warning,
117
+ schedule_rounded_up_warning,
107
118
  ])
108
119
  .describe(
109
120
  'Warning associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
@@ -124,6 +135,7 @@ const _access_method_warning_map = z.object({
124
135
  requested_code_unavailable: requested_code_unavailable_warning
125
136
  .optional()
126
137
  .nullable(),
138
+ schedule_rounded_up: schedule_rounded_up_warning.optional().nullable(),
127
139
  })
128
140
 
129
141
  export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
@@ -121,6 +121,16 @@ const requested_code_unavailable = common_acs_credential_warning
121
121
  'Indicates that the requested PIN code could not be used, so the access system assigned a different code. Give the guest the assigned code.',
122
122
  )
123
123
 
124
+ const schedule_rounded_up = common_acs_credential_warning
125
+ .extend({
126
+ warning_code: z
127
+ .literal('schedule_rounded_up')
128
+ .describe(warning_code_description),
129
+ })
130
+ .describe(
131
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
132
+ )
133
+
124
134
  const acs_credential_warning = z
125
135
  .discriminatedUnion('warning_code', [
126
136
  waiting_to_be_issued,
@@ -130,6 +140,7 @@ const acs_credential_warning = z
130
140
  unknown_issue_with_acs_credential,
131
141
  needs_to_be_reissued,
132
142
  requested_code_unavailable,
143
+ schedule_rounded_up,
133
144
  ])
134
145
  .describe(
135
146
  'Warning associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
@@ -147,6 +158,7 @@ const _acs_credential_warning_map = z.object({
147
158
  .nullable(),
148
159
  needs_to_be_reissued: needs_to_be_reissued.optional().nullable(),
149
160
  requested_code_unavailable: requested_code_unavailable.optional().nullable(),
161
+ schedule_rounded_up: schedule_rounded_up.optional().nullable(),
150
162
  })
151
163
 
152
164
  export type AcsCredentialWarningMap = z.infer<
@@ -1323,6 +1323,15 @@ export const device_metadata = z
1323
1323
  .partial()
1324
1324
  .describe(`Metadata for an Aqara device.`),
1325
1325
 
1326
+ eufy_metadata: z
1327
+ .object({
1328
+ device_id: z.string().optional(),
1329
+ device_name: z.string().optional(),
1330
+ model: z.string().optional(),
1331
+ })
1332
+ .partial()
1333
+ .describe(`Metadata for a Eufy device.`),
1334
+
1326
1335
  sonos_metadata: z
1327
1336
  .object({
1328
1337
  household_id: z
@@ -32,6 +32,7 @@ export const LOCK_DEVICE_TYPE = {
32
32
  OMNITEC_LOCK: 'omnitec_lock',
33
33
  KISI_LOCK: 'kisi_lock',
34
34
  AQARA_LOCK: 'aqara_lock',
35
+ EUFY_LOCK: 'eufy_lock',
35
36
  } as const
36
37
 
37
38
  type LockDeviceTypeFromMapping =
@@ -3054,6 +3054,31 @@ const openapi: OpenAPISpec = {
3054
3054
  ],
3055
3055
  type: 'object',
3056
3056
  },
3057
+ {
3058
+ description:
3059
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
3060
+ properties: {
3061
+ created_at: {
3062
+ description:
3063
+ 'Date and time at which Seam created the warning.',
3064
+ format: 'date-time',
3065
+ type: 'string',
3066
+ },
3067
+ message: {
3068
+ description:
3069
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
3070
+ type: 'string',
3071
+ },
3072
+ warning_code: {
3073
+ description:
3074
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
3075
+ enum: ['schedule_rounded_up'],
3076
+ type: 'string',
3077
+ },
3078
+ },
3079
+ required: ['created_at', 'message', 'warning_code'],
3080
+ type: 'object',
3081
+ },
3057
3082
  ],
3058
3083
  },
3059
3084
  type: 'array',
@@ -4125,6 +4150,31 @@ const openapi: OpenAPISpec = {
4125
4150
  ],
4126
4151
  type: 'object',
4127
4152
  },
4153
+ {
4154
+ description:
4155
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
4156
+ properties: {
4157
+ created_at: {
4158
+ description:
4159
+ 'Date and time at which Seam created the warning.',
4160
+ format: 'date-time',
4161
+ type: 'string',
4162
+ },
4163
+ message: {
4164
+ description:
4165
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4166
+ type: 'string',
4167
+ },
4168
+ warning_code: {
4169
+ description:
4170
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4171
+ enum: ['schedule_rounded_up'],
4172
+ type: 'string',
4173
+ },
4174
+ },
4175
+ required: ['created_at', 'message', 'warning_code'],
4176
+ type: 'object',
4177
+ },
4128
4178
  ],
4129
4179
  },
4130
4180
  type: 'array',
@@ -7270,6 +7320,35 @@ const openapi: OpenAPISpec = {
7270
7320
  ],
7271
7321
  type: 'object',
7272
7322
  },
7323
+ {
7324
+ description:
7325
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
7326
+ properties: {
7327
+ created_at: {
7328
+ description:
7329
+ 'Date and time at which Seam created the warning.',
7330
+ format: 'date-time',
7331
+ type: 'string',
7332
+ },
7333
+ message: {
7334
+ description:
7335
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
7336
+ type: 'string',
7337
+ },
7338
+ warning_code: {
7339
+ description:
7340
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
7341
+ enum: ['schedule_rounded_up'],
7342
+ type: 'string',
7343
+ },
7344
+ },
7345
+ required: [
7346
+ 'created_at',
7347
+ 'message',
7348
+ 'warning_code',
7349
+ ],
7350
+ type: 'object',
7351
+ },
7273
7352
  ],
7274
7353
  },
7275
7354
  type: 'array',
@@ -7789,6 +7868,35 @@ const openapi: OpenAPISpec = {
7789
7868
  ],
7790
7869
  type: 'object',
7791
7870
  },
7871
+ {
7872
+ description:
7873
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
7874
+ properties: {
7875
+ created_at: {
7876
+ description:
7877
+ 'Date and time at which Seam created the warning.',
7878
+ format: 'date-time',
7879
+ type: 'string',
7880
+ },
7881
+ message: {
7882
+ description:
7883
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
7884
+ type: 'string',
7885
+ },
7886
+ warning_code: {
7887
+ description:
7888
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
7889
+ enum: ['schedule_rounded_up'],
7890
+ type: 'string',
7891
+ },
7892
+ },
7893
+ required: [
7894
+ 'created_at',
7895
+ 'message',
7896
+ 'warning_code',
7897
+ ],
7898
+ type: 'object',
7899
+ },
7792
7900
  ],
7793
7901
  },
7794
7902
  type: 'array',
@@ -8567,6 +8675,35 @@ const openapi: OpenAPISpec = {
8567
8675
  ],
8568
8676
  type: 'object',
8569
8677
  },
8678
+ {
8679
+ description:
8680
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
8681
+ properties: {
8682
+ created_at: {
8683
+ description:
8684
+ 'Date and time at which Seam created the warning.',
8685
+ format: 'date-time',
8686
+ type: 'string',
8687
+ },
8688
+ message: {
8689
+ description:
8690
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
8691
+ type: 'string',
8692
+ },
8693
+ warning_code: {
8694
+ description:
8695
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
8696
+ enum: ['schedule_rounded_up'],
8697
+ type: 'string',
8698
+ },
8699
+ },
8700
+ required: [
8701
+ 'created_at',
8702
+ 'message',
8703
+ 'warning_code',
8704
+ ],
8705
+ type: 'object',
8706
+ },
8570
8707
  ],
8571
8708
  },
8572
8709
  type: 'array',
@@ -9083,6 +9220,35 @@ const openapi: OpenAPISpec = {
9083
9220
  ],
9084
9221
  type: 'object',
9085
9222
  },
9223
+ {
9224
+ description:
9225
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
9226
+ properties: {
9227
+ created_at: {
9228
+ description:
9229
+ 'Date and time at which Seam created the warning.',
9230
+ format: 'date-time',
9231
+ type: 'string',
9232
+ },
9233
+ message: {
9234
+ description:
9235
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9236
+ type: 'string',
9237
+ },
9238
+ warning_code: {
9239
+ description:
9240
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9241
+ enum: ['schedule_rounded_up'],
9242
+ type: 'string',
9243
+ },
9244
+ },
9245
+ required: [
9246
+ 'created_at',
9247
+ 'message',
9248
+ 'warning_code',
9249
+ ],
9250
+ type: 'object',
9251
+ },
9086
9252
  ],
9087
9253
  },
9088
9254
  type: 'array',
@@ -9873,6 +10039,31 @@ const openapi: OpenAPISpec = {
9873
10039
  ],
9874
10040
  type: 'object',
9875
10041
  },
10042
+ {
10043
+ description:
10044
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
10045
+ properties: {
10046
+ created_at: {
10047
+ description:
10048
+ 'Date and time at which Seam created the warning.',
10049
+ format: 'date-time',
10050
+ type: 'string',
10051
+ },
10052
+ message: {
10053
+ description:
10054
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
10055
+ type: 'string',
10056
+ },
10057
+ warning_code: {
10058
+ description:
10059
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
10060
+ enum: ['schedule_rounded_up'],
10061
+ type: 'string',
10062
+ },
10063
+ },
10064
+ required: ['created_at', 'message', 'warning_code'],
10065
+ type: 'object',
10066
+ },
9876
10067
  ],
9877
10068
  },
9878
10069
  type: 'array',
@@ -10629,6 +10820,31 @@ const openapi: OpenAPISpec = {
10629
10820
  ],
10630
10821
  type: 'object',
10631
10822
  },
10823
+ {
10824
+ description:
10825
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
10826
+ properties: {
10827
+ created_at: {
10828
+ description:
10829
+ 'Date and time at which Seam created the warning.',
10830
+ format: 'date-time',
10831
+ type: 'string',
10832
+ },
10833
+ message: {
10834
+ description:
10835
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
10836
+ type: 'string',
10837
+ },
10838
+ warning_code: {
10839
+ description:
10840
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
10841
+ enum: ['schedule_rounded_up'],
10842
+ type: 'string',
10843
+ },
10844
+ },
10845
+ required: ['created_at', 'message', 'warning_code'],
10846
+ type: 'object',
10847
+ },
10632
10848
  ],
10633
10849
  },
10634
10850
  type: 'array',
@@ -15731,6 +15947,7 @@ const openapi: OpenAPISpec = {
15731
15947
  'omnitec_lock',
15732
15948
  'kisi_lock',
15733
15949
  'aqara_lock',
15950
+ 'eufy_lock',
15734
15951
  ],
15735
15952
  type: 'string',
15736
15953
  },
@@ -17042,6 +17259,15 @@ const openapi: OpenAPISpec = {
17042
17259
  },
17043
17260
  type: 'object',
17044
17261
  },
17262
+ eufy_metadata: {
17263
+ description: 'Metadata for a Eufy device.',
17264
+ properties: {
17265
+ device_id: { type: 'string' },
17266
+ device_name: { type: 'string' },
17267
+ model: { type: 'string' },
17268
+ },
17269
+ type: 'object',
17270
+ },
17045
17271
  four_suites_metadata: {
17046
17272
  description: 'Metadata for a 4SUITES device.',
17047
17273
  properties: {
@@ -34874,6 +35100,35 @@ const openapi: OpenAPISpec = {
34874
35100
  ],
34875
35101
  type: 'object',
34876
35102
  },
35103
+ {
35104
+ description:
35105
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
35106
+ properties: {
35107
+ created_at: {
35108
+ description:
35109
+ 'Date and time at which Seam created the warning.',
35110
+ format: 'date-time',
35111
+ type: 'string',
35112
+ },
35113
+ message: {
35114
+ description:
35115
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
35116
+ type: 'string',
35117
+ },
35118
+ warning_code: {
35119
+ description:
35120
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
35121
+ enum: ['schedule_rounded_up'],
35122
+ type: 'string',
35123
+ },
35124
+ },
35125
+ required: [
35126
+ 'created_at',
35127
+ 'message',
35128
+ 'warning_code',
35129
+ ],
35130
+ type: 'object',
35131
+ },
34877
35132
  ],
34878
35133
  },
34879
35134
  type: 'array',
@@ -38264,6 +38519,31 @@ const openapi: OpenAPISpec = {
38264
38519
  ],
38265
38520
  type: 'object',
38266
38521
  },
38522
+ {
38523
+ description:
38524
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
38525
+ properties: {
38526
+ created_at: {
38527
+ description:
38528
+ 'Date and time at which Seam created the warning.',
38529
+ format: 'date-time',
38530
+ type: 'string',
38531
+ },
38532
+ message: {
38533
+ description:
38534
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
38535
+ type: 'string',
38536
+ },
38537
+ warning_code: {
38538
+ description:
38539
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
38540
+ enum: ['schedule_rounded_up'],
38541
+ type: 'string',
38542
+ },
38543
+ },
38544
+ required: ['created_at', 'message', 'warning_code'],
38545
+ type: 'object',
38546
+ },
38267
38547
  ],
38268
38548
  },
38269
38549
  type: 'array',
@@ -39326,6 +39606,31 @@ const openapi: OpenAPISpec = {
39326
39606
  ],
39327
39607
  type: 'object',
39328
39608
  },
39609
+ {
39610
+ description:
39611
+ 'Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.',
39612
+ properties: {
39613
+ created_at: {
39614
+ description:
39615
+ 'Date and time at which Seam created the warning.',
39616
+ format: 'date-time',
39617
+ type: 'string',
39618
+ },
39619
+ message: {
39620
+ description:
39621
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
39622
+ type: 'string',
39623
+ },
39624
+ warning_code: {
39625
+ description:
39626
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
39627
+ enum: ['schedule_rounded_up'],
39628
+ type: 'string',
39629
+ },
39630
+ },
39631
+ required: ['created_at', 'message', 'warning_code'],
39632
+ type: 'object',
39633
+ },
39329
39634
  ],
39330
39635
  },
39331
39636
  type: 'array',
@@ -40491,6 +40796,7 @@ const openapi: OpenAPISpec = {
40491
40796
  'omnitec_lock',
40492
40797
  'kisi_lock',
40493
40798
  'aqara_lock',
40799
+ 'eufy_lock',
40494
40800
  ],
40495
40801
  type: 'string',
40496
40802
  },
@@ -55044,6 +55350,7 @@ const openapi: OpenAPISpec = {
55044
55350
  'omnitec_lock',
55045
55351
  'kisi_lock',
55046
55352
  'aqara_lock',
55353
+ 'eufy_lock',
55047
55354
  ],
55048
55355
  type: 'string',
55049
55356
  },
@@ -55134,6 +55441,7 @@ const openapi: OpenAPISpec = {
55134
55441
  'omnitec_lock',
55135
55442
  'kisi_lock',
55136
55443
  'aqara_lock',
55444
+ 'eufy_lock',
55137
55445
  ],
55138
55446
  type: 'string',
55139
55447
  },
@@ -57389,6 +57697,7 @@ const openapi: OpenAPISpec = {
57389
57697
  'omnitec_lock',
57390
57698
  'kisi_lock',
57391
57699
  'aqara_lock',
57700
+ 'eufy_lock',
57392
57701
  ],
57393
57702
  type: 'string',
57394
57703
  },
@@ -57479,6 +57788,7 @@ const openapi: OpenAPISpec = {
57479
57788
  'omnitec_lock',
57480
57789
  'kisi_lock',
57481
57790
  'aqara_lock',
57791
+ 'eufy_lock',
57482
57792
  ],
57483
57793
  type: 'string',
57484
57794
  },
@@ -58939,6 +59249,7 @@ const openapi: OpenAPISpec = {
58939
59249
  'omnitec_lock',
58940
59250
  'kisi_lock',
58941
59251
  'aqara_lock',
59252
+ 'eufy_lock',
58942
59253
  ],
58943
59254
  type: 'string',
58944
59255
  },
@@ -58982,6 +59293,7 @@ const openapi: OpenAPISpec = {
58982
59293
  'omnitec_lock',
58983
59294
  'kisi_lock',
58984
59295
  'aqara_lock',
59296
+ 'eufy_lock',
58985
59297
  ],
58986
59298
  type: 'string',
58987
59299
  },