@seamapi/types 1.432.0 → 1.434.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.
@@ -16479,6 +16479,8 @@ export interface Routes {
16479
16479
  access_grant_id?: string | undefined;
16480
16480
  /** ID of the access method for which you want to retrieve all entrances. */
16481
16481
  access_method_id?: string | undefined;
16482
+ /** ID of the connected account for which you want to retrieve all entrances. */
16483
+ connected_account_id?: string | undefined;
16482
16484
  };
16483
16485
  formData: {};
16484
16486
  jsonResponse: {
@@ -61912,6 +61914,13 @@ export interface Routes {
61912
61914
  message: string;
61913
61915
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61914
61916
  warning_code: 'being_deleted';
61917
+ } | {
61918
+ /** Date and time at which Seam created the warning. */
61919
+ created_at: string;
61920
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61921
+ message: string;
61922
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61923
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
61915
61924
  }>;
61916
61925
  };
61917
61926
  };
@@ -62111,6 +62120,13 @@ export interface Routes {
62111
62120
  message: string;
62112
62121
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62113
62122
  warning_code: 'being_deleted';
62123
+ } | {
62124
+ /** Date and time at which Seam created the warning. */
62125
+ created_at: string;
62126
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62127
+ message: string;
62128
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62129
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
62114
62130
  }>;
62115
62131
  };
62116
62132
  };
@@ -62178,6 +62194,13 @@ export interface Routes {
62178
62194
  message: string;
62179
62195
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62180
62196
  warning_code: 'being_deleted';
62197
+ } | {
62198
+ /** Date and time at which Seam created the warning. */
62199
+ created_at: string;
62200
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62201
+ message: string;
62202
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62203
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
62181
62204
  }>;
62182
62205
  }>;
