chore: update API documentation

Signed-off-by: Vitor Mattos <[email protected]>
LibreSign · Dec 13, 2024 · 8d2f059 · 8d2f059
1 parent e5892ea
commit 8d2f059
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 0 deletions.
diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
@@ -120,6 +120,16 @@
  *     type: string,
  *     coordinates: LibresignCoordinate,
  * }
+ * @psalm-type LibresignSignatureMethod = array{
+ *     enabled: bool,
+ *     label: string,
+ *     name: string,
+ * }
+ * @psalm-type LibresignSignatureMethods = array{
+ *     clickToSign?: LibresignSignatureMethod,
+ *     emailToken?: LibresignSignatureMethod,
+ *     password?: LibresignSignatureMethod,
+ * }
  * @psalm-type LibresignSigner = array{
  *     description: ?string,
  *     displayName: string,
@@ -133,6 +143,7 @@
  *     signRequestId: non-negative-int,
  *     identifyMethods?: LibresignIdentifyMethod[],
  *     visibleElements?: LibresignVisibleElement[],
+ *     signatureMethods?: LibresignSignatureMethods[],
  * }
  * @psalm-type LibresignValidateFile = array{
  *     uuid: string,

diff --git a/openapi-full.json b/openapi-full.json
@@ -593,6 +593,39 @@
                     }
                 }
             },
+            "SignatureMethod": {
+                "type": "object",
+                "required": [
+                    "enabled",
+                    "label",
+                    "name"
+                ],
+                "properties": {
+                    "enabled": {
+                        "type": "boolean"
+                    },
+                    "label": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    }
+                }
+            },
+            "SignatureMethods": {
+                "type": "object",
+                "properties": {
+                    "clickToSign": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    },
+                    "emailToken": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    },
+                    "password": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    }
+                }
+            },
             "Signer": {
                 "type": "object",
                 "required": [
@@ -650,6 +683,12 @@
                         "items": {
                             "$ref": "#/components/schemas/VisibleElement"
                         }
+                    },
+                    "signatureMethods": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/SignatureMethods"
+                        }
                     }
                 }
             },

diff --git a/openapi.json b/openapi.json
@@ -497,6 +497,39 @@
                     }
                 }
             },
+            "SignatureMethod": {
+                "type": "object",
+                "required": [
+                    "enabled",
+                    "label",
+                    "name"
+                ],
+                "properties": {
+                    "enabled": {
+                        "type": "boolean"
+                    },
+                    "label": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    }
+                }
+            },
+            "SignatureMethods": {
+                "type": "object",
+                "properties": {
+                    "clickToSign": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    },
+                    "emailToken": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    },
+                    "password": {
+                        "$ref": "#/components/schemas/SignatureMethod"
+                    }
+                }
+            },
             "Signer": {
                 "type": "object",
                 "required": [
@@ -554,6 +587,12 @@
                         "items": {
                             "$ref": "#/components/schemas/VisibleElement"
                         }
+                    },
+                    "signatureMethods": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/SignatureMethods"
+                        }
                     }
                 }
             },

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1205,6 +1205,16 @@ export type components = {
             needIdentificationDocuments?: boolean;
             identificationDocumentsWaitingApproval?: boolean;
         };
+        SignatureMethod: {
+            enabled: boolean;
+            label: string;
+            name: string;
+        };
+        SignatureMethods: {
+            clickToSign?: components["schemas"]["SignatureMethod"];
+            emailToken?: components["schemas"]["SignatureMethod"];
+            password?: components["schemas"]["SignatureMethod"];
+        };
         Signer: {
             description: string | null;
             displayName: string;
@@ -1219,6 +1229,7 @@ export type components = {
             signRequestId: number;
             identifyMethods?: components["schemas"]["IdentifyMethod"][];
             visibleElements?: components["schemas"]["VisibleElement"][];
+            signatureMethods?: components["schemas"]["SignatureMethods"][];
         };
         UserElement: {
             /** Format: int64 */

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -1059,6 +1059,16 @@ export type components = {
             needIdentificationDocuments?: boolean;
             identificationDocumentsWaitingApproval?: boolean;
         };
+        SignatureMethod: {
+            enabled: boolean;
+            label: string;
+            name: string;
+        };
+        SignatureMethods: {
+            clickToSign?: components["schemas"]["SignatureMethod"];
+            emailToken?: components["schemas"]["SignatureMethod"];
+            password?: components["schemas"]["SignatureMethod"];
+        };
         Signer: {
             description: string | null;
             displayName: string;
@@ -1073,6 +1083,7 @@ export type components = {
             signRequestId: number;
             identifyMethods?: components["schemas"]["IdentifyMethod"][];
             visibleElements?: components["schemas"]["VisibleElement"][];
+            signatureMethods?: components["schemas"]["SignatureMethods"][];
         };
         UserElement: {
             /** Format: int64 */