@seamapi/types 1.834.0 → 1.836.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.
@@ -13055,6 +13055,13 @@ export type Routes = {
13055
13055
  message: string;
13056
13056
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13057
13057
  warning_code: 'being_deleted';
13058
+ } | {
13059
+ /** Date and time at which Seam created the warning. */
13060
+ created_at: string;
13061
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13062
+ message: string;
13063
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13064
+ warning_code: 'provider_service_unavailable';
13058
13065
  })[];
13059
13066
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
13060
13067
  custom_metadata: {
@@ -31354,6 +31361,13 @@ export type Routes = {
31354
31361
  message: string;
31355
31362
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31356
31363
  warning_code: 'being_deleted';
31364
+ } | {
31365
+ /** Date and time at which Seam created the warning. */
31366
+ created_at: string;
31367
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31368
+ message: string;
31369
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31370
+ warning_code: 'provider_service_unavailable';
31357
31371
  })[];
31358
31372
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
31359
31373
  custom_metadata: {
@@ -31520,6 +31534,13 @@ export type Routes = {
31520
31534
  message: string;
31521
31535
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31522
31536
  warning_code: 'being_deleted';
31537
+ } | {
31538
+ /** Date and time at which Seam created the warning. */
31539
+ created_at: string;
31540
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31541
+ message: string;
31542
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31543
+ warning_code: 'provider_service_unavailable';
31523
31544
  })[];
31524
31545
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
31525
31546
  custom_metadata: {
@@ -31718,6 +31739,13 @@ export type Routes = {
31718
31739
  message: string;
31719
31740
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31720
31741
  warning_code: 'being_deleted';
31742
+ } | {
31743
+ /** Date and time at which Seam created the warning. */
31744
+ created_at: string;
31745
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31746
+ message: string;
31747
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31748
+ warning_code: 'provider_service_unavailable';
31721
31749
  })[];
31722
31750
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
31723
31751
  custom_metadata: {
@@ -68938,6 +68966,8 @@ export type Routes = {
68938
68966
  customer_key?: string | undefined;
68939
68967
  /** Collection key. */
68940
68968
  collection_key?: string | undefined;
68969
+ /** Connected account to scope auto-mapping to. Filters partner resources by the matching connector and limits available devices/entrances to this account. */
68970
+ connected_account_id?: string | undefined;
68941
68971
  };
68942
68972
  formData: {};
68943
68973
  jsonResponse: {
@@ -70794,6 +70824,13 @@ export type Routes = {
70794
70824
  message: string;
70795
70825
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70796
70826
  warning_code: 'being_deleted';
70827
+ } | {
70828
+ /** Date and time at which Seam created the warning. */
70829
+ created_at: string;
70830
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70831
+ message: string;
70832
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70833
+ warning_code: 'provider_service_unavailable';
70797
70834
  })[];
70798
70835
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
70799
70836
  custom_metadata: {
@@ -96954,6 +96991,13 @@ export type Routes = {
96954
96991
  message: string;
96955
96992
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96956
96993
  warning_code: 'being_deleted';
96994
+ } | {
96995
+ /** Date and time at which Seam created the warning. */
96996
+ created_at: string;
96997
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96998
+ message: string;
96999
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97000
+ warning_code: 'provider_service_unavailable';
96957
97001
  })[];
96958
97002
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
96959
97003
  custom_metadata: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.834.0",
3
+ "version": "1.836.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -230,6 +230,16 @@ const being_deleted = common_connected_account_warning
230
230
  'Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.',
231
231
  )
232
232
 
233
+ const provider_service_unavailable = common_connected_account_warning
234
+ .extend({
235
+ warning_code: z
236
+ .literal('provider_service_unavailable')
237
+ .describe(warning_code_description),
238
+ })
239
+ .describe(
240
+ "Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.",
241
+ )
242
+
233
243
  const connected_account_warning = z
234
244
  .discriminatedUnion('warning_code', [
235
245
  scheduled_maintenance_window,
@@ -237,6 +247,7 @@ const connected_account_warning = z
237
247
  salto_ks_subscription_limit_almost_reached,
238
248
  account_reauthorization_requested,
239
249
  being_deleted,
250
+ provider_service_unavailable,
240
251
  ])
241
252
  .describe('Warning associated with the connected account.')
242
253
 
@@ -253,6 +264,9 @@ export const connected_account_warning_map = z.object({
253
264
  .nullable()
254
265
  .optional(),
255
266
  being_deleted: being_deleted.nullable().optional(),
267
+ provider_service_unavailable: provider_service_unavailable
268
+ .nullable()
269
+ .optional(),
256
270
  })
257
271
 
258
272
  export type ConnectedAccountWarningMap = z.infer<
@@ -11383,6 +11383,31 @@ const openapi: OpenAPISpec = {
11383
11383
  required: ['created_at', 'message', 'warning_code'],
11384
11384
  type: 'object',
11385
11385
  },
11386
+ {
11387
+ description:
11388
+ "Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.",
11389
+ properties: {
11390
+ created_at: {
11391
+ description:
11392
+ 'Date and time at which Seam created the warning.',
11393
+ format: 'date-time',
11394
+ type: 'string',
11395
+ },
11396
+ message: {
11397
+ description:
11398
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
11399
+ type: 'string',
11400
+ },
11401
+ warning_code: {
11402
+ description:
11403
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
11404
+ enum: ['provider_service_unavailable'],
11405
+ type: 'string',
11406
+ },
11407
+ },
11408
+ required: ['created_at', 'message', 'warning_code'],
11409
+ type: 'object',
11410
+ },
11386
11411
  ],
11387
11412
  },
11388
11413
  type: 'array',
@@ -73442,6 +73467,16 @@ const openapi: OpenAPISpec = {
73442
73467
  name: 'collection_key',
73443
73468
  schema: { description: 'Collection key.', type: 'string' },
73444
73469
  },
73470
+ {
73471
+ in: 'query',
73472
+ name: 'connected_account_id',
73473
+ schema: {
73474
+ description:
73475
+ 'Connected account to scope auto-mapping to. Filters partner resources by the matching connector and limits available devices/entrances to this account.',
73476
+ format: 'uuid',
73477
+ type: 'string',
73478
+ },
73479
+ },
73445
73480
  ],
73446
73481
  responses: {
73447
73482
  200: {
@@ -73557,6 +73592,12 @@ const openapi: OpenAPISpec = {
73557
73592
  description: 'Collection key.',
73558
73593
  type: 'string',
73559
73594
  },
73595
+ connected_account_id: {
73596
+ description:
73597
+ 'Connected account to scope auto-mapping to. Filters partner resources by the matching connector and limits available devices/entrances to this account.',
73598
+ format: 'uuid',
73599
+ type: 'string',
73600
+ },
73560
73601
  customer_key: {
73561
73602
  description: 'Customer key for which to auto-map spaces.',
73562
73603
  type: 'string',
@@ -14967,6 +14967,14 @@ export type Routes = {
14967
14967
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14968
14968
  warning_code: 'being_deleted'
14969
14969
  }
14970
+ | {
14971
+ /** Date and time at which Seam created the warning. */
14972
+ created_at: string
14973
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
14974
+ message: string
14975
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
14976
+ warning_code: 'provider_service_unavailable'
14977
+ }
14970
14978
  )[]
14971
14979
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
14972
14980
  custom_metadata: {
@@ -36306,6 +36314,14 @@ export type Routes = {
36306
36314
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36307
36315
  warning_code: 'being_deleted'
36308
36316
  }
36317
+ | {
36318
+ /** Date and time at which Seam created the warning. */
36319
+ created_at: string
36320
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36321
+ message: string
36322
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36323
+ warning_code: 'provider_service_unavailable'
36324
+ }
36309
36325
  )[]
36310
36326
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
36311
36327
  custom_metadata: {
@@ -36492,6 +36508,14 @@ export type Routes = {
36492
36508
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36493
36509
  warning_code: 'being_deleted'
36494
36510
  }
36511
+ | {
36512
+ /** Date and time at which Seam created the warning. */
36513
+ created_at: string
36514
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36515
+ message: string
36516
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36517
+ warning_code: 'provider_service_unavailable'
36518
+ }
36495
36519
  )[]
36496
36520
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
36497
36521
  custom_metadata: {
@@ -36718,6 +36742,14 @@ export type Routes = {
36718
36742
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36719
36743
  warning_code: 'being_deleted'
36720
36744
  }
36745
+ | {
36746
+ /** Date and time at which Seam created the warning. */
36747
+ created_at: string
36748
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36749
+ message: string
36750
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
36751
+ warning_code: 'provider_service_unavailable'
36752
+ }
36721
36753
  )[]
36722
36754
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
36723
36755
  custom_metadata: {
@@ -82239,6 +82271,8 @@ export type Routes = {
82239
82271
  customer_key?: string | undefined
82240
82272
  /** Collection key. */
82241
82273
  collection_key?: string | undefined
82274
+ /** Connected account to scope auto-mapping to. Filters partner resources by the matching connector and limits available devices/entrances to this account. */
82275
+ connected_account_id?: string | undefined
82242
82276
  }
82243
82277
  formData: {}
82244
82278
  jsonResponse: {
@@ -84528,6 +84562,14 @@ export type Routes = {
84528
84562
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84529
84563
  warning_code: 'being_deleted'
84530
84564
  }
84565
+ | {
84566
+ /** Date and time at which Seam created the warning. */
84567
+ created_at: string
84568
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84569
+ message: string
84570
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84571
+ warning_code: 'provider_service_unavailable'
84572
+ }
84531
84573
  )[]
84532
84574
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
84533
84575
  custom_metadata: {
@@ -115558,6 +115600,14 @@ export type Routes = {
115558
115600
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115559
115601
  warning_code: 'being_deleted'
115560
115602
  }
115603
+ | {
115604
+ /** Date and time at which Seam created the warning. */
115605
+ created_at: string
115606
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115607
+ message: string
115608
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115609
+ warning_code: 'provider_service_unavailable'
115610
+ }
115561
115611
  )[]
115562
115612
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
115563
115613
  custom_metadata: {