WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-27 20:14:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
21ff334181c0962a0936ab048f68af95008394ee
OpenSign/assets/js/bbdfc22d.fe21bddf.js
T

1 line
30 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var a=s(85893),t=s(11151),i=s(58219),l=(s(62316),s(51039)),r=s.n(l),d=(s(82723),s(9487)),c=(s(41429),s(5397)),o=s(4667),m=s(9472),p=s(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGmtv4zbyr8zxS7uG7MTZ7OOMw+F2t7026COLJoviEAcpLY0t7kqkSlJx1MD//TB8SLJjJ7vbos0d/CWxOA/Oi+SQM7fM8oVhkwt2jmVVcIuGXSYsQ5NqUVmhJJuw8xwhguGNRk7j8OrtCfCiUEsDtUFtwCpICYiQ1saqUvzGZwWCjYwTWOYizcGgvkbgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEgmwFDaHSmOGcyExA2N1ndpaoxnBu0pJMHWaojHzumhn8mIIJROwOTpBNdpaSwMcail+rREGg4h9JbLBAGzOLaRcwgxJnYy0CQJhT5wZJ5iSjrGpMBVzQciB12gqp/JdVSieQaNqqLI5CAmq1nAxGHyFs3oB704Gg8svc2srMzk44FU1UhVKIxay4DMzSlV5kBFilc2fQI4aHScSLdN8CUuRLdAa4DKDVFUNpGqotMgkt5hAxRcIsi5nqEHNScpyBLwwqmXiaEiN58eE8farfzuhB4PXWKgee41g6qpS2mJGOpDC0Q6TwYBo3qiyVBIqrnmJlkJAzSODCSEMycxNhZPBAE5kJlIKA8eJRjvskUcl4Qn1LNjVo66pJEMMkTZLLi25qSp4ig5VI7nEimtcZ3yTQEOMv0KpogS50uI3JS0vnCmvUVuR8gJSpXQmpJPUWxCM5dqFZaWEtHE0zAD/CYatjRciC14m0TIySymkgxiEa17UaIJUywRykuonrDQaF16Br82dTDmKRb5zPp69r41dYwy1ITH7UoS5NP5aC42ZMy86s815YRDEfM2WJf+AvdlAuT2AFyN43UCGc14XNgFhvzBgdY0j+FFZ4FVViNQtdlrHFMqclujQeTkERBBE8tL5+K1W1yJDWpGZmM9Ro7RAQMciRmGQjoKxcgSkXqk0ycglKNlz9HgEg0E7twvRX375ZSpvpxJgykiWKZtMWYsyZQl4GIXYlE3GCYSBmymbwNOjFxGhoe/nRy/j95K+x+Pj+J3T99F4Kldh0iMnjOVldY8gBP7jhYif3nWGBt3MNBbDgAbJfx6XIGR6Gm3FIsCqU+gpKSSksIIXZrdOEePxqdVJtqHZMWmGJRfFbrUc+PHpFMTaUOjZqFtnO/TxLB6bOv7XhjbPSZv3agZW2OIelVqUx6dXT7QN5V6QcqkqKy6b3aoFhMenWCvYhlovSa2M23vcRdDHp1CQKgLCgedhh8fD8bPh0eHRcQ9jrnTJA0JZDrNs2DRNM2XQWQSc/nT2BXZ0/MXzz5/VlGPOtSq3JDcu9+iwQi7gfseE4AdKA2bxhOyytS499VKun+FWZbz5wnhWkTQc0h6/S8WanpgORHI0lNWmuRJpEJ5wguFhRsnkiIwwJDtmBz/8cOAtk3SDw7IM5vK+oFH6HjpL9kfLcpRlo03cvsH7oyVkWQJbxrcDsgzKstw13gIoof37yF0cbuxM3eyO7YDw+MK7E2xrhIdTIcJyIQMghAdsIGhc1AXXeEP5qxFKOu3v7AYboR8jn8dY9Mmry/vc1cALCV+ehtzzSYhKkmedAY08THdHzD4TjQu8cTz8pZWEEVm4PZo6zemi6q65lHoqWTThLmIS/5XyStAlokBr3SjadLQuxFSOD91Gn2P64d7IiRiPL3R6kkWgv3MQ+GLKSh5OXjbH7reyOeopu2xpDBaYWsx6tLCNGC57UcYzsjQhuztLJ14uMiz4DIsO1hMuuLGnKgFKIb0Q0QyHkZ+D8psNaACutgS1V6IfTXH7izEZrQaFMPEyum6CPnW4xLmnCIn+DWKGEAlg1m7f24LcW6l3wSNXbt7vDNp1wbiBSLrljudsGldfsPUDMxAeOMT2/hwn2zVBUGHNM327EI9SSFHWZe9tI3KNFivDMdg3F1HS41Scoe/dOzPwmwdmCM9DOyaYyrG7gmZaVZlaSrfKYXvyE1Ae3zLvSfZ7lvnaseLxfs8yilL1l9GWE4VQ/VnSLiGzew2N4JT2b3pD8ETCAE9TrCxmGxv42F3nNc+EglltrZK7t/A+1uPz74Z0f4KPSeGP83Jftr/K01M59i8dpX+L3PXMUTp/PjbvBrG2uyEccZIlTFXuoV3Jk4xNmH+0j0/YLHFTobGvVdawyS1LlbQoLf0ML31EevDeUHHglpk0x5LTrygilRPmoiBW9NiG2rCEuQsw1RbIiGzC1Ow9ppYllFxW9PiKhng4usltxDJWC7lgSbhosQnzT9csYXjDy4qQwxCgTBVdfxyLVZzxPl7tSMfLuB/tgz7xoTfjz2TjSFcb9ZTP4tTnsOrs2jHjWvOGbZZu4mNxzOA9XfusWzTx+BaWUoGYXng0ljBhsezPssNrWn26pVNUpIl7w/pUWucWXn7ynERX5Up+FmF4lN5i84+0kofenXjdZa/osoFZzAaH3Xt6Au5tdvRQxER8py1f9Of0yc2dOc931Vl6pQCTq7rI6LEfuR65csfn17WoVsiLtHblunY3X9OsFbXVbLxK2M3Dytz4kpgv4sCXBc4t1FWFGlKlJeon/beWR6Pc0fHxKmHNw+o1/5PqvSDnLR/W7mdX/eoqg3+FrE9frhKWPyzrt2197i8U9vj5qjvrNs7yq5nKmqu4b60eQoyHCuEZlNmJPNUZ6p4hZkoVyGV/fneDe4Czn7pLDyh/cQOmUtL4zfHo8JD+bexLaxV9Kv+31f6i+RtLPj43uX9n9sOUDd3dnbuN9XV+9K2pZJnmtLOWaMz65rqF5AEF+nYTshASr6JRro4OD6+ekeVWCTveZpwzVaLN6VlqScXTpVZykUBVIKdKtG6AL7iQQNPrP9BWqLXS92v9aZLdZ4Tjw8OrcWuEZ3eNcCLdS49r8jhXH1D+uZr2p7d+ehL1pnQpjU9RmPBIDs7WlO2PeyUNprUWtmGTi1t2M+SVGHr45OJydUlRZ3NFWXuljJOY25xN2MGdJN512VCGeHHLal2wCbt3F+KVOLges1WyiW0sXwi5GN5LddkJfkbG9fZbE79LmirxHVLWFKzTx0qYIKfmyGnfIXuQz37q7iNfR8vHm8LW5L8z8WY6H7P5tQR9c1/fknL3Mu6LmO66DLZNYFmnEWuTTPrZpo0XXSC1GVpM0MYuszk6PnYpwIuxOyufvnTH0PHz1aW3cG9L9tsu2WuunHGDwqcVyjOx8O1Z1+MtmZ4wdP8lcGzn8f1cdA3foF5vdyIgjT8djWNtyS+sEdDFmRY9HYDUiVUI+YFagIZwcTqfi1TwAn7GmREWu9NwuVzeiagnjuYbYfN6Bhor1aEv3KALuz5V+/GE3I66NKfzM9TXIsUQxTumOnDIB2G74KnbLqIzw9C/Nolo+RYiRWmwt8BfffP2e7iGp6NDlvSWz0cIffD9yZuvfzz7mvjScvVOGo8OR4cue1fGllz2pnrjO+zOu4DeuFu2e9++bW/ftrdv29u37e3b9vZte/u2vcek075tb9+2t2/b+yOr1vu2vX3b3nTftrdv29u37cG+bW/ftrdv29u37e3b9vZte/u2Pfg/atsL1SPKmA6qggtXTHTlhttQB7zYbOa7TFhOhcLJBbu9pefjd7pYrWj41xo1VRkvE3bNtaBnQFdjTGL1jepVH7ChmoMvKQzPaf7ER50r5G2UVql46CleOTfdi9uvZb49PTtnCZuFhsNSZUSj+ZKaEfmSTSg7Za5x0VnYtZxx101ScLmoXQmNeb5UNOS1zdcrjh9cxTH86FXiuGx6Uq6XIr0q9JcU20rwDypSfIfNP1t0D9lJEGwbscmFl6vV6r9hWUIX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGmtv4zbyr8zxS7uG7MTZ7OOMw+F2t7026COLJoviEAcpLY0t7kqkSlJx1MD//TB8SLJjJ7vbos0d/CWxOA/Oi+SQM7fM8oVhkwt2jmVVcIuGXSYsQ5NqUVmhJJuw8xwhguGNRk7j8OrtCfCiUEsDtUFtwCpICYiQ1saqUvzGZwWCjYwTWOYizcGgvkbgBmZFjZUW0hqYKw0LlKi5FXIBmUrrEgmwFDaHSmOGcyExA2N1ndpaoxnBu0pJMHWaojHzumhn8mIIJROwOTpBNdpaSwMcail+rREGg4h9JbLBAGzOLaRcwgxJnYy0CQJhT5wZJ5iSjrGpMBVzQciB12gqp/JdVSieQaNqqLI5CAmq1nAxGHyFs3oB704Gg8svc2srMzk44FU1UhVKIxay4DMzSlV5kBFilc2fQI4aHScSLdN8CUuRLdAa4DKDVFUNpGqotMgkt5hAxRcIsi5nqEHNScpyBLwwqmXiaEiN58eE8farfzuhB4PXWKgee41g6qpS2mJGOpDC0Q6TwYBo3qiyVBIqrnmJlkJAzSODCSEMycxNhZPBAE5kJlIKA8eJRjvskUcl4Qn1LNjVo66pJEMMkTZLLi25qSp4ig5VI7nEimtcZ3yTQEOMv0KpogS50uI3JS0vnCmvUVuR8gJSpXQmpJPUWxCM5dqFZaWEtHE0zAD/CYatjRciC14m0TIySymkgxiEa17UaIJUywRykuonrDQaF16Br82dTDmKRb5zPp69r41dYwy1ITH7UoS5NP5aC42ZMy86s815YRDEfM2WJf+AvdlAuT2AFyN43UCGc14XNgFhvzBgdY0j+FFZ4FVViNQtdlrHFMqclujQeTkERBBE8tL5+K1W1yJDWpGZmM9Ro7RAQMciRmGQjoKxcgSkXqk0ycglKNlz9HgEg0E7twvRX375ZSpvpxJgykiWKZtMWYsyZQl4GIXYlE3GCYSBmymbwNOjFxGhoe/nRy/j95K+x+Pj+J3T99F4Kldh0iMnjOVldY8gBP7jhYif3nWGBt3MNBbDgAbJfx6XIGR6Gm3FIsCqU+gpKSSksIIXZrdOEePxqdVJtqHZMWmGJRfFbrUc+PHpFMTaUOjZqFtnO/TxLB6bOv7XhjbPSZv3agZW2OIelVqUx6dXT7QN5V6QcqkqKy6b3aoFhMenWCvYhlovSa2M23vcRdDHp1CQKgLCgedhh8fD8bPh0eHRcQ9jrnTJA0JZDrNs2DRNM2XQWQSc/nT2BXZ0/MXzz5/VlGPOtSq3JDcu9+iwQi7gfseE4AdKA2bxhOyytS499VKun+FWZbz5wnhWkTQc0h6/S8WanpgORHI0lNWmuRJpEJ5wguFhRsnkiIwwJDtmBz/8cOAtk3SDw7IM5vK+oFH6HjpL9kfLcpRlo03cvsH7oyVkWQJbxrcDsgzKstw13gIoof37yF0cbuxM3eyO7YDw+MK7E2xrhIdTIcJyIQMghAdsIGhc1AXXeEP5qxFKOu3v7AYboR8jn8dY9Mmry/vc1cALCV+ehtzzSYhKkmedAY08THdHzD4TjQu8cTz8pZWEEVm4PZo6zemi6q65lHoqWTThLmIS/5XyStAlokBr3SjadLQuxFSOD91Gn2P64d7IiRiPL3R6kkWgv3MQ+GLKSh5OXjbH7reyOeopu2xpDBaYWsx6tLCNGC57UcYzsjQhuztLJ14uMiz4DIsO1hMuuLGnKgFKIb0Q0QyHkZ+D8psNaACutgS1V6IfTXH7izEZrQaFMPEyum6CPnW4xLmnCIn+DWKGEAlg1m7f24LcW6l3wSNXbt7vDNp1wbiBSLrljudsGldfsPUDMxAeOMT2/hwn2zVBUGHNM327EI9SSFHWZe9tI3KNFivDMdg3F1HS41Scoe/dOzPwmwdmCM9DOyaYyrG7gmZaVZlaSrfKYXvyE1Ae3zLvSfZ7lvnaseLxfs8yilL1l9GWE4VQ/VnSLiGzew2N4JT2b3pD8ETCAE9TrCxmGxv42F3nNc+EglltrZK7t/A+1uPz74Z0f4KPSeGP83Jftr/K01M59i8dpX+L3PXMUTp/PjbvBrG2uyEccZIlTFXuoV3Jk4xNmH+0j0/YLHFTobGvVdawyS1LlbQoLf0ML31EevDeUHHglpk0x5LTrygilRPmoiBW9NiG2rCEuQsw1RbIiGzC1Ow9ppYllFxW9PiKhng4usltxDJWC7lgSbhosQnzT9csYXjDy4qQwxCgTBVdfxyLVZzxPl7tSMfLuB/tgz7xoTfjz2TjSFcb9ZTP4tTnsOrs2jHjWvOGbZZu4mNxzOA9XfusWzTx+BaWUoGYXng0ljBhsezPssNrWn26pVNUpIl7w/pUWucWXn7ynERX5Up+FmF4lN5i84+0kofenXjdZa/osoFZzAaH3Xt6Au5tdvRQxER8py1f9Of0yc2dOc931Vl6pQCTq7rI6LEfuR65csfn17WoVsiLtHblunY3X9OsFbXVbLxK2M3Dytz4kpgv4sCXBc4t1FWFGlKlJeon/beWR6Pc0fHxKmHNw+o1/5PqvSDnLR/W7mdX/eoqg3+FrE9frhKWPyzrt2197i8U9vj5qjvrNs7yq5nKmqu4b60eQoyHCuEZlNmJPNUZ6p4hZkoVyGV/fneDe4Czn7pLDyh/cQOmUtL4zfHo8JD+bexLaxV9Kv+31f6i+RtLPj43uX9n9sOUDd3dnbuN9XV+9K2pZJnmtLOWaMz65rqF5AEF+nYTshASr6JRro4OD6+ekeVWCTveZpwzVaLN6VlqScXTpVZykUBVIKdKtG6AL7iQQNPrP9BWqLXS92v9aZLdZ4Tjw8OrcWuEZ3eNcCLdS49r8jhXH1D+uZr2p7d+ehL1pnQpjU9RmPBIDs7WlO2PeyUNprUWtmGTi1t2M+SVGHr45OJydUlRZ3NFWXuljJOY25xN2MGdJN512VCGeHHLal2wCbt3F+KVOLges1WyiW0sXwi5GN5LddkJfkbG9fZbE79LmirxHVLWFKzTx0qYIKfmyGnfIXuQz37q7iNfR8vHm8LW5L8z8WY6H7P5tQR9c1/fknL3Mu6LmO66DLZNYFmnEWuTTPrZpo0XXSC1GVpM0MYuszk6PnYpwIuxOyufvnTH0PHz1aW3cG9L9tsu2WuunHGDwqcVyjOx8O1Z1+MtmZ4wdP8lcGzn8f1cdA3foF5vdyIgjT8djWNtyS+sEdDFmRY9HYDUiVUI+YFagIZwcTqfi1TwAn7GmREWu9NwuVzeiagnjuYbYfN6Bhor1aEv3KALuz5V+/GE3I66NKfzM9TXIsUQxTumOnDIB2G74KnbLqIzw9C/Nolo+RYiRWmwt8BfffP2e7iGp6NDlvSWz0cIffD9yZuvfzz7mvjScvVOGo8OR4cue1fGllz2pnrjO+zOu4DeuFu2e9++bW/ftrdv29u37e3b9vZte/u2vcek075tb9+2t2/b+yOr1vu2vX3b3nTftrdv29u37cG+bW/ftrdv29u37e3b9vZte/u2Pfg/atsL1SPKmA6qggtXTHTlhttQB7zYbOa7TFhOhcLJBbu9pefjd7pYrWj41xo1VRkvE3bNtaBnQFdjTGL1jepVH7ChmoMvKQzPaf7ER50r5G2UVql46CleOTfdi9uvZb49PTtnCZuFhsNSZUSj+ZKaEfmSTSg7Za5x0VnYtZxx101ScLmoXQmNeb5UNOS1zdcrjh9cxTH86FXiuGx6Uq6XIr0q9JcU20rwDypSfIfNP1t0D9lJEGwbscmFl6vV6r9hWUIX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(n.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink