@seamapi/types 1.404.0 → 1.404.1
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/dist/connect.cjs +109 -32
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +91 -2
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +55 -15
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/custom-metadata.js +5 -2
- package/lib/seam/connect/models/custom-metadata.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +23 -0
- package/lib/seam/connect/openapi.js +65 -13
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +68 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +79 -15
- package/src/lib/seam/connect/models/custom-metadata.ts +8 -4
- package/src/lib/seam/connect/openapi.ts +82 -13
- package/src/lib/seam/connect/route-types.ts +68 -2
|
@@ -6450,39 +6450,62 @@ export default {
|
|
|
6450
6450
|
'x-deprecated': 'Unused. Will be removed.',
|
|
6451
6451
|
'x-undocumented': 'Unused. Will be removed.',
|
|
6452
6452
|
},
|
|
6453
|
-
accepted_providers: {
|
|
6453
|
+
accepted_providers: {
|
|
6454
|
+
description: 'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
6455
|
+
items: { type: 'string' },
|
|
6456
|
+
type: 'array',
|
|
6457
|
+
},
|
|
6454
6458
|
any_device_allowed: {
|
|
6455
6459
|
deprecated: true,
|
|
6456
6460
|
type: 'boolean',
|
|
6457
6461
|
'x-deprecated': 'Unused. Will be removed.',
|
|
6458
6462
|
'x-undocumented': 'Unused. Will be removed.',
|
|
6459
6463
|
},
|
|
6460
|
-
any_provider_allowed: {
|
|
6464
|
+
any_provider_allowed: {
|
|
6465
|
+
description: 'Indicates whether any provider is allowed.',
|
|
6466
|
+
type: 'boolean',
|
|
6467
|
+
},
|
|
6461
6468
|
authorized_at: {
|
|
6469
|
+
description: 'Date and time at which the user authorized (through the Connect Webview) the management of their devices.',
|
|
6462
6470
|
format: 'date-time',
|
|
6463
6471
|
nullable: true,
|
|
6464
6472
|
type: 'string',
|
|
6465
6473
|
},
|
|
6466
|
-
automatically_manage_new_devices: {
|
|
6467
|
-
|
|
6474
|
+
automatically_manage_new_devices: {
|
|
6475
|
+
description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
|
|
6476
|
+
type: 'boolean',
|
|
6477
|
+
},
|
|
6478
|
+
connect_webview_id: {
|
|
6479
|
+
description: 'ID of the Connect Webview.',
|
|
6480
|
+
format: 'uuid',
|
|
6481
|
+
type: 'string',
|
|
6482
|
+
},
|
|
6468
6483
|
connected_account_id: {
|
|
6484
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.',
|
|
6469
6485
|
format: 'uuid',
|
|
6470
6486
|
nullable: true,
|
|
6471
6487
|
type: 'string',
|
|
6472
6488
|
},
|
|
6473
|
-
created_at: {
|
|
6489
|
+
created_at: {
|
|
6490
|
+
description: 'Date and time at which the Connect Webview was created.',
|
|
6491
|
+
format: 'date-time',
|
|
6492
|
+
type: 'string',
|
|
6493
|
+
},
|
|
6474
6494
|
custom_metadata: {
|
|
6475
6495
|
additionalProperties: {
|
|
6476
6496
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6477
6497
|
},
|
|
6498
|
+
description: '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.',
|
|
6478
6499
|
type: 'object',
|
|
6479
6500
|
},
|
|
6480
6501
|
custom_redirect_failure_url: {
|
|
6502
|
+
description: 'URL to which the Connect Webview should redirect when an unexpected error occurs.',
|
|
6481
6503
|
format: 'uri',
|
|
6482
6504
|
nullable: true,
|
|
6483
6505
|
type: 'string',
|
|
6484
6506
|
},
|
|
6485
6507
|
custom_redirect_url: {
|
|
6508
|
+
description: 'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.',
|
|
6486
6509
|
format: 'uri',
|
|
6487
6510
|
nullable: true,
|
|
6488
6511
|
type: 'string',
|
|
@@ -6491,12 +6514,34 @@ export default {
|
|
|
6491
6514
|
enum: ['none', 'single', 'multiple'],
|
|
6492
6515
|
type: 'string',
|
|
6493
6516
|
},
|
|
6494
|
-
login_successful: {
|
|
6495
|
-
|
|
6496
|
-
|
|
6497
|
-
|
|
6498
|
-
|
|
6499
|
-
|
|
6517
|
+
login_successful: {
|
|
6518
|
+
description: 'Indicates whether the user logged in successfully using the Connect Webview.',
|
|
6519
|
+
type: 'boolean',
|
|
6520
|
+
},
|
|
6521
|
+
selected_provider: {
|
|
6522
|
+
description: 'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
6523
|
+
nullable: true,
|
|
6524
|
+
type: 'string',
|
|
6525
|
+
},
|
|
6526
|
+
status: {
|
|
6527
|
+
description: 'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.',
|
|
6528
|
+
enum: ['pending', 'failed', 'authorized'],
|
|
6529
|
+
type: 'string',
|
|
6530
|
+
},
|
|
6531
|
+
url: {
|
|
6532
|
+
description: 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
|
|
6533
|
+
format: 'uri',
|
|
6534
|
+
type: 'string',
|
|
6535
|
+
},
|
|
6536
|
+
wait_for_device_creation: {
|
|
6537
|
+
description: 'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
|
|
6538
|
+
type: 'boolean',
|
|
6539
|
+
},
|
|
6540
|
+
workspace_id: {
|
|
6541
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.',
|
|
6542
|
+
format: 'uuid',
|
|
6543
|
+
type: 'string',
|
|
6544
|
+
},
|
|
6500
6545
|
},
|
|
6501
6546
|
required: [
|
|
6502
6547
|
'connect_webview_id',
|
|
@@ -6534,6 +6579,7 @@ export default {
|
|
|
6534
6579
|
additionalProperties: {
|
|
6535
6580
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6536
6581
|
},
|
|
6582
|
+
description: '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.',
|
|
6537
6583
|
type: 'object',
|
|
6538
6584
|
},
|
|
6539
6585
|
errors: {
|
|
@@ -6821,6 +6867,7 @@ export default {
|
|
|
6821
6867
|
additionalProperties: {
|
|
6822
6868
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
6823
6869
|
},
|
|
6870
|
+
description: '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.',
|
|
6824
6871
|
type: 'object',
|
|
6825
6872
|
},
|
|
6826
6873
|
device_id: {
|
|
@@ -22903,12 +22950,17 @@ export default {
|
|
|
22903
22950
|
type: 'string',
|
|
22904
22951
|
},
|
|
22905
22952
|
acs_user_id: {
|
|
22906
|
-
description: 'ID of the access system user that you want to remove from an access group.',
|
|
22953
|
+
description: 'ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
|
|
22954
|
+
format: 'uuid',
|
|
22955
|
+
type: 'string',
|
|
22956
|
+
},
|
|
22957
|
+
user_identity_id: {
|
|
22958
|
+
description: 'ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
|
|
22907
22959
|
format: 'uuid',
|
|
22908
22960
|
type: 'string',
|
|
22909
22961
|
},
|
|
22910
22962
|
},
|
|
22911
|
-
required: ['
|
|
22963
|
+
required: ['acs_access_group_id'],
|
|
22912
22964
|
type: 'object',
|
|
22913
22965
|
},
|
|
22914
22966
|
},
|