WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-21 17:17:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
f01dcfb76ef4dfff4621336c8dd483e549adc747
OpenSign/assets/js/bbdfc22d.59c4d21a.js
T

1 line
29 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:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),l=s(11151),i=s(58219),t=(s(62316),s(51039)),r=s.n(t),d=(s(82723),s(9487)),o=(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:"eJztGmtz2zbyr+zhSxsNJVuO8zjNzc0laa/19OFM7UznxvK4ELkSkZAAC4CWWY/++83iQVKyZCdp7+q7UT44Inax2BeAxe7eMssXhk0u2DmWVcEtGnaZsAxNqkVlhZJsws5zhAiGNxo5jcOrtyfAi0ItDdQGtQGrICUgQlobq0rxG58VCDYSTmCZizQHg/oagRuYFTVWWkhrYK40LFCi5lbIBWQqrUskwFLYHCqNGc6FxAyM1XVqa41mBO8qJcHUaYrGzOuiXcmzIZRMwOboGNVoay0NcKil+LVGGAwi9pXIBgOwObeQcgkzJHEykiYwhD12ZpxgSjrCpsJUzAUhB1qjqZzKd1WheAaNqqHK5iAkqFrDxWDwFc7qBbw7GQwuv8ytrczk4IBX1UhVKI1YyILPzChV5UFGiFU2fwI5anSUiLVM8yUsRbZAa4DLDFJVNZCqodIik9xiAhVfIMi6nKEGNScuyxHwwqiWiJtDYjw/Joy3X/3TMT0YvMZC9chrBFNXldIWM5KBBI56mAwGNOeNKksloeKal2jJBdQ8EpgQwpDU3FQ4GQzgRGYiJTdwlGi0wx55VGKeUM+CXj3qmkgy+BBJs+TSkpmqgqfoUDWSSay4xnXCNwk0RPgrlCpykCstflPS8sKp8hq1FSkvIFVKZ0I6Tr0GwViunVtWSkgbR8MK8K+g2Np4JrJgZWItI7WUQjqIQbjmRY0mcLVMICeufsJKo3HuFeja3PGUo1jkO9fj2fva2DXCUBtis89FWEvjr7XQmDn1olPbnBcGQczXdFnyD9hbDZQ7A3gxgtcNZDjndWETEPYLA1bXOIIflQVeVYVI3WanfUyuzGmLDp2Vg0MERiQvnY3fanUtMqQdmYn5HDVKCwR0JKIXBu7IGSs3gcQrlSYeuQQle4Yej2AwaNd2LvrLL79M5e1UAkwZ8TJlkylrUaYsAQ8jF5uyyTiBMHAzZRN4evQiIjT0/fzoZfxe0vd4fBy/c/o+Gk/lKix65JixvKzuYYTAfzwT8dObztCgW5nGohvQINnP4xKEVE+jLVsEWHUCPSWBhBRW8MLsliliPD6xOs42JDsmybDkotgtlgM/PpkCWxsCPRt1+2yHPJ7EYxPH/9qQ5jlJ817NwApb3CNSi/L45OqxtiHcCxIuVWXFZbNbtIDw+ARrGdsQ6yWJlXF7j7kI+vgEClxFQLjwPOzweDh+Njw6PDruYcyVLnlAKMthlg2bpmmmDDqNgJOf7r5Ajq6/eP/5u5pizLlW5ZbgxsUeHVaIBdzvGBD8QGHALN6QXbTWhaeey/U73KqMN18YTypODZe0x+9CsabHpgMRHw1FtWmuRBqYJ5ygeJhRMDkiJQxJj9nBDz8ceM0k3eCwLIO6vC1olL6HTpP90bIcZdloE7ev8P5oCVmWwJbx7YAsg7Isd417ALn4VP515N4NN3ambna7dkB4fN7dMbbVwcOlEGG5kAEQvAM2EDQu6oJrvKHw1QglnfR3DoMNz4+Oz6Mr+tjVhX3uZeCZhC9PQ+j5JDgl8bNOgEYenneHzT4RjQu8cTT8m5WYEVl4PJo6zemd6l65FHkqWTThKWIS/5XyStAbokBr3SjadLTOxFSOD905n2P64V7PiRiPz3V6nEWgf3IQ+GLKSh4uXjbH7reyOeopu2znGCwwtZj15sK2yXDZ8zKekaYJ2T1ZOvZykWHBZ1h0sB5zwYw9UQlQCumZiGo4jPQclN9sQANwtcWpvRB9b4qnX/TJqDUohIlv0XUV9GeHN5zLREj0KYgZQpwAs/b03ubkXku99x2ZcvN5Z9CuM8YNxKlbnnhOp3H3BV0/sALhgUNsn89xsV0LBBHWLNPXC9EohRRlXfZSG5Fq1FgZbsG+umgm5abiCn3r3lmB3zywQsgO7VhgKsfuBZppVWVqKd0uh+2xT0B5fNu8x9nv2eZr14rH+z3bKHLV30ZbbhRC9XdJu4XM7j00glM6vymF4CcJAzxNsbKYbRzgY/ea1zwTCma1tUruPsL7WI/Pvhvc/adt/HHm7TP1Z5nY2XLskxylT0PuynCUzpaPzbKBrW3bDMK/qWQJU5XLsSt5krEJ8/n6mL1miVsKjX2tsoZNblmqpEVp6WdI8tHUg/eG6gK3zKQ5lpx+RRapkjAXBZGiPBtqwxLm3r5UViAlsglTs/eYWpZQYFlR3hUN0XDzJrcRy1gt5IIl4Y3FJsxnrVnC8IaXFSGHIUCZKnr5OBKruOJ9tNqRjpZxP9pcPtGhdPFnknFTVxullM+i1Kew6vTaEeNa84ZtVm1injhG735em9Etmnh1C0thQAwtPBpLmLBY9lfZYTWtPl3TKSqSxKWvPnWuMwsvP3lNmlflSn7WxJCP3qLzj9SSh95deN1kr+ihgVmMBIddKj0Bl5YdPeQxEd9Jyxf9NX1gc2fN810lll4VwOSqLjLK8yPXI1fp+PySFpUJeZHWrlLXHuhrkrWstpKNVwm7eViYG18N8/Ub+LLAuYW6qlBDqrRE/aSfZnk0wh0dH68S1jwsXvM/Kd4LMt7yYel+doWvrij4Z/D69OUqYfnDvH7blub+RGaPn6+6u27jLr+aqay5iufW6iHEeKkQnkGZnchTnaHuKWKmVIFc9td3r7cHKPulu/CA4hc3YColjT8cjw4P6b+Nc2mtmE+V/7bQXzR/YcnHxyb3n8x+mKKhu6dzd7C+zo++NZUs05xO1hKNWT9ct0x5QIC+3oQshMSrqJSro8PDq2ekuVXCjrcp50yVaHNKSS2pbrrUSi4SqArkVITWDfAFFxJoef0H6gq1Vvp+qT+Ns/uUcHx4eDVulfDsrhJOpMvyuP6Oc/UB5X9X0v7y1i9PrN6ULqTxIQoTHsnB2Zqw/XEvpMG01sI2bHJxy26GvBJDD59cXK4uyetsrihqr5RxHHObswk7uBPEuwYbihAvblmtCzZh955CvBIH12O2SjaxjeULIRfDe2dddoyfkXK9/tbY74KmSnyHFDUF7fSxEibIqDlyOndIH2Szn7r3yNdR8/GlsDX471S8Gc7HaH4tQN8817eE3L2I+yKGuy6CbQNY1knE2iCTfrZh40XnSG2EFgO0sYtsjo6PXQjwYuzuyqcv3TV0/Hx16TXcO5L9sUv6miun3CDwaYXyTCx8Z9b1eEukJww9gQkcO3l8Kxe9xDdmr3c6EZDGn47GsazkN9YIKPNFm54uQGrCKoT8QN0/Q7g4nc9FKngBP+PMCIvdbbhcLu941BM35xth83oGGivVoS/coHO7/qz24wmZHXVpTudnqK9FisGLdyx14JAPwnHBU3dcRGOGoX9sTqLtW4gUpcHeBn/1zdvv4Rqejg5Z0ts+H8H0wfcnb77+8exrokvb1RtpPDocHbroXRlbctlb6o1vrjvvHHrjbdmeffuOvX3H3r5jb9+xt+/Y23fs7Tv2HpNM+469fcfevmPvj6xY7zv29h17033HHuw79vYde/uOvX3H3r5jb9+xt+/Y23fs7Tv2/k869kLhiKKlg6rgwtURXaXhNpQALzb7+C4TllONcHLBbm8pc/xOF6sVDf9ao6YC42XCrrkWlAF05cUkFt6oVPUBGyo3+GrC8JzWT7zHuRreRlWV6oZ+xitnqXtx+2XMt6dn5yxhs9BrWKqM5mi+pD5EvmQTikyZ61l0GnbdZtw1khRcLmpXPWOeLtULeW3z9WLjB1dsDD96RTgumx6X61VILwr9JcG2Tvgb1Se+w+bvLbqH7JwQdBuxyYSXq9Xq36cVPxE=",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:"eJztGmtz2zbyr+zhSxsNJVuO8zjNzc0laa/19OFM7UznxvK4ELkSkZAAC4CWWY/++83iQVKyZCdp7+q7UT44Inax2BeAxe7eMssXhk0u2DmWVcEtGnaZsAxNqkVlhZJsws5zhAiGNxo5jcOrtyfAi0ItDdQGtQGrICUgQlobq0rxG58VCDYSTmCZizQHg/oagRuYFTVWWkhrYK40LFCi5lbIBWQqrUskwFLYHCqNGc6FxAyM1XVqa41mBO8qJcHUaYrGzOuiXcmzIZRMwOboGNVoay0NcKil+LVGGAwi9pXIBgOwObeQcgkzJHEykiYwhD12ZpxgSjrCpsJUzAUhB1qjqZzKd1WheAaNqqHK5iAkqFrDxWDwFc7qBbw7GQwuv8ytrczk4IBX1UhVKI1YyILPzChV5UFGiFU2fwI5anSUiLVM8yUsRbZAa4DLDFJVNZCqodIik9xiAhVfIMi6nKEGNScuyxHwwqiWiJtDYjw/Joy3X/3TMT0YvMZC9chrBFNXldIWM5KBBI56mAwGNOeNKksloeKal2jJBdQ8EpgQwpDU3FQ4GQzgRGYiJTdwlGi0wx55VGKeUM+CXj3qmkgy+BBJs+TSkpmqgqfoUDWSSay4xnXCNwk0RPgrlCpykCstflPS8sKp8hq1FSkvIFVKZ0I6Tr0GwViunVtWSkgbR8MK8K+g2Np4JrJgZWItI7WUQjqIQbjmRY0mcLVMICeufsJKo3HuFeja3PGUo1jkO9fj2fva2DXCUBtis89FWEvjr7XQmDn1olPbnBcGQczXdFnyD9hbDZQ7A3gxgtcNZDjndWETEPYLA1bXOIIflQVeVYVI3WanfUyuzGmLDp2Vg0MERiQvnY3fanUtMqQdmYn5HDVKCwR0JKIXBu7IGSs3gcQrlSYeuQQle4Yej2AwaNd2LvrLL79M5e1UAkwZ8TJlkylrUaYsAQ8jF5uyyTiBMHAzZRN4evQiIjT0/fzoZfxe0vd4fBy/c/o+Gk/lKix65JixvKzuYYTAfzwT8dObztCgW5nGohvQINnP4xKEVE+jLVsEWHUCPSWBhBRW8MLsliliPD6xOs42JDsmybDkotgtlgM/PpkCWxsCPRt1+2yHPJ7EYxPH/9qQ5jlJ817NwApb3CNSi/L45OqxtiHcCxIuVWXFZbNbtIDw+ARrGdsQ6yWJlXF7j7kI+vgEClxFQLjwPOzweDh+Njw6PDruYcyVLnlAKMthlg2bpmmmDDqNgJOf7r5Ajq6/eP/5u5pizLlW5ZbgxsUeHVaIBdzvGBD8QGHALN6QXbTWhaeey/U73KqMN18YTypODZe0x+9CsabHpgMRHw1FtWmuRBqYJ5ygeJhRMDkiJQxJj9nBDz8ceM0k3eCwLIO6vC1olL6HTpP90bIcZdloE7ev8P5oCVmWwJbx7YAsg7Isd417ALn4VP515N4NN3ambna7dkB4fN7dMbbVwcOlEGG5kAEQvAM2EDQu6oJrvKHw1QglnfR3DoMNz4+Oz6Mr+tjVhX3uZeCZhC9PQ+j5JDgl8bNOgEYenneHzT4RjQu8cTT8m5WYEVl4PJo6zemd6l65FHkqWTThKWIS/5XyStAbokBr3SjadLTOxFSOD905n2P64V7PiRiPz3V6nEWgf3IQ+GLKSh4uXjbH7reyOeopu2znGCwwtZj15sK2yXDZ8zKekaYJ2T1ZOvZykWHBZ1h0sB5zwYw9UQlQCumZiGo4jPQclN9sQANwtcWpvRB9b4qnX/TJqDUohIlv0XUV9GeHN5zLREj0KYgZQpwAs/b03ubkXku99x2ZcvN5Z9CuM8YNxKlbnnhOp3H3BV0/sALhgUNsn89xsV0LBBHWLNPXC9EohRRlXfZSG5Fq1FgZbsG+umgm5abiCn3r3lmB3zywQsgO7VhgKsfuBZppVWVqKd0uh+2xT0B5fNu8x9nv2eZr14rH+z3bKHLV30ZbbhRC9XdJu4XM7j00glM6vymF4CcJAzxNsbKYbRzgY/ea1zwTCma1tUruPsL7WI/Pvhvc/adt/HHm7TP1Z5nY2XLskxylT0PuynCUzpaPzbKBrW3bDMK/qWQJU5XLsSt5krEJ8/n6mL1miVsKjX2tsoZNblmqpEVp6WdI8tHUg/eG6gK3zKQ5lpx+RRapkjAXBZGiPBtqwxLm3r5UViAlsglTs/eYWpZQYFlR3hUN0XDzJrcRy1gt5IIl4Y3FJsxnrVnC8IaXFSGHIUCZKnr5OBKruOJ9tNqRjpZxP9pcPtGhdPFnknFTVxullM+i1Kew6vTaEeNa84ZtVm1injhG735em9Etmnh1C0thQAwtPBpLmLBY9lfZYTWtPl3TKSqSxKWvPnWuMwsvP3lNmlflSn7WxJCP3qLzj9SSh95deN1kr+ihgVmMBIddKj0Bl5YdPeQxEd9Jyxf9NX1gc2fN810lll4VwOSqLjLK8yPXI1fp+PySFpUJeZHWrlLXHuhrkrWstpKNVwm7eViYG18N8/Ub+LLAuYW6qlBDqrRE/aSfZnk0wh0dH68S1jwsXvM/Kd4LMt7yYel+doWvrij4Z/D69OUqYfnDvH7blub+RGaPn6+6u27jLr+aqay5iufW6iHEeKkQnkGZnchTnaHuKWKmVIFc9td3r7cHKPulu/CA4hc3YColjT8cjw4P6b+Nc2mtmE+V/7bQXzR/YcnHxyb3n8x+mKKhu6dzd7C+zo++NZUs05xO1hKNWT9ct0x5QIC+3oQshMSrqJSro8PDq2ekuVXCjrcp50yVaHNKSS2pbrrUSi4SqArkVITWDfAFFxJoef0H6gq1Vvp+qT+Ns/uUcHx4eDVulfDsrhJOpMvyuP6Oc/UB5X9X0v7y1i9PrN6ULqTxIQoTHsnB2Zqw/XEvpMG01sI2bHJxy26GvBJDD59cXK4uyetsrihqr5RxHHObswk7uBPEuwYbihAvblmtCzZh955CvBIH12O2SjaxjeULIRfDe2dddoyfkXK9/tbY74KmSnyHFDUF7fSxEibIqDlyOndIH2Szn7r3yNdR8/GlsDX471S8Gc7HaH4tQN8817eE3L2I+yKGuy6CbQNY1knE2iCTfrZh40XnSG2EFgO0sYtsjo6PXQjwYuzuyqcv3TV0/Hx16TXcO5L9sUv6miun3CDwaYXyTCx8Z9b1eEukJww9gQkcO3l8Kxe9xDdmr3c6EZDGn47GsazkN9YIKPNFm54uQGrCKoT8QN0/Q7g4nc9FKngBP+PMCIvdbbhcLu941BM35xth83oGGivVoS/coHO7/qz24wmZHXVpTudnqK9FisGLdyx14JAPwnHBU3dcRGOGoX9sTqLtW4gUpcHeBn/1zdvv4Rqejg5Z0ts+H8H0wfcnb77+8exrokvb1RtpPDocHbroXRlbctlb6o1vrjvvHHrjbdmeffuOvX3H3r5jb9+xt+/Y23fs7Tv2HpNM+469fcfevmPvj6xY7zv29h17033HHuw79vYde/uOvX3H3r5jb9+xt+/Y23fs7Tv2/k869kLhiKKlg6rgwtURXaXhNpQALzb7+C4TllONcHLBbm8pc/xOF6sVDf9ao6YC42XCrrkWlAF05cUkFt6oVPUBGyo3+GrC8JzWT7zHuRreRlWV6oZ+xitnqXtx+2XMt6dn5yxhs9BrWKqM5mi+pD5EvmQTikyZ61l0GnbdZtw1khRcLmpXPWOeLtULeW3z9WLjB1dsDD96RTgumx6X61VILwr9JcG2Tvgb1Se+w+bvLbqH7JwQdBuxyYSXq9Xq36cVPxE=",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 b(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.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- **values:** Provide options for the radio button list.\n- **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)(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)(i.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)(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)(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)(o.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)(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)(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)(o.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)(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)(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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink