@seamapi/types 1.386.2 → 1.388.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.
@@ -3621,6 +3621,10 @@ export interface Routes {
3621
3621
  access_code_ids?: string[] | undefined;
3622
3622
  /** Your user ID for the user by which to filter access codes. */
3623
3623
  user_identifier_key?: string | undefined;
3624
+ /** Numerical limit on the number of access codes to return. */
3625
+ limit?: number;
3626
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
3627
+ page_cursor?: (string | undefined) | null;
3624
3628
  };
3625
3629
  formData: {};
3626
3630
  jsonResponse: {
@@ -4064,6 +4068,15 @@ export interface Routes {
4064
4068
  /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
4065
4069
  is_offline_access_code: boolean;
4066
4070
  }>;
4071
+ /** Information about the current page of results. */
4072
+ pagination: {
4073
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
4074
+ next_page_cursor: string | null;
4075
+ /** Indicates whether there is another page of results after this one. */
4076
+ has_next_page: boolean;
4077
+ /** URL to get the next page of results. */
4078
+ next_page_url: string | null;
4079
+ };
4067
4080
  };
4068
4081
  };
4069
4082
  '/access_codes/pull_backup_access_code': {
@@ -8832,6 +8845,12 @@ export interface Routes {
8832
8845
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
8833
8846
  message: string;
8834
8847
  warning_code: 'unknown_issue_with_acs_user';
8848
+ } | {
8849
+ /** Date and time at which Seam created the warning. */
8850
+ created_at: string;
8851
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
8852
+ message: string;
8853
+ warning_code: 'latch_resident_user';
8835
8854
  }>;
8836
8855
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
8837
8856
  errors: Array<{
@@ -14691,6 +14710,12 @@ export interface Routes {
14691
14710
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
14692
14711
  message: string;
14693
14712
  warning_code: 'unknown_issue_with_acs_user';
14713
+ } | {
14714
+ /** Date and time at which Seam created the warning. */
14715
+ created_at: string;
14716
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
14717
+ message: string;
14718
+ warning_code: 'latch_resident_user';
14694
14719
  }>;
14695
14720
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
14696
14721
  errors: Array<{
@@ -14889,6 +14914,12 @@ export interface Routes {
14889
14914
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
14890
14915
  message: string;
14891
14916
  warning_code: 'unknown_issue_with_acs_user';
14917
+ } | {
14918
+ /** Date and time at which Seam created the warning. */
14919
+ created_at: string;
14920
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
14921
+ message: string;
14922
+ warning_code: 'latch_resident_user';
14892
14923
  }>;
14893
14924
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
14894
14925
  errors: Array<{
@@ -15083,6 +15114,12 @@ export interface Routes {
15083
15114
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15084
15115
  message: string;
15085
15116
  warning_code: 'unknown_issue_with_acs_user';
15117
+ } | {
15118
+ /** Date and time at which Seam created the warning. */
15119
+ created_at: string;
15120
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15121
+ message: string;
15122
+ warning_code: 'latch_resident_user';
15086
15123
  }>;
15087
15124
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
15088
15125
  errors: Array<{
@@ -15386,6 +15423,12 @@ export interface Routes {
15386
15423
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15387
15424
  message: string;
15388
15425
  warning_code: 'unknown_issue_with_acs_user';
15426
+ } | {
15427
+ /** Date and time at which Seam created the warning. */
15428
+ created_at: string;
15429
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15430
+ message: string;
15431
+ warning_code: 'latch_resident_user';
15389
15432
  }>;
15390
15433
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
15391
15434
  errors: Array<{
@@ -15570,6 +15613,12 @@ export interface Routes {
15570
15613
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15571
15614
  message: string;
15572
15615
  warning_code: 'unknown_issue_with_acs_user';
15616
+ } | {
15617
+ /** Date and time at which Seam created the warning. */
15618
+ created_at: string;
15619
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15620
+ message: string;
15621
+ warning_code: 'latch_resident_user';
15573
15622
  }>;
15574
15623
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
15575
15624
  errors: Array<{
@@ -49150,6 +49199,12 @@ export interface Routes {
49150
49199
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49151
49200
  message: string;
49152
49201
  warning_code: 'unknown_issue_with_acs_user';
49202
+ } | {
49203
+ /** Date and time at which Seam created the warning. */
49204
+ created_at: string;
49205
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49206
+ message: string;
49207
+ warning_code: 'latch_resident_user';
49153
49208
  }>;
49154
49209
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
49155
49210
  errors: Array<{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.386.2",
3
+ "version": "1.388.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -133,6 +133,14 @@ export const unknown_issue_with_acs_user = common_acs_user_warning
133
133
  'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
134
134
  )
135
135
 
136
+ export const latch_resident_user = common_acs_user_warning
137
+ .extend({
138
+ warning_code: z.literal('latch_resident_user'),
139
+ })
140
+ .describe(
141
+ 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
142
+ )
143
+
136
144
  export const acs_users_warning_map = z.object({
137
145
  being_deleted: acs_users_being_deleted.optional().nullable(),
138
146
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
@@ -141,6 +149,7 @@ export const acs_users_warning_map = z.object({
141
149
  unknown_issue_with_acs_user: unknown_issue_with_acs_user
142
150
  .optional()
143
151
  .nullable(),
152
+ latch_resident_user: latch_resident_user.optional().nullable(),
144
153
  })
145
154
 
146
155
  export const acs_users_warnings = z
@@ -148,6 +157,7 @@ export const acs_users_warnings = z
148
157
  acs_users_being_deleted,
149
158
  acs_users_salto_ks_user_not_subscribed,
150
159
  unknown_issue_with_acs_user,
160
+ latch_resident_user,
151
161
  ])
152
162
  .describe(
153
163
  'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
@@ -3281,6 +3281,29 @@ export default {
3281
3281
  required: ['created_at', 'message', 'warning_code'],
3282
3282
  type: 'object',
3283
3283
  },
3284
+ {
3285
+ description:
3286
+ 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
3287
+ properties: {
3288
+ created_at: {
3289
+ description:
3290
+ 'Date and time at which Seam created the warning.',
3291
+ format: 'date-time',
3292
+ type: 'string',
3293
+ },
3294
+ message: {
3295
+ description:
3296
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
3297
+ type: 'string',
3298
+ },
3299
+ warning_code: {
3300
+ enum: ['latch_resident_user'],
3301
+ type: 'string',
3302
+ },
3303
+ },
3304
+ required: ['created_at', 'message', 'warning_code'],
3305
+ type: 'object',
3306
+ },
3284
3307
  ],
3285
3308
  },
3286
3309
  type: 'array',
@@ -17477,6 +17500,29 @@ export default {
17477
17500
  required: ['created_at', 'message', 'warning_code'],
17478
17501
  type: 'object',
17479
17502
  },
17503
+ {
17504
+ description:
17505
+ 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
17506
+ properties: {
17507
+ created_at: {
17508
+ description:
17509
+ 'Date and time at which Seam created the warning.',
17510
+ format: 'date-time',
17511
+ type: 'string',
17512
+ },
17513
+ message: {
17514
+ description:
17515
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
17516
+ type: 'string',
17517
+ },
17518
+ warning_code: {
17519
+ enum: ['latch_resident_user'],
17520
+ type: 'string',
17521
+ },
17522
+ },
17523
+ required: ['created_at', 'message', 'warning_code'],
17524
+ type: 'object',
17525
+ },
17480
17526
  ],
17481
17527
  },
17482
17528
  type: 'array',
@@ -19167,6 +19213,19 @@ export default {
19167
19213
  format: 'uuid',
19168
19214
  type: 'string',
19169
19215
  },
19216
+ limit: {
19217
+ default: 55_000,
19218
+ description:
19219
+ 'Numerical limit on the number of access codes to return.',
19220
+ format: 'float',
19221
+ type: 'number',
19222
+ },
19223
+ page_cursor: {
19224
+ description:
19225
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
19226
+ nullable: true,
19227
+ type: 'string',
19228
+ },
19170
19229
  user_identifier_key: {
19171
19230
  description:
19172
19231
  'Your user ID for the user by which to filter access codes.',
@@ -19189,8 +19248,9 @@ export default {
19189
19248
  type: 'array',
19190
19249
  },
19191
19250
  ok: { type: 'boolean' },
19251
+ pagination: { $ref: '#/components/schemas/pagination' },
19192
19252
  },
19193
- required: ['access_codes', 'ok'],
19253
+ required: ['access_codes', 'pagination', 'ok'],
19194
19254
  type: 'object',
19195
19255
  },
19196
19256
  },
@@ -4144,6 +4144,10 @@ export interface Routes {
4144
4144
  access_code_ids?: string[] | undefined
4145
4145
  /** Your user ID for the user by which to filter access codes. */
4146
4146
  user_identifier_key?: string | undefined
4147
+ /** Numerical limit on the number of access codes to return. */
4148
+ limit?: number
4149
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
4150
+ page_cursor?: (string | undefined) | null
4147
4151
  }
4148
4152
  formData: {}
4149
4153
  jsonResponse: {
@@ -4640,6 +4644,15 @@ export interface Routes {
4640
4644
  /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
4641
4645
  is_offline_access_code: boolean
4642
4646
  }>
4647
+ /** Information about the current page of results. */
4648
+ pagination: {
4649
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
4650
+ next_page_cursor: string | null
4651
+ /** Indicates whether there is another page of results after this one. */
4652
+ has_next_page: boolean
4653
+ /** URL to get the next page of results. */
4654
+ next_page_url: string | null
4655
+ }
4643
4656
  }
4644
4657
  }
4645
4658
  '/access_codes/pull_backup_access_code': {
@@ -10100,6 +10113,13 @@ export interface Routes {
10100
10113
  message: string
10101
10114
  warning_code: 'unknown_issue_with_acs_user'
10102
10115
  }
10116
+ | {
10117
+ /** Date and time at which Seam created the warning. */
10118
+ created_at: string
10119
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10120
+ message: string
10121
+ warning_code: 'latch_resident_user'
10122
+ }
10103
10123
  >
10104
10124
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
10105
10125
  errors: Array<
@@ -17045,6 +17065,13 @@ export interface Routes {
17045
17065
  message: string
17046
17066
  warning_code: 'unknown_issue_with_acs_user'
17047
17067
  }
17068
+ | {
17069
+ /** Date and time at which Seam created the warning. */
17070
+ created_at: string
17071
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17072
+ message: string
17073
+ warning_code: 'latch_resident_user'
17074
+ }
17048
17075
  >
17049
17076
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
17050
17077
  errors: Array<
@@ -17274,6 +17301,13 @@ export interface Routes {
17274
17301
  message: string
17275
17302
  warning_code: 'unknown_issue_with_acs_user'
17276
17303
  }
17304
+ | {
17305
+ /** Date and time at which Seam created the warning. */
17306
+ created_at: string
17307
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17308
+ message: string
17309
+ warning_code: 'latch_resident_user'
17310
+ }
17277
17311
  >
17278
17312
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
17279
17313
  errors: Array<
@@ -17499,6 +17533,13 @@ export interface Routes {
17499
17533
  message: string
17500
17534
  warning_code: 'unknown_issue_with_acs_user'
17501
17535
  }
17536
+ | {
17537
+ /** Date and time at which Seam created the warning. */
17538
+ created_at: string
17539
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17540
+ message: string
17541
+ warning_code: 'latch_resident_user'
17542
+ }
17502
17543
  >
17503
17544
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
17504
17545
  errors: Array<
@@ -17856,6 +17897,13 @@ export interface Routes {
17856
17897
  message: string
17857
17898
  warning_code: 'unknown_issue_with_acs_user'
17858
17899
  }
17900
+ | {
17901
+ /** Date and time at which Seam created the warning. */
17902
+ created_at: string
17903
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17904
+ message: string
17905
+ warning_code: 'latch_resident_user'
17906
+ }
17859
17907
  >
17860
17908
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
17861
17909
  errors: Array<
@@ -18071,6 +18119,13 @@ export interface Routes {
18071
18119
  message: string
18072
18120
  warning_code: 'unknown_issue_with_acs_user'
18073
18121
  }
18122
+ | {
18123
+ /** Date and time at which Seam created the warning. */
18124
+ created_at: string
18125
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
18126
+ message: string
18127
+ warning_code: 'latch_resident_user'
18128
+ }
18074
18129
  >
18075
18130
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
18076
18131
  errors: Array<
@@ -58871,6 +58926,13 @@ export interface Routes {
58871
58926
  message: string
58872
58927
  warning_code: 'unknown_issue_with_acs_user'
58873
58928
  }
58929
+ | {
58930
+ /** Date and time at which Seam created the warning. */
58931
+ created_at: string
58932
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
58933
+ message: string
58934
+ warning_code: 'latch_resident_user'
58935
+ }
58874
58936
  >
58875
58937
  /** Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
58876
58938
  errors: Array<