docs: Add note about conflicting segments (box/box-openapi#433) (#144)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "62c749a", "specHash": "ee83bc7", "version": "0.1.0" }
+{ "engineHash": "62c749a", "specHash": "fc01415", "version": "0.1.0" }

Sources/Schemas/SignRequestCreateRequest/SignRequestCreateRequest.swift

@@ -9,7 +9,14 @@ public class SignRequestCreateRequest: SignRequestBase {
         case parentFolder = "parent_folder"
     }
 
-    /// Array of signers for the signature request. 35 is the max number of signers permitted.
+    /// Array of signers for the signature request. 35 is the
+    /// max number of signers permitted.
+    /// 
+    /// **Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+    /// This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+    /// In such a case, an attempt to send the sign request will result in an error.
+    /// 
+    /// Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
     public let signers: [SignRequestCreateSigner]
 
     /// List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
@@ -23,7 +30,14 @@ public class SignRequestCreateRequest: SignRequestBase {
     /// Initializer for a SignRequestCreateRequest.
     ///
     /// - Parameters:
-    ///   - signers: Array of signers for the signature request. 35 is the max number of signers permitted.
+    ///   - signers: Array of signers for the signature request. 35 is the
+    ///     max number of signers permitted.
+    ///     
+    ///     **Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+    ///     This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+    ///     In such a case, an attempt to send the sign request will result in an error.
+    ///     
+    ///     Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
     ///   - isDocumentPreparationNeeded: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.
     ///   - redirectUrl: When specified, the signature request will be redirected to this url when a document is signed.
     ///   - declinedRedirectUrl: The uri that a signer will be redirected to after declining to sign a document.

Sources/Schemas/SignTemplate/SignTemplate.swift

@@ -61,6 +61,12 @@ public class SignTemplate: Codable {
     public let areFilesLocked: Bool?
 
     /// Array of signers for the template.
+    /// 
+    /// **Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+    /// This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+    /// In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
+    /// 
+    /// Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
     public let signers: [TemplateSigner]?
 
     /// Additional information on which fields are required and which fields are not editable.
@@ -90,6 +96,12 @@ public class SignTemplate: Codable {
     ///   - areEmailSettingsLocked: Indicates if the template email settings are editable or not.
     ///   - areFilesLocked: Indicates if the template files are editable or not. This includes deleting or renaming template files.
     ///   - signers: Array of signers for the template.
+    ///     
+    ///     **Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+    ///     This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+    ///     In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
+    ///     
+    ///     Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
     ///   - additionalInfo: Additional information on which fields are required and which fields are not editable.
     ///   - readySignLink: Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.
     ///   - customBranding: Custom branding applied to notifications