chore: update documentation

Signed-off-by: Vitor Mattos <[email protected]>
LibreSign · Dec 23, 2024 · 1225ab7 · 1225ab7
1 parent 44ecba7
commit 1225ab7
Show file tree

Hide file tree

Showing 5 changed files with 164 additions and 21 deletions.
diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
@@ -125,10 +125,23 @@
  *     label: string,
  *     name: string,
  * }
+ * @psalm-type LibresignSignatureMethodEmailToken = array{
+ *     label: string,
+ *     identifyMethod: "email"|"account",
+ *     needCode: bool,
+ *     hasConfirmCode: bool,
+ *     blurredEmail: string,
+ *     hashOfEmail: string,
+ * }
+ * @psalm-type LibresignSignatureMethodPassword = array{
+ *     label: string,
+ *     name: string,
+ *     hasSignatureFile: bool,
+ * }
  * @psalm-type LibresignSignatureMethods = array{
  *     clickToSign?: LibresignSignatureMethod,
- *     emailToken?: LibresignSignatureMethod,
- *     password?: LibresignSignatureMethod,
+ *     emailToken?: LibresignSignatureMethodEmailToken,
+ *     password?: LibresignSignatureMethodPassword,
  * }
  * @psalm-type LibresignSigner = array{
  *     description: ?string,
@@ -143,7 +156,7 @@
  *     signRequestId: non-negative-int,
  *     identifyMethods?: LibresignIdentifyMethod[],
  *     visibleElements?: LibresignVisibleElement[],
- *     signatureMethods?: LibresignSignatureMethods[],
+ *     signatureMethods?: LibresignSignatureMethods,
  * }
  * @psalm-type LibresignValidateFile = array{
  *     uuid: string,

diff --git a/openapi-full.json b/openapi-full.json
@@ -612,17 +612,71 @@
                     }
                 }
             },
+            "SignatureMethodEmailToken": {
+                "type": "object",
+                "required": [
+                    "label",
+                    "identifyMethod",
+                    "needCode",
+                    "hasConfirmCode",
+                    "blurredEmail",
+                    "hashOfEmail"
+                ],
+                "properties": {
+                    "label": {
+                        "type": "string"
+                    },
+                    "identifyMethod": {
+                        "type": "string",
+                        "enum": [
+                            "email",
+                            "account"
+                        ]
+                    },
+                    "needCode": {
+                        "type": "boolean"
+                    },
+                    "hasConfirmCode": {
+                        "type": "boolean"
+                    },
+                    "blurredEmail": {
+                        "type": "string"
+                    },
+                    "hashOfEmail": {
+                        "type": "string"
+                    }
+                }
+            },
+            "SignatureMethodPassword": {
+                "type": "object",
+                "required": [
+                    "label",
+                    "name",
+                    "hasSignatureFile"
+                ],
+                "properties": {
+                    "label": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "hasSignatureFile": {
+                        "type": "boolean"
+                    }
+                }
+            },
             "SignatureMethods": {
                 "type": "object",
                 "properties": {
                     "clickToSign": {
                         "$ref": "#/components/schemas/SignatureMethod"
                     },
                     "emailToken": {
-                        "$ref": "#/components/schemas/SignatureMethod"
+                        "$ref": "#/components/schemas/SignatureMethodEmailToken"
                     },
                     "password": {
-                        "$ref": "#/components/schemas/SignatureMethod"
+                        "$ref": "#/components/schemas/SignatureMethodPassword"
                     }
                 }
             },
@@ -685,10 +739,7 @@
                         }
                     },
                     "signatureMethods": {
-                        "type": "array",
-                        "items": {
-                            "$ref": "#/components/schemas/SignatureMethods"
-                        }
+                        "$ref": "#/components/schemas/SignatureMethods"
                     }
                 }
             },

diff --git a/openapi.json b/openapi.json
@@ -516,17 +516,71 @@
                     }
                 }
             },
