mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 04:07:40 +02:00
1 line
30 KiB
JavaScript
1 line
30 KiB
JavaScript
"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:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbsTu9EK/EwfWQrZJNaGP5TMhZ/xNXcZlRxmfniouW1TNSh5f4GsNtmFWJ75DirCDPLlTCBJlBjpw8FUmQtPxT+4L5Ouoqvi22PhdapWw+AGL8vxbSb94EW4L0Tox+HgNkF/M2IS9rOWJNWEo/m0DzvDW9JqaLId3QxUJHx8cuaHg2dLfr4+fu4jp+urrwEu44ce+oSV5T5YQbGD6tUJ6Jme/nuh7evpGxSFWJLt+XI0Tw//zr325FbAlyR+wLOK01VGqOmvqxqIdlWuBCUGdIp12MHhwuGcnLAo2hV4i0OPOtVmLm8unEMXmQlFd8IgpBh5LAlK87dc61GcDPOVJ6gqa+1L60cI0FnWUolLpyPTEKeG1V2W3ngrnSV1MiKQEOE2qeQWPAIMYlKHMuU8oqeFtNQGngElBa1JUWBoGLkoApi4HTqUgFISYPpHlqoeSSz5A2S1xkQFKoYuuLVhNKWhpV1D4VQg04iNaz6LIaA3hN3UyOcRrM0HJRYAazmlAkQEYMwSERGzKDCRoLFW0vUjRtEbHAa9TuNDtN0h0ElSJPKXhBYUxXt4TIai4NxR6eoKiaRnyVVnSZuT0yvhwAJVDI+VMgRAZQCHlFnWB9OG/M7GecGGGxjYrm8/ktP/Fofc03wub1BDRWql03c4POq3SXNx+P6FSjLs3p9Az1tUgxOKgdex444INwf/DU3R/xrPJK/H1zAfnyQqQoDXa8/Ytv3nwP1/B4cMiSjlf8CIIPvj959fWPZ18TXvLd/vwNB4eDQ/eUU8aWXHa2euW7Ld+2vmoj0dBchPsWzn0L576Fc9/CuW/h3Ldw7ls4HxJP+xbOfQvnvoXz92xh2Ldw7ls4x/sWTti3cO5bOPctnPsWzn0L576Fc9/CuW/h3Ldw/h+1cIa6IEVMB1XBhSssu2rDTagJn282dl4kLKei8eic3dxQ9vidLlYrGv5Qo6aK80XCrrkWlAV09eYk1lWpEnmFSyo5+IpC/y3tn3irc+WRjTI7lYT9ihdOTXfCduvab07P3rKETULzaakyWqP5nBpT+ZyNKDplronVSdi1H3LXWVRwOatdcZR5vFQO5rXN12vJV66WHH50aqxcLjtUrheZPSv0lxjbuuCvVKP4Dpd/a8D9zM4FQbYRmlR4sVqt/gvY9QeY",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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbsTu9EK/EwfWQrZJNaGP5TMhZ/xNXcZlRxmfniouW1TNSh5f4GsNtmFWJ75DirCDPLlTCBJlBjpw8FUmQtPxT+4L5Ouoqvi22PhdapWw+AGL8vxbSb94EW4L0Tox+HgNkF/M2IS9rOWJNWEo/m0DzvDW9JqaLId3QxUJHx8cuaHg2dLfr4+fu4jp+urrwEu44ce+oSV5T5YQbGD6tUJ6Jme/nuh7evpGxSFWJLt+XI0Tw//zr325FbAlyR+wLOK01VGqOmvqxqIdlWuBCUGdIp12MHhwuGcnLAo2hV4i0OPOtVmLm8unEMXmQlFd8IgpBh5LAlK87dc61GcDPOVJ6gqa+1L60cI0FnWUolLpyPTEKeG1V2W3ngrnSV1MiKQEOE2qeQWPAIMYlKHMuU8oqeFtNQGngElBa1JUWBoGLkoApi4HTqUgFISYPpHlqoeSSz5A2S1xkQFKoYuuLVhNKWhpV1D4VQg04iNaz6LIaA3hN3UyOcRrM0HJRYAazmlAkQEYMwSERGzKDCRoLFW0vUjRtEbHAa9TuNDtN0h0ElSJPKXhBYUxXt4TIai4NxR6eoKiaRnyVVnSZuT0yvhwAJVDI+VMgRAZQCHlFnWB9OG/M7GecGGGxjYrm8/ktP/Fofc03wub1BDRWql03c4POq3SXNx+P6FSjLs3p9Az1tUgxOKgdex444INwf/DU3R/xrPJK/H1zAfnyQqQoDXa8/Ytv3nwP1/B4cMiSjlf8CIIPvj959fWPZ18TXvLd/vwNB4eDQ/eUU8aWXHa2euW7Ld+2vmoj0dBchPsWzn0L576Fc9/CuW/h3Ldw7ls4HxJP+xbOfQvnvoXz92xh2Ldw7ls4x/sWTti3cO5bOPctnPsWzn0L576Fc9/CuW/h3Ldw/h+1cIa6IEVMB1XBhSssu2rDTagJn282dl4kLKei8eic3dxQ9vidLlYrGv5Qo6aK80XCrrkWlAV09eYk1lWpEnmFSyo5+IpC/y3tn3irc+WRjTI7lYT9ihdOTXfCduvab07P3rKETULzaakyWqP5nBpT+ZyNKDplronVSdi1H3LXWVRwOatdcZR5vFQO5rXN12vJV66WHH50aqxcLjtUrheZPSv0lxjbuuCvVKP4Dpd/a8D9zM4FQbYRmlR4sVqt/gvY9QeY",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},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,i.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, yyy"'}),"\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)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.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)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(c.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)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.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)(c.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)(c.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)(c.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)(c.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)(c.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)(c.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)(c.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)(l.Z,{children:[(0,a.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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)(c.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); |