@seamapi/types 1.413.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.
Files changed (18) hide show
  1. package/dist/connect.cjs +93 -8
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +155 -4
  4. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -14
  5. package/lib/seam/connect/models/phones/phone-session.js +4 -0
  6. package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
  7. package/lib/seam/connect/models/user-identities/user-identity.d.ts +73 -0
  8. package/lib/seam/connect/models/user-identities/user-identity.js +40 -0
  9. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  10. package/lib/seam/connect/openapi.d.ts +60 -2
  11. package/lib/seam/connect/openapi.js +64 -7
  12. package/lib/seam/connect/openapi.js.map +1 -1
  13. package/lib/seam/connect/route-types.d.ts +53 -2
  14. package/package.json +1 -1
  15. package/src/lib/seam/connect/models/phones/phone-session.ts +4 -0
  16. package/src/lib/seam/connect/models/user-identities/user-identity.ts +60 -0
  17. package/src/lib/seam/connect/openapi.ts +73 -8
  18. package/src/lib/seam/connect/route-types.ts +53 -2
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -9075,8 +9075,6 @@ declare const _default: {
9075
9075
  type: string;
9076
9076
  };
9077
9077
  acs_credential_id: {
9078
- description: string;
9079
- format: string;
9080
9078
  type: string;
9081
9079
  };
9082
9080
  acs_credential_pool_id: {
@@ -11027,6 +11025,25 @@ declare const _default: {
11027
11025
  nullable: boolean;
11028
11026
  type: string;
11029
11027
  };
11028
+ errors: {
11029
+ description: string;
11030
+ items: {
11031
+ properties: {
11032
+ created_at: {
11033
+ description: string;
11034
+ format: string;
11035
+ type: string;
11036
+ };
11037
+ message: {
11038
+ description: string;
11039
+ type: string;
11040
+ };
11041
+ };
11042
+ required: string[];
11043
+ type: string;
11044
+ };
11045
+ type: string;
11046
+ };
11030
11047
  full_name: {
11031
11048
  minLength: number;
11032
11049
  nullable: boolean;
@@ -11048,6 +11065,37 @@ declare const _default: {
11048
11065
  nullable: boolean;
11049
11066
  type: string;
11050
11067
  };
11068
+ warnings: {
11069
+ description: string;
11070
+ items: {
11071
+ description: string;
11072
+ discriminator: {
11073
+ propertyName: string;
11074
+ };
11075
+ oneOf: {
11076
+ description: string;
11077
+ properties: {
11078
+ created_at: {
11079
+ description: string;
11080
+ format: string;
11081
+ type: string;
11082
+ };
11083
+ message: {
11084
+ description: string;
11085
+ type: string;
11086
+ };
11087
+ warning_code: {
11088
+ description: string;
11089
+ enum: string[];
11090
+ type: string;
11091
+ };
11092
+ };
11093
+ required: string[];
11094
+ type: string;
11095
+ }[];
11096
+ };
11097
+ type: string;
11098
+ };
11051
11099
  workspace_id: {
11052
11100
  description: string;
11053
11101
  format: string;
@@ -17379,6 +17427,16 @@ declare const _default: {
17379
17427
  'application/json': {
17380
17428
  schema: {
17381
17429
  properties: {
17430
+ access_grant_id: {
17431
+ description: string;
17432
+ format: string;
17433
+ type: string;
17434
+ };
17435
+ access_method_id: {
17436
+ description: string;
17437
+ format: string;
17438
+ type: string;
17439
+ };
17382
17440
  acs_credential_id: {
17383
17441
  description: string;
17384
17442
  format: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -15016,11 +15016,7 @@ export default {
15016
15016
  enum: ['code', 'card', 'mobile_key'],
15017
15017
  type: 'string',
15018
15018
  },
15019
- acs_credential_id: {
15020
- description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
15021
- format: 'uuid',
15022
- type: 'string',
15023
- },
15019
+ acs_credential_id: { type: 'string' },
15024
15020
  acs_credential_pool_id: {
15025
15021
  format: 'uuid',
15026
15022
  type: 'string',
@@ -15508,7 +15504,6 @@ export default {
15508
15504
  },
15509
15505
  },
15510
15506
  required: [
15511
- 'acs_credential_id',
15512
15507
  'acs_system_id',
15513
15508
  'display_name',
15514
15509
  'access_method',
@@ -18941,6 +18936,25 @@ export default {
18941
18936
  nullable: true,
18942
18937
  type: 'string',
18943
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
+ },
18944
18958
  full_name: { minLength: 1, nullable: true, type: 'string' },
18945
18959
  phone_number: {
18946
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).',
@@ -18958,6 +18972,37 @@ export default {
18958
18972
  nullable: true,
18959
18973
  type: 'string',
18960
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
+ },
18961
19006
  workspace_id: {
18962
19007
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
18963
19008
  format: 'uuid',
@@ -18973,6 +19018,8 @@ export default {
18973
19018
  'full_name',
18974
19019
  'created_at',
18975
19020
  'workspace_id',
19021
+ 'errors',
19022
+ 'warnings',
18976
19023
  ],
18977
19024
  type: 'object',
18978
19025
  'x-route-path': '/user_identities',
@@ -23959,6 +24006,16 @@ export default {
23959
24006
  'application/json': {
23960
24007
  schema: {
23961
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
+ },
23962
24019
  acs_credential_id: {
23963
24020
  description: 'ID of the credential for which you want to retrieve all entrances.',
23964
24021
  format: 'uuid',
@@ -36963,7 +37020,7 @@ export default {
36963
37020
  },
36964
37021
  '/user_identities/delete': {
36965
37022
  post: {
36966
- 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). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.',
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).',
36967
37024
  operationId: 'userIdentitiesDeletePost',
36968
37025
  requestBody: {
36969
37026
  content: {