WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 17:44:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
92e933b61311535c94aac28df67bcb73eeda2e77
OpenSign/assets/js/bbdfc22d.52af9f43.js
T

1 line
30 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var a=s(85893),r=s(11151),i=s(58219),l=(s(62316),s(51039)),t=s.n(l),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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f4pFyI1LKv+dnr25G9q99+6hwxPaBhNhB6rtKmm8Kz06PKR/G15srfxPvQJNa0Cx/IIlHx/J3O3H/TDFTrd9eeuGX+ZH35pKlmlOfrhEY9Zd8ZYl9zDQlZuQhZB4GYVyeXR4ePmEJLdK2PE24bxVJdqcklhzqrTOtZKzBKoCOZWt9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9LlhVxHyJm6QvnHctrd3vrtidRF6QIgH9Aw4YHcPFtjtjvumTSY1lrYJRud37BFn1ei7+dH5xerC7I6myuK8StlHMXc5mzEDm6F/K4lh+LJ8xtW64KNWPRZhsuMcje3/BavxMH1kK2SzRVbvdxOaGP5TMhZ/85VFy2rb0kdXuJrDLdBWSW+Q4rKgjy7UAkTZAY5cvJrJEHS8k/te+frqKv4Etn6uGiVsvlciK+FtQfA5r2xJaTvRPTnMZx2EXITILOWI9YEsfSzCUvPW9NrIsAYAA5d5HR0fOxCjGdDdxc/fu6uueOnqwsv4Y7Ld0/Mrlf3npsEOFVO2kECpxXKt2Lm28Guh7cvdCxSVaJLF+YIEfw///q3WxE7ityZ+wJOaw2VmqOmdi5qgZkWuBDUWNLpNqP3istl8rJAY+gRIy3OfKeWmLl0PImAXErKKz4RhaBTSmDKl606B90M4OccKbtBU19qX5m4xoIONxRKXbmWGgW8tqrsdoPBXOmrKZGUAIcJ9d6gMWAQ4xKUOZcpJSW88SagNHAJKC3qSguDwEVJwJQEwelUpIIQk0vSPLVQcslnSJslLrAgKVSxc0arCeU8jSpqn0mh/h1E61l0SZEBvKZmKMc4DWZouSgwg1lNKBIgq4bgoYgNmcEEjYWKthcpmrYGWeA1andYnSbpUoJKkesUvKAoqKtbQmQ1l4ZCF09QVE0jvkorut3cHhlfDoDyL3QbUBxFBlAIeUWNZH04b8zsZ5wYYbENqubz+S3H8Wh9zTfC5vUENFaqXTdzg87NdJc3H4/omKMuzen0LeprkWLwWjv2PHDAB+FC4am7UOLh5ZX4++YCcu6FSFEa7Lj/F9+8+R6u4fHgkCUdV/kRBB98f/Lq6x/ffk14yZn78zccHA4O3UtQGVty2dnqlW/WPGud10aeorkZ9x2g+w7QfQfovgN03wG67wDdd4A+JJ72HaD7DtB9B+jv2QGx7wDdd4CO9x2gsO8A3XeA7jtA9x2g+w7QfQfovgN03wG67wD9P+oADYVCipgOqoILV2l21YabUCQ+3+wLvUhYTlXk0Tm7uaHs8TtdrFY0/KFGTSXoi4Rdcy0oC+gK0EkstFJp8gqXVHLwFYX+Ge2feKtz5ZGNujvVif2KF05Nd8J2C91vTt+esYRNQu9qqTJao/mc+lr5nI0oOmWuB9ZJ2HUvcteYVHA5q121lHm8VB/mtc3Xi8tXrrgcfnSKrlwuO1SuV509K/SXGNu64K9Uo/gOl39rwP3MzgVBthGaVHixWq3+Czi1HRI=",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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UHGg2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3N2hmVVcIuGXSQsQ5NqUVmhJBuxsxwhTsMrjZzG4cWbE+BFoeYGaoPagFWQ0iRCWhurSvErnxQINiJOYJ6LNAeD+hqBG5gUNVZaSGtgqjTMUKLmVsgZZCqtS6SJubA5VBoznAqJGRir69TWGs0A3lVKgqnTFI2Z1kWzkydDKJmAzdERqtHWWhrgUEvxoUbo9SL0pch6PbA5t5ByCRMkdjLiJhCEHXImnOaUdIhNhamYCgIOuAZjOZbvqkLxDJaqhiqbgpCgag3nvd5rnNQzeHfS6118lVtbmdHBAa+qgapQGjGTBZ+YQarKg4wAq2z6CHLU6DARaZnmc5iLbIbWAJcZpKpaQqr6SotMcosJVHyGIOtyghrUlKgsB8ALoxokbg2x8fSYIN68/ocjutd7iYXqoNcIpq4qpS1mxAMxHOUw6vVozStVlkpCxTUv0ZIJqGlEMCKAPol5WeGo14MTmYmUzMBhotEWeuBBiXgCfRvk6kHXWJLBhoibOZeW1FQVPEUHqpFUYsU1riNeJLAkxK9RqkhBrrT4VUnLCyfKa9RWpLyAVCmdCeko9RIEY7l2ZlkpIW0cDTvAP4Nga+OJyIKWibSMxFIK6WYMwjUvajSBqnkCOVH1E1YajTOvgNfmjqYcxSzfuR/P3tfGriGG2hCZXSrCXho/1EJj5sSLTmxTXhgEMV2TZcmvsLMbKOcDeDGAl0vIcMrrwiYg7JcGrK5xAD8qC7yqCpG6w07nmEyZ0xHtOy0HgwiESF46Hb/R6lpkSCcyE9MpapQWaNKhiFYYqCNjrNwCYq9UmmjkEpTsKHo4gF6v2duZ6C+//DKWN2MJMGZEy5iNxqwBGbME/ByZ2JiNhgmEgcWYjeDx0bMIsKTvp0fP4/ecvofD4/id0/fRcCxXYdMjR4zlZXUHITT9+xMRP73qDA26nWksmgENkv48LM2Q6Gm0IYsmVi1Dj4khIYUVvDC7eYoQD4+tlrINzo6JMyy5KHaz5aYfHk+BrA2Gngzac7aDH4/iobHjf21w85S4ea8mYIUt7mCpAXl4fHVI22DuGTGXqrLicrmbtQDw8BhrCNtg6zmxlXF7h7po9uExFKiKE+HC83OHx/3hk/7R4dFxB2KqdMkDQFn2s6y/XC6XYwatRMDxT3dfQEfXX7z//F1NMeZUq3JLcONijxYqxALudwwIfqAwYBJvyDZaa8NTT+X6HW5VxpdfGo8qLg2XtIdvQ7Flh0w3RXQsKapNcyXSQDzBBMHDhILJAQmhT3LMDn744cBLJmkH+2UZxOV1QaP03XeS7I6W5SDLBpuwXYF3R0vIsgS2jG+fyDIoy3LXuJ8gEx/Lvwzcu2FhJ2qx27QDwMOz7pawrQYeLoU4lwsZJoJ1wAaAxlldcI0LCl+NUNJxf8sZbFh+NHweTdHHri7scy8DTyR8dRpCz0fBKImedQQ0cv+6W2R2kWic4cLh8G9WIkZk4fFo6jSnd6p75VLkqWSxDE8Rk/ivlFeC3hAFWutG0aaDdSLGcnjo/HyO6dWdlhMhHp7pdCiLk/7JQdPnY1bycPGyKba/lc1Rj9lFs8ZgganFrLMWti2Gi46V8YwkTcDuydKSl4sMCz7Bop3rEBfU2GGVJkohPRFRDIcRn5vli43ZMLnaYtSeia41Re8XbTJKDQph4lt0XQTd1eEN5zIREn0KYoIQF8Ck8d7bjNxLqfO+I1VuPu8M2nXCuIG4dMsTz8k0nr4g63t2IDhwgM3zOW62a4PAwppmunIhHKWQoqzLTmojYo0SK8Mt2BUXraTcVNyhq91bO/DFPTuE7NCODcZy6F6gmVZVpubSnXLYHvsEkId3zDuU/ZZjvnateLjfcowiVd1jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Eenn43qPsDdEwMf5yWu7T9WZoey6FPdJQ+Fbkry1E6fT407QaytqshXHGSJUxVLs+u5EnGRszn7GMGmyVuKzT2pcqWbHTDUiUtSks/Q6KPlh68N1QbuGEmzbHk9CuSSNWEqSgIFeXaUBuWMPf+pdICCZGNmJq8x9SyhILLinKvaAiHWze6iVDGaiFnLAnvLDZiPnPNEoYLXlYEHIYAZaro9eNQrOKOd+FqRlpcxv1o8vmEh1LGn4nGLV1tlFM+C1MXw6qVa4uMa82XbLNyE3PFMYL365qsbrGM17ewFArE8MKDsYQJi2V3lx1a0+rTJZ2iIk5cCutT1zq18PKT96R1Va7kZy0MOektMv9IKfnZ2xuvq+wFPTYwi9Fgv02nJ+BSs4P7LCbCO275rLunD25u7Xm2q8zSqQSYXNVFRrl+5Hrgqh2fX9aiUiEv0tpV6xpvvsZZQ2rD2XCVsMX9zCx8RczXcOCrAqcW6qpCDanSEvWjbqrlwTB3dHy8StjyfvaW/5PsPSPlze/n7mdX/GoLg38GrY+frxKW30/rt0157k8k9vjpqr3rNu7yy4nKlpfRb63uA4yXCsEZlNmJPNUZ6o4gJkoVyGV3f4pFyI1LKv+dnr25G9q99+6hwxPaBhNhB6rtKmm8Kz06PKR/G15srfxPvQJNa0Cx/IIlHx/J3O3H/TDFTrd9eeuGX+ZH35pKlmlOfrhEY9Zd8ZYl9zDQlZuQhZB4GYVyeXR4ePmEJLdK2PE24bxVJdqcklhzqrTOtZKzBKoCOZWt9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9LlhVxHyJm6QvnHctrd3vrtidRF6QIgH9Aw4YHcPFtjtjvumTSY1lrYJRud37BFn1ei7+dH5xerC7I6myuK8StlHMXc5mzEDm6F/K4lh+LJ8xtW64KNWPRZhsuMcje3/BavxMH1kK2SzRVbvdxOaGP5TMhZ/85VFy2rb0kdXuJrDLdBWSW+Q4rKgjy7UAkTZAY5cvJrJEHS8k/te+frqKv4Etn6uGiVsvlciK+FtQfA5r2xJaTvRPTnMZx2EXITILOWI9YEsfSzCUvPW9NrIsAYAA5d5HR0fOxCjGdDdxc/fu6uueOnqwsv4Y7Ld0/Mrlf3npsEOFVO2kECpxXKt2Lm28Guh7cvdCxSVaJLF+YIEfw///q3WxE7ityZ+wJOaw2VmqOmdi5qgZkWuBDUWNLpNqP3istl8rJAY+gRIy3OfKeWmLl0PImAXErKKz4RhaBTSmDKl606B90M4OccKbtBU19qX5m4xoIONxRKXbmWGgW8tqrsdoPBXOmrKZGUAIcJ9d6gMWAQ4xKUOZcpJSW88SagNHAJKC3qSguDwEVJwJQEwelUpIIQk0vSPLVQcslnSJslLrAgKVSxc0arCeU8jSpqn0mh/h1E61l0SZEBvKZmKMc4DWZouSgwg1lNKBIgq4bgoYgNmcEEjYWKthcpmrYGWeA1andYnSbpUoJKkesUvKAoqKtbQmQ1l4ZCF09QVE0jvkorut3cHhlfDoDyL3QbUBxFBlAIeUWNZH04b8zsZ5wYYbENqubz+S3H8Wh9zTfC5vUENFaqXTdzg87NdJc3H4/omKMuzen0LeprkWLwWjv2PHDAB+FC4am7UOLh5ZX4++YCcu6FSFEa7Lj/F9+8+R6u4fHgkCUdV/kRBB98f/Lq6x/ffk14yZn78zccHA4O3UtQGVty2dnqlW/WPGud10aeorkZ9x2g+w7QfQfovgN03wG67wDdd4A+JJ72HaD7DtB9B+jv2QGx7wDdd4CO9x2gsO8A3XeA7jtA9x2g+w7QfQfovgN03wG67wD9P+oADYVCipgOqoILV2l21YabUCQ+3+wLvUhYTlXk0Tm7uaHs8TtdrFY0/KFGTSXoi4Rdcy0oC+gK0EkstFJp8gqXVHLwFYX+Ge2feKtz5ZGNujvVif2KF05Nd8J2C91vTt+esYRNQu9qqTJao/mc+lr5nI0oOmWuB9ZJ2HUvcteYVHA5q121lHm8VB/mtc3Xi8tXrrgcfnSKrlwuO1SuV509K/SXGNu64K9Uo/gOl39rwP3MzgVBthGaVHixWq3+Czi1HRI=",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"}},g={},j=[{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,r.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)(t(),{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)(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:!0}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"enableOTP",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,r.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink