@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.
@@ -16969,6 +16969,10 @@ export interface Routes {
16969
16969
  location_id?: (string | null) | undefined
16970
16970
  /** ID of the space for which you want to list entrances. */
16971
16971
  space_id?: string | undefined
16972
+ /** ID of the access grant for which you want to retrieve all entrances. */
16973
+ access_grant_id?: string | undefined
16974
+ /** ID of the access method for which you want to retrieve all entrances. */
16975
+ access_method_id?: string | undefined
16972
16976
  }
16973
16977
  formData: {}
16974
16978
  jsonResponse: {
@@ -21862,8 +21866,11 @@ export interface Routes {
21862
21866
  connect_webview_ids?: string[] | undefined
21863
21867
  /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
21864
21868
  connected_account_ids?: string[] | undefined
21865
- /** 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) for which you want to create a client session. */
21869
+ /** 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.
21870
+ * @deprecated Use `user_identity_id`. */
21866
21871
  user_identity_ids?: string[] | undefined
21872
+ /** 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. */
21873
+ user_identity_id?: string | undefined
21867
21874
  /** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21868
21875
  expires_at?: Date | undefined
21869
21876
  }
@@ -21890,7 +21897,9 @@ export interface Routes {
21890
21897
  customer_id?: string | undefined
21891
21898
  connected_account_ids: string[]
21892
21899
  connect_webview_ids: string[]
21900
+ /** deprecated: Use `user_identity_id`. */
21893
21901
  user_identity_ids: string[]
21902
+ user_identity_id?: string | undefined
21894
21903
  }
21895
21904
  }
21896
21905
  }
@@ -21939,7 +21948,9 @@ export interface Routes {
21939
21948
  customer_id?: string | undefined
21940
21949
  connected_account_ids: string[]
21941
21950
  connect_webview_ids: string[]
21951
+ /** deprecated: Use `user_identity_id`. */
21942
21952
  user_identity_ids: string[]
21953
+ user_identity_id?: string | undefined
21943
21954
  }
21944
21955
  }
21945
21956
  }
@@ -21954,8 +21965,11 @@ export interface Routes {
21954
21965
  connect_webview_ids?: string[] | undefined
21955
21966
  /** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
21956
21967
  connected_account_ids?: string[] | undefined
21957
- /** 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 (or that are already associated with the existing client session). */
21968
+ /** 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.
21969
+ * @deprecated Use `user_identity_id`. */
21958
21970
  user_identity_ids?: string[] | undefined
21971
+ /** 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). */
21972
+ user_identity_id?: string | undefined
21959
21973
  /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21960
21974
  expires_at?: Date | undefined
21961
21975
  }
@@ -21982,7 +21996,9 @@ export interface Routes {
21982
21996
  customer_id?: string | undefined
21983
21997
  connected_account_ids: string[]
21984
21998
  connect_webview_ids: string[]
21999
+ /** deprecated: Use `user_identity_id`. */
21985
22000
  user_identity_ids: string[]
22001
+ user_identity_id?: string | undefined
21986
22002
  }
21987
22003
  }
21988
22004
  }
@@ -22000,8 +22016,11 @@ export interface Routes {
22000
22016
  connected_account_ids?: string[] | undefined
22001
22017
  /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
22002
22018
  connect_webview_ids?: string[] | undefined
22003
- /** 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. */
22019
+ /** 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.
22020
+ * @deprecated Use `user_identity_id`. */
22004
22021
  user_identity_ids?: string[] | undefined
22022
+ /** 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. */
22023
+ user_identity_id?: string | undefined
22005
22024
  }
22006
22025
  formData: {}
22007
22026
  jsonResponse: {
@@ -22025,7 +22044,9 @@ export interface Routes {
22025
22044
  customer_id?: string | undefined
22026
22045
  connected_account_ids: string[]
22027
22046
  connect_webview_ids: string[]
22047
+ /** deprecated: Use `user_identity_id`. */
22028
22048
  user_identity_ids: string[]
22049
+ user_identity_id?: string | undefined
22029
22050
  }
22030
22051
  }
22031
22052
  }
@@ -22059,7 +22080,9 @@ export interface Routes {
22059
22080
  customer_id?: string | undefined
22060
22081
  connected_account_ids: string[]
22061
22082
  connect_webview_ids: string[]
22083
+ /** deprecated: Use `user_identity_id`. */
22062
22084
  user_identity_ids: string[]
22085
+ user_identity_id?: string | undefined
22063
22086
  }>
22064
22087
  }
22065
22088
  }
@@ -49120,7 +49143,9 @@ export interface Routes {
49120
49143
  customer_id?: string | undefined
49121
49144
  connected_account_ids: string[]
49122
49145
  connect_webview_ids: string[]
49146
+ /** deprecated: Use `user_identity_id`. */
49123
49147
  user_identity_ids: string[]
49148
+ user_identity_id?: string | undefined
49124
49149
  }
49125
49150
  }
49126
49151
  }
@@ -49305,8 +49330,6 @@ export interface Routes {
49305
49330
  is_being_activated: boolean
49306
49331
  }
49307
49332
  acs_credentials: Array<{
49308
- /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
49309
- acs_credential_id: string
49310
49333
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
49311
49334
  acs_user_id?: string | undefined
49312
49335
  acs_credential_pool_id?: string | undefined
@@ -49442,6 +49465,7 @@ export interface Routes {
49442
49465
  }
49443
49466
  | undefined
49444
49467
  is_managed: true
49468
+ acs_credential_id?: string | undefined
49445
49469
  acs_entrances: Array<{
49446
49470
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
49447
49471
  acs_system_id: string
@@ -67170,6 +67194,22 @@ export interface Routes {
67170
67194
  created_at: string
67171
67195
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
67172
67196
  workspace_id: string
67197
+ /** 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. */
67198
+ errors: Array<{
67199
+ /** Date and time at which Seam created the error. */
67200
+ created_at: string
67201
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
67202
+ message: string
67203
+ }>
67204
+ /** 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. */
67205
+ warnings: Array<{
67206
+ /** Date and time at which Seam created the warning. */
67207
+ created_at: string
67208
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
67209
+ message: string
67210
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
67211
+ warning_code: 'being_deleted'
67212
+ }>
67173
67213
  }
67174
67214
  }
67175
67215
  }
@@ -67333,6 +67373,22 @@ export interface Routes {
67333
67373
  created_at: string
67334
67374
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
67335
67375
  workspace_id: string
67376
+ /** 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. */
67377
+ errors: Array<{
67378
+ /** Date and time at which Seam created the error. */
67379
+ created_at: string
67380
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
67381
+ message: string
67382
+ }>
67383
+ /** 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. */
67384
+ warnings: Array<{
67385
+ /** Date and time at which Seam created the warning. */
67386
+ created_at: string
67387
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
67388
+ message: string
67389
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
67390
+ warning_code: 'being_deleted'
67391
+ }>
67336
67392
  }
67337
67393
  }
67338
67394
  }
@@ -67376,6 +67432,22 @@ export interface Routes {
67376
67432
  created_at: string
67377
67433
  /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
67378
67434
  workspace_id: string
67435
+ /** 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. */
67436
+ errors: Array<{
67437
+ /** Date and time at which Seam created the error. */
67438
+ created_at: string
67439
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
67440
+ message: string
67441
+ }>
67442
+ /** 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. */
67443
+ warnings: Array<{
67444
+ /** Date and time at which Seam created the warning. */
67445
+ created_at: string
67446
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
67447
+ message: string
67448
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
67449
+ warning_code: 'being_deleted'
67450
+ }>
67379
67451
  }>
67380
67452
  }
67381
67453
  }