@seamapi/types 1.322.3 → 1.323.0

package/dist/connect.cjs

@@ -1738,6 +1738,24 @@ zod.z.object({
   salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed.optional().nullable()
 });
 var acs_users_warnings = zod.z.union([acs_users_being_deleted, acs_users_salto_ks_user_not_subscribed]).describe("Warning associated with the `acs_user`.");
+var common_acs_user_modification = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
+  message: zod.z.string().describe("Detailed description of the modification.")
+});
+var acs_user_suspension_state_modification = common_acs_user_modification.extend({
+  modification_code: zod.z.literal("suspension_state")
+}).describe(
+  "Indicates that the acs_user's is_suspended state was updated on Seam and will soon be applied on the user on the ACS System"
+);
+var acs_user_profile_modification = common_acs_user_modification.extend({
+  modification_code: zod.z.literal("profile")
+}).describe(
+  "Indicates that the acs_user's profile details (name, email, phone) were updated on Seam and will soon be applied on the user on the ACS System"
+);
+zod.z.object({
+  suspension_state: acs_user_suspension_state_modification.optional().nullable(),
+  profile: acs_user_profile_modification.optional().nullable()
+});
 var user_fields = zod.z.object({
   full_name: zod.z.string().optional().describe("Full name of the `acs_user`."),
   email: zod.z.string().email().optional().describe(`
@@ -16743,6 +16761,7 @@ var openapi_default = {
     },
     "/acs/encoders/encode_credential": {
       post: {
+        description: "Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
         operationId: "acsEncodersEncodeCredentialPost",
         requestBody: {
           content: {
@@ -16750,12 +16769,12 @@ var openapi_default = {
               schema: {
                 properties: {
                   acs_credential_id: {
-                    description: "ID of the acs_credential to encode on a physical card.",
+                    description: "ID of the `acs_credential` to encode onto a card.",
                     format: "uuid",
                     type: "string"
                   },
                   acs_encoder_id: {
-                    description: "ID of the acs_encoder to use for the encoding.",
+                    description: "ID of the `acs_encoder` to use to encode the `acs_credential`.",
                     format: "uuid",
                     type: "string"
                   }
@@ -16798,11 +16817,12 @@ var openapi_default = {
         "x-fern-sdk-method-name": "encode_credential",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-undocumented": "Encoders are in alpha."
+        "x-title": "Encode a Credential"
       }
     },
     "/acs/encoders/list": {
       post: {
+        description: "Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
         operationId: "acsEncodersListPost",
         requestBody: {
           content: {
@@ -16811,8 +16831,17 @@ var openapi_default = {
                 oneOf: [
                   {
                     properties: {
-                      acs_system_id: { format: "uuid", type: "string" },
-                      limit: { default: 500, format: "float", type: "number" }
+                      acs_system_id: {
+                        description: "ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.",
+                        format: "uuid",
+                        type: "string"
+                      },
+                      limit: {
+                        default: 500,
+                        description: "Number of `acs_encoders` to return.",
+                        format: "float",
+                        type: "number"
+                      }
                     },
                     required: ["acs_system_id"],
                     type: "object"
@@ -16820,10 +16849,16 @@ var openapi_default = {
                   {
                     properties: {
                       acs_system_ids: {
+                        description: "IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.",
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
-                      limit: { default: 500, format: "float", type: "number" }
+                      limit: {
+                        default: 500,
+                        description: "Number of `acs_encoders` to return.",
+                        format: "float",
+                        type: "number"
+                      }
                     },
                     required: ["acs_system_ids"],
                     type: "object"
@@ -16831,10 +16866,16 @@ var openapi_default = {
                   {
                     properties: {
                       acs_encoder_ids: {
+                        description: "IDs of the `acs_encoder`s that you want to retrieve.",
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
-                      limit: { default: 500, format: "float", type: "number" }
+                      limit: {
+                        default: 500,
+                        description: "Number of `acs_encoders` to return.",
+                        format: "float",
+                        type: "number"
+                      }
                     },
                     required: ["acs_encoder_ids"],
                     type: "object"
@@ -16938,11 +16979,12 @@ var openapi_default = {
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "acs_encoders",
         "x-response-key": "acs_encoders",
-        "x-undocumented": "Encoders are in alpha."
+        "x-title": "List Encoders"
       }
     },
     "/acs/encoders/scan_credential": {
       post: {
+        description: "Scans an encoded [acs_credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
         operationId: "acsEncodersScanCredentialPost",
         requestBody: {
           content: {
@@ -16950,7 +16992,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   acs_encoder_id: {
-                    description: "ID of the acs_encoder to use for the scan.",
+                    description: "ID of the `acs_encoder` to use for the scan.",
                     format: "uuid",
                     type: "string"
                   }
@@ -16993,11 +17035,12 @@ var openapi_default = {
         "x-fern-sdk-method-name": "scan_credential",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-undocumented": "Encoders are in alpha."
+        "x-title": "Scan a Credential"
       }
     },
     "/acs/encoders/simulate/next_credential_encode_will_fail": {
       post: {
+        description: "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
         operationId: "acsEncodersSimulateNextCredentialEncodeWillFailPost",
         requestBody: {
           content: {
@@ -17007,9 +17050,14 @@ var openapi_default = {
                   {
                     additionalProperties: false,
                     properties: {
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       error_code: {
                         default: "no_credential_on_encoder",
+                        description: "Code of the error to simulate.",
                         enum: ["no_credential_on_encoder"],
                         type: "string"
                       }
@@ -17020,9 +17068,18 @@ var openapi_default = {
                   {
                     additionalProperties: false,
                     properties: {
-                      acs_credential_id: { format: "uuid", type: "string" },
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_credential_id: {
+                        description: "ID of the `acs_credential` that will fail to be encoded onto a card in the next request.",
+                        format: "uuid",
+                        type: "string"
+                      },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       error_code: {
+                        description: "Code of the error to simulate.",
                         enum: ["uncategorized_error", "action_attempt_expired"],
                         type: "string"
                       }
@@ -17061,11 +17118,12 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
         "x-fern-sdk-method-name": "next_credential_encode_will_fail",
         "x-response-key": null,
-        "x-undocumented": "Encoder simulations are in alpha."
+        "x-title": "Simulate that the Next Credential Encoding Will Fail"
       }
     },
     "/acs/encoders/simulate/next_credential_encode_will_succeed": {
       post: {
+        description: "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
         operationId: "acsEncodersSimulateNextCredentialEncodeWillSucceedPost",
         requestBody: {
           content: {
@@ -17073,9 +17131,14 @@ var openapi_default = {
               schema: {
                 additionalProperties: false,
                 properties: {
-                  acs_encoder_id: { format: "uuid", type: "string" },
+                  acs_encoder_id: {
+                    description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   scenario: {
                     default: "credential_is_issued",
+                    description: "Scenario to simulate.",
                     enum: ["credential_is_issued"],
                     type: "string"
                   }
@@ -17112,11 +17175,12 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
         "x-fern-sdk-method-name": "next_credential_encode_will_succeed",
         "x-response-key": null,
-        "x-undocumented": "Encoder simulations are in alpha."
+        "x-title": "Simulate that the Next Credential Encoding Will Succeed"
       }
     },
     "/acs/encoders/simulate/next_credential_scan_will_fail": {
       post: {
+        description: "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
         operationId: "acsEncodersSimulateNextCredentialScanWillFailPost",
         requestBody: {
           content: {
@@ -17126,7 +17190,11 @@ var openapi_default = {
                   {
                     additionalProperties: false,
                     properties: {
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       error_code: {
                         default: "no_credential_on_encoder",
                         enum: ["no_credential_on_encoder"],
@@ -17143,7 +17211,11 @@ var openapi_default = {
                         format: "uuid",
                         type: "string"
                       },
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       error_code: {
                         enum: ["uncategorized_error", "action_attempt_expired"],
                         type: "string"
@@ -17183,11 +17255,12 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
         "x-fern-sdk-method-name": "next_credential_scan_will_fail",
         "x-response-key": null,
-        "x-undocumented": "Encoder simulations are in alpha."
+        "x-title": "Simulate that the Next Credential Scan Will Fail"
       }
     },
     "/acs/encoders/simulate/next_credential_scan_will_succeed": {
       post: {
+        description: "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
         operationId: "acsEncodersSimulateNextCredentialScanWillSucceedPost",
         requestBody: {
           content: {
@@ -17198,12 +17271,18 @@ var openapi_default = {
                     additionalProperties: false,
                     properties: {
                       acs_credential_id_on_seam: {
+                        description: "ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.",
+                        format: "uuid",
+                        type: "string"
+                      },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
                         format: "uuid",
                         type: "string"
                       },
-                      acs_encoder_id: { format: "uuid", type: "string" },
                       scenario: {
                         default: "credential_exists_on_seam",
+                        description: "Scenario to simulate.",
                         enum: [
                           "credential_exists_on_seam",
                           "credential_on_encoder_needs_update"
@@ -17217,8 +17296,13 @@ var openapi_default = {
                   {
                     additionalProperties: false,
                     properties: {
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       scenario: {
+                        description: "Scenario to simulate.",
                         enum: ["credential_does_not_exist_on_seam"],
                         type: "string"
                       }
@@ -17229,8 +17313,13 @@ var openapi_default = {
                   {
                     additionalProperties: false,
                     properties: {
-                      acs_encoder_id: { format: "uuid", type: "string" },
+                      acs_encoder_id: {
+                        description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
+                        format: "uuid",
+                        type: "string"
+                      },
                       scenario: {
+                        description: "Scenario to simulate.",
                         enum: ["credential_on_encoder_is_empty"],
                         type: "string"
                       }
@@ -17269,7 +17358,7 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
         "x-fern-sdk-method-name": "next_credential_scan_will_succeed",
         "x-response-key": null,
-        "x-undocumented": "Encoder simulations are in alpha."
+        "x-title": "Simulate that the Next Credential Scan Will Succeed"
       }
     },
     "/acs/entrances/get": {