62183
62206
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.432.0",
3
+ "version": "1.434.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.24.0"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.50.6",
95
+ "@seamapi/blueprint": "^0.51.1",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -66,7 +66,6 @@ export type ProviderCategory = keyof typeof PROVIDER_CATEGORY_MAP
66
66
  export const PROVIDER_CATEGORY_MAP = {
67
67
  stable: [
68
68
  'august',
69
- 'avigilon_alta',
70
69
  'brivo',
71
70
  'schlage',
72
71
  'smartthings',
@@ -74,7 +73,6 @@ export const PROVIDER_CATEGORY_MAP = {
74
73
  'nuki',
75
74
  'salto',
76
75
  'salto_space',
77
- 'controlbyweb',
78
76
  'minut',
79
77
  'my_2n',
80
78
  'kwikset',
@@ -82,7 +80,6 @@ export const PROVIDER_CATEGORY_MAP = {
82
80
  'noiseaware',
83
81
  'igloohome',
84
82
  'ecobee',
85
- 'four_suites',
86
83
  'lockly',
87
84
  'wyze',
88
85
  'nest',
@@ -262,25 +262,27 @@ const many_active_backup_codes = common_device_warning.extend({
262
262
  Indicates that there are too many backup codes.
263
263
  `)
264
264
 
265
- const salto_ks_office_mode = common_device_warning
266
- .extend({
267
- warning_code: z
268
- .literal('salto_ks_office_mode')
269
- .describe(warning_code_description),
270
- })
271
- .describe(
272
- 'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.',
273
- )
265
+ const salto_ks_office_mode = common_device_warning.extend({
266
+ warning_code: z
267
+ .literal('salto_ks_office_mode')
268
+ .describe(warning_code_description),
269
+ }).describe(`
270
+ ---
271
+ variant_group_key: access_codes
272
+ ---
273
+ Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.
274
+ `)
274
275
 
275
- const salto_ks_privacy_mode = common_device_warning
276
- .extend({
277
- warning_code: z
278
- .literal('salto_ks_privacy_mode')
279
- .describe(warning_code_description),
280
- })
281
- .describe(
282
- 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
283
- )
276
+ const salto_ks_privacy_mode = common_device_warning.extend({
277
+ warning_code: z
278
+ .literal('salto_ks_privacy_mode')
279
+ .describe(warning_code_description),
280
+ }).describe(`
281
+ ---
282
+ variant_group_key: access_codes
283
+ ---
284
+ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
285
+ `)
284
286
 
285
287
  const salto_ks_subscription_limit_almost_reached = common_device_warning
286
288
  .extend({
@@ -36,6 +36,19 @@ const user_identity_being_deleted = common_user_identity_warning
36
36
  })
37
37
  .describe('Indicates that the user identity is currently being deleted.')
38
38
 
39
+ const acs_user_profile_does_not_match_user_identity =
40
+ common_user_identity_warning
41
+ .extend({
42
+ warning_code: z
43
+ .literal('acs_user_profile_does_not_match_user_identity')
44
+ .describe(
45
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
46
+ ),
47
+ })
48
+ .describe(
49
+ "Indicates that the ACS user's profile does not match the user identity's profile",
50
+ )
51
+
39
52
  const user_identity_issue_with_acs_user = common_user_identity_error
40
53
  .extend({
41
54
  error_code: z
@@ -71,13 +84,18 @@ export const user_identity_error_map = z.object({
71
84
  export type UserIdentityErrorMap = z.infer<typeof user_identity_error_map>
72
85
 
73
86
  const user_identity_warnings = z
74
- .discriminatedUnion('warning_code', [user_identity_being_deleted])
87
+ .discriminatedUnion('warning_code', [
88
+ user_identity_being_deleted,
89
+ acs_user_profile_does_not_match_user_identity,
90
+ ])
75
91
  .describe('Warnings associated with the user identity.')
76
92
 
77
93
  export const user_identity_warning_map = z.object({
78
94
  user_identity_being_deleted: user_identity_being_deleted
79
95
  .optional()
80
96
  .nullable(),
97
+ acs_user_profile_does_not_match_user_identity:
98
+ acs_user_profile_does_not_match_user_identity.optional().nullable(),
81
99
  })
82
100
 
83
101
  export type UserIdentityWarningMap = z.infer<typeof user_identity_warning_map>
@@ -12541,6 +12541,7 @@ export default {
12541
12541
  },
12542
12542
  required: ['message', 'created_at', 'warning_code'],
12543
12543
  type: 'object',
12544
+ 'x-variant-group-key': 'access_codes',
12544
12545
  },
12545
12546
  {
12546
12547
  description:
@@ -12566,6 +12567,7 @@ export default {
12566
12567
  },
12567
12568
  required: ['message', 'created_at', 'warning_code'],
12568
12569
  type: 'object',
12570
+ 'x-variant-group-key': 'access_codes',
12569
12571
  },
12570
12572
  {
12571
12573
  description:
@@ -23530,6 +23532,7 @@ export default {
23530
23532
  },
23531
23533
  required: ['message', 'created_at', 'warning_code'],
23532
23534
  type: 'object',
23535
+ 'x-variant-group-key': 'access_codes',
23533
23536
  },
23534
23537
  {
23535
23538
  description:
@@ -23555,6 +23558,7 @@ export default {
23555
23558
  },
23556
23559
  required: ['message', 'created_at', 'warning_code'],
23557
23560
  type: 'object',
23561
+ 'x-variant-group-key': 'access_codes',
23558
23562
  },
23559
23563
  {
23560
23564
  description:
@@ -23798,6 +23802,31 @@ export default {
23798
23802
  required: ['created_at', 'message', 'warning_code'],
23799
23803
  type: 'object',
23800
23804
  },
23805
+ {
23806
+ description:
23807
+ "Indicates that the ACS user's profile does not match the user identity's profile",
23808
+ properties: {
23809
+ created_at: {
23810
+ description:
23811
+ 'Date and time at which Seam created the warning.',
23812
+ format: 'date-time',
23813
+ type: 'string',
23814
+ },
23815
+ message: {
23816
+ description:
23817
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
23818
+ type: 'string',
23819
+ },
23820
+ warning_code: {
23821
+ description:
23822
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
23823
+ enum: ['acs_user_profile_does_not_match_user_identity'],
23824
+ type: 'string',
23825
+ },
23826
+ },
23827
+ required: ['created_at', 'message', 'warning_code'],
23828
+ type: 'object',
23829
+ },
23801
23830
  ],
23802
23831
  },
23803
23832
  type: 'array',
@@ -31108,6 +31137,16 @@ export default {
31108
31137
  type: 'string',
31109
31138
  },
31110
31139
  },
31140
+ {
31141
+ in: 'query',
31142
+ name: 'connected_account_id',
31143
+ schema: {
31144
+ description:
31145
+ 'ID of the connected account for which you want to retrieve all entrances.',
31146
+ format: 'uuid',
31147
+ type: 'string',
31148
+ },
31149
+ },
31111
31150
  ],
31112
31151
  responses: {
31113
31152
  200: {
@@ -31178,6 +31217,12 @@ export default {
31178
31217
  format: 'uuid',
31179
31218
  type: 'string',
31180
31219
  },
31220
+ connected_account_id: {
31221
+ description:
31222
+ 'ID of the connected account for which you want to retrieve all entrances.',
31223
+ format: 'uuid',
31224
+ type: 'string',
31225
+ },
31181
31226
  location_id: {
31182
31227
  deprecated: true,
31183
31228
  format: 'uuid',
@@ -18660,6 +18660,8 @@ export interface Routes {
18660
18660
  access_grant_id?: string | undefined
18661
18661
  /** ID of the access method for which you want to retrieve all entrances. */
18662
18662
  access_method_id?: string | undefined
18663
+ /** ID of the connected account for which you want to retrieve all entrances. */
18664
+ connected_account_id?: string | undefined
18663
18665
  }
18664
18666
  formData: {}
18665
18667
  jsonResponse: {
@@ -72291,14 +72293,24 @@ export interface Routes {
72291
72293
  acs_system_id: string
72292
72294
  }>
72293
72295
  /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
72294
- warnings: Array<{
72295
- /** Date and time at which Seam created the warning. */
72296
- created_at: string
72297
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72298
- message: string
72299
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72300
- warning_code: 'being_deleted'
72301
- }>
72296
+ warnings: Array<
72297
+ | {
72298
+ /** Date and time at which Seam created the warning. */
72299
+ created_at: string
72300
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72301
+ message: string
72302
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72303
+ warning_code: 'being_deleted'
72304
+ }
72305
+ | {
72306
+ /** Date and time at which Seam created the warning. */
72307
+ created_at: string
72308
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72309
+ message: string
72310
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72311
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
72312
+ }
72313
+ >
72302
72314
  }
72303
72315
  }
72304
72316
  }
@@ -72492,14 +72504,24 @@ export interface Routes {
72492
72504
  acs_system_id: string
72493
72505
  }>
72494
72506
  /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
72495
- warnings: Array<{
72496
- /** Date and time at which Seam created the warning. */
72497
- created_at: string
72498
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72499
- message: string
72500
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72501
- warning_code: 'being_deleted'
72502
- }>
72507
+ warnings: Array<
72508
+ | {
72509
+ /** Date and time at which Seam created the warning. */
72510
+ created_at: string
72511
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72512
+ message: string
72513
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72514
+ warning_code: 'being_deleted'
72515
+ }
72516
+ | {
72517
+ /** Date and time at which Seam created the warning. */
72518
+ created_at: string
72519
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72520
+ message: string
72521
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72522
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
72523
+ }
72524
+ >
72503
72525
  }
72504
72526
  }
72505
72527
  }
@@ -72559,14 +72581,24 @@ export interface Routes {
72559
72581
  acs_system_id: string
72560
72582
  }>
72561
72583
  /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
72562
- warnings: Array<{
72563
- /** Date and time at which Seam created the warning. */
72564
- created_at: string
72565
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72566
- message: string
72567
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72568
- warning_code: 'being_deleted'
72569
- }>
72584
+ warnings: Array<
72585
+ | {
72586
+ /** Date and time at which Seam created the warning. */
72587
+ created_at: string
72588
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72589
+ message: string
72590
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72591
+ warning_code: 'being_deleted'
72592
+ }
72593
+ | {
72594
+ /** Date and time at which Seam created the warning. */
72595
+ created_at: string
72596
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72597
+ message: string
72598
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72599
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
72600
+ }
72601
+ >
72570
72602
  }>
72571
72603
  }
72572
72604
  }