@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.
package/dist/connect.cjs CHANGED
@@ -5109,6 +5109,28 @@ var magic_link = zod.z.object({
5109
5109
  route_path: /unstable_partner/building_blocks
5110
5110
  ---
5111
5111
  `);
5112
+ var common_user_identity_error = zod.z.object({
5113
+ created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
5114
+ message: zod.z.string().describe(
5115
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
5116
+ )
5117
+ });
5118
+ var common_user_identity_warning = zod.z.object({
5119
+ created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
5120
+ message: zod.z.string().describe(
5121
+ "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
5122
+ )
5123
+ });
5124
+ var user_identity_being_deleted = common_user_identity_warning.extend({
5125
+ warning_code: zod.z.literal("being_deleted").describe(
5126
+ "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue."
5127
+ )
5128
+ }).describe("Indicates that the user identity is currently being deleted.");
5129
+ zod.z.object({});
5130
+ var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [user_identity_being_deleted]).describe("Warnings associated with the user identity.");
5131
+ zod.z.object({
5132
+ user_identity_being_deleted: user_identity_being_deleted.optional().nullable()
5133
+ });
5112
5134
  var user_identity = zod.z.object({
5113
5135
  user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
5114
5136
  user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
@@ -5121,6 +5143,12 @@ var user_identity = zod.z.object({
5121
5143
  created_at: zod.z.string().datetime().describe("Date and time at which the user identity was created."),
5122
5144
  workspace_id: zod.z.string().uuid().describe(
5123
5145
  "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
5146
+ ),
5147
+ errors: zod.z.array(common_user_identity_error).describe(
5148
+ '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.'
5149
+ ),
5150
+ warnings: zod.z.array(user_identity_warnings).describe(
5151
+ '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.'
5124
5152
  )
5125
5153
  }).describe(`
5126
5154
  ---
@@ -20192,11 +20220,7 @@ var openapi_default = {
20192
20220
  enum: ["code", "card", "mobile_key"],
20193
20221
  type: "string"
20194
20222
  },
20195
- acs_credential_id: {
20196
- description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
20197
- format: "uuid",
20198
- type: "string"
20199
- },
20223
+ acs_credential_id: { type: "string" },
20200
20224
  acs_credential_pool_id: {
20201
20225
  format: "uuid",
20202
20226
  type: "string"
@@ -20684,7 +20708,6 @@ var openapi_default = {
20684
20708
  }
20685
20709
  },
20686
20710
  required: [
20687
- "acs_credential_id",
20688
20711
  "acs_system_id",
20689
20712
  "display_name",
20690
20713
  "access_method",
@@ -24117,6 +24140,25 @@ var openapi_default = {
24117
24140
  nullable: true,
24118
24141
  type: "string"
24119
24142
  },
24143
+ errors: {
24144
+ 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.',
24145
+ items: {
24146
+ properties: {
24147
+ created_at: {
24148
+ description: "Date and time at which Seam created the error.",
24149
+ format: "date-time",
24150
+ type: "string"
24151
+ },
24152
+ message: {
24153
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
24154
+ type: "string"
24155
+ }
24156
+ },
24157
+ required: ["created_at", "message"],
24158
+ type: "object"
24159
+ },
24160
+ type: "array"
24161
+ },
24120
24162
  full_name: { minLength: 1, nullable: true, type: "string" },
24121
24163
  phone_number: {
24122
24164
  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).",
@@ -24134,6 +24176,37 @@ var openapi_default = {
24134
24176
  nullable: true,
24135
24177
  type: "string"
24136
24178
  },
24179
+ warnings: {
24180
+ 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.',
24181
+ items: {
24182
+ description: "Warnings associated with the user identity.",
24183
+ discriminator: { propertyName: "warning_code" },
24184
+ oneOf: [
24185
+ {
24186
+ description: "Indicates that the user identity is currently being deleted.",
24187
+ properties: {
24188
+ created_at: {
24189
+ description: "Date and time at which Seam created the warning.",
24190
+ format: "date-time",
24191
+ type: "string"
24192
+ },
24193
+ message: {
24194
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
24195
+ type: "string"
24196
+ },
24197
+ warning_code: {
24198
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
24199
+ enum: ["being_deleted"],
24200
+ type: "string"
24201
+ }
24202
+ },
24203
+ required: ["created_at", "message", "warning_code"],
24204
+ type: "object"
24205
+ }
24206
+ ]
24207
+ },
24208
+ type: "array"
24209
+ },
24137
24210
  workspace_id: {
24138
24211
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
24139
24212
  format: "uuid",
@@ -24148,7 +24221,9 @@ var openapi_default = {
24148
24221
  "display_name",
24149
24222
  "full_name",
24150
24223
  "created_at",
24151
- "workspace_id"
24224
+ "workspace_id",
24225
+ "errors",
24226
+ "warnings"
24152
24227
  ],
24153
24228
  type: "object",
24154
24229
  "x-route-path": "/user_identities"
@@ -29135,6 +29210,16 @@ var openapi_default = {
29135
29210
  "application/json": {
29136
29211
  schema: {
29137
29212
  properties: {
29213
+ access_grant_id: {
29214
+ description: "ID of the access grant for which you want to retrieve all entrances.",
29215
+ format: "uuid",
29216
+ type: "string"
29217
+ },
29218
+ access_method_id: {
29219
+ description: "ID of the access method for which you want to retrieve all entrances.",
29220
+ format: "uuid",
29221
+ type: "string"
29222
+ },
29138
29223
  acs_credential_id: {
29139
29224
  description: "ID of the credential for which you want to retrieve all entrances.",
29140
29225
  format: "uuid",
@@ -42139,7 +42224,7 @@ var openapi_default = {
42139
42224
  },
42140
42225
  "/user_identities/delete": {
42141
42226
  post: {
42142
- 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.",
42227
+ 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).",
42143
42228
  operationId: "userIdentitiesDeletePost",
42144
42229
  requestBody: {
42145
42230
  content: {