@seamapi/types 1.321.0 → 1.322.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.321.0",
3
+ "version": "1.322.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -70,10 +70,10 @@ const being_deleted = common_acs_credential_warning
70
70
  })
71
71
  .describe('Indicates that this credential is being deleted.')
72
72
 
73
- export const unknown_issue_with_credential = common_acs_credential_warning
73
+ export const unknown_issue_with_acs_credential = common_acs_credential_warning
74
74
  .extend({
75
75
  warning_code: z
76
- .literal('unknown_issue_with_credential')
76
+ .literal('unknown_issue_with_acs_credential')
77
77
  .describe(warning_code_description),
78
78
  })
79
79
  .describe(
@@ -87,7 +87,7 @@ const acs_credential_warning = z
87
87
  schedule_externally_modified,
88
88
  schedule_modified,
89
89
  being_deleted,
90
- unknown_issue_with_credential,
90
+ unknown_issue_with_acs_credential,
91
91
  ])
92
92
  .describe('Warning associated with the `acs_credential`.')
93
93
 
@@ -98,7 +98,7 @@ const acs_credential_warning_map = z.object({
98
98
  .nullable(),
99
99
  schedule_modified: schedule_modified.optional().nullable(),
100
100
  being_deleted: being_deleted.optional().nullable(),
101
- unknown_issue_with_credential: unknown_issue_with_credential
101
+ unknown_issue_with_acs_credential: unknown_issue_with_acs_credential
102
102
  .optional()
103
103
  .nullable(),
104
104
  })
