@seamapi/types 1.412.0 → 1.414.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/dist/connect.cjs +145 -17
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +227 -7
- package/lib/seam/connect/models/client-sessions/client-session.d.ts +3 -0
- package/lib/seam/connect/models/client-sessions/client-session.js +4 -1
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -14
- package/lib/seam/connect/models/phones/phone-session.js +4 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +73 -0
- package/lib/seam/connect/models/user-identities/user-identity.js +40 -0
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +105 -2
- package/lib/seam/connect/openapi.js +109 -10
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +77 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +4 -1
- package/src/lib/seam/connect/models/phones/phone-session.ts +4 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +60 -0
- package/src/lib/seam/connect/openapi.ts +123 -11
- package/src/lib/seam/connect/route-types.ts +77 -5
|
@@ -6597,7 +6597,9 @@ export default {
|
|
|
6597
6597
|
expires_at: { format: 'date-time', type: 'string' },
|
|
6598
6598
|
token: { type: 'string' },
|
|
6599
6599
|
user_identifier_key: { nullable: true, type: 'string' },
|
|
6600
|
+
user_identity_id: { format: 'uuid', type: 'string' },
|
|
6600
6601
|
user_identity_ids: {
|
|
6602
|
+
description: 'deprecated: Use `user_identity_id`.',
|
|
6601
6603
|
items: { format: 'uuid', type: 'string' },
|
|
6602
6604
|
type: 'array',
|
|
6603
6605
|
},
|
|
@@ -15014,11 +15016,7 @@ export default {
|
|
|
15014
15016
|
enum: ['code', 'card', 'mobile_key'],
|
|
15015
15017
|
type: 'string',
|
|
15016
15018
|
},
|
|
15017
|
-
acs_credential_id: {
|
|
15018
|
-
description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
15019
|
-
format: 'uuid',
|
|
15020
|
-
type: 'string',
|
|
15021
|
-
},
|
|
15019
|
+
acs_credential_id: { type: 'string' },
|
|
15022
15020
|
acs_credential_pool_id: {
|
|
15023
15021
|
format: 'uuid',
|
|
15024
15022
|
type: 'string',
|
|
@@ -15506,7 +15504,6 @@ export default {
|
|
|
15506
15504
|
},
|
|
15507
15505
|
},
|
|
15508
15506
|
required: [
|
|
15509
|
-
'acs_credential_id',
|
|
15510
15507
|
'acs_system_id',
|
|
15511
15508
|
'display_name',
|
|
15512
15509
|
'access_method',
|
|
@@ -18939,6 +18936,25 @@ export default {
|
|
|
18939
18936
|
nullable: true,
|
|
18940
18937
|
type: 'string',
|
|
18941
18938
|
},
|
|
18939
|
+
errors: {
|
|
18940
|
+
description: 'Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
18941
|
+
items: {
|
|
18942
|
+
properties: {
|
|
18943
|
+
created_at: {
|
|
18944
|
+
description: 'Date and time at which Seam created the error.',
|
|
18945
|
+
format: 'date-time',
|
|
18946
|
+
type: 'string',
|
|
18947
|
+
},
|
|
18948
|
+
message: {
|
|
18949
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18950
|
+
type: 'string',
|
|
18951
|
+
},
|
|
18952
|
+
},
|
|
18953
|
+
required: ['created_at', 'message'],
|
|
18954
|
+
type: 'object',
|
|
18955
|
+
},
|
|
18956
|
+
type: 'array',
|
|
18957
|
+
},
|
|
18942
18958
|
full_name: { minLength: 1, nullable: true, type: 'string' },
|
|
18943
18959
|
phone_number: {
|
|
18944
18960
|
description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
@@ -18956,6 +18972,37 @@ export default {
|
|
|
18956
18972
|
nullable: true,
|
|
18957
18973
|
type: 'string',
|
|
18958
18974
|
},
|
|
18975
|
+
warnings: {
|
|
18976
|
+
description: '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.',
|
|
18977
|
+
items: {
|
|
18978
|
+
description: 'Warnings associated with the user identity.',
|
|
18979
|
+
discriminator: { propertyName: 'warning_code' },
|
|
18980
|
+
oneOf: [
|
|
18981
|
+
{
|
|
18982
|
+
description: 'Indicates that the user identity is currently being deleted.',
|
|
18983
|
+
properties: {
|
|
18984
|
+
created_at: {
|
|
18985
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18986
|
+
format: 'date-time',
|
|
18987
|
+
type: 'string',
|
|
18988
|
+
},
|
|
18989
|
+
message: {
|
|
18990
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18991
|
+
type: 'string',
|
|
18992
|
+
},
|
|
18993
|
+
warning_code: {
|
|
18994
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18995
|
+
enum: ['being_deleted'],
|
|
18996
|
+
type: 'string',
|
|
18997
|
+
},
|
|
18998
|
+
},
|
|
18999
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
19000
|
+
type: 'object',
|
|
19001
|
+
},
|
|
19002
|
+
],
|
|
19003
|
+
},
|
|
19004
|
+
type: 'array',
|
|
19005
|
+
},
|
|
18959
19006
|
workspace_id: {
|
|
18960
19007
|
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
18961
19008
|
format: 'uuid',
|
|
@@ -18971,6 +19018,8 @@ export default {
|
|
|
18971
19018
|
'full_name',
|
|
18972
19019
|
'created_at',
|
|
18973
19020
|
'workspace_id',
|
|
19021
|
+
'errors',
|
|
19022
|
+
'warnings',
|
|
18974
19023
|
],
|
|
18975
19024
|
type: 'object',
|
|
18976
19025
|
'x-route-path': '/user_identities',
|
|
@@ -23957,6 +24006,16 @@ export default {
|
|
|
23957
24006
|
'application/json': {
|
|
23958
24007
|
schema: {
|
|
23959
24008
|
properties: {
|
|
24009
|
+
access_grant_id: {
|
|
24010
|
+
description: 'ID of the access grant for which you want to retrieve all entrances.',
|
|
24011
|
+
format: 'uuid',
|
|
24012
|
+
type: 'string',
|
|
24013
|
+
},
|
|
24014
|
+
access_method_id: {
|
|
24015
|
+
description: 'ID of the access method for which you want to retrieve all entrances.',
|
|
24016
|
+
format: 'uuid',
|
|
24017
|
+
type: 'string',
|
|
24018
|
+
},
|
|
23960
24019
|
acs_credential_id: {
|
|
23961
24020
|
description: 'ID of the credential for which you want to retrieve all entrances.',
|
|
23962
24021
|
format: 'uuid',
|
|
@@ -25577,10 +25636,18 @@ export default {
|
|
|
25577
25636
|
minLength: 1,
|
|
25578
25637
|
type: 'string',
|
|
25579
25638
|
},
|
|
25639
|
+
user_identity_id: {
|
|
25640
|
+
description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
|
|
25641
|
+
type: 'string',
|
|
25642
|
+
},
|
|
25580
25643
|
user_identity_ids: {
|
|
25581
|
-
|
|
25644
|
+
deprecated: true,
|
|
25645
|
+
description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25582
25646
|
items: { type: 'string' },
|
|
25647
|
+
maxItems: 1,
|
|
25648
|
+
minItems: 1,
|
|
25583
25649
|
type: 'array',
|
|
25650
|
+
'x-deprecated': 'Use `user_identity_id`.',
|
|
25584
25651
|
},
|
|
25585
25652
|
},
|
|
25586
25653
|
type: 'object',
|
|
@@ -25653,10 +25720,18 @@ export default {
|
|
|
25653
25720
|
minLength: 1,
|
|
25654
25721
|
type: 'string',
|
|
25655
25722
|
},
|
|
25723
|
+
user_identity_id: {
|
|
25724
|
+
description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
|
|
25725
|
+
type: 'string',
|
|
25726
|
+
},
|
|
25656
25727
|
user_identity_ids: {
|
|
25657
|
-
|
|
25728
|
+
deprecated: true,
|
|
25729
|
+
description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25658
25730
|
items: { type: 'string' },
|
|
25731
|
+
maxItems: 1,
|
|
25732
|
+
minItems: 1,
|
|
25659
25733
|
type: 'array',
|
|
25734
|
+
'x-deprecated': 'Use `user_identity_id`.',
|
|
25660
25735
|
},
|
|
25661
25736
|
},
|
|
25662
25737
|
type: 'object',
|
|
@@ -25836,10 +25911,18 @@ export default {
|
|
|
25836
25911
|
minLength: 1,
|
|
25837
25912
|
type: 'string',
|
|
25838
25913
|
},
|
|
25914
|
+
user_identity_id: {
|
|
25915
|
+
description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).',
|
|
25916
|
+
type: 'string',
|
|
25917
|
+
},
|
|
25839
25918
|
user_identity_ids: {
|
|
25840
|
-
|
|
25919
|
+
deprecated: true,
|
|
25920
|
+
description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25841
25921
|
items: { type: 'string' },
|
|
25922
|
+
maxItems: 1,
|
|
25923
|
+
minItems: 1,
|
|
25842
25924
|
type: 'array',
|
|
25925
|
+
'x-deprecated': 'Use `user_identity_id`.',
|
|
25843
25926
|
},
|
|
25844
25927
|
},
|
|
25845
25928
|
type: 'object',
|
|
@@ -25910,10 +25993,18 @@ export default {
|
|
|
25910
25993
|
description: 'Your user ID for the user that you want to associate with the client session.',
|
|
25911
25994
|
type: 'string',
|
|
25912
25995
|
},
|
|
25996
|
+
user_identity_id: {
|
|
25997
|
+
description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25998
|
+
type: 'string',
|
|
25999
|
+
},
|
|
25913
26000
|
user_identity_ids: {
|
|
26001
|
+
deprecated: true,
|
|
25914
26002
|
description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25915
26003
|
items: { type: 'string' },
|
|
26004
|
+
maxItems: 1,
|
|
26005
|
+
minItems: 1,
|
|
25916
26006
|
type: 'array',
|
|
26007
|
+
'x-deprecated': 'Use `user_identity_id`.',
|
|
25917
26008
|
},
|
|
25918
26009
|
},
|
|
25919
26010
|
type: 'object',
|
|
@@ -25979,10 +26070,18 @@ export default {
|
|
|
25979
26070
|
description: 'Your user ID for the user that you want to associate with the client session.',
|
|
25980
26071
|
type: 'string',
|
|
25981
26072
|
},
|
|
26073
|
+
user_identity_id: {
|
|
26074
|
+
description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
26075
|
+
type: 'string',
|
|
26076
|
+
},
|
|
25982
26077
|
user_identity_ids: {
|
|
26078
|
+
deprecated: true,
|
|
25983
26079
|
description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25984
26080
|
items: { type: 'string' },
|
|
26081
|
+
maxItems: 1,
|
|
26082
|
+
minItems: 1,
|
|
25985
26083
|
type: 'array',
|
|
26084
|
+
'x-deprecated': 'Use `user_identity_id`.',
|
|
25986
26085
|
},
|
|
25987
26086
|
},
|
|
25988
26087
|
type: 'object',
|
|
@@ -36921,7 +37020,7 @@ export default {
|
|
|
36921
37020
|
},
|
|
36922
37021
|
'/user_identities/delete': {
|
|
36923
37022
|
post: {
|
|
36924
|
-
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
37023
|
+
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
|
|
36925
37024
|
operationId: 'userIdentitiesDeletePost',
|
|
36926
37025
|
requestBody: {
|
|
36927
37026
|
content: {
|