+            "SignatureMethodEmailToken": {
+                "type": "object",
+                "required": [
+                    "label",
+                    "identifyMethod",
+                    "needCode",
+                    "hasConfirmCode",
+                    "blurredEmail",
+                    "hashOfEmail"
+                ],
+                "properties": {
+                    "label": {
+                        "type": "string"
+                    },
+                    "identifyMethod": {
+                        "type": "string",
+                        "enum": [
+                            "email",
+                            "account"
+                        ]
+                    },
+                    "needCode": {
+                        "type": "boolean"
+                    },
+                    "hasConfirmCode": {
+                        "type": "boolean"
+                    },
+                    "blurredEmail": {
+                        "type": "string"
+                    },
+                    "hashOfEmail": {
+                        "type": "string"
+                    }
+                }
+            },
+            "SignatureMethodPassword": {
+                "type": "object",
+                "required": [
+                    "label",
+                    "name",
+                    "hasSignatureFile"
+                ],
+                "properties": {
+                    "label": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "hasSignatureFile": {
+                        "type": "boolean"
+                    }
+                }
+            },
             "SignatureMethods": {
                 "type": "object",
                 "properties": {
                     "clickToSign": {
                         "$ref": "#/components/schemas/SignatureMethod"
                     },
                     "emailToken": {
-                        "$ref": "#/components/schemas/SignatureMethod"
+                        "$ref": "#/components/schemas/SignatureMethodEmailToken"
                     },
                     "password": {
-                        "$ref": "#/components/schemas/SignatureMethod"
+                        "$ref": "#/components/schemas/SignatureMethodPassword"
                     }
                 }
             },
@@ -589,10 +643,7 @@
                         }
                     },
                     "signatureMethods": {
-                        "type": "array",
-                        "items": {
-                            "$ref": "#/components/schemas/SignatureMethods"
-                        }
+                        "$ref": "#/components/schemas/SignatureMethods"
                     }
                 }
             },

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1210,10 +1210,24 @@ export type components = {
             label: string;
             name: string;
         };
+        SignatureMethodEmailToken: {
+            label: string;
+            /** @enum {string} */
+            identifyMethod: "email" | "account";
+            needCode: boolean;
+            hasConfirmCode: boolean;
+            blurredEmail: string;
+            hashOfEmail: string;
+        };
+        SignatureMethodPassword: {
+            label: string;
+            name: string;
+            hasSignatureFile: boolean;
+        };
         SignatureMethods: {
             clickToSign?: components["schemas"]["SignatureMethod"];
-            emailToken?: components["schemas"]["SignatureMethod"];
-            password?: components["schemas"]["SignatureMethod"];
+            emailToken?: components["schemas"]["SignatureMethodEmailToken"];
+            password?: components["schemas"]["SignatureMethodPassword"];
         };
         Signer: {
             description: string | null;
@@ -1229,7 +1243,7 @@ export type components = {
             signRequestId: number;
             identifyMethods?: components["schemas"]["IdentifyMethod"][];
             visibleElements?: components["schemas"]["VisibleElement"][];
-            signatureMethods?: components["schemas"]["SignatureMethods"][];
+            signatureMethods?: components["schemas"]["SignatureMethods"];
         };
         UserElement: {
             /** Format: int64 */

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -1064,10 +1064,24 @@ export type components = {
             label: string;
             name: string;
         };
+        SignatureMethodEmailToken: {
+            label: string;
+            /** @enum {string} */
+            identifyMethod: "email" | "account";
+            needCode: boolean;
+            hasConfirmCode: boolean;
+            blurredEmail: string;
+            hashOfEmail: string;
+        };
+        SignatureMethodPassword: {
+            label: string;
+            name: string;
+            hasSignatureFile: boolean;
+        };
         SignatureMethods: {
             clickToSign?: components["schemas"]["SignatureMethod"];
-            emailToken?: components["schemas"]["SignatureMethod"];
-            password?: components["schemas"]["SignatureMethod"];
+            emailToken?: components["schemas"]["SignatureMethodEmailToken"];
+            password?: components["schemas"]["SignatureMethodPassword"];
         };
         Signer: {
             description: string | null;
@@ -1083,7 +1097,7 @@ export type components = {
             signRequestId: number;
             identifyMethods?: components["schemas"]["IdentifyMethod"][];
             visibleElements?: components["schemas"]["VisibleElement"][];
-            signatureMethods?: components["schemas"]["SignatureMethods"][];
+            signatureMethods?: components["schemas"]["SignatureMethods"];
         };
         UserElement: {
             /** Format: int64 */