@@ -195,6 +195,7 @@ const common_acs_credential = z.object({
195
195
  ),
196
196
  is_latest_desired_state_synced_with_provider: z
197
197
  .boolean()
198
+ .nullable()
198
199
  .optional()
199
200
  .describe(
200
201
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
@@ -202,6 +203,7 @@ const common_acs_credential = z.object({
202
203
  latest_desired_state_synced_with_provider_at: z
203
204
  .string()
204
205
  .datetime()
206
+ .nullable()
205
207
  .optional()
206
208
  .describe(
207
209
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
@@ -215,13 +215,16 @@ const common_acs_user = z
215
215
  latest_desired_state_synced_with_provider_at: z
216
216
  .string()
217
217
  .datetime()
218
+ .nullable()
218
219
  .optional().describe(`
219
220
  ---
220
221
  undocumented: Only used internally.
221
222
  ---
222
223
  `),
223
- is_latest_desired_state_synced_with_provider: z.boolean().optional()
224
- .describe(`
224
+ is_latest_desired_state_synced_with_provider: z
225
+ .boolean()
226
+ .nullable()
227
+ .optional().describe(`
225
228
  ---
226
229
  undocumented: Only used internally.
227
230
  ---
@@ -377,6 +377,7 @@ export default {
377
377
  is_latest_desired_state_synced_with_provider: {
378
378
  description:
379
379
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
380
+ nullable: true,
380
381
  type: 'boolean',
381
382
  },
382
383
  is_managed: { enum: [true], type: 'boolean' },
@@ -395,6 +396,7 @@ export default {
395
396
  description:
396
397
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
397
398
  format: 'date-time',
399
+ nullable: true,
398
400
  type: 'string',
399
401
  },
400
402
  parent_acs_credential_id: {
@@ -554,7 +556,7 @@ export default {
554
556
  warning_code: {
555
557
  description:
556
558
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
557
- enum: ['unknown_issue_with_credential'],
559
+ enum: ['unknown_issue_with_acs_credential'],
558
560
  type: 'string',
559
561
  },
560
562
  },
@@ -1364,6 +1366,7 @@ export default {
1364
1366
  },
1365
1367
  hid_acs_system_id: { format: 'uuid', type: 'string' },
1366
1368
  is_latest_desired_state_synced_with_provider: {
1369
+ nullable: true,
1367
1370
  type: 'boolean',
1368
1371
  'x-undocumented': 'Only used internally.',
1369
1372
  },
@@ -1375,6 +1378,7 @@ export default {
1375
1378
  },
1376
1379
  latest_desired_state_synced_with_provider_at: {
1377
1380
  format: 'date-time',
1381
+ nullable: true,
1378
1382
  type: 'string',
1379
1383
  'x-undocumented': 'Only used internally.',
1380
1384
  },
@@ -1828,6 +1832,7 @@ export default {
1828
1832
  is_latest_desired_state_synced_with_provider: {
1829
1833
  description:
1830
1834
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
1835
+ nullable: true,
1831
1836
  type: 'boolean',
1832
1837
  },
1833
1838
  is_managed: { enum: [true], type: 'boolean' },
@@ -1850,6 +1855,7 @@ export default {
1850
1855
  description:
1851
1856
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
1852
1857
  format: 'date-time',
1858
+ nullable: true,
1853
1859
  type: 'string',
1854
1860
  },
1855
1861
  parent_acs_credential_id: {
@@ -2031,7 +2037,9 @@ export default {
2031
2037
  warning_code: {
2032
2038
  description:
2033
2039
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2034
- enum: ['unknown_issue_with_credential'],
2040
+ enum: [
2041
+ 'unknown_issue_with_acs_credential',
2042
+ ],
2035
2043
  type: 'string',
2036
2044
  },
2037
2045
  },
@@ -2155,6 +2163,7 @@ export default {
2155
2163
  is_latest_desired_state_synced_with_provider: {
2156
2164
  description:
2157
2165
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2166
+ nullable: true,
2158
2167
  type: 'boolean',
2159
2168
  },
2160
2169
  is_managed: { enum: [false], type: 'boolean' },
@@ -2177,6 +2186,7 @@ export default {
2177
2186
  description:
2178
2187
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2179
2188
  format: 'date-time',
2189
+ nullable: true,
2180
2190
  type: 'string',
2181
2191
  },
2182
2192
  parent_acs_credential_id: {
@@ -2358,7 +2368,9 @@ export default {
2358
2368
  warning_code: {
2359
2369
  description:
2360
2370
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2361
- enum: ['unknown_issue_with_credential'],
2371
+ enum: [
2372
+ 'unknown_issue_with_acs_credential',
2373
+ ],
2362
2374
  type: 'string',
2363
2375
  },
2364
2376
  },
@@ -2615,6 +2627,7 @@ export default {
2615
2627
  is_latest_desired_state_synced_with_provider: {
2616
2628
  description:
2617
2629
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2630
+ nullable: true,
2618
2631
  type: 'boolean',
2619
2632
  },
2620
2633
  is_managed: { enum: [true], type: 'boolean' },
@@ -2637,6 +2650,7 @@ export default {
2637
2650
  description:
2638
2651
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2639
2652
  format: 'date-time',
2653
+ nullable: true,
2640
2654
  type: 'string',
2641
2655
  },
2642
2656
  parent_acs_credential_id: {
@@ -2818,7 +2832,7 @@ export default {
2818
2832
  warning_code: {
2819
2833
  description:
2820
2834
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2821
- enum: ['unknown_issue_with_credential'],
2835
+ enum: ['unknown_issue_with_acs_credential'],
2822
2836
  type: 'string',
2823
2837
  },
2824
2838
  },
@@ -2941,6 +2955,7 @@ export default {
2941
2955
  is_latest_desired_state_synced_with_provider: {
2942
2956
  description:
2943
2957
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2958
+ nullable: true,
2944
2959
  type: 'boolean',
2945
2960
  },
2946
2961
  is_managed: { enum: [false], type: 'boolean' },
@@ -2963,6 +2978,7 @@ export default {
2963
2978
  description:
2964
2979
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2965
2980
  format: 'date-time',
2981
+ nullable: true,
2966
2982
  type: 'string',
2967
2983
  },
2968
2984
  parent_acs_credential_id: {
@@ -3144,7 +3160,7 @@ export default {
3144
3160
  warning_code: {
3145
3161
  description:
3146
3162
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
3147
- enum: ['unknown_issue_with_credential'],
3163
+ enum: ['unknown_issue_with_acs_credential'],
3148
3164
  type: 'string',
3149
3165
  },
3150
3166
  },
@@ -13066,6 +13082,15 @@ export default {
13066
13082
  'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
13067
13083
  type: 'boolean',
13068
13084
  },
13085
+ salto_space_metadata: {
13086
+ description:
13087
+ 'Salto Space-specific metadata for the new credential.',
13088
+ properties: {
13089
+ assign_new_key: { type: 'boolean' },
13090
+ update_current_key: { type: 'boolean' },
13091
+ },
13092
+ type: 'object',
13093
+ },
13069
13094
  starts_at: {
13070
13095
  description:
13071
13096
  'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -13768,6 +13793,7 @@ export default {
13768
13793
  is_latest_desired_state_synced_with_provider: {
13769
13794
  description:
13770
13795
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
13796
+ nullable: true,
13771
13797
  type: 'boolean',
13772
13798
  },
13773
13799
  is_managed: { enum: [false], type: 'boolean' },
@@ -13790,6 +13816,7 @@ export default {
13790
13816
  description:
13791
13817
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
13792
13818
  format: 'date-time',
13819
+ nullable: true,
13793
13820
  type: 'string',
13794
13821
  },
13795
13822
  parent_acs_credential_id: {
@@ -13971,7 +13998,7 @@ export default {
13971
13998
  warning_code: {
13972
13999
  description:
13973
14000
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13974
- enum: ['unknown_issue_with_credential'],
14001
+ enum: ['unknown_issue_with_acs_credential'],
13975
14002
  type: 'string',
13976
14003
  },
13977
14004
  },
@@ -14198,6 +14225,7 @@ export default {
14198
14225
  is_latest_desired_state_synced_with_provider: {
14199
14226
  description:
14200
14227
  'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
14228
+ nullable: true,
14201
14229
  type: 'boolean',
14202
14230
  },
14203
14231
  is_managed: { enum: [false], type: 'boolean' },
@@ -14220,6 +14248,7 @@ export default {
14220
14248
  description:
14221
14249
  'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
14222
14250
  format: 'date-time',
14251
+ nullable: true,
14223
14252
  type: 'string',
14224
14253
  },
14225
14254
  parent_acs_credential_id: {
@@ -14401,7 +14430,9 @@ export default {
14401
14430
  warning_code: {
14402
14431
  description:
14403
14432
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
14404
- enum: ['unknown_issue_with_credential'],
14433
+ enum: [
14434
+ 'unknown_issue_with_acs_credential',
14435
+ ],
14405
14436
  type: 'string',
14406
14437
  },
14407
14438
  },
@@ -16385,6 +16416,7 @@ export default {
16385
16416
  },
16386
16417
  hid_acs_system_id: { format: 'uuid', type: 'string' },
16387
16418
  is_latest_desired_state_synced_with_provider: {
16419
+ nullable: true,
16388
16420
  type: 'boolean',
16389
16421
  'x-undocumented': 'Only used internally.',
16390
16422
  },
@@ -16396,6 +16428,7 @@ export default {
16396
16428
  },
16397
16429
  latest_desired_state_synced_with_provider_at: {
16398
16430
  format: 'date-time',
16431
+ nullable: true,
16399
16432
  type: 'string',
16400
16433
  'x-undocumented': 'Only used internally.',
16401
16434
  },
@@ -16780,6 +16813,7 @@ export default {
16780
16813
  },
16781
16814
  hid_acs_system_id: { format: 'uuid', type: 'string' },
16782
16815
  is_latest_desired_state_synced_with_provider: {
16816
+ nullable: true,
16783
16817
  type: 'boolean',
16784
16818
  'x-undocumented': 'Only used internally.',
16785
16819
  },
@@ -16791,6 +16825,7 @@ export default {
16791
16825
  },
16792
16826
  latest_desired_state_synced_with_provider_at: {
16793
16827
  format: 'date-time',
16828
+ nullable: true,
16794
16829
  type: 'string',
16795
16830
  'x-undocumented': 'Only used internally.',
16796
16831
  },