WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-30 19:59:49 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef74da02c706f6aefbfc8b41c4e95a6d7d7ca9ab
OpenSign/assets/js/bbdfc22d.70967907.js
T

1 line
30 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=n(85893),i=n(11151),t=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=(n(41429),n(5397)),o=n(4667),m=n(9472),h=n(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/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",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 s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.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)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(s.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)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.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)(s.li,{children:[(0,a.jsx)(s.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)(s.li,{children:[(0,a.jsx)(s.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)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.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)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.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)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{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)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.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)(n,{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)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.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)(s.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)(n,{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)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.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)(s.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)(s.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)(s.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)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.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)(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)(n,{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)(s.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)(h.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)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.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)(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)(n,{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)(s.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)(h.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)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.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)(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)(n,{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)(s.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)(h.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 b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink