WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-12 12:47:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
7a53ce64fb8ca4c66eec86e43e9faa2eba21b37b
OpenSign/assets/js/bbdfc22d.d268a821.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:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),i=n(11151),l=n(58219),t=(n(62316),n(51039)),r=n.n(t),d=(n(82723),n(9487)),o=(n(41429),n(5397)),c=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:"eJztGmtvGzfyr/D4pY2wkiVHeZxwOFyS9lqjDwe1g+JgGS61HGmZ7JJbkmtpa+i/H4aP3ZUs2UlatLqDvthazoPzIjnkzB21bGHo5IpeQlHmzIKh1wnlYFItSiuUpBN6mQGJYPJGA8Nx8urtGWF5rpaGVAa0IVaRFIFA0spYVYjf2CwHYiPjhCwzkWbEgL4FwgyZ5RWUWkhryFxpsgAJmlkhF4SrtCoAAUthM1Jq4DAXEjgxVleprTSYAXlXKklMlaZgzLzKm5m8GELJhNgMnKAabKWlIYxUUvxaAen1IvaN4L0esRmzJGWSzADV4ahNEAg64swYwpR0jE0JqZgLRA68BlM5le/KXDFOalWRks+JkERVmlz1el/BrFqQd2e93vWXmbWlmZycsLIcqBKkEQuZs5kZpKo44YhY8vkTkoEGxwlF45otyVLwBVhDmOQkVWVNUtVXWnDJLCSkZAsgsipmoImao5TFgLDcqIaJo0E1no8R4+1X/3ZC93qvIVcd9hqIqcpSaQscdUCFox0mvR7SvFFFoSQpmWYFWAwBNY8MJojQRzPXJUx6PXImuUgxDBwnHG2xBx4VhUfUi2BXj7qhkgwxhNosmbTopjJnKThUDegSK25hk/EqITUy/gqkihJkSovflLQsd6a8BW1FynKSKqW5kE5Sb0FiLNMuLEslpI2jYQbyn2DYynghePAyisbRLIWQDmKA3LK8AhOkWiYkQ6l+glKDceEV+NrMyZSBWGR752P8fWXsBmNSGRSzK0WYS8OvldDAnXnBmW3OcgNEzDdsWbAP0JmNKLcHsHxAXteEw5xVuU2IsF8YYnUFA/KjsoSVZS5St9hxHWMoM1yifeflEBBBEMkK5+O3Wt0KDrgiuZjPQYO0BIGORYzCIB0GY+kIUL1CaZSRSaJkx9GjAen1mrldiP7yyy9TeTeVhEwpyjKlkyltUKY0IR6GITalk1FCwsBqSifk6emLiFDj9/PTl/F7id+j0Th+Z/h9OprKdZj01AljWVE+IAiC/3gh4qd3ncFBNzOOxTDAQfSfx0UImh5HG7EQsG4VeooKCSmsYLnZr1PEODy1Wsm2NBujZlAwke9Xy4EPT6cg1pZCzwbtOtujj2dxaOr4X1vaPEdt3qsZscLmD6jUoByeXh3RtpR7gcqlqiiZrPerFhAOT7FGsC21XqJanNkH3IXQw1MoSBUB4cDzsOG4P3rWPx2ejjsYc6ULFhCKos95v67rekpJaxHi9MezL7DD4y+ef/6sxhxzrlWxI7lxuUeLFXIB9zsmBD9gGjCLJ2SbrbXpqZdy8wy3irP6C+NZRdJwSHv8NhWrO2I6EMpRY1abZkqkQXjECYYnM0wmB2iEPtqRn/zww4m3TNIO9osimMv7Akfxu+8s2R0tigHng23crsG7owXhPCE7xncDOCdFUewb9wAM8an8+8DdG1Z2plb7QzsgHF50t4LtDPBwKERYJmQAhOggWwgaFlXONKwwfTVCSaf9vc1gK/Jj4LMYij53dWmfuxl4IcmX5yH1fBKCEuXZZIAjj9PdE7PLRMMCVo6Hv7OiMIKHy6Op0gzvqe6Wi5mnknkdriIm8V8pKwXeIXKw1o2CTQebQkzlaOj2+QzSDw9GTsQ4vNDpSBaB/sqB4KspLVg4eOkc2t/KZqCn9LqhMZBDaoF3aMkuYnLdiTLG0dKI7K4srXiZ4JCzGeQtrCNccGNHVQQUQnohohmGkZ+DstUWNADXO4LaK9GNprj7xZiMViO5MPEuummCLnW4w7mXCAn+CWIGJBKQWbN77wpyb6XO/Q5duX29M2A3BWOGRNIdVzxn07j6gq0fmQHxiENsrs9xsn0TBBU2PNO1C/IohBRFVXSeNiLXaLEinIJdcyElvk3FGbrevTcDWz0yQ3gd2jPBVI7cDZRrVXK1lG6Vk925T0A5vGXekez3LPONY8Xj/Z5lFKXqLqMdJwqi+rOkWUJm/xoakHPcv/EJwRMJQ1iaQmmBb23gI3eb14wLRWaVtUru38K7WIfn3y3p/gQfo8If5+WubH+Vp6dy5B86Cv8Uue+Vo3D+PDTvBrF2uyEccZImVJXunV3JM04n1L/ZxxdsmripwNjXitd0ckdTJS1Iiz/DQx+Snrw3WBu4oybNoGD4K4qI1YS5yJEVvrWBNjSh7v6LpQU0Ip1QNXsPqaUJJpclvr2CQR6ObnIXsYzVQi5oEu5ZdEL9yzVNKKxYUSJyGCIgU4W3H8diHWd8iFcz0vIy7kfzno988Mn4M9k40vVWOeWzOHU5rFu7tsyY1qym25Wb+FYcM3hP17zq5nU8voXFVCCmFx6NJlRYKLqz7PGaVp9u6RQUauKesD6V1rmFFZ88J9KVmZKfRRjepHfY/COt5KH3J9502Su8bACP2WC/fU5PiHuaHTwWMRHfacsW3Tl9cnNvzst9ZZZOJcBkqso5vvUD0wNX7fj8shaWClmeVq5a1+zmG5o1ojaajdYJXT2uzMpXxHwNh3yZw9ySqixBk1RpCfpJ96nlYJQ7HY/XCa0fV6/+n1TvBTpv+bh2P7viV1sY/CtkffpyndDscVm/bcpzf6Gw4+fr9qzbOstvZorXN3HfWj+GGA8VxDMg+Zk81xx0xxAzpXJgsju/u8E9wtlP3aYHmL+4AVMqafzmeDoc4r+tfWmjoI/V/6bYn9d/o8nH5yYP78x+GLOh+7tzu7G+zk6/NaUs0gx31gKM2dxcd5A8okDXbkLmQsJNNMrN6XB48wwtt07oeJdxLlQBNsNnqSXWTpdayUVCyhwYFqJ1TdiCCUlwev0H2gq0VvphrT9NsoeMMB4Ob0aNEZ7dN8KZdC89rsfjUn0A+edq2p3e+ulR1FXhUhqfolDhkRycbijbHfdKGkgrLWxNJ1d3dNVnpeh7+OTqen2NUWczhVl7qYyTmNmMTujJvSTeNdlghnh1Ryud0wl9cBdipTi5HdF1so1tLFsIueg/SHXdCn6BxvX22xC/TZpK8R1g1hSs08VKqECnZsBw30F7oM9+au8jX0fLx5vCzuS/NfF2Oh+z+Y0EfXtf35FydzLuq5juugy2SWBpqxFtkkz82aSNV20gNRlaTNBGLrM5HY9dCvBi5M7Kpy/dMTR+vr72Fu5syX7bRXvNlTNuUPi8BHkhFr4763a0I9MTBu+/CI7dPL6dC6/hW9Sb3U4IxPGng1EsLfmFNSB4ccZFjwcgNmLlQn7ADqA+uTqfz0UqWE5+hpkRFtrTcLlc3ouoJ47mG2GzakY0lKpFX7hBF3ZdqubjCboddGHO5xegb0UKIYr3THXikE/CdsFSt11EZ4ahf20T4fLNRQrSQGeBv/rm7ffkljwdDGnSWT4fIfTJ92dvvv7x4mvki8vVO2k0GA6GLntXxhZMdqZ64xvsLtuA3rpbNnvfsWvv2LV37No7du0du/aOXXvHrr1D0unYtXfs2jt27f2RVetj196xa2967Nojx669Y9fesWvv2LV37No7du0du/aOXXvHrr3/o669UDzCjOmkzJlwtURXbbgLZcCr7V6+64RmWCecXNG7O3w9fqfz9RqHf61AY5HxOqG3TAt8BXQlxiQW37Bc9QFqLDn4ikL/EudPfNS5Ot5WZRVrh57ilXPTg7jdUubb84tLmtBZ6DcsFEcazZbYi8iWdILZKXV9i87CruOMuWaSnMlF5Spo1PPFmiGrbLZZcPzgCo7hR6cQx2TdkXKzEulVwb+o2E6Cf2CN4juo/9mge8hegmDbiI0uvF6v1/8FPV9BJQ==",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:"eJztGmtvGzfyr/D4pY2wkiVHeZxwOFyS9lqjDwe1g+JgGS61HGmZ7JJbkmtpa+i/H4aP3ZUs2UlatLqDvthazoPzIjnkzB21bGHo5IpeQlHmzIKh1wnlYFItSiuUpBN6mQGJYPJGA8Nx8urtGWF5rpaGVAa0IVaRFIFA0spYVYjf2CwHYiPjhCwzkWbEgL4FwgyZ5RWUWkhryFxpsgAJmlkhF4SrtCoAAUthM1Jq4DAXEjgxVleprTSYAXlXKklMlaZgzLzKm5m8GELJhNgMnKAabKWlIYxUUvxaAen1IvaN4L0esRmzJGWSzADV4ahNEAg64swYwpR0jE0JqZgLRA68BlM5le/KXDFOalWRks+JkERVmlz1el/BrFqQd2e93vWXmbWlmZycsLIcqBKkEQuZs5kZpKo44YhY8vkTkoEGxwlF45otyVLwBVhDmOQkVWVNUtVXWnDJLCSkZAsgsipmoImao5TFgLDcqIaJo0E1no8R4+1X/3ZC93qvIVcd9hqIqcpSaQscdUCFox0mvR7SvFFFoSQpmWYFWAwBNY8MJojQRzPXJUx6PXImuUgxDBwnHG2xBx4VhUfUi2BXj7qhkgwxhNosmbTopjJnKThUDegSK25hk/EqITUy/gqkihJkSovflLQsd6a8BW1FynKSKqW5kE5Sb0FiLNMuLEslpI2jYQbyn2DYynghePAyisbRLIWQDmKA3LK8AhOkWiYkQ6l+glKDceEV+NrMyZSBWGR752P8fWXsBmNSGRSzK0WYS8OvldDAnXnBmW3OcgNEzDdsWbAP0JmNKLcHsHxAXteEw5xVuU2IsF8YYnUFA/KjsoSVZS5St9hxHWMoM1yifeflEBBBEMkK5+O3Wt0KDrgiuZjPQYO0BIGORYzCIB0GY+kIUL1CaZSRSaJkx9GjAen1mrldiP7yyy9TeTeVhEwpyjKlkyltUKY0IR6GITalk1FCwsBqSifk6emLiFDj9/PTl/F7id+j0Th+Z/h9OprKdZj01AljWVE+IAiC/3gh4qd3ncFBNzOOxTDAQfSfx0UImh5HG7EQsG4VeooKCSmsYLnZr1PEODy1Wsm2NBujZlAwke9Xy4EPT6cg1pZCzwbtOtujj2dxaOr4X1vaPEdt3qsZscLmD6jUoByeXh3RtpR7gcqlqiiZrPerFhAOT7FGsC21XqJanNkH3IXQw1MoSBUB4cDzsOG4P3rWPx2ejjsYc6ULFhCKos95v67rekpJaxHi9MezL7DD4y+ef/6sxhxzrlWxI7lxuUeLFXIB9zsmBD9gGjCLJ2SbrbXpqZdy8wy3irP6C+NZRdJwSHv8NhWrO2I6EMpRY1abZkqkQXjECYYnM0wmB2iEPtqRn/zww4m3TNIO9osimMv7Akfxu+8s2R0tigHng23crsG7owXhPCE7xncDOCdFUewb9wAM8an8+8DdG1Z2plb7QzsgHF50t4LtDPBwKERYJmQAhOggWwgaFlXONKwwfTVCSaf9vc1gK/Jj4LMYij53dWmfuxl4IcmX5yH1fBKCEuXZZIAjj9PdE7PLRMMCVo6Hv7OiMIKHy6Op0gzvqe6Wi5mnknkdriIm8V8pKwXeIXKw1o2CTQebQkzlaOj2+QzSDw9GTsQ4vNDpSBaB/sqB4KspLVg4eOkc2t/KZqCn9LqhMZBDaoF3aMkuYnLdiTLG0dKI7K4srXiZ4JCzGeQtrCNccGNHVQQUQnohohmGkZ+DstUWNADXO4LaK9GNprj7xZiMViO5MPEuummCLnW4w7mXCAn+CWIGJBKQWbN77wpyb6XO/Q5duX29M2A3BWOGRNIdVzxn07j6gq0fmQHxiENsrs9xsn0TBBU2PNO1C/IohBRFVXSeNiLXaLEinIJdcyElvk3FGbrevTcDWz0yQ3gd2jPBVI7cDZRrVXK1lG6Vk925T0A5vGXekez3LPONY8Xj/Z5lFKXqLqMdJwqi+rOkWUJm/xoakHPcv/EJwRMJQ1iaQmmBb23gI3eb14wLRWaVtUru38K7WIfn3y3p/gQfo8If5+WubH+Vp6dy5B86Cv8Uue+Vo3D+PDTvBrF2uyEccZImVJXunV3JM04n1L/ZxxdsmripwNjXitd0ckdTJS1Iiz/DQx+Snrw3WBu4oybNoGD4K4qI1YS5yJEVvrWBNjSh7v6LpQU0Ip1QNXsPqaUJJpclvr2CQR6ObnIXsYzVQi5oEu5ZdEL9yzVNKKxYUSJyGCIgU4W3H8diHWd8iFcz0vIy7kfzno988Mn4M9k40vVWOeWzOHU5rFu7tsyY1qym25Wb+FYcM3hP17zq5nU8voXFVCCmFx6NJlRYKLqz7PGaVp9u6RQUauKesD6V1rmFFZ88J9KVmZKfRRjepHfY/COt5KH3J9502Su8bACP2WC/fU5PiHuaHTwWMRHfacsW3Tl9cnNvzst9ZZZOJcBkqso5vvUD0wNX7fj8shaWClmeVq5a1+zmG5o1ojaajdYJXT2uzMpXxHwNh3yZw9ySqixBk1RpCfpJ96nlYJQ7HY/XCa0fV6/+n1TvBTpv+bh2P7viV1sY/CtkffpyndDscVm/bcpzf6Gw4+fr9qzbOstvZorXN3HfWj+GGA8VxDMg+Zk81xx0xxAzpXJgsju/u8E9wtlP3aYHmL+4AVMqafzmeDoc4r+tfWmjoI/V/6bYn9d/o8nH5yYP78x+GLOh+7tzu7G+zk6/NaUs0gx31gKM2dxcd5A8okDXbkLmQsJNNMrN6XB48wwtt07oeJdxLlQBNsNnqSXWTpdayUVCyhwYFqJ1TdiCCUlwev0H2gq0VvphrT9NsoeMMB4Ob0aNEZ7dN8KZdC89rsfjUn0A+edq2p3e+ulR1FXhUhqfolDhkRycbijbHfdKGkgrLWxNJ1d3dNVnpeh7+OTqen2NUWczhVl7qYyTmNmMTujJvSTeNdlghnh1Ryud0wl9cBdipTi5HdF1so1tLFsIueg/SHXdCn6BxvX22xC/TZpK8R1g1hSs08VKqECnZsBw30F7oM9+au8jX0fLx5vCzuS/NfF2Oh+z+Y0EfXtf35FydzLuq5juugy2SWBpqxFtkkz82aSNV20gNRlaTNBGLrM5HY9dCvBi5M7Kpy/dMTR+vr72Fu5syX7bRXvNlTNuUPi8BHkhFr4763a0I9MTBu+/CI7dPL6dC6/hW9Sb3U4IxPGng1EsLfmFNSB4ccZFjwcgNmLlQn7ADqA+uTqfz0UqWE5+hpkRFtrTcLlc3ouoJ47mG2GzakY0lKpFX7hBF3ZdqubjCboddGHO5xegb0UKIYr3THXikE/CdsFSt11EZ4ahf20T4fLNRQrSQGeBv/rm7ffkljwdDGnSWT4fIfTJ92dvvv7x4mvki8vVO2k0GA6GLntXxhZMdqZ64xvsLtuA3rpbNnvfsWvv2LV37No7du0du/aOXXvHrr1D0unYtXfs2jt27f2RVetj196xa2967Nojx669Y9fesWvv2LV37No7du0du/aOXXvHrr3/o669UDzCjOmkzJlwtURXbbgLZcCr7V6+64RmWCecXNG7O3w9fqfz9RqHf61AY5HxOqG3TAt8BXQlxiQW37Bc9QFqLDn4ikL/EudPfNS5Ot5WZRVrh57ilXPTg7jdUubb84tLmtBZ6DcsFEcazZbYi8iWdILZKXV9i87CruOMuWaSnMlF5Spo1PPFmiGrbLZZcPzgCo7hR6cQx2TdkXKzEulVwb+o2E6Cf2CN4juo/9mge8hegmDbiI0uvF6v1/8FPV9BJQ==",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 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)(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)(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)(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)(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)(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)(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)(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)(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)(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)(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)(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)(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)(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: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