diff --git a/404.html b/404.html index 6b55a5780..a47e61b68 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.1a71e32c.js b/assets/js/0028a090.1a71e32c.js deleted file mode 100644 index 24d124dcf..000000000 --- a/assets/js/0028a090.1a71e32c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var s=t(85893),l=t(11151),i=t(58219),n=(t(62316),t(51039)),r=t.n(n),d=(t(82723),t(9487)),o=(t(41429),t(5397)),m=t(4667),c=t(9472),p=t(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWjNVyKG683F3vQ7Iq8L8XsxQlSnbSIsipF5ua93wz85E7CHzlIZ/DDGureEAPiwwK9MJJG6TRkMOsQvab42VgnRG7vL1mXCmz8WxrIguGCYekENEHU8u/+VIhK5JT6CKzEUUiV4chOu0ZZ1HLx4hsMOis7mUxGLBQ8cAE12yJLHosKMMKNTrKURgRa9TBsyUnndEsVMi8RSFLScZdmVwXbDCITlFIw7CQx3JGkIGxFFEafV1ADqncTg0ZOHyM6MOvpthCvgNhdEAd6JFbq6RInuNPnkDagRcV1pyewtYi5GCWn1AEyMA6yhMketKWUmHPygcn9QoyKI2reYAcqKkf30IG+MRrS8Z7EUMtTIEFSyGaDIIM/xLrIDnG8unhAAPF0SZ8bZjk2pxtzFdF6kdojs2dTuV+ScNoSE/TkQ4LyIOLmATeGu1blF9PJvTvbJG7vWiXtWA+CoHel1Gp7XeQfasRt2LaqYOljvUSHSEVnXoJoSMeVQjW5+NxdGoYzJCWdnhYWmHqE3SkVlLjfdf7/evJ5L4IhFCTwdvJD89BuNZrrmSR7nBmHlB/w8bROeO+3F0/fWjTU6lPdUJF87rtKhklPZx025e3TXoU0cmwhXy+g6cht3LY6vP5ollkUGOoDJ23NT5VzEMFOYzPr92jW6PzKUya0WEQPvCV1Ksht3ZkLGovV1rxpadhjLmV4/UFUKaukimh1QJyUs8BFm7lB9xC1rXbt8pA0pQq5AXtS5MBDeGPIxVddVB2VPIiOxwxO7/37txPLvic8l+6SaqsNKmNfegbi3oqVzoNc33xLMqskp5Jn9QdaafFYqVx7Mz7lMxJSfI3o4uO2NudHLE7faenpk4vhjIqpqR+8PmdHrL5TVlKIblif+HSy4CL77sZbjabZ7N7lXzey1DFJXNozdF8lYRpwH2vw49XBDC62t+UU3RrKbrD/UyqcTIe7y+Ni3RpWHNJe7YX/XLuRJArKVB77N3G5fvbj+zNaAJZb03/Q8njj9fvrn6fXlFUWvR2RBejyWhCIrqOmuteotNX/vlwe+/D//EHwv5gAz6FsVVc6h6Dt0QyP/tsWGRQEdHkc9jtKP2fTjUNiR8jOmKpRQZr7iQBkDgq646dmOcBt5DDuxba4YzSk7mKLW+cUXOTdR6XQqANX7Ttc+HtzXQGGSz3nza1KcjH8Q199vAN5HAHd5C+kChC4rIk34HiehX5iuzbuMRRPBIWfYJ7SAS3f6DOOpXe9qo8Zb62FfpLjb3o8BNtxwfc/nwwbzWfddhj21nTBBdN0/wD7CPKug==",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/drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWjNVyKG683F3vQ7Iq8L8XsxQlSnbSIsipF5ua93wz85E7CHzlIZ/DDGureEAPiwwK9MJJG6TRkMOsQvab42VgnRG7vL1mXCmz8WxrIguGCYekENEHU8u/+VIhK5JT6CKzEUUiV4chOu0ZZ1HLx4hsMOis7mUxGLBQ8cAE12yJLHosKMMKNTrKURgRa9TBsyUnndEsVMi8RSFLScZdmVwXbDCITlFIw7CQx3JGkIGxFFEafV1ADqncTg0ZOHyM6MOvpthCvgNhdEAd6JFbq6RInuNPnkDagRcV1pyewtYi5GCWn1AEyMA6yhMketKWUmHPygcn9QoyKI2reYAcqKkf30IG+MRrS8Z7EUMtTIEFSyGaDIIM/xLrIDnG8unhAAPF0SZ8bZjk2pxtzFdF6kdojs2dTuV+ScNoSE/TkQ4LyIOLmATeGu1blF9PJvTvbJG7vWiXtWA+CoHel1Gp7XeQfasRt2LaqYOljvUSHSEVnXoJoSMeVQjW5+NxdGoYzJCWdnhYWmHqE3SkVlLjfdf7/evJ5L4IhFCTwdvJD89BuNZrrmSR7nBmHlB/w8bROeO+3F0/fWjTU6lPdUJF87rtKhklPZx025e3TXoU0cmwhXy+g6cht3LY6vP5ollkUGOoDJ23NT5VzEMFOYzPr92jW6PzKUya0WEQPvCV1Ksht3ZkLGovV1rxpadhjLmV4/UFUKaukimh1QJyUs8BFm7lB9xC1rXbt8pA0pQq5AXtS5MBDeGPIxVddVB2VPIiOxwxO7/37txPLvic8l+6SaqsNKmNfegbi3oqVzoNc33xLMqskp5Jn9QdaafFYqVx7Mz7lMxJSfI3o4uO2NudHLE7faenpk4vhjIqpqR+8PmdHrL5TVlKIblif+HSy4CL77sZbjabZ7N7lXzey1DFJXNozdF8lYRpwH2vw49XBDC62t+UU3RrKbrD/UyqcTIe7y+Ni3RpWHNJe7YX/XLuRJArKVB77N3G5fvbj+zNaAJZb03/Q8njj9fvrn6fXlFUWvR2RBejyWhCIrqOmuteotNX/vlwe+/D//EHwv5gAz6FsVVc6h6Dt0QyP/tsWGRQEdHkc9jtKP2fTjUNiR8jOmKpRQZr7iQBkDgq646dmOcBt5DDuxba4YzSk7mKLW+cUXOTdR6XQqANX7Ttc+HtzXQGGSz3nza1KcjH8Q199vAN5HAHd5C+kChC4rIk34HiehX5iuzbuMRRPBIWfYJ7SAS3f6DOOpXe9qo8Zb62FfpLjb3o8BNtxwfc/nwwbzWfddhj21nTBBdN0/wD7CPKug==",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:"Create Template",permalink:"/docs/API-docs/createtemplate"}},f={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Draft Template"})}),"\n",(0,s.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,s.jsxs)(a.p,{children:["The Draft Template API allows you to create customizable draft templates .The API returns a unique ",(0,s.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,s.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,s.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,s.jsx)(a.p,{children:"Body"})}),(0,s.jsx)("strong",{className:"openapi-schema__required",children:(0,s.jsx)(a.p,{children:"required"})})]}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}})]})]})})}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(p.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template created successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://url-to-edit-template.com"}})]})]})}),(0,s.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://url-to-edit-template.com"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(p.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.da7ff0bb.js b/assets/js/0028a090.da7ff0bb.js new file mode 100644 index 000000000..2976b9d2a --- /dev/null +++ b/assets/js/0028a090.da7ff0bb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>j});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),c=s(9472),p=s(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWhBU5JDde7q73IVkV+N+LWYoSJTtuGwQ99GJT855vZr/dHXheOkjnMMPaSO7RwSKBHF1mhfFCK0hhViH7xfLCs86IXd5eMy6l3ji21YF5zTKLpMiC87oWf/KVRJZHJ99FZiOKRK4WfbDKMc6CEg8B2WDQWS1FPhgwX3HPMq7YCllwmFOGEhVaypHrLNSovGMrTjqtmK+QOYOZKAQZd2VylbPBIFhJITXDXBzLGUEC2lBEodV1DinEcjs1JGDxIaDzP+t8C+kOMq08Kk+f3Bgpsug5/uQIpB24rMKa05ffGoQU9OoTZh4SMJbyeIGOtIWQ2LNy3gpVQgKFtjX3kAI19f1bSAAfeW3IeC9iqDKdY85iiCYBL/zfxDpIjrFc/DjAQHGU9l8aJro2ZxvzRZH6EZpjc6dTWa5oGA3paTrCYg6ptwGjwBmtXIvy68mE/p0tcrcX7bLmzIUsQ+eKIOX2G0i+1ohbMe3UwVKFeoWWkApWPofQEY/Ke+PS8ThYOfR6SEs7PCxtpusTdISSQuGy6335ejJZ5p4QahJ4+xwIU12jr4Qq2QaVZxurVZkwI5E7ZN5uGS+5UIyy2a+ICVqr7cuN/7vKXkLh7WSyvDiA8N1TEK7VmkuRRzKa6XtU/22n/fS+TU+lPtZxNRSv26aiUdTDSbN9edukwyxY4beQznfwOORGDFt9Ol80iwQIWE0cZ7SLFXNfQQrjc8pzaNdoXQwTF/WwjdyYkTaonCiV5CtHmzjmRozXF9Ak59bO81Kocvii1+JY95SwbeE7qf4AIjfiA24h6cDpWyUgaKYV8pyOWJMAjey3I3tfdcB37PssoR4RPqfIjiFPSO/8lnyOxqiyQsc29qFvDKqpKFUc/friSZRZJRwTLqq7ey6uISu0ZWfep/cfKUn+ZnTR3YXtBo/YnbpTdLroLi2CZFKoe5feqSGb3xSFyASX7A9cOeFx8W03w81m82R2r6LPe+GrsGIWjT6al1EYB9z3Ovx4RQCjrd1NMUW7FlnHdZ9JNY7G4/255Fk8l1hzQXu2F/107kSQS5Ghctg7SZfvbz+yNXszmkDSW9R/UPT44/W7q1+nVxSXDkY7pIvRZDQhEZ2mmqteqtN30vl4e4+I//Gran9kPT76sZFcqN611xLP/OyttUigImJK57DbUfrfrWwaEj8EtMRqiwTW3AoCIHJa0h13Yqp73EIK71pohzNKT+YytMxxRuXEVq3HZZah8S/a9rnz9mY6gwRW+/dgrXPysXxDb0W+gRTu4A7is5IiRDaL8h1IrsrAS7Jv4xJL8UBY9CnuPlLc/oM661Rq26vylPvaVugvNfasww+0HR9w++PBvNV81mGPbWdNE1w0TfMX23M3Iw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWhBU5JDde7q73IVkV+N+LWYoSJTtuGwQ99GJT855vZr/dHXheOkjnMMPaSO7RwSKBHF1mhfFCK0hhViH7xfLCs86IXd5eMy6l3ji21YF5zTKLpMiC87oWf/KVRJZHJ99FZiOKRK4WfbDKMc6CEg8B2WDQWS1FPhgwX3HPMq7YCllwmFOGEhVaypHrLNSovGMrTjqtmK+QOYOZKAQZd2VylbPBIFhJITXDXBzLGUEC2lBEodV1DinEcjs1JGDxIaDzP+t8C+kOMq08Kk+f3Bgpsug5/uQIpB24rMKa05ffGoQU9OoTZh4SMJbyeIGOtIWQ2LNy3gpVQgKFtjX3kAI19f1bSAAfeW3IeC9iqDKdY85iiCYBL/zfxDpIjrFc/DjAQHGU9l8aJro2ZxvzRZH6EZpjc6dTWa5oGA3paTrCYg6ptwGjwBmtXIvy68mE/p0tcrcX7bLmzIUsQ+eKIOX2G0i+1ohbMe3UwVKFeoWWkApWPofQEY/Ke+PS8ThYOfR6SEs7PCxtpusTdISSQuGy6335ejJZ5p4QahJ4+xwIU12jr4Qq2QaVZxurVZkwI5E7ZN5uGS+5UIyy2a+ICVqr7cuN/7vKXkLh7WSyvDiA8N1TEK7VmkuRRzKa6XtU/22n/fS+TU+lPtZxNRSv26aiUdTDSbN9edukwyxY4beQznfwOORGDFt9Ol80iwQIWE0cZ7SLFXNfQQrjc8pzaNdoXQwTF/WwjdyYkTaonCiV5CtHmzjmRozXF9Ak59bO81Kocvii1+JY95SwbeE7qf4AIjfiA24h6cDpWyUgaKYV8pyOWJMAjey3I3tfdcB37PssoR4RPqfIjiFPSO/8lnyOxqiyQsc29qFvDKqpKFUc/friSZRZJRwTLqq7ey6uISu0ZWfep/cfKUn+ZnTR3YXtBo/YnbpTdLroLi2CZFKoe5feqSGb3xSFyASX7A9cOeFx8W03w81m82R2r6LPe+GrsGIWjT6al1EYB9z3Ovx4RQCjrd1NMUW7FlnHdZ9JNY7G4/255Fk8l1hzQXu2F/107kSQS5Ghctg7SZfvbz+yNXszmkDSW9R/UPT44/W7q1+nVxSXDkY7pIvRZDQhEZ2mmqteqtN30vl4e4+I//Gran9kPT76sZFcqN611xLP/OyttUigImJK57DbUfrfrWwaEj8EtMRqiwTW3AoCIHJa0h13Yqp73EIK71pohzNKT+YytMxxRuXEVq3HZZah8S/a9rnz9mY6gwRW+/dgrXPysXxDb0W+gRTu4A7is5IiRDaL8h1IrsrAS7Jv4xJL8UBY9CnuPlLc/oM661Rq26vylPvaVugvNfasww+0HR9w++PBvNV81mGPbWdNE1w0TfMX23M3Iw==",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:"Create Template",permalink:"/docs/API-docs/createtemplate"}},x={},j=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Draft Template"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/drafttemplate"}),"\n",(0,t.jsxs)(a.p,{children:["The Draft Template API allows you to create customizable draft templates .The API returns a unique ",(0,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://url-to-edit-template.com"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://url-to-edit-template.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.804248b0.js b/assets/js/05632a52.804248b0.js new file mode 100644 index 000000000..f59fe68fd --- /dev/null +++ b/assets/js/05632a52.804248b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const j={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r4zgQ/iu6+bQFJ3HS7B5njmPLsvTKLtfl2uPg2lBkexKrlSWtNM4Lwf/9kOwkzkvL9VgKIYmleUbzPJ4XrYH4zEFyB5+0Ip6Rg0kEObrMCkNCK0jgtkB2icRaC3bx7YpxKfXCsZWuGGlmkazAObIciQvpGE91RYwzZzATU5GxrMH2IQJt0HLv+iqHBGZI7R5EYLjlJRJaH9EaFC8REmj3H0QOEQgfkeFUwGGYOn3EjK5ypqds59Li90pYzCEhW2EEjlbSO3WiNBIhAlwaqXOEZMql8wZZgSWHZA20MsGSrFAziGCqbcmpu4JLHrwkYH4fpkU2KkwKdT3xxzqjlUPnHY3i2P/sh+uqLEPnppVkW0UgCmRRkbfnxkiRhY3Bo/Og9XF0DWuvnfVuSDRHbsR4NY9imBbL0aOBOmr1f52DR40sRfRwLLmQ/wOfIn5sF/qZLr0rU2j16lDGw/PhKHy8i8wiJ8wv6JSbHWgUj857w7gX/3w7/JCMf0nef+jHcfwPRLAsA5s2K3NOgSUJkt3nyuRvcE59aNZmfFuAXcCmFurao8ancvFGl0iFUDO2QEVsYbWaRcxI5A4Z2RXjMy4Uk5zQ/vTjkhSt1fZlmV4XWd2hLZQUCh82hfgwjuOH4VaE8bEIm/amNLGprlT+tkxPHP8ynfHDaEvn/TGdKzXnUuShW9/qJ1RvS6d7PDXHHyetaIzCPuyR7a43JB1mlRW0CpNh2eNG9Jr95G7iO67PE91OlDBKqIAEBm32D9a7KVKD92bnmzFTWQkJFETGJYMBN6avDSonZkry1PkWNOBGDOa+jRxaO+IzoWa9F1GTXfQ3XuFGxD0OWym5EV9wBZvmu2fVTr8CeY42yCnUVAdwK9y1QXUjZirIPh8ezcjbQjgmXNjOdVaVqCikAJtqyw7QLOUOc6YVowLDpl8/7w+3Yz1A++xe3StfqKxy6OeZFOrJJfeqx+6up1ORCS7Z35g6QTh5t1FusVgcKXYWMJeCiiplFo3emc/CYpC1i9o+nEEEhLZ019MbtHORYfuWnjlqEIwHbU34/ujzuplYm6WPhyCfo1JkqBx2svji8ttXNmfn/RiiTnr8h6AHX68+ff7j5rP369OxeUnDftyPw9TTjkquOkd1rmGH73a9K+4ffWNrU5NwSQMjuQi1Goiu2zq7g92NK+nc1yYRFNqRN1ivfTr9ZWVd++XvFVpfy5MI5twKnvr8vVtDLpz/n2/vY8+SfPdne7U7Y6evfifD3pSZ8jU257LyTxDBE672r5r1pI42peYDawwusgwNdaBHbXSvF11+voUIeOU16pb4Uyjx9o/3fjKs/dpvAvDfvg2dBPzqX/QXXP22NW92ngW0/DbWXqJJXdf/AlpoGwc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r4zgQ/iu6+bQFJ3HS7B5njmPLsvTKLtfl2uPg2lBkexKrlSWtNM4Lwf/9kOwkzkvL9VgKIYmleUbzPJ4XrYH4zEFyB5+0Ip6Rg0kEObrMCkNCK0jgtkB2icRaC3bx7YpxKfXCsZWuGGlmkazAObIciQvpGE91RYwzZzATU5GxrMH2IQJt0HLv+iqHBGZI7R5EYLjlJRJaH9EaFC8REmj3H0QOEQgfkeFUwGGYOn3EjK5ypqds59Li90pYzCEhW2EEjlbSO3WiNBIhAlwaqXOEZMql8wZZgSWHZA20MsGSrFAziGCqbcmpu4JLHrwkYH4fpkU2KkwKdT3xxzqjlUPnHY3i2P/sh+uqLEPnppVkW0UgCmRRkbfnxkiRhY3Bo/Og9XF0DWuvnfVuSDRHbsR4NY9imBbL0aOBOmr1f52DR40sRfRwLLmQ/wOfIn5sF/qZLr0rU2j16lDGw/PhKHy8i8wiJ8wv6JSbHWgUj857w7gX/3w7/JCMf0nef+jHcfwPRLAsA5s2K3NOgSUJkt3nyuRvcE59aNZmfFuAXcCmFurao8ancvFGl0iFUDO2QEVsYbWaRcxI5A4Z2RXjMy4Uk5zQ/vTjkhSt1fZlmV4XWd2hLZQUCh82hfgwjuOH4VaE8bEIm/amNLGprlT+tkxPHP8ynfHDaEvn/TGdKzXnUuShW9/qJ1RvS6d7PDXHHyetaIzCPuyR7a43JB1mlRW0CpNh2eNG9Jr95G7iO67PE91OlDBKqIAEBm32D9a7KVKD92bnmzFTWQkJFETGJYMBN6avDSonZkry1PkWNOBGDOa+jRxaO+IzoWa9F1GTXfQ3XuFGxD0OWym5EV9wBZvmu2fVTr8CeY42yCnUVAdwK9y1QXUjZirIPh8ezcjbQjgmXNjOdVaVqCikAJtqyw7QLOUOc6YVowLDpl8/7w+3Yz1A++xe3StfqKxy6OeZFOrJJfeqx+6up1ORCS7Z35g6QTh5t1FusVgcKXYWMJeCiiplFo3emc/CYpC1i9o+nEEEhLZ019MbtHORYfuWnjlqEIwHbU34/ujzuplYm6WPhyCfo1JkqBx2svji8ttXNmfn/RiiTnr8h6AHX68+ff7j5rP369OxeUnDftyPw9TTjkquOkd1rmGH73a9K+4ffWNrU5NwSQMjuQi1Goiu2zq7g92NK+nc1yYRFNqRN1ivfTr9ZWVd++XvFVpfy5MI5twKnvr8vVtDLpz/n2/vY8+SfPdne7U7Y6evfifD3pSZ8jU257LyTxDBE672r5r1pI42peYDawwusgwNdaBHbXSvF11+voUIeOU16pb4Uyjx9o/3fjKs/dpvAvDfvg2dBPzqX/QXXP22NW92ngW0/DbWXqJJXdf/AlpoGwc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.967ec4da.js b/assets/js/05632a52.967ec4da.js deleted file mode 100644 index 4cac9d062..000000000 --- a/assets/js/05632a52.967ec4da.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kB2ZIdt0fFcTSUkAstl1KnHFxiwkoaWZtIu9vdkWNj9N+PXUm2HCfH5SgFY0s788zLszPj2QLxpYX4Bj4qSTwlC4sAMrSpEZqEkhDDdYHsAol1GuzsyyXjZakeLduompFiBskIXCHLkLgoLeOJqolxZjWmIhcpS1vsGAJQGg13pi8ziGGJ1MkgAM0Nr5DQuIi2IHmFEEMnvxMZBCBcRJpTAU/DVMk9pnSZMZWzvUmD32thMIOYTI0BWNqUzqgVlS4RAsC1LlWGEOe8tE4hLbDiEG+BNtprkhFyCQHkylSchie45t5KDPqPSVKk00In0DQL59ZqJS1aZ2gaRe7nMFxbpylam9cl2zECgU8WJTl9rnUpUi8I760DbY+ja7N23BlnhkTrsifj1XkUk6RYT+81NEHH/+sM3CtkCaKDY8VF+T/wCeKH7mCcqsqZ0oWSrw5lNjmdTP3HmUgNcsLsjJ4zswdNo+npaBKNol+vJ+/i2fv47btxFEV/QwDrymfTVWXGyWdJgsrhe62zn+CnearWVXzXgENA3wtN41CzaHZci31nS0UsV7XMfvlxlYjGKPPvXDzjvhkkIGQpJN71LXU3i2Z30106b4/TuZQrXorMD6pr9YDy56YzdE+t++P7Eq2Sl8NBssPzNkmLaW0EbfxQXI+4FqNWHt8s3LCpkArVDVM/RamAGMLu4sPtfoA24KyZVT9ha1NCDAWRtnEYWuJLIZcjrvVYaZRWLGXJE+u6MORahKsJOH99PHPHWUvLQVQ7crgWn3AD/SQ50OpGeYE8Q+MJEjJXHtxRcaVRzsVSeiJXk6OBf10Iy4T14kyldYWS/KWyXBn2BM0SbjFjSjIq0Avd+el4svuP8tAxu5W3cq4qZLVFN5xLIR9sfCtH7OYqz0UqeMn+wsQKwsWbnrnHx8cjxk485kJQUSfMoFZ79aU/9LQOUbuXEwiA0FT2Kp+jWYkUu1t6wVXolcOuyl2zu0ptx29/9OEpyFVdKVKUFgd1eXbx5TM7HUcQDIrjP4Qcfr78eP7n/NxZdeXVXtFkHI0jP8CVpYrLgaPBRvH0Zrf7Zv3Ry0dXmIRrCnXJhe89n+i265sb2C8P8WD1WARQKEtOYbt1xfTNlE3jjr/XaFxvLgJYcSN44qr3ZguZsO45260WLyb55mu3pZyw57eYZ8Pum0y6DlvxsnZvEMADbg63pmbRBH2jucBahbM0RU0D6NFYPJgtF+fXEACvHUfDBn/wDd49OOvPhnXY+W0A7rsJXgD85i76E25+36m3khcBXX69tqNo0TTNP75Yrp4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kB2ZIdt0fFcTSUkAstl1KnHFxiwkoaWZtIu9vdkWNj9N+PXUm2HCfH5SgFY0s788zLszPj2QLxpYX4Bj4qSTwlC4sAMrSpEZqEkhDDdYHsAol1GuzsyyXjZakeLduompFiBskIXCHLkLgoLeOJqolxZjWmIhcpS1vsGAJQGg13pi8ziGGJ1MkgAM0Nr5DQuIi2IHmFEEMnvxMZBCBcRJpTAU/DVMk9pnSZMZWzvUmD32thMIOYTI0BWNqUzqgVlS4RAsC1LlWGEOe8tE4hLbDiEG+BNtprkhFyCQHkylSchie45t5KDPqPSVKk00In0DQL59ZqJS1aZ2gaRe7nMFxbpylam9cl2zECgU8WJTl9rnUpUi8I760DbY+ja7N23BlnhkTrsifj1XkUk6RYT+81NEHH/+sM3CtkCaKDY8VF+T/wCeKH7mCcqsqZ0oWSrw5lNjmdTP3HmUgNcsLsjJ4zswdNo+npaBKNol+vJ+/i2fv47btxFEV/QwDrymfTVWXGyWdJgsrhe62zn+CnearWVXzXgENA3wtN41CzaHZci31nS0UsV7XMfvlxlYjGKPPvXDzjvhkkIGQpJN71LXU3i2Z30106b4/TuZQrXorMD6pr9YDy56YzdE+t++P7Eq2Sl8NBssPzNkmLaW0EbfxQXI+4FqNWHt8s3LCpkArVDVM/RamAGMLu4sPtfoA24KyZVT9ha1NCDAWRtnEYWuJLIZcjrvVYaZRWLGXJE+u6MORahKsJOH99PHPHWUvLQVQ7crgWn3AD/SQ50OpGeYE8Q+MJEjJXHtxRcaVRzsVSeiJXk6OBf10Iy4T14kyldYWS/KWyXBn2BM0SbjFjSjIq0Avd+el4svuP8tAxu5W3cq4qZLVFN5xLIR9sfCtH7OYqz0UqeMn+wsQKwsWbnrnHx8cjxk485kJQUSfMoFZ79aU/9LQOUbuXEwiA0FT2Kp+jWYkUu1t6wVXolcOuyl2zu0ptx29/9OEpyFVdKVKUFgd1eXbx5TM7HUcQDIrjP4Qcfr78eP7n/NxZdeXVXtFkHI0jP8CVpYrLgaPBRvH0Zrf7Zv3Ry0dXmIRrCnXJhe89n+i265sb2C8P8WD1WARQKEtOYbt1xfTNlE3jjr/XaFxvLgJYcSN44qr3ZguZsO45260WLyb55mu3pZyw57eYZ8Pum0y6DlvxsnZvEMADbg63pmbRBH2jucBahbM0RU0D6NFYPJgtF+fXEACvHUfDBn/wDd49OOvPhnXY+W0A7rsJXgD85i76E25+36m3khcBXX69tqNo0TTNP75Yrp4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.8e8c149c.js b/assets/js/13fdae3b.8e8c149c.js new file mode 100644 index 000000000..e6365bae5 --- /dev/null +++ b/assets/js/13fdae3b.8e8c149c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>j,toc:()=>b});var a=l(85893),n=l(11151),o=l(58219),i=(l(62316),l(51039)),t=l.n(i),r=(l(82723),l(9487)),d=(l(41429),l(5397)),c=l(4667),p=l(9472),h=l(85162);const m={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VVFv0zAQ/ivmnkDKmg7GAxFCTFChiYlN6iYeumpynWtj6tjGdtpVVf47Oidp045NCCFe2uTuO9995/suWwh84SGbwHecFcYsYZpAjl44aYM0GjK4KZB9RoUBWYth59cXjCtl1mxjKhYMyxv/uvVXTkECxqLjdMhFDhk0kC5LAg69Ndqjh2wLr4dD+jtMPK6EQO/nlWK7oyABYXRAHQjPrVVSREf6w1PQFrwosOT0FDYWIQMz+4EiQALW0TFBNikd+kqFHs4HJ/UCEsAHXlpFpo5vU3vO/K4itXkBdZ1AkCEipVZS431H6v71cHj/DuqaMGfDs8fkbj06pk1gc1Pp/MW/44XOGfc8rePczxGh4jsabx/TuNArrmQeJ+LGLFH/Xyb99KFJT6U+lIriNC8bShEU/XBAtW9vSHoUlZNhA9lkCw8n3MqTxp9NpvU0gRJDYfbjTDXzUEAG6Xo32R7dCp2PR5ASMihCsD5LU27twFjUXi604jM/EKZMuZXp6hTq5BjtA19IvTh5Nmq6r3lMfW1ad1D5roHcyq+4gaRrTB+VgKT7LJDn6GITpZ6bGNy268qiHsuFjs1encLjPSE9kz66cyOqEnWIF8/mxrGjaDbjHnNmNAsFRifZ3wxOmbco5LydmQG703d6bEpklUfaBErqpc/u9AmbXM3nUkiuaC15GXD6suvcer1+1LFXMeaLDEU1Yw6t2cMX0Rjb2o/avbyCBAK60l/Nx+hWUmB7S0+kSiM4bZXARVQCllzS7bamj8dBNJlKCtQee7N7/uX6kq3Ym8EQkt54/EHR6eXFp9G38YjOpXFsLul0MBwMyWSNDyXXvVSHO/74erd7Vf/9F6Gdw4APIbWKyyjHyGrb6mgC6/13qDA+kGm7pWm5daquyfyzQkcCnSaw4k7yGY3nZFon3fSS8Ja4ofYJgZY2y4qrqpHA0T46EPXn0eXoZgQJ8IqK6QtnGYXTPlCCzqU3veMPFdXUQL8k7t8GvKfGfcXNhx288TwZ0FLs0NTCaV3XvwAJnqup",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VVFv0zAQ/ivmnkDKmg7GAxFCTFChiYlN6iYeumpynWtj6tjGdtpVVf47Oidp045NCCFe2uTuO9995/suWwh84SGbwHecFcYsYZpAjl44aYM0GjK4KZB9RoUBWYth59cXjCtl1mxjKhYMyxv/uvVXTkECxqLjdMhFDhk0kC5LAg69Ndqjh2wLr4dD+jtMPK6EQO/nlWK7oyABYXRAHQjPrVVSREf6w1PQFrwosOT0FDYWIQMz+4EiQALW0TFBNikd+kqFHs4HJ/UCEsAHXlpFpo5vU3vO/K4itXkBdZ1AkCEipVZS431H6v71cHj/DuqaMGfDs8fkbj06pk1gc1Pp/MW/44XOGfc8rePczxGh4jsabx/TuNArrmQeJ+LGLFH/Xyb99KFJT6U+lIriNC8bShEU/XBAtW9vSHoUlZNhA9lkCw8n3MqTxp9NpvU0gRJDYfbjTDXzUEAG6Xo32R7dCp2PR5ASMihCsD5LU27twFjUXi604jM/EKZMuZXp6hTq5BjtA19IvTh5Nmq6r3lMfW1ad1D5roHcyq+4gaRrTB+VgKT7LJDn6GITpZ6bGNy268qiHsuFjs1encLjPSE9kz66cyOqEnWIF8/mxrGjaDbjHnNmNAsFRifZ3wxOmbco5LydmQG703d6bEpklUfaBErqpc/u9AmbXM3nUkiuaC15GXD6suvcer1+1LFXMeaLDEU1Yw6t2cMX0Rjb2o/avbyCBAK60l/Nx+hWUmB7S0+kSiM4bZXARVQCllzS7bamj8dBNJlKCtQee7N7/uX6kq3Ym8EQkt54/EHR6eXFp9G38YjOpXFsLul0MBwMyWSNDyXXvVSHO/74erd7Vf/9F6Gdw4APIbWKyyjHyGrb6mgC6/13qDA+kGm7pWm5daquyfyzQkcCnSaw4k7yGY3nZFon3fSS8Ja4ofYJgZY2y4qrqpHA0T46EPXn0eXoZgQJ8IqK6QtnGYXTPlCCzqU3veMPFdXUQL8k7t8GvKfGfcXNhx288TwZ0FLs0NTCaV3XvwAJnqup",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},x={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:l}=s;return l||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:"Delete Webhook"})}),"\n",(0,a.jsx)(t(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(o.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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:"User not found!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.f155125f.js b/assets/js/13fdae3b.f155125f.js deleted file mode 100644 index eda6fc43b..000000000 --- a/assets/js/13fdae3b.f155125f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>f});var a=l(85893),o=l(11151),i=l(58219),n=(l(62316),l(51039)),t=l.n(n),r=(l(82723),l(9487)),d=(l(41429),l(5397)),c=l(4667),h=l(9472),p=l(85162);const m={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VV1v0zAU/SvmPoGUNd2AByKEQFChahND6iYeumpyndvG1LGN7fRDVf47uk7SpZ02IYR4SdL7fa7PcfcQ+NJDNoUfOC+MWcEsgRy9cNIGaTRkcFMg+4IKA7I2hn36PmZcKbNhO1OxYFje+Detv3IKEjAWHaci4xwyaEK6Lgk49NZojx6yPVwMh/Q6bjyphEDvF5Vih1KQgDA6oA4Uz61VUkRH+tNT0h68KLDk9BV2FiEDM/+JIkAC1lGZIJuWDn2lQi/OByf1EhLALS+tIlOHt5k9Z/4wkdq9gLpOIMgQI6VWUuN9B+r+Yji8fwd1TTFvhm8eg7v16Jg2gS1MpfMX/w4XOmfc87BOez8HhIbvYLx9DGOs11zJPDLixqxQ/18k/fahaU+jbktFeZqXDaQYFP1wBLVvb0B6FJWTYQfZdA/bM27lWePPprN6lkCJoTAPdKaZeSggg3RzYLZHt0bnYwlSQgZFCNZnaeoDX0q9POPWDoxF7eVSKz73A2HKlFuZrs+BunRTTGhTzTKOZjmshFt5iTtIOqj9qAQknVCBPEcX1yL1wsTkdgHXFvVELnVc3/ocHitfeiZ9dOdGVCXqEI+SLYxjJ9lszj3mzGgWCoxOsr8enDNvUchFy4IBu9N3emJKZJVH0raSeuWzO33GpteLhRSSK7povAw4e9ltbrPZPNrYq5jzVYaimjOH1jyEL6MxrrWfdfjxChII6Ep/vZigW0uB7Sk90SqNwWnLbS4it7Hkkk63NX08TSKuKSlQe+yx8dPX71fs9WAISY8cfzByejX+PPo2GVFVoldzROeD4WBIJmt8KLnuNTq+s08Pd/+g0r+/4VsWBtyG1Couo7wiqn2riylsHv5XCuMDmfZ74sqtU3VN5l8VOhLcLIE1d5LPiZzTWZ103CUhrXBHyxMCLd0Ua66qRgAn98uRSL+MrkY3I0iAVzRMXzarKJv2gxp0Lr3rlT/WUzMDPevkiYT3tLhL3H04hDeeJxNaiF00rXBW1/VvU6ea7w==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VV1v0zAU/SvmPoGUNd2AByKEQFChahND6iYeumpyndvG1LGN7fRDVf47uk7SpZ02IYR4SdL7fa7PcfcQ+NJDNoUfOC+MWcEsgRy9cNIGaTRkcFMg+4IKA7I2hn36PmZcKbNhO1OxYFje+Detv3IKEjAWHaci4xwyaEK6Lgk49NZojx6yPVwMh/Q6bjyphEDvF5Vih1KQgDA6oA4Uz61VUkRH+tNT0h68KLDk9BV2FiEDM/+JIkAC1lGZIJuWDn2lQi/OByf1EhLALS+tIlOHt5k9Z/4wkdq9gLpOIMgQI6VWUuN9B+r+Yji8fwd1TTFvhm8eg7v16Jg2gS1MpfMX/w4XOmfc87BOez8HhIbvYLx9DGOs11zJPDLixqxQ/18k/fahaU+jbktFeZqXDaQYFP1wBLVvb0B6FJWTYQfZdA/bM27lWePPprN6lkCJoTAPdKaZeSggg3RzYLZHt0bnYwlSQgZFCNZnaeoDX0q9POPWDoxF7eVSKz73A2HKlFuZrs+BunRTTGhTzTKOZjmshFt5iTtIOqj9qAQknVCBPEcX1yL1wsTkdgHXFvVELnVc3/ocHitfeiZ9dOdGVCXqEI+SLYxjJ9lszj3mzGgWCoxOsr8enDNvUchFy4IBu9N3emJKZJVH0raSeuWzO33GpteLhRSSK7povAw4e9ltbrPZPNrYq5jzVYaimjOH1jyEL6MxrrWfdfjxChII6Ep/vZigW0uB7Sk90SqNwWnLbS4it7Hkkk63NX08TSKuKSlQe+yx8dPX71fs9WAISY8cfzByejX+PPo2GVFVoldzROeD4WBIJmt8KLnuNTq+s08Pd/+g0r+/4VsWBtyG1Couo7wiqn2riylsHv5XCuMDmfZ74sqtU3VN5l8VOhLcLIE1d5LPiZzTWZ103CUhrXBHyxMCLd0Ua66qRgAn98uRSL+MrkY3I0iAVzRMXzarKJv2gxp0Lr3rlT/WUzMDPevkiYT3tLhL3H04hDeeJxNaiF00rXBW1/VvU6ea7w==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},j={},f=[{value:"Request",id:"request",level:2}];function k(e){const s={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:l}=s;return l||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:"Delete Webhook"})}),"\n",(0,a.jsx)(t(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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:"User not found!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.450477a3.js b/assets/js/1f73ca32.450477a3.js new file mode 100644 index 000000000..841c8284d --- /dev/null +++ b/assets/js/1f73ca32.450477a3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>j});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2W6LGRv6JRHv7rn3h/QOHF9ZiGdwb9HAPIAUbWKEdkJJiGGaIRujY6Rl159vGUq+yNGyrSqZU2yFjj4NU0+S8SRRpXQsRcdFbvsQgNJoOPm6TSGGFTofJgCDVitp0UK8g2EU0b/DyJMySdDaZZmzvRMIIFHSoXRkz7XOReIV4aMl0A5skmHB6cttNUIMavGIiYMAtCE3TtQhazEltbe0zgi5ggCWyhTcdSX4zAudk9EfY7EejhbZ/XuoApC8wHM9vFfIfkMkOBZc5OfiHxUuEN81gn6iCnKlMyXPTuXi8urNz6PhYDgiF49qMRUuP9tLihuCJ6rQXG7PRSuN0oqV9C4McofptfuakxfIMBqOeoOoF72ZDq7ii7fx5VU/iqK/IIDnwveznguk3Pk+u7qs/bnU6Q+IUx2blbT6HbP6XJHhRXRxygDPOakcW6pSpj/9f8uPxijz/dqPY1edvIXMhcQvLYW/UPJtGZenZdzKDc9F6m+PqVqj/LGVdMO7OvzpaERt5PVwUGpXXhdpMSmNcFuIZzt47nEterU+ns2reQAFukw1tx0lzF0GMYQrdGV991k0GzTW40uTQwyZc9rGYci17reEyPnCErtDrkW4GUAVHFtbx1dCrnrfRc1fEp5QU+u+HaS97x7X4gNuob3XDqwCEDTMDHnqt5bOS+XBTa/uNMqJWEnf6c0ATp8SYZmwXp2qpCxQOj91tlSGHaHZgltMmZLMZeiVJB/1B8xqTMSyWZg+e5APcqIKZKVFeityIdc2fpA9NrtbLkUieM7+xIUVDuev2s49PT2ddOy1x4yFy8oFM6jVi/nKC31bu6j94TUE4NAU9m45QbMRCTZT+kao0BuHDQ144mnQPAat6N0xiNYyFwlKi53FvR5//sg2bNSPIOisx79IOvx4+/vNp8kN+aV1rIc06Ef9yD8oyrqCy06ocfvUHz3zx4PevZD7P/98aBbT4bMLdc6FJ6cvc9cQawYtseYBZMo6Eu12tD73Jq8qEv9doiG6zgPYcCMoA0/WoF1nYuIat9TPJEFNtN3wvKw5cXQ7HVB8fDOFAHhJmXRptPY0aj7Ie6uS247vQ37VCdBfovpXAb9QCz/g9te9ea35JqCpr7Wm/s2rqvoH+d5bFA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2W6LGRv6JRHv7rn3h/QOHF9ZiGdwb9HAPIAUbWKEdkJJiGGaIRujY6Rl159vGUq+yNGyrSqZU2yFjj4NU0+S8SRRpXQsRcdFbvsQgNJoOPm6TSGGFTofJgCDVitp0UK8g2EU0b/DyJMySdDaZZmzvRMIIFHSoXRkz7XOReIV4aMl0A5skmHB6cttNUIMavGIiYMAtCE3TtQhazEltbe0zgi5ggCWyhTcdSX4zAudk9EfY7EejhbZ/XuoApC8wHM9vFfIfkMkOBZc5OfiHxUuEN81gn6iCnKlMyXPTuXi8urNz6PhYDgiF49qMRUuP9tLihuCJ6rQXG7PRSuN0oqV9C4McofptfuakxfIMBqOeoOoF72ZDq7ii7fx5VU/iqK/IIDnwveznguk3Pk+u7qs/bnU6Q+IUx2blbT6HbP6XJHhRXRxygDPOakcW6pSpj/9f8uPxijz/dqPY1edvIXMhcQvLYW/UPJtGZenZdzKDc9F6m+PqVqj/LGVdMO7OvzpaERt5PVwUGpXXhdpMSmNcFuIZzt47nEterU+ns2reQAFukw1tx0lzF0GMYQrdGV991k0GzTW40uTQwyZc9rGYci17reEyPnCErtDrkW4GUAVHFtbx1dCrnrfRc1fEp5QU+u+HaS97x7X4gNuob3XDqwCEDTMDHnqt5bOS+XBTa/uNMqJWEnf6c0ATp8SYZmwXp2qpCxQOj91tlSGHaHZgltMmZLMZeiVJB/1B8xqTMSyWZg+e5APcqIKZKVFeityIdc2fpA9NrtbLkUieM7+xIUVDuev2s49PT2ddOy1x4yFy8oFM6jVi/nKC31bu6j94TUE4NAU9m45QbMRCTZT+kao0BuHDQ144mnQPAat6N0xiNYyFwlKi53FvR5//sg2bNSPIOisx79IOvx4+/vNp8kN+aV1rIc06Ef9yD8oyrqCy06ocfvUHz3zx4PevZD7P/98aBbT4bMLdc6FJ6cvc9cQawYtseYBZMo6Eu12tD73Jq8qEv9doiG6zgPYcCMoA0/WoF1nYuIat9TPJEFNtN3wvKw5cXQ7HVB8fDOFAHhJmXRptPY0aj7Ie6uS247vQ37VCdBfovpXAb9QCz/g9te9ea35JqCpr7Wm/s2rqvoH+d5bFA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,t.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"User not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.71a25ebe.js b/assets/js/1f73ca32.71a25ebe.js deleted file mode 100644 index 653faf5fc..000000000 --- a/assets/js/1f73ca32.71a25ebe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2V6GeRj6xRbv7rk33nPcgeMrC/EM7i0amAeQok2M0E4oCTFMM2RjdIy07PrrLUPJFzlatlUlc4qt0NGnYepJshQdF7ntQwBKo+Hk4zaFGFbovPsADFqtpEUL8Q6GUUR/hxEnZZKgtcsyZ3snEECipEPpyJ5rnYvEK8JHS6Ad2CTDgtOX22qEGNTiERMHAWhDbpyoQ9ZiSmpvaZ0RcgUBLJUpuOtK8JkXOiej38ZiPRwtsvuPUAUgeYHneviokP2CSHAsuMjPxT8qXCB+aAT9RBXkSmdKnp3KxeXVux9Hw8FwRC4e1WIqXH62lxQ3BE9UobncnotWGqUVK+ldGOQO02v3d05eIMNoOOoNol70bjq4ii/ex5dX/SiK/oAAngvfz/peIOXO99nVZe3PpU6/Q5zq2Kyk0e+Y1eeKDC+ii1MGeK5J5dhSlTL94f8bfjRGmX+u/Th21clbyFxI/NZS+Bsl35ZxeVrGrdzwXKR+a0zVGuX3raQb3tXhT69G1EZeDwelduV1kRaT0gi3hXi2g+ce16JX6+PZvJoHUKDLVLPtKGHuMoghXKEr691n0WzQWI8vTQ4xZM5pG4ehdXwl5KrHte63xMj5whLLQ65FuBkAhWhTmFCb6k4cJLLvB9fiE26h3VQHVgEIup4MeernkM5L5cFN9Xca5USspO/dZgCnj4KwTFivTlVSFiidv0e2VIYdodmCW0yZksxl6JUkH/UHzGpMxLIZgT57kA9yogpkpUXa/rmQaxs/yB6b3S2XIhE8Z7/jwgqH8zdt556enk469tZjxsJl5YIZ1OrFfOWFvq1d1P7wFgJwaAp7t5yg2YgEm1t6JVTojcNmsHniB7tZ763owzGIBi0XCUqLnVG8Hn/9zEb9CILOcPyLlMPPt7/efJnckFcar/qKBv2oH/kHQllXcNkJNG6f7Oa5Pr7e3QtJ//Pz34yhw2cX6pwLTy5f1q4hxgxaYswDyJR1JNrtaFjuTV5VJP6zREN0mwew4UZQZE+2oB1eYtIat9S9JEFNtNvwvKwZcLRdDig6vplCALykTLqkWXvSNB/kvVXJbcf3IZvqBOi3Cl4B/ESt+4Tbn/fmteZVQFNfa039m1dV9Rc7pUEz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2V6GeRj6xRbv7rk33nPcgeMrC/EM7i0amAeQok2M0E4oCTFMM2RjdIy07PrrLUPJFzlatlUlc4qt0NGnYepJshQdF7ntQwBKo+Hk4zaFGFbovPsADFqtpEUL8Q6GUUR/hxEnZZKgtcsyZ3snEECipEPpyJ5rnYvEK8JHS6Ad2CTDgtOX22qEGNTiERMHAWhDbpyoQ9ZiSmpvaZ0RcgUBLJUpuOtK8JkXOiej38ZiPRwtsvuPUAUgeYHneviokP2CSHAsuMjPxT8qXCB+aAT9RBXkSmdKnp3KxeXVux9Hw8FwRC4e1WIqXH62lxQ3BE9UobncnotWGqUVK+ldGOQO02v3d05eIMNoOOoNol70bjq4ii/ex5dX/SiK/oAAngvfz/peIOXO99nVZe3PpU6/Q5zq2Kyk0e+Y1eeKDC+ii1MGeK5J5dhSlTL94f8bfjRGmX+u/Th21clbyFxI/NZS+Bsl35ZxeVrGrdzwXKR+a0zVGuX3raQb3tXhT69G1EZeDwelduV1kRaT0gi3hXi2g+ce16JX6+PZvJoHUKDLVLPtKGHuMoghXKEr691n0WzQWI8vTQ4xZM5pG4ehdXwl5KrHte63xMj5whLLQ65FuBkAhWhTmFCb6k4cJLLvB9fiE26h3VQHVgEIup4MeernkM5L5cFN9Xca5USspO/dZgCnj4KwTFivTlVSFiidv0e2VIYdodmCW0yZksxl6JUkH/UHzGpMxLIZgT57kA9yogpkpUXa/rmQaxs/yB6b3S2XIhE8Z7/jwgqH8zdt556enk469tZjxsJl5YIZ1OrFfOWFvq1d1P7wFgJwaAp7t5yg2YgEm1t6JVTojcNmsHniB7tZ763owzGIBi0XCUqLnVG8Hn/9zEb9CILOcPyLlMPPt7/efJnckFcar/qKBv2oH/kHQllXcNkJNG6f7Oa5Pr7e3QtJ//Pz34yhw2cX6pwLTy5f1q4hxgxaYswDyJR1JNrtaFjuTV5VJP6zREN0mwew4UZQZE+2oB1eYtIat9S9JEFNtNvwvKwZcLRdDig6vplCALykTLqkWXvSNB/kvVXJbcf3IZvqBOi3Cl4B/ESt+4Tbn/fmteZVQFNfa039m1dV9Rc7pUEz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},g={},j=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.72df1f77.js b/assets/js/28b19cd2.72df1f77.js new file mode 100644 index 000000000..7e23a0525 --- /dev/null +++ b/assets/js/28b19cd2.72df1f77.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),d=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [debug PDF](https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/itXfmkDKLaTdPtgDEO7tOuCFUvQZNgHxzBo6WQxoUiWpOxohv77cNSrHSdtgWEYhgFFah3vjvfOh9wyz1eOTWfsnY6LHJV3bB6xBF1shfFCKzZlNxnCuUXuEVoueHt1AVxKvXFQ6gK8hhUqtMSjcANJqw2WJdwVzoOxei0SoVbgMTeSe1yIBIRyHnkCOoXCSM0DAw8qUiHxlVDgM4RU25x4ltzh969BW1gKxW15BLhGW4IXOQY7FGJCxsS1ubwzZAQ3zbaOtIFFQxyJLKFwmITdHMRcwRIb6QRSq3NatiCUR5vyGIF7mCW4LFZw9e7n+avMe+Om47HzfCXU6pibkTaonFgpyZduFOt8TH7l6ZhouYit5saMgwqTpEfkTOFCXPowt7ZSmEe3ikVMGwqu0OoiYVPWGNj4thE+a4MqEhYxwy3P0aOlzG6Z4jmyKRvEnUVMUGYN9xnbT7de3mHsL0JSWkNYxCx+LoTFhE29LTBizpeS1DqRG0kM+GCkTpBNUy4dMcQZ5pxNt8yXJnB6K9SKRYzSyf2Qgg88aJky88vJMotPM7NkVTWvt0Xnf9JJSapirTwqTz+5MVLEISjjO0embwd79ubOGEWegjGPWlNqHylUliLrBbog3jD2NnNreUnh8pgP6U8osJqceOxx79/bONaFV1x5VkUMcy7ksyEKDEMFdxrfNF9UXaSlTvBzu95phCUiMZtMqy9wn5ye0b+zE1ZVEfPCB+pu0Q2qaXHdhI24Uy0TtFSl+ztUEXOoksW+z0utJXL1qA5vMuGgK+W9aeMMxiItYZOhz9AG8oYrD0G7I5YlgqNRRdy1gSOgUZZgygvpYc1lgSAc3DKq6Fs2gos0dGG9ouljx4QBL3CVgNLwMuy3cEWoh5fj5nupk/JlL+mAW2xsFph0JgTmbiA62AgpyW4aSXXfd0mhbduCabc7lMXdGJ4XzuscwjaNUBh/FBDuC4vQ9NcIzrkCoWJZJNjMXAo4DSbYbtusL0IxVBVst5RLtAuqvaqKegLttUMIBVdTLMYo1jtSHQl7wY42EMUHI2y5SLhvCLHODVfl0ACxUkKtFoWVVTXq2isk46tD9SgyTZJIyX8xSE82+GLY4SGEFTHvHgOB4IxWrp5/p5MJ/bcb2QsFrohjdA5a5rpfqdpX6KGwEoTqF0Ua1qlnuHRt+xJLaxxo6vqNcAhayTJoac+tCHJ0zvEVHUpffV48P9db3d96mmV34vTPh3h9ekXlWNjnZ/0hBQ2+2Jv45CE5+I3aOvgWBmOTlLSQsnyxUwlCSaFw0SZkcTqZLE4p/1XEXh9McZ2xjK9RvfTAkwQ2Ilmhd2FQNvOXMthWFeEepVtciB0Ll1qtgCANNZiwQEdqkAw1+LdlFK3V9lvjdyWROzpWfGF6T2rFX4rh68lkEcddEL871CdrLkUSsPWNvkf14h9wt3duuL2vtydTH/JQtA2IFDVTWGc73g7ptZMO48IKXwYQ+nDMjTiu16ezOUG7HH2mCc4a7YLFhEanbLw7h8bbwSCqGKm16xbaho7qmoSbA+ibGzFen7Aq2ufuIfszUvPejWsKdR3NHWd6rGjEr0gl2sRqyNUA7gx5gjbElTL4qQe379s8DFDorAWUQ9TYgcZHSLDbuEV7HdgbIrr5EKP1dTCEZjXA34Mag5IZnKoDcCdUqkM0mpK4NKgIGYaCWp8cxnfCheU22aG4A0LZkw5XvwR0fR+kRaKfjU5aVFX3xQhu1a261nnAUGkhQQp176a36hhml2kqYsEl/IFLJzz2t7fNZvOoBI6CzAfhs2JJ10Xds68CMdTJUKr7OGIR82hzd5leo12LuJ3kT2w1Dszjptt5DezaLDekN/tCFHIpYlQOB/359sPVR1jD2WjCokG9f4XR448X5+9/u35Peqm/6iSdjCajSbg2aOdzrgZb7T8JhNvy4MK4k+3Bze3/94R/wXtCM7I8PvixkVyoAT6p5/BsDw+yiE2HTwjziGU0t6cztt1SIH8nREnkzwVaGvrziK25FXxJ42C2ZYlw9DvpXgierJBXnxqUeQRPvEYctL+dw4qGcLjEsSljEbvHcu/9o5pXUTuMybSa47w24PiG9PQaHp27dJbUEm/jGI1/lnd40F1dXt+wiLUXkjw8lzDLN/S+wjdsym7ZLQvPPaShflIg+pZJrlZFgHys1ktnCC8oU8MD6D4cQM0P8uxgTHZPptoV+kuOHRT4gfrzVyx/7NjrlScFmti23JSfeVVVfwHX2zaE",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [debug PDF](https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [debug PDF](https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/itXfmkDKLaTdPtgDEO7tOuCFUvQZNgHxzBo6WQxoUiWpOxohv77cNSrHSdtgWEYhgFFah3vjvfOh9wyz1eOTWfsnY6LHJV3bB6xBF1shfFCKzZlNxnCuUXuEVoueHt1AVxKvXFQ6gK8hhUqtMSjcANJqw2WJdwVzoOxei0SoVbgMTeSe1yIBIRyHnkCOoXCSM0DAw8qUiHxlVDgM4RU25x4ltzh969BW1gKxW15BLhGW4IXOQY7FGJCxsS1ubwzZAQ3zbaOtIFFQxyJLKFwmITdHMRcwRIb6QRSq3NatiCUR5vyGIF7mCW4LFZw9e7n+avMe+Om47HzfCXU6pibkTaonFgpyZduFOt8TH7l6ZhouYit5saMgwqTpEfkTOFCXPowt7ZSmEe3ikVMGwqu0OoiYVPWGNj4thE+a4MqEhYxwy3P0aOlzG6Z4jmyKRvEnUVMUGYN9xnbT7de3mHsL0JSWkNYxCx+LoTFhE29LTBizpeS1DqRG0kM+GCkTpBNUy4dMcQZ5pxNt8yXJnB6K9SKRYzSyf2Qgg88aJky88vJMotPM7NkVTWvt0Xnf9JJSapirTwqTz+5MVLEISjjO0embwd79ubOGEWegjGPWlNqHylUliLrBbog3jD2NnNreUnh8pgP6U8osJqceOxx79/bONaFV1x5VkUMcy7ksyEKDEMFdxrfNF9UXaSlTvBzu95phCUiMZtMqy9wn5ye0b+zE1ZVEfPCB+pu0Q2qaXHdhI24Uy0TtFSl+ztUEXOoksW+z0utJXL1qA5vMuGgK+W9aeMMxiItYZOhz9AG8oYrD0G7I5YlgqNRRdy1gSOgUZZgygvpYc1lgSAc3DKq6Fs2gos0dGG9ouljx4QBL3CVgNLwMuy3cEWoh5fj5nupk/JlL+mAW2xsFph0JgTmbiA62AgpyW4aSXXfd0mhbduCabc7lMXdGJ4XzuscwjaNUBh/FBDuC4vQ9NcIzrkCoWJZJNjMXAo4DSbYbtusL0IxVBVst5RLtAuqvaqKegLttUMIBVdTLMYo1jtSHQl7wY42EMUHI2y5SLhvCLHODVfl0ACxUkKtFoWVVTXq2isk46tD9SgyTZJIyX8xSE82+GLY4SGEFTHvHgOB4IxWrp5/p5MJ/bcb2QsFrohjdA5a5rpfqdpX6KGwEoTqF0Ua1qlnuHRt+xJLaxxo6vqNcAhayTJoac+tCHJ0zvEVHUpffV48P9db3d96mmV34vTPh3h9ekXlWNjnZ/0hBQ2+2Jv45CE5+I3aOvgWBmOTlLSQsnyxUwlCSaFw0SZkcTqZLE4p/1XEXh9McZ2xjK9RvfTAkwQ2Ilmhd2FQNvOXMthWFeEepVtciB0Ll1qtgCANNZiwQEdqkAw1+LdlFK3V9lvjdyWROzpWfGF6T2rFX4rh68lkEcddEL871CdrLkUSsPWNvkf14h9wt3duuL2vtydTH/JQtA2IFDVTWGc73g7ptZMO48IKXwYQ+nDMjTiu16ezOUG7HH2mCc4a7YLFhEanbLw7h8bbwSCqGKm16xbaho7qmoSbA+ibGzFen7Aq2ufuIfszUvPejWsKdR3NHWd6rGjEr0gl2sRqyNUA7gx5gjbElTL4qQe379s8DFDorAWUQ9TYgcZHSLDbuEV7HdgbIrr5EKP1dTCEZjXA34Mag5IZnKoDcCdUqkM0mpK4NKgIGYaCWp8cxnfCheU22aG4A0LZkw5XvwR0fR+kRaKfjU5aVFX3xQhu1a261nnAUGkhQQp176a36hhml2kqYsEl/IFLJzz2t7fNZvOoBI6CzAfhs2JJ10Xds68CMdTJUKr7OGIR82hzd5leo12LuJ3kT2w1Dszjptt5DezaLDekN/tCFHIpYlQOB/359sPVR1jD2WjCokG9f4XR448X5+9/u35Peqm/6iSdjCajSbg2aOdzrgZb7T8JhNvy4MK4k+3Bze3/94R/wXtCM7I8PvixkVyoAT6p5/BsDw+yiE2HTwjziGU0t6cztt1SIH8nREnkzwVaGvrziK25FXxJ42C2ZYlw9DvpXgierJBXnxqUeQRPvEYctL+dw4qGcLjEsSljEbvHcu/9o5pXUTuMybSa47w24PiG9PQaHp27dJbUEm/jGI1/lnd40F1dXt+wiLUXkjw8lzDLN/S+wjdsym7ZLQvPPaShflIg+pZJrlZFgHys1ktnCC8oU8MD6D4cQM0P8uxgTHZPptoV+kuOHRT4gfrzVyx/7NjrlScFmti23JSfeVVVfwHX2zaE",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},j={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={a:"a",h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,t.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,t.jsx)(a.a,{href:"https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," or using the Create Template API."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})}),(0,t.jsx)("span",{className:"openapi-schema__divider"}),(0,t.jsx)("span",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.fcbda936.js b/assets/js/28b19cd2.fcbda936.js deleted file mode 100644 index e8b283c0e..000000000 --- a/assets/js/28b19cd2.fcbda936.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.21cb025d.js b/assets/js/2c586be5.21cb025d.js new file mode 100644 index 000000000..bf648c16d --- /dev/null +++ b/assets/js/2c586be5.21cb025d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var i=a(85893),n=a(11151),r=a(58219),l=(a(62316),a(51039)),t=a.n(l),m=(a(82723),a(9487)),o=(a(41429),a(5397)),c=a(4667),d=a(9472),p=a(85162);const h={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN9v2zYQ/ldufOkKyHbseG1hDEO7tCuCFk2wtNiDYxi0dJKYSiRLUnY8Q//7cNRPO25WF8MehuXBsU93x+N3x7uP2jHHE8tmc/ZahUWO0lm2CFiENjRCO6Ekm7GPKcKFQe4QGi14dX0JPMvUxkJh0VhwChKUaEhL4gaixh+stqCNWotIyAQi7jhshEthxS0+mwLKUEUYQSwyHN7KW/lJZ4pHsFUF6CgGIWEe4apI4Pr1b4sfU+e0nY1GXOuh0iitSGTGV3YYqnxEhnk8IlkuQqO41iNvq6P4KaRo0LsNuYTI8A1sRJSgs8BlBKHSWwjVQBkRSe4wAM0TBFnkKzSgYnAp5kPgmVWtE29T70PFFOCtZAFTmmAQSl5GbMZCj1wDBwuYwS8FWverirZstmOhko4ezHaMa52J0JuO7ixhv2M2TDHn9I3shMGIskVosYDRTtFYFjAnXIaUOrfVyGZMre4wpNW0oXCcQEs+vN1s12hZZ4RMWMBiZXLu2IxVu2EBw3uea1JmB4nSUczKZsHHXLWSzpX1X9raID97pfZd3l73PJQBk8p9b1wfyLTsYO28cGP4lgVMOMz78q/AbNTp2ISoaG3MuchOtb1TuEJ8WQnoKHggeH5yEHcKYYUeBJ0qebL9eHI+nozPxxPyUB+v74exenpiKkUiuStMtQee9B1Uh7nvoJW0DsZlwO5PtJlMp2XAtidaPaelNicanb8oA5aeaDR9VnYn9qAhLVcq2i6bVJV/p9gcDdKLVRahoSZ3mCI6Qyij5WExr5TKkFOPPJwwwoLmhufo0DSDhdqsU2A1hiLewiZFl6Lx4g2XDrx3P3lWCJamEmlXAQ6BplaEMS8yB2ueFQjCwi1zpsBbNoRL39HrJ76974XQ0/XjQSp44tdb2sIX65NR/ZtgedJZWuAG65gFRm0IXhkc5jrjDi1sRJZR3IXFaAjtnx8gbeIogKYnNAsfOxD7aF4U1qkc/IK1EcTKQHs0oB5BQ7jgEoQMsyJCD0esCHoa1LDbtZn3BVGWsNtRVtEsqbWUZdAJaK09ge8elcRgiGK9Z9WKsDNsZT1TvNfCbJcRd7UgVLnmctsPQCRSyGRZmKwsh20H9Wn5ZqgeIFOni5z8F0F6/JBXXaCjG3UVGrRaSVu15snZGf3bR7Nlh7VTsEUYorVxkWXbH1jw7Vzn8blQiY81nsdnQ3onJn/eh+vJNdVJYU6esw37LEw2cGpAsA4a6Kqx20NWyExIXDawLSdnZ8sxYVsGbHoMvhuVo0uprjYE4sYomQSgM+QWwZkt8IQLCdQ/zD+IJhqjzDEkun2fFtljIEz3QPjpIQiXcs0zEfkLxkf1GeW/u9P+8q5ankK9z32tVJSKiUrJP2d7m+3Lq01aDAsj3JbN5jt2P+BaDKrns/miXASMgFV0T9DK+oi5S9mMjR5cGyyatSel811VuuzRuxDXYrQeszI41LaOJ0Img0etFl3gNwRuhd9e+B2p0+IdEqur0elrBUxQUlPkERqPJOXs9+4G9KZBvrmbHLtudAgfXiAO+/mRK0FzI9gj+T2OP2/oumfgLQE/wqnbHTYsuSXJPd7bo73zrtBaUtpw0rFnmZPp1PPG52PPBM9feG43fVb60uj4VVepfVpFffkBOegVdW8O9oiZkLHy2ashvdIob0Qifcmvx8e5mbD+cYO7P36eUxxY+9twBEr6QUkPSX4+HDeMqDq5Q6CbPnUV4j9xkUEm5Gc7u5UDmF/FsQgFz+APXFnhsLv0bzabByX71Nu8FS4tVmBQq0498UJf132r9sdTKiw0ub2Kb9CsRdi0+K8sNfLKo7of8YqKNeVSi14eGhHkmQhRWux1kFdvr9/DGs6HZyzonc9vCHr0/vLizYebN+SX+kGVpPHwbHjmbzzKupzL3lIHb24O89t7AfH/i54TX/TUp9vhvRvpjAvZoxVVH58fvv5ZBCylRj+bs92OPH4iSkbiLwUamhKLgK25EXxFp3O+oOte1T2pn3xGOswXVcYGH2l9Us+KqhEfjEZq/pXFqzBE7R7V7c+i66ubjyxgDYfOVUQ2hm/o9RXfsBm7ZbfMv+oiD9U7D+7vshmXSeFbHKv8UtPnhUv3J8ZnPzHqL71OyeW2F+X+KKm2Qp+0saMGP1O5vsPtL6169eSrBjW2jTalcFGW5V/8tFgj",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/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN9v2zYQ/ldufOkKyHbseG1hDEO7tCuCFk2wtNiDYxi0dJKYSiRLUnY8Q//7cNRPO25WF8MehuXBsU93x+N3x7uP2jHHE8tmc/ZahUWO0lm2CFiENjRCO6Ekm7GPKcKFQe4QGi14dX0JPMvUxkJh0VhwChKUaEhL4gaixh+stqCNWotIyAQi7jhshEthxS0+mwLKUEUYQSwyHN7KW/lJZ4pHsFUF6CgGIWEe4apI4Pr1b4sfU+e0nY1GXOuh0iitSGTGV3YYqnxEhnk8IlkuQqO41iNvq6P4KaRo0LsNuYTI8A1sRJSgs8BlBKHSWwjVQBkRSe4wAM0TBFnkKzSgYnAp5kPgmVWtE29T70PFFOCtZAFTmmAQSl5GbMZCj1wDBwuYwS8FWverirZstmOhko4ezHaMa52J0JuO7ixhv2M2TDHn9I3shMGIskVosYDRTtFYFjAnXIaUOrfVyGZMre4wpNW0oXCcQEs+vN1s12hZZ4RMWMBiZXLu2IxVu2EBw3uea1JmB4nSUczKZsHHXLWSzpX1X9raID97pfZd3l73PJQBk8p9b1wfyLTsYO28cGP4lgVMOMz78q/AbNTp2ISoaG3MuchOtb1TuEJ8WQnoKHggeH5yEHcKYYUeBJ0qebL9eHI+nozPxxPyUB+v74exenpiKkUiuStMtQee9B1Uh7nvoJW0DsZlwO5PtJlMp2XAtidaPaelNicanb8oA5aeaDR9VnYn9qAhLVcq2i6bVJV/p9gcDdKLVRahoSZ3mCI6Qyij5WExr5TKkFOPPJwwwoLmhufo0DSDhdqsU2A1hiLewiZFl6Lx4g2XDrx3P3lWCJamEmlXAQ6BplaEMS8yB2ueFQjCwi1zpsBbNoRL39HrJ76974XQ0/XjQSp44tdb2sIX65NR/ZtgedJZWuAG65gFRm0IXhkc5jrjDi1sRJZR3IXFaAjtnx8gbeIogKYnNAsfOxD7aF4U1qkc/IK1EcTKQHs0oB5BQ7jgEoQMsyJCD0esCHoa1LDbtZn3BVGWsNtRVtEsqbWUZdAJaK09ge8elcRgiGK9Z9WKsDNsZT1TvNfCbJcRd7UgVLnmctsPQCRSyGRZmKwsh20H9Wn5ZqgeIFOni5z8F0F6/JBXXaCjG3UVGrRaSVu15snZGf3bR7Nlh7VTsEUYorVxkWXbH1jw7Vzn8blQiY81nsdnQ3onJn/eh+vJNdVJYU6esw37LEw2cGpAsA4a6Kqx20NWyExIXDawLSdnZ8sxYVsGbHoMvhuVo0uprjYE4sYomQSgM+QWwZkt8IQLCdQ/zD+IJhqjzDEkun2fFtljIEz3QPjpIQiXcs0zEfkLxkf1GeW/u9P+8q5ankK9z32tVJSKiUrJP2d7m+3Lq01aDAsj3JbN5jt2P+BaDKrns/miXASMgFV0T9DK+oi5S9mMjR5cGyyatSel811VuuzRuxDXYrQeszI41LaOJ0Img0etFl3gNwRuhd9e+B2p0+IdEqur0elrBUxQUlPkERqPJOXs9+4G9KZBvrmbHLtudAgfXiAO+/mRK0FzI9gj+T2OP2/oumfgLQE/wqnbHTYsuSXJPd7bo73zrtBaUtpw0rFnmZPp1PPG52PPBM9feG43fVb60uj4VVepfVpFffkBOegVdW8O9oiZkLHy2ashvdIob0Qifcmvx8e5mbD+cYO7P36eUxxY+9twBEr6QUkPSX4+HDeMqDq5Q6CbPnUV4j9xkUEm5Gc7u5UDmF/FsQgFz+APXFnhsLv0bzabByX71Nu8FS4tVmBQq0498UJf132r9sdTKiw0ub2Kb9CsRdi0+K8sNfLKo7of8YqKNeVSi14eGhHkmQhRWux1kFdvr9/DGs6HZyzonc9vCHr0/vLizYebN+SX+kGVpPHwbHjmbzzKupzL3lIHb24O89t7AfH/i54TX/TUp9vhvRvpjAvZoxVVH58fvv5ZBCylRj+bs92OPH4iSkbiLwUamhKLgK25EXxFp3O+oOte1T2pn3xGOswXVcYGH2l9Us+KqhEfjEZq/pXFqzBE7R7V7c+i66ubjyxgDYfOVUQ2hm/o9RXfsBm7ZbfMv+oiD9U7D+7vshmXSeFbHKv8UtPnhUv3J8ZnPzHqL71OyeW2F+X+KKm2Qp+0saMGP1O5vsPtL6169eSrBjW2jTalcFGW5V/8tFgj",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(s.p,{children:["Upload you pdf in ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.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,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.f9ece43f.js b/assets/js/2c586be5.f9ece43f.js deleted file mode 100644 index 571c3a80a..000000000 --- a/assets/js/2c586be5.f9ece43f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>h,default:()=>j,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var i=s(85893),r=s(11151),n=s(58219),l=(s(62316),s(51039)),t=s.n(l),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/ivcfVoD+TVeWwjD0C7piqJFEywp9sEJDFo6SUwkkiUpv8zQfx+OsizZSdO42KdhXxL7yDsen3t5jt6A46mFcArnKioLlM7CbQAx2sgI7YSSEMJ1huzMIHfIml3s7eUHxvNcLS0rLRrLnGIpSjS0S+KSxY09Nl8zbdRCxEKmLOaOs6VwGZtziy8nDGWkYoxZInLss+tMWJbkuBLzHFmBLlNxc06iDHMZMiGjvLRCSaYStuBGqNLWdt1aow1Ywe/pKOGYLYXjZIl06dwYmeEyRVJtPGQR3Y3s2Qgl2bP9G3kjT06+6FzxmK1VyXScMCHZNMZ5mbLL8z9uf86c0zYcDKzjqZBpj2vdVxqlFanM+dz2I1UMyECRDEhWiMgorvXA29Bx8oJlaNCbj7hkseFLcjFFZxmXMYuUXrNI9ZQRseQOA6Z5ikyWxRwN3cBlWPQZz63aGfE6W2hVQo6enNxICEBpio1Q8kMMIfgrY4MABGDwa4nW/a7iNYQbiJR0tBBugGudi8irDu4sJcQGbJRhwekT6QmDMaUQhRACoLuisRCAEy5HyicKDISg5ncY0WnakDtOoCUbXi/cNLusM0KmEECiTMEdhFDfBwLAFS80bYaD7NFxAlVz4FOmdpLWlPUfdulAdvby/4esnXcsVAFI5X7Ur8+kWrWwtla4MXwNAQiHRVf+DZiNOh6bCBWdjQUX+bG6dwrniG9qARWDB4IXRztxp5DN0YOgMyWP1h+NT0fj0eloTBa2BfbjMNarR4ZSpJK70tR34GnXQF3OXQM7yc7AqApgdaTOeDKpAlgfqfWKjloeqXT6ugogO1Jp8rJqK/agIc3mKl7PmlBV39vYlAbtS1Qeo6EmdxgiqiGU8ewwmedK5chl1zdnSmzSfmbLOhEeifk+T56V1qmCkRLbKnni2UWfbbvsrqS8+882/MAO80YYGemzMy5raozR02SiiDaJCNlms8PLw1hVbLMhLNDMqCCrKmgFZHJP4GuulhiMUCz2tHYibBV3so4qrrQw61nM3VYQqUJzue46IFIpZDorTV5VffhO1Ou0aPlnGzODVitp61odD4f0bx/N8z3ex5jZMorQ2qTM8/VPEDyf/J5uFLX4sUx8ullkd2L89ypajC8pT0pzdONtBpPS5D2negRrr4Gu7sMdZIXMhcRZA9tsPBzORoRtFcBk+MtD+D7IBc9F7CfAa3WP8l+EDI1R5rHrtpfrHu/q48nVVeFhqukFRL3Jr8PeZbvy+pIWo9IIt4ZwuoFVj2vRq9fD6W11G0A9hEIIWlnvMXcZhDB4MEJZNAtP0NNNHTV41oTItRgsRkBHNa5cEVw1InsOtZSlxUckztret7srAEFhypDHaDw2FIU/2/nuXYNlM3k9Nky1mB2OR4fN6ZGBp5l39kaYzgQzbYYRP1/sxotHJobdDZsZYDcCdFi9Q+rTNnV2lNsw7shz6Hgy8az4auR57vS1Z67Jy8oHu2WPNve6pEFN5gEvdNK009Q7tCNkonz0tpBeaJRXIpU+iRejB5D6V5CwfrnBvX6hEJ0caPtpP2ZK+q5PiyQ/7Y+Y1RiJZFuLfUZvmitVID3YkjJnuZD3NryRPTa9SBIRCZ6zv3BuhcP2cbNcLh+k7Auv8164rJwzg1q121Mv9Hnd1dp9eUGJhaawF8kVmoWImn71jaMGfvNg22F4zcJNumxFbw6VCPJcRCgtdnrC2/eXn9hpfwhBpzqf4fLg04ezd5+v3pFVqu86RKP+sD/005yyruCyc9DBU/kwup3H1f8v6//Cy3rbcByu3EDnXMgObddkMT18b98GkBGbhFPYbMjmFxp5SPy1RENUdBsABYAg9kQUNA2dWtw9Un85q9Ood03n0/a8rLnhgH+roNF4G0Wo3ZN7u4R3eXF1DQE0M2qhYtIxfEm/F/AlhHADN+B/WyAL9SOT+8dDzmVa+q4LtV3iIV66bJ/E7j2JbT90mjeX646X++xWX4X+0sUeVfiVaugjrn/bba9XvqmwxbbZTSG8rarqH9QgoUc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/ivcfVoD+TVeWwjD0C7piqJFEywp9sEJDFo6SUwkkiUpv8zQfx+OsizZSdO42KdhXxL7yDsen3t5jt6A46mFcArnKioLlM7CbQAx2sgI7YSSEMJ1huzMIHfIml3s7eUHxvNcLS0rLRrLnGIpSjS0S+KSxY09Nl8zbdRCxEKmLOaOs6VwGZtziy8nDGWkYoxZInLss+tMWJbkuBLzHFmBLlNxc06iDHMZMiGjvLRCSaYStuBGqNLWdt1aow1Ywe/pKOGYLYXjZIl06dwYmeEyRVJtPGQR3Y3s2Qgl2bP9G3kjT06+6FzxmK1VyXScMCHZNMZ5mbLL8z9uf86c0zYcDKzjqZBpj2vdVxqlFanM+dz2I1UMyECRDEhWiMgorvXA29Bx8oJlaNCbj7hkseFLcjFFZxmXMYuUXrNI9ZQRseQOA6Z5ikyWxRwN3cBlWPQZz63aGfE6W2hVQo6enNxICEBpio1Q8kMMIfgrY4MABGDwa4nW/a7iNYQbiJR0tBBugGudi8irDu4sJcQGbJRhwekT6QmDMaUQhRACoLuisRCAEy5HyicKDISg5ncY0WnakDtOoCUbXi/cNLusM0KmEECiTMEdhFDfBwLAFS80bYaD7NFxAlVz4FOmdpLWlPUfdulAdvby/4esnXcsVAFI5X7Ur8+kWrWwtla4MXwNAQiHRVf+DZiNOh6bCBWdjQUX+bG6dwrniG9qARWDB4IXRztxp5DN0YOgMyWP1h+NT0fj0eloTBa2BfbjMNarR4ZSpJK70tR34GnXQF3OXQM7yc7AqApgdaTOeDKpAlgfqfWKjloeqXT6ugogO1Jp8rJqK/agIc3mKl7PmlBV39vYlAbtS1Qeo6EmdxgiqiGU8ewwmedK5chl1zdnSmzSfmbLOhEeifk+T56V1qmCkRLbKnni2UWfbbvsrqS8+882/MAO80YYGemzMy5raozR02SiiDaJCNlms8PLw1hVbLMhLNDMqCCrKmgFZHJP4GuulhiMUCz2tHYibBV3so4qrrQw61nM3VYQqUJzue46IFIpZDorTV5VffhO1Ou0aPlnGzODVitp61odD4f0bx/N8z3ex5jZMorQ2qTM8/VPEDyf/J5uFLX4sUx8ullkd2L89ypajC8pT0pzdONtBpPS5D2negRrr4Gu7sMdZIXMhcRZA9tsPBzORoRtFcBk+MtD+D7IBc9F7CfAa3WP8l+EDI1R5rHrtpfrHu/q48nVVeFhqukFRL3Jr8PeZbvy+pIWo9IIt4ZwuoFVj2vRq9fD6W11G0A9hEIIWlnvMXcZhDB4MEJZNAtP0NNNHTV41oTItRgsRkBHNa5cEVw1InsOtZSlxUckztret7srAEFhypDHaDw2FIU/2/nuXYNlM3k9Nky1mB2OR4fN6ZGBp5l39kaYzgQzbYYRP1/sxotHJobdDZsZYDcCdFi9Q+rTNnV2lNsw7shz6Hgy8az4auR57vS1Z67Jy8oHu2WPNve6pEFN5gEvdNK009Q7tCNkonz0tpBeaJRXIpU+iRejB5D6V5CwfrnBvX6hEJ0caPtpP2ZK+q5PiyQ/7Y+Y1RiJZFuLfUZvmitVID3YkjJnuZD3NryRPTa9SBIRCZ6zv3BuhcP2cbNcLh+k7Auv8164rJwzg1q121Mv9Hnd1dp9eUGJhaawF8kVmoWImn71jaMGfvNg22F4zcJNumxFbw6VCPJcRCgtdnrC2/eXn9hpfwhBpzqf4fLg04ezd5+v3pFVqu86RKP+sD/005yyruCyc9DBU/kwup3H1f8v6//Cy3rbcByu3EDnXMgObddkMT18b98GkBGbhFPYbMjmFxp5SPy1RENUdBsABYAg9kQUNA2dWtw9Un85q9Ood03n0/a8rLnhgH+roNF4G0Wo3ZN7u4R3eXF1DQE0M2qhYtIxfEm/F/AlhHADN+B/WyAL9SOT+8dDzmVa+q4LtV3iIV66bJ/E7j2JbT90mjeX646X++xWX4X+0sUeVfiVaugjrn/bba9XvqmwxbbZTSG8rarqH9QgoUc=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(a.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."}),"\n",(0,i.jsx)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]})}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"signature"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function j(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.544c0626.js b/assets/js/377084eb.544c0626.js new file mode 100644 index 000000000..0cc19c43d --- /dev/null +++ b/assets/js/377084eb.544c0626.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),d=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/ivcfWoBxS9Jmm7CMDTYiixo0RaLhwFLjICWzhYbiWTJkx3D0H8fjnqxYidxBwwB9iWRjvfcy6O743kDJBce4muYYGFzSehhGkGKPnHKkjIaYphkKC6QRKsizr9cCpnnZuXF2pSCjHBITuESRYokVe6FnJmShBTeYqLmKhHUgAedGS88uiUK6cUsL9E6pcmLuXEicShJ6YVITVIWyOKVokxYhynOlcZUeHJlQqVDP4AIjEUnOdrLFGJYILU+IAIrnSyQ0HGaG9CyQIihDedWpRCB4jStpAx2c7/8TZh5F7ygTJLQiKnnrGco5khJhmzD4bdSOUwhJldiBJ7WOXvyqrA5B4L3NjcpQjyXuWeFJMNCQrwBWtugSU7pBUQwN66QVEv0Aqpqyua9NdqjZ8DxaMT/HobqyyRB7+dlLjo+IILEaEJNrC+tzVUSDoZfPYM2+1GY2VdMiIlzbIZU7bIWM7/Px1tL8F6GrGO4H/8+04U//rKAKgJSxNJ9E1uADw8d5YzShg6Aug8UVCsOKU/RvVRadVE9F2AdjwiK1ZaIbR02AXPo6hBFGZH18XDYgkuPbpCYgtFmpR/k/RxZoc9MG1UEXi106JMOLZ2Ta24QwsIfZvMwD18NihkGb1hIlR/UniG+awRtijYz+oCb0zdnx+OTH9+OHyf7qkmUDwMJmJ7T8xaPR8cnR+PR0ejtZHwWn/4UvzkbjEajvyGC+yLfJg9pU7St0/a9tOkL+Kl21fp9tMsDVBUDTh+bJlemQMp4CK9Qk1g5oxeRsDlKj4LcWsiFVFqwGffDfzdm0DlzoHz/XWT97690rjTetqP09nQ0uh13JJzukzDpjRUxN6VOXzbVx/w/n9Dp7VmX0Jv9hC71UuYqDTf4xNyhftl8+u6pdr9fsapWCufwINm+vE7SY1I6Retwtd8fSauO6vP4esq3JleKaXaCsAtQBjF0g3O46e0BFbA9t2w3hdLlvVkrrR0Yi5pnZC5nnofRUFo1XI6hina1PcmF0oujZ1HTbfxXzHFN44MstoPYqg/Ik7ghqa/V7C8ZynCDVPw+NwHcUPfZouaZF4hfjve2nEmmvFA+HLc7VyiCsI7toMVMekyF0YIyDIcsPxmMu2UvQAfiRt9oblZReuStJFf6zsc3+khcf57PVaJkLv7CmVeE01ctc6vVao+x1wFzoSgrZ8KhNVv1RRAGWvuo7uU1REDoCv95foVuqZL2/nzC1TAoD5uukEnoiuamakXvdkFcpblKUHvs1fH5xZePYilOBiOIeuXxHUEPP17++v7T1Xu2y+VYf6TxYDQYhfvPeCqk7rnqb+e7H3ez7e//wSbflDvhPQ1tLlWYAIG8TdO919vrK4K4v8dPI8iMJ1bZbLhI/3R5VbH4W4mOZ8Q0gqV0Ss64K643kCrPz2m3kz/J3Ks/mvX+tfj+nwSPJtM2tOZuXsq85DeI4A7XO79LqmkVtV3N0dYa50mClnrYvZn9YPBdvJ9ABLJk6vrT5C5Mk+aBrT8a18MxUwfAf3niPQr4mSvqA65/6dTrkycBTX6tNnM0rarqH0MJAQo=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/ivcfWoBxS9Jmm7CMDTYiixo0RaLhwFLjICWzhYbiWTJkx3D0H8fjnqxYidxBwwB9iWRjvfcy6O743kDJBce4muYYGFzSehhGkGKPnHKkjIaYphkKC6QRKsizr9cCpnnZuXF2pSCjHBITuESRYokVe6FnJmShBTeYqLmKhHUgAedGS88uiUK6cUsL9E6pcmLuXEicShJ6YVITVIWyOKVokxYhynOlcZUeHJlQqVDP4AIjEUnOdrLFGJYILU+IAIrnSyQ0HGaG9CyQIihDedWpRCB4jStpAx2c7/8TZh5F7ygTJLQiKnnrGco5khJhmzD4bdSOUwhJldiBJ7WOXvyqrA5B4L3NjcpQjyXuWeFJMNCQrwBWtugSU7pBUQwN66QVEv0Aqpqyua9NdqjZ8DxaMT/HobqyyRB7+dlLjo+IILEaEJNrC+tzVUSDoZfPYM2+1GY2VdMiIlzbIZU7bIWM7/Px1tL8F6GrGO4H/8+04U//rKAKgJSxNJ9E1uADw8d5YzShg6Aug8UVCsOKU/RvVRadVE9F2AdjwiK1ZaIbR02AXPo6hBFGZH18XDYgkuPbpCYgtFmpR/k/RxZoc9MG1UEXi106JMOLZ2Ta24QwsIfZvMwD18NihkGb1hIlR/UniG+awRtijYz+oCb0zdnx+OTH9+OHyf7qkmUDwMJmJ7T8xaPR8cnR+PR0ejtZHwWn/4UvzkbjEajvyGC+yLfJg9pU7St0/a9tOkL+Kl21fp9tMsDVBUDTh+bJlemQMp4CK9Qk1g5oxeRsDlKj4LcWsiFVFqwGffDfzdm0DlzoHz/XWT97690rjTetqP09nQ0uh13JJzukzDpjRUxN6VOXzbVx/w/n9Dp7VmX0Jv9hC71UuYqDTf4xNyhftl8+u6pdr9fsapWCufwINm+vE7SY1I6Retwtd8fSauO6vP4esq3JleKaXaCsAtQBjF0g3O46e0BFbA9t2w3hdLlvVkrrR0Yi5pnZC5nnofRUFo1XI6hina1PcmF0oujZ1HTbfxXzHFN44MstoPYqg/Ik7ghqa/V7C8ZynCDVPw+NwHcUPfZouaZF4hfjve2nEmmvFA+HLc7VyiCsI7toMVMekyF0YIyDIcsPxmMu2UvQAfiRt9oblZReuStJFf6zsc3+khcf57PVaJkLv7CmVeE01ctc6vVao+x1wFzoSgrZ8KhNVv1RRAGWvuo7uU1REDoCv95foVuqZL2/nzC1TAoD5uukEnoiuamakXvdkFcpblKUHvs1fH5xZePYilOBiOIeuXxHUEPP17++v7T1Xu2y+VYf6TxYDQYhfvPeCqk7rnqb+e7H3ez7e//wSbflDvhPQ1tLlWYAIG8TdO919vrK4K4v8dPI8iMJ1bZbLhI/3R5VbH4W4mOZ8Q0gqV0Ss64K643kCrPz2m3kz/J3Ks/mvX+tfj+nwSPJtM2tOZuXsq85DeI4A7XO79LqmkVtV3N0dYa50mClnrYvZn9YPBdvJ9ABLJk6vrT5C5Mk+aBrT8a18MxUwfAf3niPQr4mSvqA65/6dTrkycBTX6tNnM0rarqH0MJAQo=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.d9040225.js b/assets/js/377084eb.d9040225.js deleted file mode 100644 index bb033ef99..000000000 --- a/assets/js/377084eb.d9040225.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),p=s(5397),d=s(4667),o=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfWoBxZaTNN2EYWiwFVnQYikWDwOWGgEtnSw2EsmSJyeGof8+HCXZip3E/TAU2JfEOt7Du3t4b2sgufCQ3MAUK1tKQg+zCDL0qVOWlNGQwLRAcYEkehVx/ulSyLI0916sTC3ICIfkFC5RZEhSlV7IualJSOEtpipXqaAOPNpc44VHt0QhvZiXNVqnNHmRGydSh5KUXojMpHWFLL5XVAjrMMNcacyEJ1enVDv0I4jAWHSSvb3MIIEFUm8DIrDSyQoJHYe5Bi0rhAR6d25VBhEoDtNKKmA39svfhMk3zgsqJAmNmHmOeo4iR0oL5Dscfq2VwwwScjVG4GlVsiWvKluyI/hgS5MhJLksPSukBVYSkjXQygZNckovIILcuEpSK9ELaJoZX++t0R49A47jmP89dtXXaYre53UpNnxABKnRhJpYX1pbqjQcjL94Bq33vTDzL5gSE+f4GlKtyVbM/L7sbyvBBxmiTuBh8vtcV/740wKaCEgRS/ev2AJ8+LGhnFHa0AHQ5oGCasMulRm67xVWm1QvOdj6I4JisyVim4edw+y6OkRRQWR9Mh734NqjG6WmYrS514/ifomsUGem9yoCrxY61MkGLZ2TKy4QwsofZvMwD18MijkGa1hJVR7UniO+6wR9iLYw+oCZ0zdnx5OTH99Onib7uguUDwMJmJ3Tyzcex8cnR5P4KH47nZwlpz8lb85GcRz/AxE8VOU2eMi6pO2N9t+1zb6DnWZXbVhHuzxA0zDgND7d7ybTQUWJ3NQ6++G/aybonDmQpE/ZH76l0qXSeNu3xdvT+PT2bBPQm/2ALvVSlioLw2tq7lB/33iG5qk1v/9YqlUK5/Ao2KG8DdJjWjtFqzDVHo6kVUfteXIz44FRIRWmG4dhDFIBCWx6xng9GIEN8H1u2Q/J2pWDNuNJLpReHElrR8ai5jZRyrnnehxLq8bLCbDF3qNrZq0l5pFf265i1QfkttKFPdTqhnGBMrTDhr9zE8AdGVcWNRdwoHI52RvZ00J5oXw47heI8Kxht9hBi7n0mAmjBRUYDll+MppsNpcAHYnP+rO+NhWK2iOP2FLpO5981kfi5irPVapkKf7GuVeEs1c9c/f393uMvQ6YC0VFPRcOrdmqL4Iw0DpEbT5eQwSErvJX+TW6pUr7YfCMqXFQHnd5LtOQ513b7UXvdkGcd6VKUXscZOb5xaeP4mQUQzRIjm9wefzx8tf3f1y/51s5vdonmoziURxaufFUST0wNFw0d592va3X/8FS2iU74QONbSlVqOhA3rqrxpttJ44gGa6kswgK44lV1mtO0b9c2TQs/lqj45qfRbCUTsk518TNGjLl+Xe2WS+fZe7Vn92m+lp8+3b7ZDB9OWuu5aUsa/6CCO5wtbNiN7Mm6muavW01ztMULQ2wez34USO7eD+FCGTN1A17yV3oJd0Pvv1Jvx43mdYB/ttEzwB+5oz6gKtfNurtybOALr5emzmaNU3zL8StlKE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfWoBxZaTNN2EYWiwFVnQYikWDwOWGgEtnSw2EsmSJyeGof8+HCXZip3E/TAU2JfEOt7Du3t4b2sgufCQ3MAUK1tKQg+zCDL0qVOWlNGQwLRAcYEkehVx/ulSyLI0916sTC3ICIfkFC5RZEhSlV7IualJSOEtpipXqaAOPNpc44VHt0QhvZiXNVqnNHmRGydSh5KUXojMpHWFLL5XVAjrMMNcacyEJ1enVDv0I4jAWHSSvb3MIIEFUm8DIrDSyQoJHYe5Bi0rhAR6d25VBhEoDtNKKmA39svfhMk3zgsqJAmNmHmOeo4iR0oL5Dscfq2VwwwScjVG4GlVsiWvKluyI/hgS5MhJLksPSukBVYSkjXQygZNckovIILcuEpSK9ELaJoZX++t0R49A47jmP89dtXXaYre53UpNnxABKnRhJpYX1pbqjQcjL94Bq33vTDzL5gSE+f4GlKtyVbM/L7sbyvBBxmiTuBh8vtcV/740wKaCEgRS/ev2AJ8+LGhnFHa0AHQ5oGCasMulRm67xVWm1QvOdj6I4JisyVim4edw+y6OkRRQWR9Mh734NqjG6WmYrS514/ifomsUGem9yoCrxY61MkGLZ2TKy4QwsofZvMwD18MijkGa1hJVR7UniO+6wR9iLYw+oCZ0zdnx5OTH99Onib7uguUDwMJmJ3Tyzcex8cnR5P4KH47nZwlpz8lb85GcRz/AxE8VOU2eMi6pO2N9t+1zb6DnWZXbVhHuzxA0zDgND7d7ybTQUWJ3NQ6++G/aybonDmQpE/ZH76l0qXSeNu3xdvT+PT2bBPQm/2ALvVSlioLw2tq7lB/33iG5qk1v/9YqlUK5/Ao2KG8DdJjWjtFqzDVHo6kVUfteXIz44FRIRWmG4dhDFIBCWx6xng9GIEN8H1u2Q/J2pWDNuNJLpReHElrR8ai5jZRyrnnehxLq8bLCbDF3qNrZq0l5pFf265i1QfkttKFPdTqhnGBMrTDhr9zE8AdGVcWNRdwoHI52RvZ00J5oXw47heI8Kxht9hBi7n0mAmjBRUYDll+MppsNpcAHYnP+rO+NhWK2iOP2FLpO5981kfi5irPVapkKf7GuVeEs1c9c/f393uMvQ6YC0VFPRcOrdmqL4Iw0DpEbT5eQwSErvJX+TW6pUr7YfCMqXFQHnd5LtOQ513b7UXvdkGcd6VKUXscZOb5xaeP4mQUQzRIjm9wefzx8tf3f1y/51s5vdonmoziURxaufFUST0wNFw0d592va3X/8FS2iU74QONbSlVqOhA3rqrxpttJ44gGa6kswgK44lV1mtO0b9c2TQs/lqj45qfRbCUTsk518TNGjLl+Xe2WS+fZe7Vn92m+lp8+3b7ZDB9OWuu5aUsa/6CCO5wtbNiN7Mm6muavW01ztMULQ2wez34USO7eD+FCGTN1A17yV3oJd0Pvv1Jvx43mdYB/ttEzwB+5oz6gKtfNurtybOALr5emzmaNU3zL8StlKE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Template"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"folder"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.1cc28782.js b/assets/js/38c56221.1cc28782.js deleted file mode 100644 index 7b22cb108..000000000 --- a/assets/js/38c56221.1cc28782.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var i=a(85893),n=a(11151),t=a(58219),r=(a(62316),a(51039)),o=a.n(r),l=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v20YM/lc49qUF5J/Z9iAMQ7O2K4IWTTBn2INtBGcdZV0i3al3Jzua4f994Emy5TRtl6KPfUlsHskjP/I+0jv0Yu0wnuNrk1QFae9wGaEkl1hVemU0xnidEby2IvXQKcH51QWQFqucHNSmAm8gsSQ8gdASCqHFmkB22pKN3RCuM3LUfoNEaFgRpJX1GVkgbVWSkYRVDUJKpdfg1FqTdcGl0omxpbHC84nSnqxIvNoQbJVck3fgM2uqdQamslA5so1SKhIC4SHzvnTxaCTKcmhK0uw7Fys3TEzxPDUWktxUEjZknTL6BceqXEhTOZAUQpGcpvOWRJErTeAzgtKahJwDkx7TLS2VgiM1OgKR52bLMfMlAhwbs4G3QjvFOpBaUzSo8AWp0iI/OBsu9EI/e/YM/iThK0suXujBws/Eho7VCMVxMcwoqSzlNTg+rhmJzo8DpUG0tzgvPA2Do3MpYdbgHMO54zwPuHtz6gOkspT4vG4i5vTPry6GC40RmpKajC8kxhiuoc4OI7T0sSLn/zCyxniHidGeD+IdirLMVRJMR7eO+22HLsmoEPzJ1yVhjGZ1Swn7KS1f5BU5Pk1VTj0t563Sa4wwNbYQHmNcCUe//owR0r0oSlZuRUA6MZIklDLFfYRe+a+4OkiOrlz4cICH/Zw8nG/y9rrnYR+hNv5b4/rApvsI23L2vAhrRY0RKk+F+zrMVAiVPzWIW0MropeNgF9ZyEYUT87m1hCsKGRSZkY/2X4yPZtMJ2eTKe6PhW46tKvczcrI+qbDaf9lveacG1pZkhh7W1EQuNJo1yA2HY/53ymNHp5rw5QSXJUwd6RVntc/YfS9XkUj5nf4NKCyWzX99z7ZTK8Y68o+ueQdx1Y2H3gzIKn84Pg4eqAqzfx500F2Mx2PbyTjuo/w5/Evn0J3oTciVzLw8bW5I/0d4SJrjX0s1WNi/et9cz2Hel8EiJqmRtUohXM8SbYvb5J0TNTK1xjPd3g/EKUaNOfxfLlfRliQzwwTaWlciFj4DGMcnXQjsh+7CU97vmsKdqiB82Kt9Hrw2LwbiVKNNhPkm7pIZoxWA8hJPEfOKNU7YtJo0+1rRai4ShkJSTZAw0X468j5bzooO85+jIaPkD0k1ocLySNU2THlCfn1uG9+oLFHmOmQVMc1B6rps8dyz3mmJoDSRnpZkubxGVpjM/kk0rBFtItEl45ohr6x8MAaGBQJRofRyocsPxtOwJWUqLTt8CHwTjAzBfGek1Y55ErfhcUA5pdpqhIlcviHVk55Wj7vOmK73X7SCS+CzVvls2oFlkpzVF8HYWiXvtXhywuuF9nCXaYzshuVdAzwmatGQXnUvluR+N5k6UQvHxrxO8pVQtpR76Wdv716D2fDMUa9pv8fIY/eX7x682H2hr22ix5XeDgejsN0Mc4XQvcuOl16Hxa3t8b8WJF/rMhfXZFbIvV070dlLpTujdmG4Oen6wb/Est4AMRz3O2YHP62+X7P4o8VWZ4eywg3wirusjA7oo6EmfDuqMYYXzVNOrjm61k9rxo+fzAy91FncZ4kVPov6vZn1NXl7BojXLW7fWEk21ix5b1fbDHGBS4w/EZgD2HGBPkOc6HXlVgH6g1+eXaIirHoD567MHjaD5xZd6TrXpSnE6lJhf9yYo8a/Ma9+47q3w/qzclnDVpsO22u4HK/3/8HpFtSAw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v20YM/lc49qUF5J/Z9iAMQ7O2K4IWTTBn2INtBGcdZV0i3al3Jzua4f994Emy5TRtl6KPfUlsHskjP/I+0jv0Yu0wnuNrk1QFae9wGaEkl1hVemU0xnidEby2IvXQKcH51QWQFqucHNSmAm8gsSQ8gdASCqHFmkB22pKN3RCuM3LUfoNEaFgRpJX1GVkgbVWSkYRVDUJKpdfg1FqTdcGl0omxpbHC84nSnqxIvNoQbJVck3fgM2uqdQamslA5so1SKhIC4SHzvnTxaCTKcmhK0uw7Fys3TEzxPDUWktxUEjZknTL6BceqXEhTOZAUQpGcpvOWRJErTeAzgtKahJwDkx7TLS2VgiM1OgKR52bLMfMlAhwbs4G3QjvFOpBaUzSo8AWp0iI/OBsu9EI/e/YM/iThK0suXujBws/Eho7VCMVxMcwoqSzlNTg+rhmJzo8DpUG0tzgvPA2Do3MpYdbgHMO54zwPuHtz6gOkspT4vG4i5vTPry6GC40RmpKajC8kxhiuoc4OI7T0sSLn/zCyxniHidGeD+IdirLMVRJMR7eO+22HLsmoEPzJ1yVhjGZ1Swn7KS1f5BU5Pk1VTj0t563Sa4wwNbYQHmNcCUe//owR0r0oSlZuRUA6MZIklDLFfYRe+a+4OkiOrlz4cICH/Zw8nG/y9rrnYR+hNv5b4/rApvsI23L2vAhrRY0RKk+F+zrMVAiVPzWIW0MropeNgF9ZyEYUT87m1hCsKGRSZkY/2X4yPZtMJ2eTKe6PhW46tKvczcrI+qbDaf9lveacG1pZkhh7W1EQuNJo1yA2HY/53ymNHp5rw5QSXJUwd6RVntc/YfS9XkUj5nf4NKCyWzX99z7ZTK8Y68o+ueQdx1Y2H3gzIKn84Pg4eqAqzfx500F2Mx2PbyTjuo/w5/Evn0J3oTciVzLw8bW5I/0d4SJrjX0s1WNi/et9cz2Hel8EiJqmRtUohXM8SbYvb5J0TNTK1xjPd3g/EKUaNOfxfLlfRliQzwwTaWlciFj4DGMcnXQjsh+7CU97vmsKdqiB82Kt9Hrw2LwbiVKNNhPkm7pIZoxWA8hJPEfOKNU7YtJo0+1rRai4ShkJSTZAw0X468j5bzooO85+jIaPkD0k1ocLySNU2THlCfn1uG9+oLFHmOmQVMc1B6rps8dyz3mmJoDSRnpZkubxGVpjM/kk0rBFtItEl45ohr6x8MAaGBQJRofRyocsPxtOwJWUqLTt8CHwTjAzBfGek1Y55ErfhcUA5pdpqhIlcviHVk55Wj7vOmK73X7SCS+CzVvls2oFlkpzVF8HYWiXvtXhywuuF9nCXaYzshuVdAzwmatGQXnUvluR+N5k6UQvHxrxO8pVQtpR76Wdv716D2fDMUa9pv8fIY/eX7x682H2hr22ix5XeDgejsN0Mc4XQvcuOl16Hxa3t8b8WJF/rMhfXZFbIvV070dlLpTujdmG4Oen6wb/Est4AMRz3O2YHP62+X7P4o8VWZ4eywg3wirusjA7oo6EmfDuqMYYXzVNOrjm61k9rxo+fzAy91FncZ4kVPov6vZn1NXl7BojXLW7fWEk21ix5b1fbDHGBS4w/EZgD2HGBPkOc6HXlVgH6g1+eXaIirHoD567MHjaD5xZd6TrXpSnE6lJhf9yYo8a/Ma9+47q3w/qzclnDVpsO22u4HK/3/8HpFtSAw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},x={},g=[{value:"Features:",id:"features",level:3},{value:"Request",id:"request",level:2}];function j(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(o(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com(for",children:"https://app.opensignlabs.com(for"})," cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,i.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,i.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.971ddfe3.js b/assets/js/38c56221.971ddfe3.js new file mode 100644 index 000000000..dc59999e5 --- /dev/null +++ b/assets/js/38c56221.971ddfe3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>x});var i=a(85893),n=a(11151),t=a(58219),r=(a(62316),a(51039)),l=a.n(r),o=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v3DYM/lc49qUFfL+Sbg/GMDRruyJo0QS7DHu4HAKdTdtKbMmV5Lt4B//vA2X7zndN06Uo9tSXxCeRFPlR5Edt0YnUYrjANzqqClLO4jLAmGxkZOmkVhjiVUbwxojEQS8EZ5fnQEqscrJQ6wqchsiQcARCxVAIJVKCuJeOWdmO4SojS90viISCFUFSGZeRAVJGRhnFsKpBxLFUKViZKjLWm5Qq0qbURjjekcqREZGTa4KNjFNyFlxmdJVmoCsDlSXTCiUiIhAOFpA5V9pwMhFlOdYlKbaei5UdR7pYPn90+wU8T7SBKNdVDGsyVmr1gsOR1iMhLcTkvY0ZCesMiSKXisBlBKXREVkLOtkjUhoqBQejVQAiz/WGw+JDBFhWZgVnhLKSZSAxumiB4wMSqUS+Mza+Vtfq2bNn8AcJVxmy4bUaAczFmvYJ8/mzIcwpqgzlNVjerhms3o4FqUB0p1gnHI29obM4hnmbihDOLMe5S43ThzYgloYil9etxxz+2eX5+FphgLqkNuLzGEP0x1CvhwEa+lSRdb/ruMZwi5FWjjfCLYqyzGXkVSe3lq/kFm2UUSH4y9UlYYh6dUsR2ykNH+QkWd5NZE4DKeuMVCkGmGhTCIchroSlX15igHQvipKFuyUgFemYYijjBJsAnXRfMbVb2Zuy/mMHD9s5qK1vsvZmYKEJUGn3rX59ZNUmwC6dAyvCGFFjgNJRYb8OMxVC5k914lbTiuhVu8B15qMRxZOjudUEK/KRlJlWT9afnZzOTmansxNs9olub2ifuZuVjuubHqfmcbl2ny+0NBRj6ExFfsGWWtkWsZPplP8ddtpdubbNNAZbRdw7kirP658w+F5V0S5zHT4NqOxWnvxzH61PLhnryjw55X2XrUw+cnpEsXSjfXEMQJWK++dND9nNyXR6EzOuTYAvH4JurgtyGXfRDQO4MVqlAZQ5CUvgTA0iFVJBLhyZ74gkGaPNQyjsY36aZ4+B8HI6vZntQPj5cxDO1VrkMvakdKXvSP2/kQ6Pd+3x7Op94e9JW9koWyG/jwfBDtfbIC2zlXQ1host3o9EKUftfrhYNssAGVjNbFJq6z0WLsMQJwcliWzHrH1/W2zbW4uP0f1ElHKynmETHEtbJ1Kp0tGjWsu933PGtoXvwPt9my3le+I+24EzlApQck4zEjEZDySn7M89Tb7tge9p7iHm2gN8zEXHY94D7NKTywFfDOhisev8DzTzXVB9e95152HDXTYcZ6I9KJ2nFyUpnjj8RVrPPvPUD17d7NWHI9o5SRs40gYGJQat/DTCm7x+Op6BLSmSSVcPY+AximuVp8ekyiGX6q6dpRYXSSIjKXL4m1ZWOlo+72/EZrP5fFz0Ou+ky6oVGCr1Xjz1i/66DLV2P15wvsgU9iKZk1nLqG+aXzhq4oUnXZWLyA3IuF96dazEVZfLiJSlQV2evbv8AGs4HU8xGFz7/+D05MP567cf52/Zbjcdc47H0/HUU7K2rhBqcNThY+I4vYPZ78fT48fT43s8Pbpu6+jeTcpcSDUYX1rOWByOcfwIzphTwgVut9xB/jJ50/Dyp4oME9IywLUwki+ip6Og79TcFe+oxhBft/d4dMXHs3hetU3/iIWZaFqNsyii0j0qO6S9y4v5FQa46t5MhY5Zx4gNv6fEBkO8xmv0by+24InIr28xFyqtROr7s7fLBCMqxmLITneenboPjqzfUvXAy0PaakPhvxzYgwq/8t19T/VvO/F254sKHba9NGdw2TTNv80Q1Ec=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v3DYM/lc49qUFfL+Sbg/GMDRruyJo0QS7DHu4HAKdTdtKbMmV5Lt4B//vA2X7zndN06Uo9tSXxCeRFPlR5Edt0YnUYrjANzqqClLO4jLAmGxkZOmkVhjiVUbwxojEQS8EZ5fnQEqscrJQ6wqchsiQcARCxVAIJVKCuJeOWdmO4SojS90viISCFUFSGZeRAVJGRhnFsKpBxLFUKViZKjLWm5Qq0qbURjjekcqREZGTa4KNjFNyFlxmdJVmoCsDlSXTCiUiIhAOFpA5V9pwMhFlOdYlKbaei5UdR7pYPn90+wU8T7SBKNdVDGsyVmr1gsOR1iMhLcTkvY0ZCesMiSKXisBlBKXREVkLOtkjUhoqBQejVQAiz/WGw+JDBFhWZgVnhLKSZSAxumiB4wMSqUS+Mza+Vtfq2bNn8AcJVxmy4bUaAczFmvYJ8/mzIcwpqgzlNVjerhms3o4FqUB0p1gnHI29obM4hnmbihDOLMe5S43ThzYgloYil9etxxz+2eX5+FphgLqkNuLzGEP0x1CvhwEa+lSRdb/ruMZwi5FWjjfCLYqyzGXkVSe3lq/kFm2UUSH4y9UlYYh6dUsR2ykNH+QkWd5NZE4DKeuMVCkGmGhTCIchroSlX15igHQvipKFuyUgFemYYijjBJsAnXRfMbVb2Zuy/mMHD9s5qK1vsvZmYKEJUGn3rX59ZNUmwC6dAyvCGFFjgNJRYb8OMxVC5k914lbTiuhVu8B15qMRxZOjudUEK/KRlJlWT9afnZzOTmansxNs9olub2ifuZuVjuubHqfmcbl2ny+0NBRj6ExFfsGWWtkWsZPplP8ddtpdubbNNAZbRdw7kirP658w+F5V0S5zHT4NqOxWnvxzH61PLhnryjw55X2XrUw+cnpEsXSjfXEMQJWK++dND9nNyXR6EzOuTYAvH4JurgtyGXfRDQO4MVqlAZQ5CUvgTA0iFVJBLhyZ74gkGaPNQyjsY36aZ4+B8HI6vZntQPj5cxDO1VrkMvakdKXvSP2/kQ6Pd+3x7Op94e9JW9koWyG/jwfBDtfbIC2zlXQ1host3o9EKUftfrhYNssAGVjNbFJq6z0WLsMQJwcliWzHrH1/W2zbW4uP0f1ElHKynmETHEtbJ1Kp0tGjWsu933PGtoXvwPt9my3le+I+24EzlApQck4zEjEZDySn7M89Tb7tge9p7iHm2gN8zEXHY94D7NKTywFfDOhisev8DzTzXVB9e95152HDXTYcZ6I9KJ2nFyUpnjj8RVrPPvPUD17d7NWHI9o5SRs40gYGJQat/DTCm7x+Op6BLSmSSVcPY+AximuVp8ekyiGX6q6dpRYXSSIjKXL4m1ZWOlo+72/EZrP5fFz0Ou+ky6oVGCr1Xjz1i/66DLV2P15wvsgU9iKZk1nLqG+aXzhq4oUnXZWLyA3IuF96dazEVZfLiJSlQV2evbv8AGs4HU8xGFz7/+D05MP567cf52/Zbjcdc47H0/HUU7K2rhBqcNThY+I4vYPZ78fT48fT43s8Pbpu6+jeTcpcSDUYX1rOWByOcfwIzphTwgVut9xB/jJ50/Dyp4oME9IywLUwki+ip6Og79TcFe+oxhBft/d4dMXHs3hetU3/iIWZaFqNsyii0j0qO6S9y4v5FQa46t5MhY5Zx4gNv6fEBkO8xmv0by+24InIr28xFyqtROr7s7fLBCMqxmLITneenboPjqzfUvXAy0PaakPhvxzYgwq/8t19T/VvO/F254sKHba9NGdw2TTNv80Q1Ec=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},j={},x=[{value:"Features:",id:"features",level:3},{value:"Request",id:"request",level:2}];function g(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,i.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,i.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.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,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.395b3964.js b/assets/js/38e3d9c8.395b3964.js new file mode 100644 index 000000000..afa67c54a --- /dev/null +++ b/assets/js/38e3d9c8.395b3964.js @@ -0,0 +1 @@ +(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5900],{77808:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=n(85893),o=n(11151),a=(n(39620),n(9472)),s=n(85162);n(3158);const i={id:"opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},l=void 0,c={id:"API-docs/opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",source:"@site/docs/API-docs/opensign-api-v-1.info.mdx",sourceDirName:"API-docs",slug:"/API-docs/opensign-api-v-1",permalink:"/docs/API-docs/opensign-api-v-1",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},sidebar:"apiSidebar",next:{title:"Get your account details",permalink:"/docs/API-docs/get-user"}},u={},d=[];function p(e){const t={a:"a",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:(0,r.jsx)(t.p,{children:"Version: 1.0.0"})}),"\n",(0,r.jsx)("h1",{className:"openapi__heading",children:(0,r.jsx)(t.p,{children:"OpenSign API v1"})}),"\n",(0,r.jsx)(t.p,{children:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."}),"\n",(0,r.jsx)(t.p,{children:"Some useful links:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"Official Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"Github repo"})}),"\n"]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,r.jsx)("h2",{id:"authentication",style:{marginBottom:"1rem"},children:(0,r.jsx)(t.p,{children:"Authentication"})}),(0,r.jsx)(a.default,{className:"openapi-tabs__security-schemes",children:(0,r.jsx)(s.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,r.jsx)("div",{children:(0,r.jsx)("table",{children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"apiKey"})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Header parameter name:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,r.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Contact"})}),(0,r.jsx)("span",{children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"mailto:contact@opensignlabs.com",children:"contact@opensignlabs.com"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Terms of Service"})}),(0,r.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"License"})}),(0,r.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,r.jsx)(t.p,{children:"AGPL v 3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},85162:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>s});n(67294);var r=n(36905);const o={tabItem:"tabItem_Ymn6"};var a=n(85893);function s(e){let{children:t,hidden:n,className:s}=e;return(0,a.jsx)("div",{role:"tabpanel",className:(0,r.Z)(o.tabItem,s),hidden:n,children:t})}},66412:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(92949),o=n(86668);function a(){const{prism:e}=(0,o.L)(),{colorMode:t}=(0,r.I)(),n=e.theme,a=e.darkTheme||n;return"dark"===t?a:n}},30913:(e,t,n)=>{"use strict";n.r(t),n.d(t,{Collapsible:()=>c.z,ErrorBoundaryError:()=>O.aG,ErrorBoundaryErrorMessageFallback:()=>O.Ac,ErrorBoundaryTryAgainButton:()=>O.Cw,ErrorCauseBoundary:()=>O.QW,HtmlClassNameProvider:()=>f.FG,NavbarSecondaryMenuFiller:()=>m.Zo,PageMetadata:()=>f.d,ReactContextError:()=>p.i6,SkipToContentFallbackId:()=>P.u,SkipToContentLink:()=>P.l,ThemeClassNames:()=>u.k,ThemedComponent:()=>o.Z,UnlistedBannerMessage:()=>C.eU,UnlistedBannerTitle:()=>C.cI,UnlistedMetadata:()=>C.T$,composeProviders:()=>p.Qc,createStorageSlot:()=>a.WA,duplicates:()=>T.l,filterDocCardListItems:()=>i.MN,isMultiColumnFooterLinks:()=>_.a,isRegexpStringMatch:()=>A.F,listStorageKeys:()=>a._f,listTagsByLetters:()=>b.P,prefersReducedMotion:()=>d.n,processAdmonitionProps:()=>E.X,translateTagsPageTitle:()=>b.M,uniq:()=>T.j,useCollapsible:()=>c.u,useColorMode:()=>h.I,useContextualSearchFilters:()=>s._q,useCurrentSidebarCategory:()=>i.jA,useDocsPreferredVersion:()=>I.J,useEvent:()=>p.zX,usePluralForm:()=>l.c,usePrevious:()=>p.D9,usePrismTheme:()=>k.p,useSearchLinkCreator:()=>S,useSearchQueryString:()=>w,useStorageSlot:()=>a.Nk,useThemeConfig:()=>r.L,useWindowSize:()=>g.i});var r=n(86668),o=n(18431),a=n(50012),s=n(43320),i=n(53438),l=n(88824),c=n(86043),u=n(35281),d=n(91442),p=n(902),f=n(10833),h=n(92949),m=n(13102),g=n(87524),b=n(35155),v=n(67294),x=n(52263),y=n(91980);const j="q";function w(){return(0,y.Nc)(j)}function S(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,x.default)(),{algolia:{searchPagePath:n}}=t;return(0,v.useCallback)((t=>`${e}${n}?${j}=${encodeURIComponent(t)}`),[e,n])}var _=n(42489),A=n(98022),T=n(67392),k=n(66412),I=n(60373),E=n(94697),P=n(55225),C=n(35835),O=n(69690)},94697:(e,t,n)=>{"use strict";n.d(t,{X:()=>a});var r=n(67294),o=n(85893);function a(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),a=t.filter((e=>e!==n)),s=n?.props.children;return{mdxAdmonitionTitle:s,rest:a.length>0?(0,o.jsx)(o.Fragment,{children:a}):null}}(e.children),a=e.title??t;return{...e,...a&&{title:a},children:n}}},70989:(e,t,n)=>{"use strict";n.d(t,{Y:()=>f,h:()=>c});var r=n(67294),o=n(16550),a=n(20469),s=n(91980),i=n(67392),l=n(50012);function c(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:t,children:n}=e;return(0,r.useMemo)((()=>{const e=t??function(e){return c(e).map((e=>{let{props:{value:t,label:n,attributes:r,default:o}}=e;return{value:t,label:n,attributes:r,default:o}}))}(n);return function(e){const t=(0,i.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function d(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const a=(0,o.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,s._X)(i),(0,r.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(a.location.search);t.set(i,e),a.replace({...a.location,search:t.toString()})}),[i,a])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:o}=e,s=u(e),[i,c]=(0,r.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const r=n.find((e=>e.default))??n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:t,tabValues:s}))),[f,h]=p({queryString:n,groupId:o}),[m,g]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[o,a]=(0,l.Nk)(n);return[o,(0,r.useCallback)((e=>{n&&a.set(e)}),[n,a])]}({groupId:o}),b=(()=>{const e=f??m;return d({value:e,tabValues:s})?e:null})();(0,a.Z)((()=>{b&&c(b)}),[b]);return{selectedValue:i,selectValue:(0,r.useCallback)((e=>{if(!d({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),h(e),g(e)}),[h,g,s]),tabValues:s}}},35155:(e,t,n)=>{"use strict";n.d(t,{M:()=>o,P:()=>a});var r=n(95999);const o=()=>(0,r.I)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});function a(e){const t={};return Object.values(e).forEach((e=>{const n=function(e){return e[0].toUpperCase()}(e.label);t[n]??=[],t[n].push(e)})),Object.entries(t).sort(((e,t)=>{let[n]=e,[r]=t;return n.localeCompare(r)})).map((e=>{let[t,n]=e;return{letter:t,tags:n.sort(((e,t)=>e.label.localeCompare(t.label)))}}))}},35835:(e,t,n)=>{"use strict";n.d(t,{T$:()=>l,cI:()=>s,eU:()=>i});n(67294);var r=n(95999),o=n(35742),a=n(85893);function s(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function i(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function l(){return(0,a.jsx)(o.Z,{children:(0,a.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}},88824:(e,t,n)=>{"use strict";n.d(t,{c:()=>u});var r=n(67294),o=n(52263),a=n(25108);const s=["zero","one","two","few","many","other"];function i(e){return s.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:i(["one","other"]),select:e=>1===e?"one":"other"};function c(){const{i18n:{currentLocale:e}}=(0,o.default)();return(0,r.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:i(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return a.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function u(){const e=c();return{selectMessage:(t,n)=>function(e,t,n){const r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&a.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${r.length}: ${e}`);const o=n.select(t),s=n.pluralForms.indexOf(o);return r[Math.min(s,r.length-1)]}(n,t,e)}}},3158:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const o=r(n(67294)),a=r(n(93162));t.default=function(e){let{url:t,proxy:n}=e;return o.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},o.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),o.default.createElement("ul",{className:"export-dropdown dropdown__menu"},o.default.createElement("li",null,o.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),a.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},39620:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const o=r(n(67294)),a=n(30913),s=r(n(44996)),i=r(n(59637));t.default=function(e){const{colorMode:t}=(0,a.useColorMode)(),{logo:n,darkLogo:r}=e,l=()=>"dark"===t?r?.altText??n?.altText:n?.altText,c=(0,s.default)(n?.url),u=(0,s.default)(r?.url);return n&&r?o.default.createElement(i.default,{alt:l(),sources:{light:c,dark:u},className:"openapi__logo"}):n||r?o.default.createElement(i.default,{alt:l(),sources:{light:c??u,dark:c??u},className:"openapi__logo"}):void 0}},9472:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>h});var r=n(67294),o=n(12466),a=n(70989),s=n(72389),i=n(86010),l=n(85564),c=n.n(l),u=n(85893);function d(e){let{className:t,block:n,selectedValue:a,selectValue:s,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:d}=(0,o.o5)(),p=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(d(t),s(r))},f=e=>{let t=null;switch(e.key){case"Enter":p(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()},h=(0,r.useRef)(null),[m,g]=(0,r.useState)(!1);(0,r.useEffect)((()=>{const e=new ResizeObserver((e=>{for(let t of e)t.target.offsetWidth{e.disconnect()}}),[]);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-tabs-container",children:[m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow left",onClick:()=>{h.current.scrollLeft-=90}}),(0,u.jsx)("ul",{ref:h,role:"tablist","aria-orientation":"horizontal",className:(0,i.default)("openapi-tabs__schema-list-container","tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:r}=e;return(0,u.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:f,onClick:p,...r,className:(0,i.default)("tabs__item","openapi-tabs__schema-item",r?.className,{active:a===t}),children:(0,u.jsx)("span",{className:"openapi-tabs__schema-label",children:n??t})},t)}))}),m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow right",onClick:()=>{h.current.scrollLeft+=90}})]})}function p(e){let{lazy:t,children:n,selectedValue:o}=e;n=Array.isArray(n)?n:[n];const a=c()(n);if(t){const e=a.find((e=>e.props.value===o));return e?(0,r.cloneElement)(e,{className:"margin-top--md"}):null}return(0,u.jsx)("div",{className:"margin-top--md",children:n.map(((e,t)=>(0,r.cloneElement)(e,{key:t,hidden:e.props.value!==o})))})}function f(e){const t=(0,a.Y)(e);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-container",children:[(0,u.jsx)(d,{...e,...t}),(0,u.jsx)(p,{...e,...t})]})}function h(e){const t=(0,s.default)();return(0,u.jsx)(f,{...e},String(t))}},86010:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;to,default:()=>a});const a=o},93162:function(e,t,n){var r,o,a,s=n(25108);o=[],void 0===(a="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(s.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){c(r.response,t,n)},r.onerror=function(){s.error("could not download file")},r.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function a(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,l=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),c=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!l?function(e,t,n){var s=i.URL||i.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?a(l):o(l.href)?r(e,t,n):a(l,l.target="_blank")):(l.href=s.createObjectURL(e),setTimeout((function(){s.revokeObjectURL(l.href)}),4e4),setTimeout((function(){a(l)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,s){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,s),n);else if(o(e))r(e,n,s);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){a(i)}))}}:function(e,t,n,o){if((o=o||open("","_blank"))&&(o.document.title=o.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var a="application/octet-stream"===e.type,s=/constructor/i.test(i.HTMLElement)||i.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||a&&s||l)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),o?o.location.href=e:location=e,o=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);o?o.location=p:location.href=p,o=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=c.saveAs=c,e.exports=c})?r.apply(t,o):r)||(e.exports=a)},62705:(e,t,n)=>{var r=n(55639).Symbol;e.exports=r},62488:e=>{e.exports=function(e,t){for(var n=-1,r=t.length,o=e.length;++n{var r=n(62488),o=n(37285);e.exports=function e(t,n,a,s,i){var l=-1,c=t.length;for(a||(a=o),i||(i=[]);++l0&&a(u)?n>1?e(u,n-1,a,s,i):r(i,u):s||(i[i.length]=u)}return i}},44239:(e,t,n)=>{var r=n(62705),o=n(89607),a=n(2333),s=r?r.toStringTag:void 0;e.exports=function(e){return null==e?void 0===e?"[object Undefined]":"[object Null]":s&&s in Object(e)?o(e):a(e)}},9454:(e,t,n)=>{var r=n(44239),o=n(37005);e.exports=function(e){return o(e)&&"[object Arguments]"==r(e)}},31957:(e,t,n)=>{var r="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g;e.exports=r},89607:(e,t,n)=>{var r=n(62705),o=Object.prototype,a=o.hasOwnProperty,s=o.toString,i=r?r.toStringTag:void 0;e.exports=function(e){var t=a.call(e,i),n=e[i];try{e[i]=void 0;var r=!0}catch(l){}var o=s.call(e);return r&&(t?e[i]=n:delete e[i]),o}},37285:(e,t,n)=>{var r=n(62705),o=n(35694),a=n(1469),s=r?r.isConcatSpreadable:void 0;e.exports=function(e){return a(e)||o(e)||!!(s&&e&&e[s])}},2333:e=>{var t=Object.prototype.toString;e.exports=function(e){return t.call(e)}},55639:(e,t,n)=>{var r=n(31957),o="object"==typeof self&&self&&self.Object===Object&&self,a=r||o||Function("return this")();e.exports=a},85564:(e,t,n)=>{var r=n(21078);e.exports=function(e){return(null==e?0:e.length)?r(e,1):[]}},35694:(e,t,n)=>{var r=n(9454),o=n(37005),a=Object.prototype,s=a.hasOwnProperty,i=a.propertyIsEnumerable,l=r(function(){return arguments}())?r:function(e){return o(e)&&s.call(e,"callee")&&!i.call(e,"callee")};e.exports=l},1469:e=>{var t=Array.isArray;e.exports=t},37005:e=>{e.exports=function(e){return null!=e&&"object"==typeof e}},11151:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i,a:()=>s});var r=n(67294);const o={},a=r.createContext(o);function s(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.a995c609.js b/assets/js/38e3d9c8.a995c609.js deleted file mode 100644 index 6befecde7..000000000 --- a/assets/js/38e3d9c8.a995c609.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5900],{77808:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=n(85893),o=n(11151),a=(n(39620),n(9472)),s=n(85162);n(3158);const i={id:"opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},l=void 0,c={id:"API-docs/opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",source:"@site/docs/API-docs/opensign-api-v-1.info.mdx",sourceDirName:"API-docs",slug:"/API-docs/opensign-api-v-1",permalink:"/docs/API-docs/opensign-api-v-1",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"opensign-api-v-1",title:"OpenSign API v1",description:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},sidebar:"apiSidebar",next:{title:"Get your details",permalink:"/docs/API-docs/get-user"}},u={},d=[];function p(e){const t={a:"a",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:(0,r.jsx)(t.p,{children:"Version: 1.0.0"})}),"\n",(0,r.jsx)("h1",{className:"openapi__heading",children:(0,r.jsx)(t.p,{children:"OpenSign API v1"})}),"\n",(0,r.jsx)(t.p,{children:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."}),"\n",(0,r.jsx)(t.p,{children:"Some useful links:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"Official Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"Github repo"})}),"\n"]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,r.jsx)("h2",{id:"authentication",style:{marginBottom:"1rem"},children:(0,r.jsx)(t.p,{children:"Authentication"})}),(0,r.jsx)(a.default,{className:"openapi-tabs__security-schemes",children:(0,r.jsx)(s.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,r.jsx)("div",{children:(0,r.jsx)("table",{children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"apiKey"})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Header parameter name:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,r.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Contact"})}),(0,r.jsx)("span",{children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"mailto:contact@opensignlabs.com",children:"contact@opensignlabs.com"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Terms of Service"})}),(0,r.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"License"})}),(0,r.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,r.jsx)(t.p,{children:"AGPL 3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},85162:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>s});n(67294);var r=n(36905);const o={tabItem:"tabItem_Ymn6"};var a=n(85893);function s(e){let{children:t,hidden:n,className:s}=e;return(0,a.jsx)("div",{role:"tabpanel",className:(0,r.Z)(o.tabItem,s),hidden:n,children:t})}},66412:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(92949),o=n(86668);function a(){const{prism:e}=(0,o.L)(),{colorMode:t}=(0,r.I)(),n=e.theme,a=e.darkTheme||n;return"dark"===t?a:n}},30913:(e,t,n)=>{"use strict";n.r(t),n.d(t,{Collapsible:()=>c.z,ErrorBoundaryError:()=>O.aG,ErrorBoundaryErrorMessageFallback:()=>O.Ac,ErrorBoundaryTryAgainButton:()=>O.Cw,ErrorCauseBoundary:()=>O.QW,HtmlClassNameProvider:()=>f.FG,NavbarSecondaryMenuFiller:()=>m.Zo,PageMetadata:()=>f.d,ReactContextError:()=>p.i6,SkipToContentFallbackId:()=>P.u,SkipToContentLink:()=>P.l,ThemeClassNames:()=>u.k,ThemedComponent:()=>o.Z,UnlistedBannerMessage:()=>C.eU,UnlistedBannerTitle:()=>C.cI,UnlistedMetadata:()=>C.T$,composeProviders:()=>p.Qc,createStorageSlot:()=>a.WA,duplicates:()=>T.l,filterDocCardListItems:()=>i.MN,isMultiColumnFooterLinks:()=>_.a,isRegexpStringMatch:()=>A.F,listStorageKeys:()=>a._f,listTagsByLetters:()=>b.P,prefersReducedMotion:()=>d.n,processAdmonitionProps:()=>E.X,translateTagsPageTitle:()=>b.M,uniq:()=>T.j,useCollapsible:()=>c.u,useColorMode:()=>h.I,useContextualSearchFilters:()=>s._q,useCurrentSidebarCategory:()=>i.jA,useDocsPreferredVersion:()=>I.J,useEvent:()=>p.zX,usePluralForm:()=>l.c,usePrevious:()=>p.D9,usePrismTheme:()=>k.p,useSearchLinkCreator:()=>S,useSearchQueryString:()=>w,useStorageSlot:()=>a.Nk,useThemeConfig:()=>r.L,useWindowSize:()=>g.i});var r=n(86668),o=n(18431),a=n(50012),s=n(43320),i=n(53438),l=n(88824),c=n(86043),u=n(35281),d=n(91442),p=n(902),f=n(10833),h=n(92949),m=n(13102),g=n(87524),b=n(35155),v=n(67294),x=n(52263),y=n(91980);const j="q";function w(){return(0,y.Nc)(j)}function S(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,x.default)(),{algolia:{searchPagePath:n}}=t;return(0,v.useCallback)((t=>`${e}${n}?${j}=${encodeURIComponent(t)}`),[e,n])}var _=n(42489),A=n(98022),T=n(67392),k=n(66412),I=n(60373),E=n(94697),P=n(55225),C=n(35835),O=n(69690)},94697:(e,t,n)=>{"use strict";n.d(t,{X:()=>a});var r=n(67294),o=n(85893);function a(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),a=t.filter((e=>e!==n)),s=n?.props.children;return{mdxAdmonitionTitle:s,rest:a.length>0?(0,o.jsx)(o.Fragment,{children:a}):null}}(e.children),a=e.title??t;return{...e,...a&&{title:a},children:n}}},70989:(e,t,n)=>{"use strict";n.d(t,{Y:()=>f,h:()=>c});var r=n(67294),o=n(16550),a=n(20469),s=n(91980),i=n(67392),l=n(50012);function c(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:t,children:n}=e;return(0,r.useMemo)((()=>{const e=t??function(e){return c(e).map((e=>{let{props:{value:t,label:n,attributes:r,default:o}}=e;return{value:t,label:n,attributes:r,default:o}}))}(n);return function(e){const t=(0,i.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function d(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const a=(0,o.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,s._X)(i),(0,r.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(a.location.search);t.set(i,e),a.replace({...a.location,search:t.toString()})}),[i,a])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:o}=e,s=u(e),[i,c]=(0,r.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const r=n.find((e=>e.default))??n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:t,tabValues:s}))),[f,h]=p({queryString:n,groupId:o}),[m,g]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[o,a]=(0,l.Nk)(n);return[o,(0,r.useCallback)((e=>{n&&a.set(e)}),[n,a])]}({groupId:o}),b=(()=>{const e=f??m;return d({value:e,tabValues:s})?e:null})();(0,a.Z)((()=>{b&&c(b)}),[b]);return{selectedValue:i,selectValue:(0,r.useCallback)((e=>{if(!d({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),h(e),g(e)}),[h,g,s]),tabValues:s}}},35155:(e,t,n)=>{"use strict";n.d(t,{M:()=>o,P:()=>a});var r=n(95999);const o=()=>(0,r.I)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});function a(e){const t={};return Object.values(e).forEach((e=>{const n=function(e){return e[0].toUpperCase()}(e.label);t[n]??=[],t[n].push(e)})),Object.entries(t).sort(((e,t)=>{let[n]=e,[r]=t;return n.localeCompare(r)})).map((e=>{let[t,n]=e;return{letter:t,tags:n.sort(((e,t)=>e.label.localeCompare(t.label)))}}))}},35835:(e,t,n)=>{"use strict";n.d(t,{T$:()=>l,cI:()=>s,eU:()=>i});n(67294);var r=n(95999),o=n(35742),a=n(85893);function s(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function i(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function l(){return(0,a.jsx)(o.Z,{children:(0,a.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}},88824:(e,t,n)=>{"use strict";n.d(t,{c:()=>u});var r=n(67294),o=n(52263),a=n(25108);const s=["zero","one","two","few","many","other"];function i(e){return s.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:i(["one","other"]),select:e=>1===e?"one":"other"};function c(){const{i18n:{currentLocale:e}}=(0,o.default)();return(0,r.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:i(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return a.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function u(){const e=c();return{selectMessage:(t,n)=>function(e,t,n){const r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&a.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${r.length}: ${e}`);const o=n.select(t),s=n.pluralForms.indexOf(o);return r[Math.min(s,r.length-1)]}(n,t,e)}}},3158:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const o=r(n(67294)),a=r(n(93162));t.default=function(e){let{url:t,proxy:n}=e;return o.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},o.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),o.default.createElement("ul",{className:"export-dropdown dropdown__menu"},o.default.createElement("li",null,o.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),a.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},39620:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const o=r(n(67294)),a=n(30913),s=r(n(44996)),i=r(n(59637));t.default=function(e){const{colorMode:t}=(0,a.useColorMode)(),{logo:n,darkLogo:r}=e,l=()=>"dark"===t?r?.altText??n?.altText:n?.altText,c=(0,s.default)(n?.url),u=(0,s.default)(r?.url);return n&&r?o.default.createElement(i.default,{alt:l(),sources:{light:c,dark:u},className:"openapi__logo"}):n||r?o.default.createElement(i.default,{alt:l(),sources:{light:c??u,dark:c??u},className:"openapi__logo"}):void 0}},9472:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>h});var r=n(67294),o=n(12466),a=n(70989),s=n(72389),i=n(86010),l=n(85564),c=n.n(l),u=n(85893);function d(e){let{className:t,block:n,selectedValue:a,selectValue:s,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:d}=(0,o.o5)(),p=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(d(t),s(r))},f=e=>{let t=null;switch(e.key){case"Enter":p(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()},h=(0,r.useRef)(null),[m,g]=(0,r.useState)(!1);(0,r.useEffect)((()=>{const e=new ResizeObserver((e=>{for(let t of e)t.target.offsetWidth{e.disconnect()}}),[]);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-tabs-container",children:[m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow left",onClick:()=>{h.current.scrollLeft-=90}}),(0,u.jsx)("ul",{ref:h,role:"tablist","aria-orientation":"horizontal",className:(0,i.default)("openapi-tabs__schema-list-container","tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:r}=e;return(0,u.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:f,onClick:p,...r,className:(0,i.default)("tabs__item","openapi-tabs__schema-item",r?.className,{active:a===t}),children:(0,u.jsx)("span",{className:"openapi-tabs__schema-label",children:n??t})},t)}))}),m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow right",onClick:()=>{h.current.scrollLeft+=90}})]})}function p(e){let{lazy:t,children:n,selectedValue:o}=e;n=Array.isArray(n)?n:[n];const a=c()(n);if(t){const e=a.find((e=>e.props.value===o));return e?(0,r.cloneElement)(e,{className:"margin-top--md"}):null}return(0,u.jsx)("div",{className:"margin-top--md",children:n.map(((e,t)=>(0,r.cloneElement)(e,{key:t,hidden:e.props.value!==o})))})}function f(e){const t=(0,a.Y)(e);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-container",children:[(0,u.jsx)(d,{...e,...t}),(0,u.jsx)(p,{...e,...t})]})}function h(e){const t=(0,s.default)();return(0,u.jsx)(f,{...e},String(t))}},86010:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;to,default:()=>a});const a=o},93162:function(e,t,n){var r,o,a,s=n(25108);o=[],void 0===(a="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(s.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){c(r.response,t,n)},r.onerror=function(){s.error("could not download file")},r.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function a(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,l=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),c=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!l?function(e,t,n){var s=i.URL||i.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?a(l):o(l.href)?r(e,t,n):a(l,l.target="_blank")):(l.href=s.createObjectURL(e),setTimeout((function(){s.revokeObjectURL(l.href)}),4e4),setTimeout((function(){a(l)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,s){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,s),n);else if(o(e))r(e,n,s);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){a(i)}))}}:function(e,t,n,o){if((o=o||open("","_blank"))&&(o.document.title=o.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var a="application/octet-stream"===e.type,s=/constructor/i.test(i.HTMLElement)||i.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||a&&s||l)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),o?o.location.href=e:location=e,o=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);o?o.location=p:location.href=p,o=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=c.saveAs=c,e.exports=c})?r.apply(t,o):r)||(e.exports=a)},62705:(e,t,n)=>{var r=n(55639).Symbol;e.exports=r},62488:e=>{e.exports=function(e,t){for(var n=-1,r=t.length,o=e.length;++n{var r=n(62488),o=n(37285);e.exports=function e(t,n,a,s,i){var l=-1,c=t.length;for(a||(a=o),i||(i=[]);++l0&&a(u)?n>1?e(u,n-1,a,s,i):r(i,u):s||(i[i.length]=u)}return i}},44239:(e,t,n)=>{var r=n(62705),o=n(89607),a=n(2333),s=r?r.toStringTag:void 0;e.exports=function(e){return null==e?void 0===e?"[object Undefined]":"[object Null]":s&&s in Object(e)?o(e):a(e)}},9454:(e,t,n)=>{var r=n(44239),o=n(37005);e.exports=function(e){return o(e)&&"[object Arguments]"==r(e)}},31957:(e,t,n)=>{var r="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g;e.exports=r},89607:(e,t,n)=>{var r=n(62705),o=Object.prototype,a=o.hasOwnProperty,s=o.toString,i=r?r.toStringTag:void 0;e.exports=function(e){var t=a.call(e,i),n=e[i];try{e[i]=void 0;var r=!0}catch(l){}var o=s.call(e);return r&&(t?e[i]=n:delete e[i]),o}},37285:(e,t,n)=>{var r=n(62705),o=n(35694),a=n(1469),s=r?r.isConcatSpreadable:void 0;e.exports=function(e){return a(e)||o(e)||!!(s&&e&&e[s])}},2333:e=>{var t=Object.prototype.toString;e.exports=function(e){return t.call(e)}},55639:(e,t,n)=>{var r=n(31957),o="object"==typeof self&&self&&self.Object===Object&&self,a=r||o||Function("return this")();e.exports=a},85564:(e,t,n)=>{var r=n(21078);e.exports=function(e){return(null==e?0:e.length)?r(e,1):[]}},35694:(e,t,n)=>{var r=n(9454),o=n(37005),a=Object.prototype,s=a.hasOwnProperty,i=a.propertyIsEnumerable,l=r(function(){return arguments}())?r:function(e){return o(e)&&s.call(e,"callee")&&!i.call(e,"callee")};e.exports=l},1469:e=>{var t=Array.isArray;e.exports=t},37005:e=>{e.exports=function(e){return null!=e&&"object"==typeof e}},11151:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i,a:()=>s});var r=n(67294);const o={},a=r.createContext(o);function s(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.4f2bfead.js b/assets/js/52d5c0f9.4f2bfead.js new file mode 100644 index 000000000..a42633ea8 --- /dev/null +++ b/assets/js/52d5c0f9.4f2bfead.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),d=(a(62316),a(51039)),i=a.n(d),c=(a(82723),a(9487)),o=a(41429),r=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v4zYM/isaP10BJ3Ha3g0zhmHdWtyKK9Zi7TBgbVAoNh3rKks6Sc4LAv/3gbKdOE0a3IDtviQ29VAkH76Ya/B85iB5hEudViUq72ASQYYutcJ4oRUk8FAgu0SJHlnWotjF3TXjUuqFYytdMa+ZxVLPkTmDqchFuoXmVpcEshuRG0IE2qDlZOE6gwSycH8HgAgMt7xEj5a8W4PiJRKsBTyLDCIQ5J3hvoDXLt9ZPRcZMj39jKm/zpjOtw55zRpzEIHFL5WwmEHibYUROL+SZMiJ0kgC4NJInSEkOZeOAGmBJYdkDX5lAtJboWYQQa5tyX1fgksebknAFKfT4pS7DOp6Qlad0cqho3tO45j+dgPo0tF6mjFXpSk6l1dSrr6DCFKtPDGVrIEbI0UauBx9dqS+3nezYYKItcS8F43xjqBDAW3d/2VJzpvfzBnUUZerC39c6TQ+PRuM40H8/cP4Q3L+Q/L+wzCO478hgmUpSbdLKvdI93rh5fa93oM1OesDW0lN4PNDNN7rEn0h1IwtiMyF1WoWMSORO2TerhifcaGY5B7tf8gqWqvtcXb+nWd1L2qhpFD43NXQ83kcP483JJwfqSWlPct1pbJvG+oh+8cDOn8+2wT0fj+gazXnUmRhCD3oF1TfNp6+ed+Y369W0YDCOewE25c3QTpMKyv8Kky65YAbMWjOk8cJjQuqFL2dkmE6+gISGHUzbbTuTcYa6Eo772ZnZSUkUHhvXDIacWOG2qByYqYkn7phqssRN2I0H0MdvUY7z2dCzQZHtSbbEO6J5obJnUA2fHIjPuEKoo6nPqqd6AXyDG3gVKhcB+WWvVuD6l7MVOB+Pt6b+w+FcEy4cNwxEuqA5dqyV9psyh1mTCvmCwyHJD8bjjcfsaA6ZE/qSVG/ssphXkkmhXpxyZMasMfbPBep4JL9hVMnPE7edcwtFos9xk6Czkfhi2rKLBq9hc+CMNDa19q8nEAEHm3pbvN7tHORYpulN0yNAnjUNgZPQ2NgyQVltxX9/FqJClWKFJXDXilffLy7YXN2Nowh6pXHVzg9urn+9er3+yu6l8qxSdJ4GA9jEhntfMlVz1S7Zlxu94Cd/K63Xf4/bSVtlXpc+pGRXITeDTGv26Z7hN6WkvQXkkkEhXaeIOs11dafVtY1ib9UaKm7JxHMuRV8SsX8uIZMOHrONtvFm9G++6NdVE7YV+82B2Pp2lBRD865rOgNInjB1av9qp7UUdeL5GyDuEhTNL6nuzdsdybW5dXN1cMVRMArIq8/Bl7CGGgfyMBB13bnQ+MD/dKoOqjwIxXBJ1z9tIE3J28qtCF2aKJpUtf1P6lL0F0=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v4zYM/isaP10BJ3Ha3g0zhmHdWtyKK9Zi7TBgbVAoNh3rKks6Sc4LAv/3gbKdOE0a3IDtviQ29VAkH76Ya/B85iB5hEudViUq72ASQYYutcJ4oRUk8FAgu0SJHlnWotjF3TXjUuqFYytdMa+ZxVLPkTmDqchFuoXmVpcEshuRG0IE2qDlZOE6gwSycH8HgAgMt7xEj5a8W4PiJRKsBTyLDCIQ5J3hvoDXLt9ZPRcZMj39jKm/zpjOtw55zRpzEIHFL5WwmEHibYUROL+SZMiJ0kgC4NJInSEkOZeOAGmBJYdkDX5lAtJboWYQQa5tyX1fgksebknAFKfT4pS7DOp6Qlad0cqho3tO45j+dgPo0tF6mjFXpSk6l1dSrr6DCFKtPDGVrIEbI0UauBx9dqS+3nezYYKItcS8F43xjqBDAW3d/2VJzpvfzBnUUZerC39c6TQ+PRuM40H8/cP4Q3L+Q/L+wzCO478hgmUpSbdLKvdI93rh5fa93oM1OesDW0lN4PNDNN7rEn0h1IwtiMyF1WoWMSORO2TerhifcaGY5B7tf8gqWqvtcXb+nWd1L2qhpFD43NXQ83kcP483JJwfqSWlPct1pbJvG+oh+8cDOn8+2wT0fj+gazXnUmRhCD3oF1TfNp6+ed+Y369W0YDCOewE25c3QTpMKyv8Kky65YAbMWjOk8cJjQuqFL2dkmE6+gISGHUzbbTuTcYa6Eo772ZnZSUkUHhvXDIacWOG2qByYqYkn7phqssRN2I0H0MdvUY7z2dCzQZHtSbbEO6J5obJnUA2fHIjPuEKoo6nPqqd6AXyDG3gVKhcB+WWvVuD6l7MVOB+Pt6b+w+FcEy4cNwxEuqA5dqyV9psyh1mTCvmCwyHJD8bjjcfsaA6ZE/qSVG/ssphXkkmhXpxyZMasMfbPBep4JL9hVMnPE7edcwtFos9xk6Czkfhi2rKLBq9hc+CMNDa19q8nEAEHm3pbvN7tHORYpulN0yNAnjUNgZPQ2NgyQVltxX9/FqJClWKFJXDXilffLy7YXN2Nowh6pXHVzg9urn+9er3+yu6l8qxSdJ4GA9jEhntfMlVz1S7Zlxu94Cd/K63Xf4/bSVtlXpc+pGRXITeDTGv26Z7hN6WkvQXkkkEhXaeIOs11dafVtY1ib9UaKm7JxHMuRV8SsX8uIZMOHrONtvFm9G++6NdVE7YV+82B2Pp2lBRD865rOgNInjB1av9qp7UUdeL5GyDuEhTNL6nuzdsdybW5dXN1cMVRMArIq8/Bl7CGGgfyMBB13bnQ+MD/dKoOqjwIxXBJ1z9tIE3J28qtCF2aKJpUtf1P6lL0F0=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.a1f30bed.js b/assets/js/52d5c0f9.a1f30bed.js deleted file mode 100644 index 496cc6032..000000000 --- a/assets/js/52d5c0f9.a1f30bed.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>v,contentTitle:()=>j,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),d=(a(82723),a(9487)),c=a(41429),r=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZKTtMOEYVi2BF3QYAmWDAOWGAEtnSw2FMmSlGND0H8fjpJsOU6Cftj2xZaOz/HunntTA54vHaR3cKazukLlHcwjyNFlVhgvtIIUbktkZyjRI8t7FDu9vmBcSv3k2EbXzGtmsdIrZM5gJgqR7aCF1RWB7FbkphCBNmg5WbjIIYU83D8AIALDLa/QoyXvGlC8QoL1gAeRQwSCvDPcl/Dc5WurVyJHphdfMPMXOdPFziGvWWcOIrD4tRYWc0i9rTEC5zeSDDlRGUkAXBupc4S04NIRICux4pA24DcmIL0VagkRFNpW3I8luObhlhRMebQoj7jLoW3nZNUZrRw6uucoSehvP4AhHb2nOXN1lqFzRS3l5juIINPKE1NpA9wYKbLAZfzFkXpz6GbHBBFriXkvOuMDQS8FtHP/lzU5b34zx9BGQ65O/dtKR8nR8WSWTJLvb2cf05Mf0g8fp0mS/A0RrCtJukNSuUe61wsvd+/tAazL2RjYS1oCnyQnb9CotGeFrlX+L3KH1mr7Ngcv2W9HEQglhcKHoR4eTpKTh+NtQB8OA7pQKy5FHvrvVj+i+n/jGZv3nfnDRIkOFM5hL9ixvAvSYVZb4TehydcTbsSkO0/v5tQpFfpS7wZEGAy+hBTioZ3jZjQUWqAr7WoYG7WVkELpvXFpHDvPl0ItJ9yYqTaonFgqyRdumukq5kbEqxmQ0cGpGyKu42bPtS1D3IjPuIFoiHyM6sdTiTxHG1gSqtBBuefjyqC6EUsV2FzNDobYbSkcEy4cDzGGzLJCW/ZMmy24w5xpxXyJ4ZDkx9PZdiIH1Sm7V/fqRlfIaodFLZkU6tGl92rC7q6KQmSCS/YXLpzwOH83MPf09HTA2Pug80n4sl4wi0bv4MsgDLSOtbYv7yECj7ZyV8UN2pXIsM/SK6biAI77UudZKHWsuKDs9qKfnytR6UmRoXI4Ks7TT9eX7HiaQDQqjm9wOb68+PX895tzupXKq0vRbJpMExIZ7XzF1chQvzHPdittL7vNrmv/owXb16jHtY+N5CL0Yoi56ZvoDkYLNx3v1nkEpXaeIE1DlfWnlW1L4q81WurWeQQrbgVfUCnfNZALR8/5dlG+Gu27P/qd+55985p+MZahCRV14IrLmt4ggkfcPPtUaOdtNHQiOdshTrMMjR/pHgzPvQl0dn55fnsOEfCayBsPgccwBPoHMvCia/vTofOBftvoFYUfqQg+4+anLbw7eVWhD3FAE03ztm3/AYcFZAM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZKTtMOEYVi2BF3QYAmWDAOWGAEtnSw2FMmSlGND0H8fjpJsOU6Cftj2xZaOz/HunntTA54vHaR3cKazukLlHcwjyNFlVhgvtIIUbktkZyjRI8t7FDu9vmBcSv3k2EbXzGtmsdIrZM5gJgqR7aCF1RWB7FbkphCBNmg5WbjIIYU83D8AIALDLa/QoyXvGlC8QoL1gAeRQwSCvDPcl/Dc5WurVyJHphdfMPMXOdPFziGvWWcOIrD4tRYWc0i9rTEC5zeSDDlRGUkAXBupc4S04NIRICux4pA24DcmIL0VagkRFNpW3I8luObhlhRMebQoj7jLoW3nZNUZrRw6uucoSehvP4AhHb2nOXN1lqFzRS3l5juIINPKE1NpA9wYKbLAZfzFkXpz6GbHBBFriXkvOuMDQS8FtHP/lzU5b34zx9BGQ65O/dtKR8nR8WSWTJLvb2cf05Mf0g8fp0mS/A0RrCtJukNSuUe61wsvd+/tAazL2RjYS1oCnyQnb9CotGeFrlX+L3KH1mr7Ngcv2W9HEQglhcKHoR4eTpKTh+NtQB8OA7pQKy5FHvrvVj+i+n/jGZv3nfnDRIkOFM5hL9ixvAvSYVZb4TehydcTbsSkO0/v5tQpFfpS7wZEGAy+hBTioZ3jZjQUWqAr7WoYG7WVkELpvXFpHDvPl0ItJ9yYqTaonFgqyRdumukq5kbEqxmQ0cGpGyKu42bPtS1D3IjPuIFoiHyM6sdTiTxHG1gSqtBBuefjyqC6EUsV2FzNDobYbSkcEy4cDzGGzLJCW/ZMmy24w5xpxXyJ4ZDkx9PZdiIH1Sm7V/fqRlfIaodFLZkU6tGl92rC7q6KQmSCS/YXLpzwOH83MPf09HTA2Pug80n4sl4wi0bv4MsgDLSOtbYv7yECj7ZyV8UN2pXIsM/SK6biAI77UudZKHWsuKDs9qKfnytR6UmRoXI4Ks7TT9eX7HiaQDQqjm9wOb68+PX895tzupXKq0vRbJpMExIZ7XzF1chQvzHPdittL7vNrmv/owXb16jHtY+N5CL0Yoi56ZvoDkYLNx3v1nkEpXaeIE1DlfWnlW1L4q81WurWeQQrbgVfUCnfNZALR8/5dlG+Gu27P/qd+55985p+MZahCRV14IrLmt4ggkfcPPtUaOdtNHQiOdshTrMMjR/pHgzPvQl0dn55fnsOEfCayBsPgccwBPoHMvCia/vTofOBftvoFYUfqQg+4+anLbw7eVWhD3FAE03ztm3/AYcFZAM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},v={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.6e9541b8.js b/assets/js/5a2de241.6e9541b8.js deleted file mode 100644 index 2f7f3c112..000000000 --- a/assets/js/5a2de241.6e9541b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),c=s(4667),o=s(9472),u=s(85162);const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWwmFMmSlB3D0H8fjpJs2XGyZui2L4ZE3cvz3B3vzhvwfO4guYYxFkZyjw4mEWToUiuMF1pBAuMFsi8m4x5ZK8XORxcMFZ9JdGytS+Y1K3Qm8jXjKmNlLe0XyDL0XEjHdM44cwZTkYuU+cZOHyLQBi0nVxcZJFCrtn4gAsMtL9CjJZgbULxASKA1MBUZRCAIpuF+AYfYL34jzwSk1WB+wT1TiJkj1DNs0JIdi19LYTGDxNsSI3B+LcmbE4WRBAbvjdQZQpJz6UggXWDBIdmAX5sg6a1Qc4gg17bgfndSVZPaPjr/q87WpLMPdWT1UmTIZij1im1pE8g2nm2O2AvumUTuPNMKO7ItgZcQQaqVR+XJETdGijQEeXDryNvmIXQ9u8XUU8QtpcQLdPS1DvjfE6Tg8BCmBFx42OKFKgKl/bPNjIgiMotLgatQWE7MFfML4Vim07IgetVByp/nYlsVXRsV6cgMLVXk8+zd37oZH77n9yOoqgi88Htupp26nc6oDKqK5Cw6o5WrI34Sxw+rY3vzmmplrkxTdC4vpVz/8P3SXR8fJ76jyV128sGNzj4YClYD6dw/rXQSn5z2hnEvfjMevk7Ofkxeve7HcfwnRHBfyF2tQdbUTBu9+r1zIJQUCqdt1KYncTw9bUJ5dix6TSWZ5ootuRQZywXKjJFP9x0DiNZq+w8r/Ql8T9Enyi35sydKR2nPcl2q7P+mewzR0wTPpm+2FF89pHih6pDRWBrrO1T/BcMdn657X7snqPtVLWqh8B32yHbPa5IO09IKvw4j777HjejV35PrCQ2SAv1C07g0ZQBMoy+BQdtdBptOn6mA7NllO0FLKyGBhffGJYOB83wu1LzHjelrg4o6rOQz1091MeBGDJZDII8toiuKWh2YPVzb8HAjPuIaopZ2V6qZ1AvkGdoQIkrG591UfNeGdBu1w1HSTpJvGw6H68DRdt/t9nsNnODmOnBrcnVpUF2RG8r0cvjA/pi8Cxc+tyBC1bFcW3agzWbcYca0CvsJfaTz0/5wuycF1T67UTfqShfISod5KZkU6s4lN6rHri/zXKSCS/YHzpzwOHnRJna1Wj1I6Mug8174RTljFo3eic/DYch6V2v7QhuFR1u4y/wK7VKk2BTRI64GQXjQXEOehmuIBRdUfM3RL4dKFHIpUlSuWwLn70ef2Gk/hqhTu98AefDp4u2736/ekVWq/jpFw37cj+nIaOcLrjqODpbcw+xudh3l396Jm7vk8d4PjOQiNIxAftNc9mvoXImkuw5PIlho50lks6ES+2JlVdHx1xIttZRJBEtuBSENHSETjp6z7Vr7KO0Xn9sFkz1vsz5KqO0YitrFksuS3iCCO1wfrPjVpIratkGIa4m3Na7emOzsLDxo9lXUapynKRr/pGy3u46+jCGCWbOuF2HzB8tX9FeBryCBG7iB8BeGDISmGM43ILmal3xO8rVZana8pMx1O+Vd6JTNAxE7GpL9FlozoV/idVThJyrFj7j+eStef3lUoQltK03pmVRV9Rc+wd06",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWwmFMmSlB3D0H8fjpJs2XGyZui2L4ZE3cvz3B3vzhvwfO4guYYxFkZyjw4mEWToUiuMF1pBAuMFsi8m4x5ZK8XORxcMFZ9JdGytS+Y1K3Qm8jXjKmNlLe0XyDL0XEjHdM44cwZTkYuU+cZOHyLQBi0nVxcZJFCrtn4gAsMtL9CjJZgbULxASKA1MBUZRCAIpuF+AYfYL34jzwSk1WB+wT1TiJkj1DNs0JIdi19LYTGDxNsSI3B+LcmbE4WRBAbvjdQZQpJz6UggXWDBIdmAX5sg6a1Qc4gg17bgfndSVZPaPjr/q87WpLMPdWT1UmTIZij1im1pE8g2nm2O2AvumUTuPNMKO7ItgZcQQaqVR+XJETdGijQEeXDryNvmIXQ9u8XUU8QtpcQLdPS1DvjfE6Tg8BCmBFx42OKFKgKl/bPNjIgiMotLgatQWE7MFfML4Vim07IgetVByp/nYlsVXRsV6cgMLVXk8+zd37oZH77n9yOoqgi88Htupp26nc6oDKqK5Cw6o5WrI34Sxw+rY3vzmmplrkxTdC4vpVz/8P3SXR8fJ76jyV128sGNzj4YClYD6dw/rXQSn5z2hnEvfjMevk7Ofkxeve7HcfwnRHBfyF2tQdbUTBu9+r1zIJQUCqdt1KYncTw9bUJ5dix6TSWZ5ootuRQZywXKjJFP9x0DiNZq+w8r/Ql8T9Enyi35sydKR2nPcl2q7P+mewzR0wTPpm+2FF89pHih6pDRWBrrO1T/BcMdn657X7snqPtVLWqh8B32yHbPa5IO09IKvw4j777HjejV35PrCQ2SAv1C07g0ZQBMoy+BQdtdBptOn6mA7NllO0FLKyGBhffGJYOB83wu1LzHjelrg4o6rOQz1091MeBGDJZDII8toiuKWh2YPVzb8HAjPuIaopZ2V6qZ1AvkGdoQIkrG591UfNeGdBu1w1HSTpJvGw6H68DRdt/t9nsNnODmOnBrcnVpUF2RG8r0cvjA/pi8Cxc+tyBC1bFcW3agzWbcYca0CvsJfaTz0/5wuycF1T67UTfqShfISod5KZkU6s4lN6rHri/zXKSCS/YHzpzwOHnRJna1Wj1I6Mug8174RTljFo3eic/DYch6V2v7QhuFR1u4y/wK7VKk2BTRI64GQXjQXEOehmuIBRdUfM3RL4dKFHIpUlSuWwLn70ef2Gk/hqhTu98AefDp4u2736/ekVWq/jpFw37cj+nIaOcLrjqODpbcw+xudh3l396Jm7vk8d4PjOQiNIxAftNc9mvoXImkuw5PIlho50lks6ES+2JlVdHx1xIttZRJBEtuBSENHSETjp6z7Vr7KO0Xn9sFkz1vsz5KqO0YitrFksuS3iCCO1wfrPjVpIratkGIa4m3Na7emOzsLDxo9lXUapynKRr/pGy3u46+jCGCWbOuF2HzB8tX9FeBryCBG7iB8BeGDISmGM43ILmal3xO8rVZana8pMx1O+Vd6JTNAxE7GpL9FlozoV/idVThJyrFj7j+eStef3lUoQltK03pmVRV9Rc+wd06",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.f6ff51c6.js b/assets/js/5a2de241.f6ff51c6.js new file mode 100644 index 000000000..2a4486445 --- /dev/null +++ b/assets/js/5a2de241.f6ff51c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.3b8abbdf.js b/assets/js/5c04ee3b.3b8abbdf.js new file mode 100644 index 000000000..0ede97705 --- /dev/null +++ b/assets/js/5c04ee3b.3b8abbdf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>b,toc:()=>j});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),o=a.n(n),r=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),h=a(9472),m=a(85162);const p={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW2L2zgQ/iu6+XQFJc72hYI5SsuxLEtLt5At9yFrFkWZ2GpkSSfJyYbg/15GtrNOtl2OUu6L7czMo3nR80wOEEUZIF/AP7isrN1AwWGFQXrlorIGcritkF1hZH0A+/Dlmgmt7Y7tbcOiZSVGtuudjdfAwTr0guDXK8ihxDgczsFjcNYEDJAf4OVsRq/TfPNGSgxh3Wh2PAc4SGsimkjxwjmtZHJk3wKBDhBkhbWgr7h3CDnY5TeUETg4T8dE1aXsCx0FhuiVKYEDPojaaTJVMbqQZ9neNn7SIyaN1+/7kKm0NbQth6hiAiijlcH7obn7l7PZ/VtoW4p5PXv9tMmvAT0zNrK1bczqj9/XH3pv/fPdned+rhEqfmjjzdM2rs1WaLVKnLi1GzT/byfj9LFLT6U+1JpwRtRdSyko+eGk1bG9azKgbLyKe8gXB3iYCKcmnT9fFG3BocZY2Z7TVLCIFeSQ7Y70Dui36EPCkxYeuSScm1qHJqjSaLEMxKFMOJVtL6Dl59EhilKZcvIsqngseE5D7eZ2UvZxesKpj7gHPkxlHMVB0WVWKFbo0wSVWdsE7md149DMVWnSpLcX8HRHqMBUSO6VlU2NJqZbZ2vr2RmaLUXAFbOGxQqTk+yvphcsOJRq3RNmyu7MnZnbGlkTkNaBVmYT8jszYYub9VpJJTRtpaAiFn8Ok9vtdk8m9iJhrlSsmiXz6OxjeJmMaaxj1PHHC+AQ0dfhZj1Hv1Vy2A8/SZWl4KyXgZBJBlgLRbfbm96fg4iWWkk0AUfE/XD15RPbslfTGfARPf5D0dmn678vP88v6VyiY3dJF9PZdEYmZ0OshRmlGu3387s9POr5V/4KevpFfIiZ00IlCaZmDr18FsedXHCobIhkOhyIJF+9blsy/9ugJ1EWHLbCK7EkVi6Klg+kJb1tcE9TkxIdiXMrdNMx/2wHnQj56vIWOIiGKhmLZZPE0n/Q6YPL7Ednn6qoK4CeJOgfAv6ikX3E/btjeOf5KaDvb4im+RVt234HViilYg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,b={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW2L2zgQ/iu6+XQFJc72hYI5SsuxLEtLt5At9yFrFkWZ2GpkSSfJyYbg/15GtrNOtl2OUu6L7czMo3nR80wOEEUZIF/AP7isrN1AwWGFQXrlorIGcritkF1hZH0A+/Dlmgmt7Y7tbcOiZSVGtuudjdfAwTr0guDXK8ihxDgczsFjcNYEDJAf4OVsRq/TfPNGSgxh3Wh2PAc4SGsimkjxwjmtZHJk3wKBDhBkhbWgr7h3CDnY5TeUETg4T8dE1aXsCx0FhuiVKYEDPojaaTJVMbqQZ9neNn7SIyaN1+/7kKm0NbQth6hiAiijlcH7obn7l7PZ/VtoW4p5PXv9tMmvAT0zNrK1bczqj9/XH3pv/fPdned+rhEqfmjjzdM2rs1WaLVKnLi1GzT/byfj9LFLT6U+1JpwRtRdSyko+eGk1bG9azKgbLyKe8gXB3iYCKcmnT9fFG3BocZY2Z7TVLCIFeSQ7Y70Dui36EPCkxYeuSScm1qHJqjSaLEMxKFMOJVtL6Dl59EhilKZcvIsqngseE5D7eZ2UvZxesKpj7gHPkxlHMVB0WVWKFbo0wSVWdsE7md149DMVWnSpLcX8HRHqMBUSO6VlU2NJqZbZ2vr2RmaLUXAFbOGxQqTk+yvphcsOJRq3RNmyu7MnZnbGlkTkNaBVmYT8jszYYub9VpJJTRtpaAiFn8Ok9vtdk8m9iJhrlSsmiXz6OxjeJmMaaxj1PHHC+AQ0dfhZj1Hv1Vy2A8/SZWl4KyXgZBJBlgLRbfbm96fg4iWWkk0AUfE/XD15RPbslfTGfARPf5D0dmn678vP88v6VyiY3dJF9PZdEYmZ0OshRmlGu3387s9POr5V/4KevpFfIiZ00IlCaZmDr18FsedXHCobIhkOhyIJF+9blsy/9ugJ1EWHLbCK7EkVi6Klg+kJb1tcE9TkxIdiXMrdNMx/2wHnQj56vIWOIiGKhmLZZPE0n/Q6YPL7Ednn6qoK4CeJOgfAv6ikX3E/btjeOf5KaDvb4im+RVt234HViilYg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},x={},j=[{value:"Request",id:"request",level:2}];function k(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(o(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.fd615a94.js b/assets/js/5c04ee3b.fd615a94.js deleted file mode 100644 index 56485a286..000000000 --- a/assets/js/5c04ee3b.fd615a94.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>b,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),o=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),r=(a(82723),a(9487)),d=(a(41429),a(5397)),p=a(4667),c=a(9472),m=a(85162);const h={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VNtqGzEQ/RV1nlqQvU4vFJZSWkoIoaUpOKEPjgmyPN5VrZVUSWvHmP33MtpdZ+2QUkrpiy8zczRzRudoD1EUAfIZfMdFae0a5hyWGKRXLiprIIfrEtkFRtYVsI/fLpnQ2m7ZztYsWlZgZNsuWXsNHKxDLwh+uYQcCoz94Rw8BmdNwAD5Hl5OJvR13G9aS4khrGrNDucAB2lNRBOpXjinlUyJ7Ecg0B6CLLES9CvuHEIOdvEDZQQOztMxUbUtu0EHhSF6ZQrggPeicppCZYwu5Fm2s7UfdYhR7fWHrmQsbQVNwyGqmADKaGXwrid393IyuXsLTUM1ryevH5O8CeiZsZGtbG2Wz/4dP/Te+t+zO+39OyI0fE/jzWMal2YjtFomTVzbNZr/y2TYPrbtadT7ShPOiKqllIpSHo6oDuMtyYCy9iruIJ/t4X4knBq1+Xw2b+YcKoyl7TRNA4tYQg7Z9iDvgH6DPiQ8eeFBSyGKQpliJJwbW4cmqMJosQikpUw4lW3OgFr0I0xpTe0mjgY57EM49Rl3wHuewyoOiq6nRLFEn3aizMomcMf+yqGZqsKk3W3O4LHrVWAqpPTSyrpCE9M9spX17ATNFiLgklnDYokpSfFX4zMWHEq16iQwZrfm1kxthawOSAbXyqxDfmtGbHa1WimphKZ3JqiI8+f95rbb7aONvUiYCxXLesE8OvtQXqRgWusQdfjzAjhE9FW4Wk3Rb5TsHf9EqywVZ52whUzCxkoout0u9OEURELTSqIJOJDix4tvX9ir8QT4QBx/MHL25fLT+dfpOZ1K8mqv6Gw8GU8o5GyIlTCDRoP3+vRm9w/+/JunvRNfxPuYOS1UslQis+/sMDu8sXMOpQ2RQvs9SeTG66ah8M8aPZlszmEjvBIL0uRs3vBesuSfNe5oZ1KiI7NthK5b3Z+8KUfGvDi/Bg6ipkmGVlknq3Q/6PQ+ZXaDs4891A5Anw1/AvCOVvYZd+8P5W3mSUDHr6+m/c2bpvkFwgiUqA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VNtqGzEQ/RV1nlqQvU4vFJZSWkoIoaUpOKEPjgmyPN5VrZVUSWvHmP33MtpdZ+2QUkrpiy8zczRzRudoD1EUAfIZfMdFae0a5hyWGKRXLiprIIfrEtkFRtYVsI/fLpnQ2m7ZztYsWlZgZNsuWXsNHKxDLwh+uYQcCoz94Rw8BmdNwAD5Hl5OJvR13G9aS4khrGrNDucAB2lNRBOpXjinlUyJ7Ecg0B6CLLES9CvuHEIOdvEDZQQOztMxUbUtu0EHhSF6ZQrggPeicppCZYwu5Fm2s7UfdYhR7fWHrmQsbQVNwyGqmADKaGXwrid393IyuXsLTUM1ryevH5O8CeiZsZGtbG2Wz/4dP/Te+t+zO+39OyI0fE/jzWMal2YjtFomTVzbNZr/y2TYPrbtadT7ShPOiKqllIpSHo6oDuMtyYCy9iruIJ/t4X4knBq1+Xw2b+YcKoyl7TRNA4tYQg7Z9iDvgH6DPiQ8eeFBSyGKQpliJJwbW4cmqMJosQikpUw4lW3OgFr0I0xpTe0mjgY57EM49Rl3wHuewyoOiq6nRLFEn3aizMomcMf+yqGZqsKk3W3O4LHrVWAqpPTSyrpCE9M9spX17ATNFiLgklnDYokpSfFX4zMWHEq16iQwZrfm1kxthawOSAbXyqxDfmtGbHa1WimphKZ3JqiI8+f95rbb7aONvUiYCxXLesE8OvtQXqRgWusQdfjzAjhE9FW4Wk3Rb5TsHf9EqywVZ52whUzCxkoout0u9OEURELTSqIJOJDix4tvX9ir8QT4QBx/MHL25fLT+dfpOZ1K8mqv6Gw8GU8o5GyIlTCDRoP3+vRm9w/+/JunvRNfxPuYOS1UslQis+/sMDu8sXMOpQ2RQvs9SeTG66ah8M8aPZlszmEjvBIL0uRs3vBesuSfNe5oZ1KiI7NthK5b3Z+8KUfGvDi/Bg6ipkmGVlknq3Q/6PQ+ZXaDs4891A5Anw1/AvCOVvYZd+8P5W3mSUDHr6+m/c2bpvkFwgiUqA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},b={},f=[{value:"Request",id:"request",level:2}];function j(e){const s={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.583ba3e8.js b/assets/js/70853c19.583ba3e8.js deleted file mode 100644 index 61800de31..000000000 --- a/assets/js/70853c19.583ba3e8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var l=n(85893),a=n(11151),i=n(58219),r=(n(62316),n(51039)),d=n.n(r),o=(n(82723),n(9487)),t=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",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/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function b(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(d(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"created:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"signed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"completed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"declined:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,a.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.d6b7d755.js b/assets/js/70853c19.d6b7d755.js new file mode 100644 index 000000000..133112fcb --- /dev/null +++ b/assets/js/70853c19.d6b7d755.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>f,frontMatter:()=>p,metadata:()=>u,toc:()=>v});var l=n(85893),a=n(11151),i=n(58219),r=(n(62316),n(51039)),o=n.n(r),t=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fLWptJpdTo1bVEPNS+oJOoHQKnZHcCNsbe2F4LQ/vdq7F1YlpSkai6nSuRDAPsZe57xs7OeWVHLJoaGffoZRlOlbugwoDGYSPPEciVpSC+nQAybA1GapEnMLJAcS066HcKEUAuyVCmxyuMW+WyqBVlMeTQl3JDUQIwIq/lkAprAHKQ1A/n8+fP8eziQA9mqk6OjOYcFxOHR0UASQkiNfJ6CJIZPJGjiJ0msonQG0hI75cavQBZciGKDurf98uWL/7LyH/g3oA4+oCEZUL/cgAbl+TEX4KffX7y7OmufX15ffTqtgCSbVUHnJ2ftKkrZHNUVwAwQDbglYTJ2jLz/BZuKcekg/BqVeR8Sg3P9zfgW2aqvvc6H8/anXU/zwMwYF1vA9tlJ5/QOZDJVcnvJ7r8X5+0BLQOzzY/hluM+6m+X92xVAE/yw7rsnLV7lydn3Qoq0sDsnbAClQ3kS5RWjqxqa60mbkgO+VVh5csclPW0ynqQFBxUvkJBOKJ79eARZLQsMtAvCsOvV4m3Gn2FyHbiAQ1Lp955X2Z9UM+jqadkNtxx/JfTTYbqOnbpRs0SAfcknI3AmBC5yMw9KntA/im2PmSg/0ZDP8xAReAf5a3loPI1iimGSPB7klWBebx0Vax4kNHTyqiI+wMuSQX0UQRHA6oS0Awj2olpSPFO/4e/+Bc1QkA1fEvB2LcqXtJwVakYulrNeQyuALAqv1CRjXGkpAVp0ZAlieCR26zx1aD1ippoCjOG33AXriHG+uRKC6xN7DIBGubvSxrQRKO3loNBg1QL/MhBxmouJzSgY6VnzJZH4JbhU0pDOrU2MWGjsVSpruWlSy3V4k0OqUdqRrMsoJZbZ5BjrkfIPctwSoNJlDTeh5fN5m5IemkUgTHjVJB1dH8mEvtpazCpsHcx3/AsajZ/kjExa4/E8tkWQS5RTdcFqeuXzeb1XznT4zvJqRnYKZcTsnBZRis5CUjiH2arl4RNGJdEMAv62eOxBq2V3k/65zzbF4TjZvO6tQ5CazcIn0tVLxMaWLwkcMuNNU9LeZ8f+wm2rhdrgse7BK8MaCKVJWOVyvhpSVX33k/keE3j9S6NjpwzwWPXu7hUNyCflkl5e+u3R1dvZy5x4UvIUXIgN0+3qJbHPUkDUaq5XdKwv6K3NZbwmp8P+8NsGFB8ABTm8UQZ5zGzUxrSxmKdjg3oOWjjFnAJdJ0TWZLUVQISX6KCjQzmwgZLeGPeollQRRvLJlxOanuthhuPexhVH7gtv9fhYwn/CEsaFGEpowLK8TSnwGLQLoR4WJ82r6V2EfKqm/sTPa47Vs6JPOgXCcgeXkPwyOYtutsf4wavXjhdXFKcfMhYaVKxJiOGjTCFlxpwkzj+qt4iJoGIj3Pl1Qk2wzB7YeMM3xqCyxtskdVI/2I85hFnAt+ohlsY/llQWywWO5F/4Ww+cDtNR0RDojbwiRt0x1O2Wv94QQNqQc/MxbgHes6j4n35g60aDtzInycWuefJ3ZdoWAy9qRphyAWPQBooPQEnH7qnZE5e1Zs0KJ3fA5xunHbetc97bVwXZe0PqVVv1ps4hE/BjMnSVr28t3m11dusHvNqkyMOHdHDdf/QET10RH8TZR06ogf1HDqih47ooSN66Ij+1jL6HzuieUFq4dY2EsG4q8rzZqMvqPtFXxCblFMstcM+Xa2w3LvSIstw+FsKGuv0YUDnTHM2wvqyP8yCoozFCvwGljSk73yxUbvEjREuUl8RV5oTWIV7i5MogsTuxZa7Ad2L3iUN6Chv4M5UjDaaLbC5yxY0pCgc1wzGFXybEcdXVDA5SdkE8X5drL5ZilEol+43rnTPvyCzYkouS15u1/SeCv5HYnca/I0l1kdY/rOG+5kfGuSxLdB4dsMsy74DLRVzHw==",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/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGjkQ/iuuK52u0fLWptJpdTo1bVEPNS+oJOoHQKnZHcCNsbe2F4LQ/vdq7F1YlpSkai6nSuRDAPsZe57xs7OeWVHLJoaGffoZRlOlbugwoDGYSPPEciVpSC+nQAybA1GapEnMLJAcS066HcKEUAuyVCmxyuMW+WyqBVlMeTQl3JDUQIwIq/lkAprAHKQ1A/n8+fP8eziQA9mqk6OjOYcFxOHR0UASQkiNfJ6CJIZPJGjiJ0msonQG0hI75cavQBZciGKDurf98uWL/7LyH/g3oA4+oCEZUL/cgAbl+TEX4KffX7y7OmufX15ffTqtgCSbVUHnJ2ftKkrZHNUVwAwQDbglYTJ2jLz/BZuKcekg/BqVeR8Sg3P9zfgW2aqvvc6H8/anXU/zwMwYF1vA9tlJ5/QOZDJVcnvJ7r8X5+0BLQOzzY/hluM+6m+X92xVAE/yw7rsnLV7lydn3Qoq0sDsnbAClQ3kS5RWjqxqa60mbkgO+VVh5csclPW0ynqQFBxUvkJBOKJ79eARZLQsMtAvCsOvV4m3Gn2FyHbiAQ1Lp955X2Z9UM+jqadkNtxx/JfTTYbqOnbpRs0SAfcknI3AmBC5yMw9KntA/im2PmSg/0ZDP8xAReAf5a3loPI1iimGSPB7klWBebx0Vax4kNHTyqiI+wMuSQX0UQRHA6oS0Awj2olpSPFO/4e/+Bc1QkA1fEvB2LcqXtJwVakYulrNeQyuALAqv1CRjXGkpAVp0ZAlieCR26zx1aD1ippoCjOG33AXriHG+uRKC6xN7DIBGubvSxrQRKO3loNBg1QL/MhBxmouJzSgY6VnzJZH4JbhU0pDOrU2MWGjsVSpruWlSy3V4k0OqUdqRrMsoJZbZ5BjrkfIPctwSoNJlDTeh5fN5m5IemkUgTHjVJB1dH8mEvtpazCpsHcx3/AsajZ/kjExa4/E8tkWQS5RTdcFqeuXzeb1XznT4zvJqRnYKZcTsnBZRis5CUjiH2arl4RNGJdEMAv62eOxBq2V3k/65zzbF4TjZvO6tQ5CazcIn0tVLxMaWLwkcMuNNU9LeZ8f+wm2rhdrgse7BK8MaCKVJWOVyvhpSVX33k/keE3j9S6NjpwzwWPXu7hUNyCflkl5e+u3R1dvZy5x4UvIUXIgN0+3qJbHPUkDUaq5XdKwv6K3NZbwmp8P+8NsGFB8ABTm8UQZ5zGzUxrSxmKdjg3oOWjjFnAJdJ0TWZLUVQISX6KCjQzmwgZLeGPeollQRRvLJlxOanuthhuPexhVH7gtv9fhYwn/CEsaFGEpowLK8TSnwGLQLoR4WJ82r6V2EfKqm/sTPa47Vs6JPOgXCcgeXkPwyOYtutsf4wavXjhdXFKcfMhYaVKxJiOGjTCFlxpwkzj+qt4iJoGIj3Pl1Qk2wzB7YeMM3xqCyxtskdVI/2I85hFnAt+ohlsY/llQWywWO5F/4Ww+cDtNR0RDojbwiRt0x1O2Wv94QQNqQc/MxbgHes6j4n35g60aDtzInycWuefJ3ZdoWAy9qRphyAWPQBooPQEnH7qnZE5e1Zs0KJ3fA5xunHbetc97bVwXZe0PqVVv1ps4hE/BjMnSVr28t3m11dusHvNqkyMOHdHDdf/QET10RH8TZR06ogf1HDqih47ooSN66Ij+1jL6HzuieUFq4dY2EsG4q8rzZqMvqPtFXxCblFMstcM+Xa2w3LvSIstw+FsKGuv0YUDnTHM2wvqyP8yCoozFCvwGljSk73yxUbvEjREuUl8RV5oTWIV7i5MogsTuxZa7Ad2L3iUN6Chv4M5UjDaaLbC5yxY0pCgc1wzGFXybEcdXVDA5SdkE8X5drL5ZilEol+43rnTPvyCzYkouS15u1/SeCv5HYnca/I0l1kdY/rOG+5kfGuSxLdB4dsMsy74DLRVzHw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},v=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function g(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(o(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"created:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"signed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"completed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"declined:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.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,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,a.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.010e8daa.js b/assets/js/770b40a9.010e8daa.js new file mode 100644 index 000000000..75a56eb9f --- /dev/null +++ b/assets/js/770b40a9.010e8daa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvOZVuhKDYogjTYoAkQFwWaGAEtjS0mFMklKV9g6N+LoSRbjjdxUSz2oS+JNTyHM3M4M+QGPJ87SB5gjIWR3KODSQQZutQK44VWkMA4R3aFnrUQdiOcZxd314xLqZeOrXXJvGYWvRW4QMaZJISeMb7gQvKpRObb/ftsnAvHZqVKaX8uhV8zY/VCZOgYV0wv0C4ELgNfyh0zYqj4VAo1Z6VD68hnmmvtkM2sLhiuhPO0umWwZY6KpRZ5sGc6LQtU3vUhAm3QcorgOoME5uhbFsUOERhueYEeLcmzAcULhASkKAStChLmS4l2DRFY/FIKixkkMy4dRuD8WhJ6pm0BEeDKSJ0hJN6WtJrmWHBINlDwlSjKApKzOI7Arw2RVFlM0UJFPF4Y2mgYV9E2BPcizDeL4G2fcTWhfZ3RyqEj7CiO6d9+cbgyTdG5WSnZVlGIINXKo/KE58ZIkYaFwbMj0uYwAD19xjTIbmkbL2qXFl0pfQfHreWUsPBYuOP82kwnvEU6b4WaQxSk4b5r2eYOq+HvU1W40d2cNPHCk/Vwix3BhR/byiOW0v4IqUWzAK0oJJmh/V5p1fX0XoB1PCwAq50Q28CfmoApdHFMotx745LBoCVTD/dTXRBbL9Ve3u+JFdpZt1FF4MRchS79r0VyXIdnjWyKwRsWXMij6Cnip8bQpmhyrY64OT07Hw1Pfvo4/LrY902itBhEwOzCv7/jKB6d9IZxL/44Hp4npz8nZ+f9OI7/hghWhdwlD1lTtK3T9rs02XfwU72GdfvotQ5QddURSgqFT+2gehrF8dM5QaoITuOzw4F1rRZciizcX2P9guqHbzeu0Fp9pIy77n3t/jB9UYPCOuwl27XXSTpMSyv8OtxSqx43olevJw8TGuEF+lw3V1y41nwOCQxe3XYO7aK96korO+3Kjelrg4raTPKpo3oecCMGiyHQrbSPdp7PhZr33mVNdlHfk7K1eHux73rZiM9IzdxI00U1l2COPAyhir5nOpAbwW4NKmqbIPdiCIdPG+GYcGG5fR2Eo2czbdkrNptyhxnTivkcwyLZT/pD5gymYtZUTZ89qkd1rwukZwpdjFKoF5c8qh57uJ3NRCq4ZH/h1AmPkx9b5ZbL5YFiHwLnSvi8nDKLRu/g82AMsnZZ248PEIFHW7jb2T29p9J2BL/hahDAg6YXeBp6oRl2renTaxLVphQpKoed6r24urthC3bSjyHqlMe/CHpwc/3b5R/3l7QvlWN9SMN+3I/DCNXOF1x1XO09S5tS3jvhza61/6fv2KZPPK78wEguwsAIqm+aZn+AvWafRJBr58m+2VBJ/2llVZG5fk3SCMiEo2x378kXXHdevwsuS3IaBsAb2OaZuoNO6MMKwobZFLWNSw5rzkWaouk6OBjGexPt6nIMEfCSkuwOjJcwMJoftHu7pNadvfcnSR0A/aWcvkr4hUrlM65/3cLrlTcJTX4tmo5mUlXVP1osmVQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvOZVuhKDYogjTYoAkQFwWaGAEtjS0mFMklKV9g6N+LoSRbjjdxUSz2oS+JNTyHM3M4M+QGPJ87SB5gjIWR3KODSQQZutQK44VWkMA4R3aFnrUQdiOcZxd314xLqZeOrXXJvGYWvRW4QMaZJISeMb7gQvKpRObb/ftsnAvHZqVKaX8uhV8zY/VCZOgYV0wv0C4ELgNfyh0zYqj4VAo1Z6VD68hnmmvtkM2sLhiuhPO0umWwZY6KpRZ5sGc6LQtU3vUhAm3QcorgOoME5uhbFsUOERhueYEeLcmzAcULhASkKAStChLmS4l2DRFY/FIKixkkMy4dRuD8WhJ6pm0BEeDKSJ0hJN6WtJrmWHBINlDwlSjKApKzOI7Arw2RVFlM0UJFPF4Y2mgYV9E2BPcizDeL4G2fcTWhfZ3RyqEj7CiO6d9+cbgyTdG5WSnZVlGIINXKo/KE58ZIkYaFwbMj0uYwAD19xjTIbmkbL2qXFl0pfQfHreWUsPBYuOP82kwnvEU6b4WaQxSk4b5r2eYOq+HvU1W40d2cNPHCk/Vwix3BhR/byiOW0v4IqUWzAK0oJJmh/V5p1fX0XoB1PCwAq50Q28CfmoApdHFMotx745LBoCVTD/dTXRBbL9Ve3u+JFdpZt1FF4MRchS79r0VyXIdnjWyKwRsWXMij6Cnip8bQpmhyrY64OT07Hw1Pfvo4/LrY902itBhEwOzCv7/jKB6d9IZxL/44Hp4npz8nZ+f9OI7/hghWhdwlD1lTtK3T9rs02XfwU72GdfvotQ5QddURSgqFT+2gehrF8dM5QaoITuOzw4F1rRZciizcX2P9guqHbzeu0Fp9pIy77n3t/jB9UYPCOuwl27XXSTpMSyv8OtxSqx43olevJw8TGuEF+lw3V1y41nwOCQxe3XYO7aK96korO+3Kjelrg4raTPKpo3oecCMGiyHQrbSPdp7PhZr33mVNdlHfk7K1eHux73rZiM9IzdxI00U1l2COPAyhir5nOpAbwW4NKmqbIPdiCIdPG+GYcGG5fR2Eo2czbdkrNptyhxnTivkcwyLZT/pD5gymYtZUTZ89qkd1rwukZwpdjFKoF5c8qh57uJ3NRCq4ZH/h1AmPkx9b5ZbL5YFiHwLnSvi8nDKLRu/g82AMsnZZ248PEIFHW7jb2T29p9J2BL/hahDAg6YXeBp6oRl2renTaxLVphQpKoed6r24urthC3bSjyHqlMe/CHpwc/3b5R/3l7QvlWN9SMN+3I/DCNXOF1x1XO09S5tS3jvhza61/6fv2KZPPK78wEguwsAIqm+aZn+AvWafRJBr58m+2VBJ/2llVZG5fk3SCMiEo2x378kXXHdevwsuS3IaBsAb2OaZuoNO6MMKwobZFLWNSw5rzkWaouk6OBjGexPt6nIMEfCSkuwOjJcwMJoftHu7pNadvfcnSR0A/aWcvkr4hUrlM65/3cLrlTcJTX4tmo5mUlXVP1osmVQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.6a911971.js b/assets/js/770b40a9.6a911971.js deleted file mode 100644 index 56d3344af..000000000 --- a/assets/js/770b40a9.6a911971.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),p=a(4667),d=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVm1v4zYM/isaP+0AJ3HSl9uMYbhiKLriirVAMwxYGxSKzcRqZUknyXlB4P8+ULYTp7k2w3C4D/vSxuRDkXxEUtyA53MHyQOMsTCSe3QwiSBDl1phvNAKEhjnyK7QsxbCboTz7OLumnEp9dKxtS6Z18yitwIXyDiThNAzxhdcSD6VyHx7fp+Nc+HYrFQpnc+l8GtmrF6IDB3jiukF2oXAZbCXcmcZMVR8KoWas9KhdeQzzbV2yGZWFwxXwnnSbi3YMkfFUos8yDOdlgUq7/oQgTZoOUVwnUECc/StFcUOERhueYEeLdGzAcULhASkKARpBRHzpUS7hggsfimFxQySGZcOI3B+LQk907aACHBlpM4QEm9L0qY5FhySDRR8JYqygOQsjiPwa0NGqiymaKEiO14YOmgYV9E2BPcizDeL4G2fcTWhc53RyqEj7CiO6d9+cbgyTdG5WSnZllGIINXKo/KE58ZIkQbF4NmR0eYwAD19xjTQbukYL2qXFl0pfQfHreWUsPBYuOP2tZhueIt03go1hyhQw31Xss0dVsPfp6pwo7s5ceKFJ+nhETsDF35sK4+slPZHjFo0C9CKQpIZ2u+VVl1P7wVYx8MCsNoRsQ38qQmYQhfHKMq9Ny4ZDFpj6uF+qguy1ku1l/d7ZIV21m1UETgxV6FL/2uRHOfhWSObYvCGBRfyKHqK+KkRtCmaXKsjbk7PzkfDk58+Dr9O9n2TKCkDCZhd+PdPHMWjk94w7sUfx8Pz5PTn5Oy8H8fx3xDBqpC75CFrirZ12n6XJvsOfqrXsG4fveYBqi47Qkmh8KkdVE+jOH46J0gVwWl8djiwrtWCS5GF92usX1D98O3GFVqrj5Rx172v3R+mL2pQ0MNesl15naTDtLTCr8MrtepxI3q1PnmY0Agv0Oe6eeLCs+ZzSGDw6rVzaBftU1da2WlX5/lcqHmPG9PXBhW1m+RTR3U94EYMFkMgP20c98RVTcdeNLvuNOIzUns2yXZRzbOWIw9jpaLvmQ7GDQW3BhU1QiBwMYTDZUU4JlxQt+99uEw205a9smZT7jBjWjGfY1CS/KQ/ZM5gKmZNHfTZo3pU97pAWjzoqZNCvbjkUfXYw+1sJlLBJfsLp054nPzYMrdcLg8Y+xBsroTPyymzaPQOPg/CQGvXavvxASLwaAt3O7unDSlth+obrgYBPGiqm6ehupvx1Yo+vTaiapMiReWwU48XV3c37KQfQ9Qpjn8R8uDm+rfLP+4v6VQqr/qKhv24H4eRqJ0vuOo42lszm9Lcu9/NrlX/p3tp0yUeV35gJBdhAATWN03zPsBe804iyLXzJN9sqKD/tLKqSFxvh9TSmXCU7W4/fMF1Z5tdcFmSU6A18w1ss3buoBP6sIKwYdZEbduSw9rmIk3RdB0cDNe9CXV1OYYIeElJdsfFSxgXzQ86vVWpdefs/TlSB0B/KaevGvxCpfIZ179u4bXmTYMmvxZNVzOpquofnqGImg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVm1v4zYM/isaP+0AJ3HSl9uMYbhiKLriirVAMwxYGxSKzcRqZUknyXlB4P8+ULYTp7k2w3C4D/vSxuRDkXxEUtyA53MHyQOMsTCSe3QwiSBDl1phvNAKEhjnyK7QsxbCboTz7OLumnEp9dKxtS6Z18yitwIXyDiThNAzxhdcSD6VyHx7fp+Nc+HYrFQpnc+l8GtmrF6IDB3jiukF2oXAZbCXcmcZMVR8KoWas9KhdeQzzbV2yGZWFwxXwnnSbi3YMkfFUos8yDOdlgUq7/oQgTZoOUVwnUECc/StFcUOERhueYEeLdGzAcULhASkKARpBRHzpUS7hggsfimFxQySGZcOI3B+LQk907aACHBlpM4QEm9L0qY5FhySDRR8JYqygOQsjiPwa0NGqiymaKEiO14YOmgYV9E2BPcizDeL4G2fcTWhc53RyqEj7CiO6d9+cbgyTdG5WSnZllGIINXKo/KE58ZIkQbF4NmR0eYwAD19xjTQbukYL2qXFl0pfQfHreWUsPBYuOP2tZhueIt03go1hyhQw31Xss0dVsPfp6pwo7s5ceKFJ+nhETsDF35sK4+slPZHjFo0C9CKQpIZ2u+VVl1P7wVYx8MCsNoRsQ38qQmYQhfHKMq9Ny4ZDFpj6uF+qguy1ku1l/d7ZIV21m1UETgxV6FL/2uRHOfhWSObYvCGBRfyKHqK+KkRtCmaXKsjbk7PzkfDk58+Dr9O9n2TKCkDCZhd+PdPHMWjk94w7sUfx8Pz5PTn5Oy8H8fx3xDBqpC75CFrirZ12n6XJvsOfqrXsG4fveYBqi47Qkmh8KkdVE+jOH46J0gVwWl8djiwrtWCS5GF92usX1D98O3GFVqrj5Rx172v3R+mL2pQ0MNesl15naTDtLTCr8MrtepxI3q1PnmY0Agv0Oe6eeLCs+ZzSGDw6rVzaBftU1da2WlX5/lcqHmPG9PXBhW1m+RTR3U94EYMFkMgP20c98RVTcdeNLvuNOIzUns2yXZRzbOWIw9jpaLvmQ7GDQW3BhU1QiBwMYTDZUU4JlxQt+99uEw205a9smZT7jBjWjGfY1CS/KQ/ZM5gKmZNHfTZo3pU97pAWjzoqZNCvbjkUfXYw+1sJlLBJfsLp054nPzYMrdcLg8Y+xBsroTPyymzaPQOPg/CQGvXavvxASLwaAt3O7unDSlth+obrgYBPGiqm6ehupvx1Yo+vTaiapMiReWwU48XV3c37KQfQ9Qpjn8R8uDm+rfLP+4v6VQqr/qKhv24H4eRqJ0vuOo42lszm9Lcu9/NrlX/p3tp0yUeV35gJBdhAATWN03zPsBe804iyLXzJN9sqKD/tLKqSFxvh9TSmXCU7W4/fMF1Z5tdcFmSU6A18w1ss3buoBP6sIKwYdZEbduSw9rmIk3RdB0cDNe9CXV1OYYIeElJdsfFSxgXzQ86vVWpdefs/TlSB0B/KaevGvxCpfIZ179u4bXmTYMmvxZNVzOpquofnqGImg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.3033ed56.js b/assets/js/7b076186.3033ed56.js deleted file mode 100644 index 75233f852..000000000 --- a/assets/js/7b076186.3033ed56.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),o=s(58219),n=(s(62316),s(51039)),i=s.n(n),c=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRky3FS9MMwYF9s6fgc7+65N+3A86WDZAbvtfI89Q7mEWToUiuMF1pBAvcFsg8o0SNrQezydsq4lPrJsa2umNfMYqnXyDhLW0hudUmHtpMstF4N2TQPGkozqdUSLVOIGePMcOtFWkm+x3/vmFC5tiUnPyLmC+GC4ZKv0DHhGXK3JdtZ45wvUFhmMdU2G0IE2qANutMMEmhA7d0QgeGWl+jRUvQ7ULxESKA9fxQZRCAoesN9Ac8pubV6LTJkevEZUz/NmM73ge8dgggsfqmExQwSbyuMwPmtJDNOlEYSADdG6gwhybl0BEgLLDkkO/BbE5DeCrWECBom+hLc8HBLAqaYLIoJdxnU9ZysOqOVQ0f3TOKY/o797/LYOJoxV6UpOpdXUm6/gyjQgMqTIjdGijTwOPrsSHt36mXDA7FqiXUvGtsdPS/Fc/D+1w35bn4z51BHbZ6yS/91pUk8OR+M40H8w/34XXLxY/L23TCO478hgk0pSbfNaMY90r1eeHl4r09gTcr6wFZSE/givnidRaU9y3Wlsn+ROrRW269T8IL5uue/UFIofOyK4fEivnic7MN5exrOVK25FFnosXu9QvXfhtM37xvzp2kSDSicw1GwfXkTpMO0ssJvQ39vBtyIQXOezObUJiX6Qh9GQ5gJvoAERm0rj3aHcVADXWjX3byorIQECu+NS0Yj5/lSqOWAGzPUBpUTSyX5wg1TXY64EaP1GMhk59Id0dYwc+TYnh9uxCfcQtTF3Ue1g6lAnqENHNGcDMotGzcG1Z1YqsDlenwyvu5plLbTNNNpVaLyIa8s15Y902YL7jBjWtGADYckPx+OmTOYirwtiSF7UA/qTpfIKod5JZkUauWSBzVgs5s8F6ngkv2FCyc8zt90zD09PZ0wdhZ0PgpfVAtm0egDfBmEgda+1v7lDCLwaEt3k9+hXYsU2yy9YmoUwKO20GkzULGWXMjDMvjluRIVnhQpKoe90rz8eHvNzocxRL3i+AaXR9fT91e/313RrVReTYrGw3gYk8ho50uueoaOd/Hz5O4OLfu/3dxtE3jc+JGRXIRWD6Tu2h6dwWGTJ72lPY+g0M4TYLejwv3Tyrom8ZcKLY2CeQRrbgVfUKfMdpAJR8/ZfgW/yuabP9ptfsa+df+/GEjX4or6e81lRW8QwQq3x18g9byOujYnVxvAZZqi8T3Vk7l8NNw+XF1f3V9BBLwi4voTZhUmTPtABl707Hj0ND7Qbx29ovATpfoTbn/ew5uTVxXaEDs0sTSv6/ofvwiihg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRky3FS9MMwYF9s6fgc7+65N+3A86WDZAbvtfI89Q7mEWToUiuMF1pBAvcFsg8o0SNrQezydsq4lPrJsa2umNfMYqnXyDhLW0hudUmHtpMstF4N2TQPGkozqdUSLVOIGePMcOtFWkm+x3/vmFC5tiUnPyLmC+GC4ZKv0DHhGXK3JdtZ45wvUFhmMdU2G0IE2qANutMMEmhA7d0QgeGWl+jRUvQ7ULxESKA9fxQZRCAoesN9Ac8pubV6LTJkevEZUz/NmM73ge8dgggsfqmExQwSbyuMwPmtJDNOlEYSADdG6gwhybl0BEgLLDkkO/BbE5DeCrWECBom+hLc8HBLAqaYLIoJdxnU9ZysOqOVQ0f3TOKY/o797/LYOJoxV6UpOpdXUm6/gyjQgMqTIjdGijTwOPrsSHt36mXDA7FqiXUvGtsdPS/Fc/D+1w35bn4z51BHbZ6yS/91pUk8OR+M40H8w/34XXLxY/L23TCO478hgk0pSbfNaMY90r1eeHl4r09gTcr6wFZSE/givnidRaU9y3Wlsn+ROrRW269T8IL5uue/UFIofOyK4fEivnic7MN5exrOVK25FFnosXu9QvXfhtM37xvzp2kSDSicw1GwfXkTpMO0ssJvQ39vBtyIQXOezObUJiX6Qh9GQ5gJvoAERm0rj3aHcVADXWjX3byorIQECu+NS0Yj5/lSqOWAGzPUBpUTSyX5wg1TXY64EaP1GMhk59Id0dYwc+TYnh9uxCfcQtTF3Ue1g6lAnqENHNGcDMotGzcG1Z1YqsDlenwyvu5plLbTNNNpVaLyIa8s15Y902YL7jBjWtGADYckPx+OmTOYirwtiSF7UA/qTpfIKod5JZkUauWSBzVgs5s8F6ngkv2FCyc8zt90zD09PZ0wdhZ0PgpfVAtm0egDfBmEgda+1v7lDCLwaEt3k9+hXYsU2yy9YmoUwKO20GkzULGWXMjDMvjluRIVnhQpKoe90rz8eHvNzocxRL3i+AaXR9fT91e/313RrVReTYrGw3gYk8ho50uueoaOd/Hz5O4OLfu/3dxtE3jc+JGRXIRWD6Tu2h6dwWGTJ72lPY+g0M4TYLejwv3Tyrom8ZcKLY2CeQRrbgVfUKfMdpAJR8/ZfgW/yuabP9ptfsa+df+/GEjX4or6e81lRW8QwQq3x18g9byOujYnVxvAZZqi8T3Vk7l8NNw+XF1f3V9BBLwi4voTZhUmTPtABl707Hj0ND7Qbx29ovATpfoTbn/ew5uTVxXaEDs0sTSv6/ofvwiihg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,t.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(o.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.40a02a7c.js b/assets/js/7b076186.40a02a7c.js new file mode 100644 index 000000000..7220730f2 --- /dev/null +++ b/assets/js/7b076186.40a02a7c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),o=s.n(r),i=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBiwxAho6WSxpkiWpPwCQ/99OEq25dgJOmAosC+JdXyOd/fw7iE34PnMQfIA77XyPPUOJhFk6FIrjBdaQQL3BbIPKNEja0Hs8nbMuJR66dhaV8xrZrHUC2ScpS0kt7qkRbu1TLWe99k4Dx5KM6nVDC1TiBnjzHDrRVpJvsN/75hQubYlpzwi5gvhQuCSz9Ex4Rlyt6bYWZOcL1BYZjHVNutDBNqgDb7jDBJoQO3eEIHhlpfo0VL1G1C8REigXX8SGUQgqHrDfQHPKbm1eiEyZHr6GVM/zpjOd4XvEoIILH6phMUMEm8rjMD5taQwTpRGEgBXRuoMIcm5dARICyw5JBvwaxOQ3go1gwgaJroWXPGwSwKmGE2LEXcZ1PWEojqjlUNH+4zimP4d5r89xybRjLkqTdG5vJJy/R1EgQZUnhy5MVKkgcfBZ0fem+MsGx6IVUuse9HE3tJzqp599r+uKHfzmzmHOmrPKbv0rzuN4tF5bxj34h/uh++Six+Tt+/6cRz/DRGsSkm+7Ylm3CPt64WX++/6CNYcWRfYWmoCX5xi8U6X6AuhZmyJyrOl1WoWMSORO2TerhmfcaGY5B7tf8gqWqvt6+z8u8zqTtVCSaHwadtCTxdx/DTckXDxcisp7VmuK5V920pPhH+9nIun0a6ct8fljNWCS5EFobnXc1TftpxueN+EP+5V0YDCOhwU27U3RTpMKyv8OojcqseN6DXrycOEtIL6RO/1MQijLyCBQatng81eE2ugDe1iK5qVlZBA4b1xyWDAjelrg8qJmZJ86vqpLgfciMFiCHX0HO08nwk1673qNdkXcEckNzwelLFjkxvxCdcQbVnqolotL5BnaAOjdLUE55a7G4PqTsxUYH4xPFL8e7p92gso02lVovKhC1iuLXvmzabcYca0ojspLJL9vD9kzmAq8raB+uxRPSqaVVY5zCvJpFBzlzyqHnu4yXORCi7ZXzh1wuPkzZa55XJ5xNhZ8PkofFFNmUWj9/BZMAZau167jzOIwKMt3U1+h3YhUmxP6YVQgwAetGNBlym1dsmF3N+fvzx3ojaVIkXlsNPIlx9vr9mCnfdjiDrt8RVJD67H769+v7uifakdm0Ma9uN+TCajnS+56oQ6fMA8P97NfsT/t8+ddgw8rvzASC6CNARSN+1MP8D++ZN0XjqTCArtPAE2G2rdP62sazJ/qdCSdEwiWHAr+JRm5WEDmXD0O9u9W15k880f7RPojH3to+lkIdshVzThCy4r+oII5rg+fLbVkzraDjql2gAu0xSN77ge6fiBGH64ur66v4IIeEXEdTVmHjSm/UEBTmZ2KD5NDvSXdPCkw0901J9w/fMO3qy86NCWuEUTS5O6rv8BTdsO7w==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLbspB0mDMOyNuiMBkuwZBiwxAho6WSxpkiWpPwCQ/99OEq25dgJOmAosC+JdXyOd/fw7iE34PnMQfIA77XyPPUOJhFk6FIrjBdaQQL3BbIPKNEja0Hs8nbMuJR66dhaV8xrZrHUC2ScpS0kt7qkRbu1TLWe99k4Dx5KM6nVDC1TiBnjzHDrRVpJvsN/75hQubYlpzwi5gvhQuCSz9Ex4Rlyt6bYWZOcL1BYZjHVNutDBNqgDb7jDBJoQO3eEIHhlpfo0VL1G1C8REigXX8SGUQgqHrDfQHPKbm1eiEyZHr6GVM/zpjOd4XvEoIILH6phMUMEm8rjMD5taQwTpRGEgBXRuoMIcm5dARICyw5JBvwaxOQ3go1gwgaJroWXPGwSwKmGE2LEXcZ1PWEojqjlUNH+4zimP4d5r89xybRjLkqTdG5vJJy/R1EgQZUnhy5MVKkgcfBZ0fem+MsGx6IVUuse9HE3tJzqp599r+uKHfzmzmHOmrPKbv0rzuN4tF5bxj34h/uh++Six+Tt+/6cRz/DRGsSkm+7Ylm3CPt64WX++/6CNYcWRfYWmoCX5xi8U6X6AuhZmyJyrOl1WoWMSORO2TerhmfcaGY5B7tf8gqWqvt6+z8u8zqTtVCSaHwadtCTxdx/DTckXDxcisp7VmuK5V920pPhH+9nIun0a6ct8fljNWCS5EFobnXc1TftpxueN+EP+5V0YDCOhwU27U3RTpMKyv8OojcqseN6DXrycOEtIL6RO/1MQijLyCBQatng81eE2ugDe1iK5qVlZBA4b1xyWDAjelrg8qJmZJ86vqpLgfciMFiCHX0HO08nwk1673qNdkXcEckNzwelLFjkxvxCdcQbVnqolotL5BnaAOjdLUE55a7G4PqTsxUYH4xPFL8e7p92gso02lVovKhC1iuLXvmzabcYca0ojspLJL9vD9kzmAq8raB+uxRPSqaVVY5zCvJpFBzlzyqHnu4yXORCi7ZXzh1wuPkzZa55XJ5xNhZ8PkofFFNmUWj9/BZMAZau167jzOIwKMt3U1+h3YhUmxP6YVQgwAetGNBlym1dsmF3N+fvzx3ojaVIkXlsNPIlx9vr9mCnfdjiDrt8RVJD67H769+v7uifakdm0Ma9uN+TCajnS+56oQ6fMA8P97NfsT/t8+ddgw8rvzASC6CNARSN+1MP8D++ZN0XjqTCArtPAE2G2rdP62sazJ/qdCSdEwiWHAr+JRm5WEDmXD0O9u9W15k880f7RPojH3to+lkIdshVzThCy4r+oII5rg+fLbVkzraDjql2gAu0xSN77ge6fiBGH64ur66v4IIeEXEdTVmHjSm/UEBTmZ2KD5NDvSXdPCkw0901J9w/fMO3qy86NCWuEUTS5O6rv8BTdsO7w==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,t.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.8323da14.js b/assets/js/8a725248.8323da14.js new file mode 100644 index 000000000..6e2ac0334 --- /dev/null +++ b/assets/js/8a725248.8323da14.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rIzcQ/ivqfOrB2t61c1e6lHJpOI5wRxMuKYU6Jsi7Y68SraSTtHaM2f9eRrtrr50XGigphRDs0bw/M4/kLXi+dJBO4UwrzzPvYBZBji6zwnihFaRwXSA7s8g9slaJnV6eMy6lXju20RXzmuFioa2X6JzcsKzRVrhmWeuW+YJ7lnHFyJ475sRSoXVsoS35sEyURlvPlWe5zqoSlXdDiEAbtJwyOc8hhcZz6xQisPi9Qud/0/kG0u1R4pdWr0SObI5Sr5nhlpfo0VK6bYZ7R/QJlScn3BgpshBzdOfI0xZcVmDJ6RNFFBZz6hmWXEiIQPESIQJTaIXUP78xCCno+R0G58ZSFV6gIw9BO912Ws5boZYQwULbkvu+BB94aSQp3WkqA6GO2qCvt58jfmwFw0yX5KpJ+JWukvFknEySyTiBuo7ACx/EB8jczgmQms73/fK2wiBwRivX9GIcx49x66ascZkzV2UZOreopNz88BqsXsahEdNYva4BpkjmxcP4zlAL/+dgniSTZBz+yEXb8FP/lJu90TgeTwZJPIh/uk4+pCc/p+8/DOM4/gsieCjlfsQh5z5U2c1I970y+RvEqY/V2uHM0XMhXd+g44E6jOzJU0N5pUv0hVBLtkbl2dpqtYyYkcgdMm83jC+5UExyj/ZfHFK0VtuX2/S6zPo7K5QUCm+7jbw9iePbZNeE5PnN5NIizzcMH4Tz7m3LfS6HlwtLeoW9f1zYuVpxKfJwsV3re1RvW1M/vG/CPx5f0SiFczgoti9vinSYVVb4DaTTLTwMuBGD5jydzupZBDQxmi5Uo13ImPsCUhgd368O7QqtC24qKyGFwnvj0tGIGzPUBhXd45LPHdHQiBsxWhGVHGs7z5dCLQcvWs32eV9Rb5v2HWS/ayI34gtuurs3PdCKQBCmBfIcbWgkQfZt/1T41DV+19uOkneM/BTJ7jj24A6kaAsdUmsBuTCorsRSBThXCTx+UAnHhAvH3VsnjFZ4DB1Zszl3mDOtmC8wHJJ8MkyYM5iJRTuVQ3ajbhRRAascLirJpFD3Lr1RAza9WCxEJrhkf+LcCY+zHztc1uv1IzzeBZvPwhfVnFk0eq++DMIAWt9q9+UdRODRlu5icYV2JTJsZ+CZUKOgPGp3jUaO9qVFoBV9PDailkuRoXJ9BE8/X35lKzYZxhD1hu8fJD36en726ferT+SXhr0BKRnGwzjcq9r5kqteqMPH8DG82z1v/MdP53ZVPD74kZFcBNYIrdm2Cz89elDPIiiIENIpbLc0eH9YWdck/l6hJTaZRbDiVvA5Tfp0VkfdmhFD3OOmJWhUfnBN4UldVs3GHlEosURjcZplaPyLun3Oury4uoYI5u2jv9Q52Vi+ph8EfA0p3MANhN8O5CGwSJBvQXK1rPgyrHzwS+zAK+pFn1ruA7W0H6iy7khtelkeck5TCv2nwp40+IXA/4KbX3fqzcmzBm1vO21CcFbX9d98NqzB",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/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rIzcQ/ivqfOrB2t61c1e6lHJpOI5wRxMuKYU6Jsi7Y68SraSTtHaM2f9eRrtrr50XGigphRDs0bw/M4/kLXi+dJBO4UwrzzPvYBZBji6zwnihFaRwXSA7s8g9slaJnV6eMy6lXju20RXzmuFioa2X6JzcsKzRVrhmWeuW+YJ7lnHFyJ475sRSoXVsoS35sEyURlvPlWe5zqoSlXdDiEAbtJwyOc8hhcZz6xQisPi9Qud/0/kG0u1R4pdWr0SObI5Sr5nhlpfo0VK6bYZ7R/QJlScn3BgpshBzdOfI0xZcVmDJ6RNFFBZz6hmWXEiIQPESIQJTaIXUP78xCCno+R0G58ZSFV6gIw9BO912Ws5boZYQwULbkvu+BB94aSQp3WkqA6GO2qCvt58jfmwFw0yX5KpJ+JWukvFknEySyTiBuo7ACx/EB8jczgmQms73/fK2wiBwRivX9GIcx49x66ascZkzV2UZOreopNz88BqsXsahEdNYva4BpkjmxcP4zlAL/+dgniSTZBz+yEXb8FP/lJu90TgeTwZJPIh/uk4+pCc/p+8/DOM4/gsieCjlfsQh5z5U2c1I970y+RvEqY/V2uHM0XMhXd+g44E6jOzJU0N5pUv0hVBLtkbl2dpqtYyYkcgdMm83jC+5UExyj/ZfHFK0VtuX2/S6zPo7K5QUCm+7jbw9iePbZNeE5PnN5NIizzcMH4Tz7m3LfS6HlwtLeoW9f1zYuVpxKfJwsV3re1RvW1M/vG/CPx5f0SiFczgoti9vinSYVVb4DaTTLTwMuBGD5jydzupZBDQxmi5Uo13ImPsCUhgd368O7QqtC24qKyGFwnvj0tGIGzPUBhXd45LPHdHQiBsxWhGVHGs7z5dCLQcvWs32eV9Rb5v2HWS/ayI34gtuurs3PdCKQBCmBfIcbWgkQfZt/1T41DV+19uOkneM/BTJ7jj24A6kaAsdUmsBuTCorsRSBThXCTx+UAnHhAvH3VsnjFZ4DB1Zszl3mDOtmC8wHJJ8MkyYM5iJRTuVQ3ajbhRRAascLirJpFD3Lr1RAza9WCxEJrhkf+LcCY+zHztc1uv1IzzeBZvPwhfVnFk0eq++DMIAWt9q9+UdRODRlu5icYV2JTJsZ+CZUKOgPGp3jUaO9qVFoBV9PDailkuRoXJ9BE8/X35lKzYZxhD1hu8fJD36en726ferT+SXhr0BKRnGwzjcq9r5kqteqMPH8DG82z1v/MdP53ZVPD74kZFcBNYIrdm2Cz89elDPIiiIENIpbLc0eH9YWdck/l6hJTaZRbDiVvA5Tfp0VkfdmhFD3OOmJWhUfnBN4UldVs3GHlEosURjcZplaPyLun3Oury4uoYI5u2jv9Q52Vi+ph8EfA0p3MANhN8O5CGwSJBvQXK1rPgyrHzwS+zAK+pFn1ruA7W0H6iy7khtelkeck5TCv2nwp40+IXA/4KbX3fqzcmzBm1vO21CcFbX9d98NqzB",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact already exists!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.b58420e2.js b/assets/js/8a725248.b58420e2.js deleted file mode 100644 index 4a138a739..000000000 --- a/assets/js/8a725248.b58420e2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>u,toc:()=>j});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1rIzcQ/ivqfOrB2t61fVe6lHJpOI5wRxPOKYU6Jsi7Y68SraSTtHaM2f9eRrvr11xooFwphLAezevzzIy0Bc+XDtIpXGrleeYdzCLI0WVWGC+0ghRuC2SXFrlHljVK7OLminEp9dqxja6Y1wwXC229ROfkhmWNtsJ1Z+GYL7hnGVeM7LljTiwVWscW2pIPy0RptPVceZbrrCpRedeHCLRByymTqxxSaDy3TiECi18rdP43nW8g3Z4kfmP1SuTI5ij1mhlueYkeLaWbHdUDEdAXKk9OuDFSZCHm4MGRpy24rMCS0xdFFBZzwgxLLiREoHiJEIEptELCz28MQgp6/oDBubFUhRfoyEPQTredlvNWqCVEsNC25P5Qgk+8NJKUHjSVgVBHbdDX288R37eCfqZLctUk/EpXyXA0TEbJaJhAXUfghQ/iI2bu50RITed7vLytMAic0co1WAzj+Jy3thVbknLmqixD5xaVlJsfXsPVyzw0Ymqr1wFgimRePA0fDEH4PydznIySYfgjFy3gF/45N3ujYTwc9ZK4F/90m7xLxz+nb9/14zj+CyJ4KuW+xSHnPlTZ9Uj3uzL5d4hTn6q1zZmj50K6Q4NuD9ShZcfx+LwpJ7pEXwi1ZGtUnq2tVsuIGYncIfN2w/iSC8Uk92j/xSZFa7V9GabXZXY4s0JJofC+m8j7cTy+T3YgvD0H4UqtuBR52P+3+hHV9630MLxvwp+zLBqlcA5HxR7KmyIdZpUVfgPpdAtPPW5ErzlPp7N6FgEBq+neMdqFjLkvIIXB6TXk0K7QuuCmshJSKLw3Lh0MnOdLoZY9bkxfG1R07Uk+dzS1A27EYJUAReoymRBaDSBH+exg4UZ8wk136aRHWhEIYqlAnqMN0BAJX/Z35IcOyh1a3S7araLntstuuRwtf4q20CG1FuJrg2oilioQtErg/CUhHBMuHHeXfGiW8Ao4sWZz7jBnWjFfYDgk+aifMGcwE4u2z/rsTt0pmgFWOVxUkkmhHl16p3pser1YiExwyf7EuRMeZz92vKzX6zM+3gSbj8IX1ZxZNHqvvgzCQNqh1e7HG4jAoy3d9WKCdiUybHvgG6EGQXnQTg81EU1Ay0Aren9qRJBLkaFyhwxefLz5zEb9GKKD1vsHKQ8+X11++H3ygbxS8zYUJf24H4frRDtfcnUQqH0DXu66/ojc7X4P/McvxnZQPD75gZFchC0QoNm2Azw9eUfOIihowNMpbLfUdn9YWdck/lqhpe0wi2DFreBz6vPprI66IaOJf8RN+2pB5Xu3FJ7UZdXM68lKrKPO4iLL0PgXdQ930M315BYimLdv3VLnZGP5mt7BfA0p3MEdhCczeQg7JMi3ILlaVnwZBj74pd3AK8LicLE8hsXSflBl3ZHaHGR5vHGaUug/FfaswS9E/ifc/LpTb06+adBi22kTg7O6rv8GFfdQfQ==",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/createcontact",title:"Create Contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1rIzcQ/ivqfOrB2t61fVe6lHJpOI5wRxPOKYU6Jsi7Y68SraSTtHaM2f9eRrvr11xooFwphLAezevzzIy0Bc+XDtIpXGrleeYdzCLI0WVWGC+0ghRuC2SXFrlHljVK7OLminEp9dqxja6Y1wwXC229ROfkhmWNtsJ1Z+GYL7hnGVeM7LljTiwVWscW2pIPy0RptPVceZbrrCpRedeHCLRByymTqxxSaDy3TiECi18rdP43nW8g3Z4kfmP1SuTI5ij1mhlueYkeLaWbHdUDEdAXKk9OuDFSZCHm4MGRpy24rMCS0xdFFBZzwgxLLiREoHiJEIEptELCz28MQgp6/oDBubFUhRfoyEPQTredlvNWqCVEsNC25P5Qgk+8NJKUHjSVgVBHbdDX288R37eCfqZLctUk/EpXyXA0TEbJaJhAXUfghQ/iI2bu50RITed7vLytMAic0co1WAzj+Jy3thVbknLmqixD5xaVlJsfXsPVyzw0Ymqr1wFgimRePA0fDEH4PydznIySYfgjFy3gF/45N3ujYTwc9ZK4F/90m7xLxz+nb9/14zj+CyJ4KuW+xSHnPlTZ9Uj3uzL5d4hTn6q1zZmj50K6Q4NuD9ShZcfx+LwpJ7pEXwi1ZGtUnq2tVsuIGYncIfN2w/iSC8Uk92j/xSZFa7V9GabXZXY4s0JJofC+m8j7cTy+T3YgvD0H4UqtuBR52P+3+hHV9630MLxvwp+zLBqlcA5HxR7KmyIdZpUVfgPpdAtPPW5ErzlPp7N6FgEBq+neMdqFjLkvIIXB6TXk0K7QuuCmshJSKLw3Lh0MnOdLoZY9bkxfG1R07Uk+dzS1A27EYJUAReoymRBaDSBH+exg4UZ8wk136aRHWhEIYqlAnqMN0BAJX/Z35IcOyh1a3S7araLntstuuRwtf4q20CG1FuJrg2oilioQtErg/CUhHBMuHHeXfGiW8Ao4sWZz7jBnWjFfYDgk+aifMGcwE4u2z/rsTt0pmgFWOVxUkkmhHl16p3pser1YiExwyf7EuRMeZz92vKzX6zM+3gSbj8IX1ZxZNHqvvgzCQNqh1e7HG4jAoy3d9WKCdiUybHvgG6EGQXnQTg81EU1Ay0Aren9qRJBLkaFyhwxefLz5zEb9GKKD1vsHKQ8+X11++H3ygbxS8zYUJf24H4frRDtfcnUQqH0DXu66/ojc7X4P/McvxnZQPD75gZFchC0QoNm2Azw9eUfOIihowNMpbLfUdn9YWdck/lqhpe0wi2DFreBz6vPprI66IaOJf8RN+2pB5Xu3FJ7UZdXM68lKrKPO4iLL0PgXdQ930M315BYimLdv3VLnZGP5mt7BfA0p3MEdhCczeQg7JMi3ILlaVnwZBj74pd3AK8LicLE8hsXSflBl3ZHaHGR5vHGaUug/FfaswS9E/ifc/LpTb06+adBi22kTg7O6rv8GFfdQfQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.26c9597e.js b/assets/js/935f2afb.26c9597e.js deleted file mode 100644 index 1738db41d..000000000 --- a/assets/js/935f2afb.26c9597e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by providing template_id.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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 .","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"id":"API-docs/draftedocument","title":"Draft Document","description":"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"The Get User API enables you to get your own details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to trigger events","sidebar":"apiSidebar"},"API-docs/update-document":{"id":"API-docs/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.f5814a5e.js b/assets/js/935f2afb.f5814a5e.js new file mode 100644 index 000000000..57255e317 --- /dev/null +++ b/assets/js/935f2afb.f5814a5e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [debug PDF](https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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.","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"id":"API-docs/draftedocument","title":"Draft Document","description":"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to trigger events","sidebar":"apiSidebar"},"API-docs/update-document":{"id":"API-docs/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.0f2754b5.js b/assets/js/a2bc1463.0f2754b5.js deleted file mode 100644 index eb572a8e5..000000000 --- a/assets/js/a2bc1463.0f2754b5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>v,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),i=s(11151),n=s(58219),l=(s(62316),s(51039)),c=s.n(l),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLzUFSCk3MIe+OvRNrJZ2kdWzM/vdjtGt7HV/aXjlKwcTRzDNvj2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdx8fFaYGXNMzov1qYWwQiHwREuUUihGGNmIu88JsI6s6SC9FxIkZvKOixRe1qiWBI+M1YqJeRSkpJThTtLQZr9u61gasxiCAkYi05ydtcFZNApOSwkYKWTFQZ0XNUGtKwQMlBUEWuJC/pco1tDAg4/1+SwgGwmlccEfFgrRs+MqyABXFllCoQsuJq1eYmVhGwDlVxRVVeQnadpAmFt2UjX1RQdNGwnK8uOxmmT7FLwC7LfLYPXY6bNhP16a7RHz9iTNOWvw0v1dZ6j97NaiR2bkEQuUQfGS2sV5VExevJstDlOwEyfMI+0O3YTqA3p0Ncq9HDSOckFU8DK/719K+bb3SF9cKTnkERqZOhLdrWDLcfTcnXyZJmSlvdvc/BkUEwRI6OVJPUv7KeI7zrBMDcVu7Kl0d+cytn4dHwSP+widygDFhfha272RifpyelgnA7Sn+7Hb7Ozn7Pzt8M0Tf+EBFZVrKbrxkKGWGWgoPrn2hb/QZzmJayb4QKDJOX7Bp0GmqYnJK1I46dtm3/iFm8i4iw9P272a72Uioq4uO7NAvUP36/V0Tnj/pqsfvjQhj9mgFpQ1MNBqX15W6THvHYU1nHDrQbS0qDVZw8THv8KQ2l4Nc6xXYmhhAxGh4vSo1tut2TtFGRQhmB9Nhr5IOek5wNp7dBY3tRzreTUczuPpKXRcgwcZpvGHVPVsnGQzH76LX1AHv+u1j6q24glyoI3WcPnmYnGHQO3FvUdzXXkbzmG498n8oJ8VBcmryvUId6lmBknXliLqfRYCKNFKDEqWX46HAtvMadZ1wZD8agf9Z2pUNQeeUsq0gufPeqBeLidzSgnqcQfOPUUcPLjlrnn5+cjxt5EmysKZT0VDq3Zw+dRGGntW+0ObyCBgK7yt7M7dEvKsbulV0KNInjUNTdPDTdou8e2oncvjbjZFOWoPfba8eLq4404HaaQ9JrjH6Q8url+f/nb3SV75fZqr2g8TIdp3ITGh0rqXqArDLvXRdeZB9e72Q/q//Al0jV4wFUYWSUpjm4kbNON3cPB+2SSQGl8YPFmw634u1NNw+L2ScDDWJDn2PtHwQLXvSfMUqqaYwK/LV7Bdm+NPXTCB0eMjUsi2Q4cB2xtLvIcbT/A0VY8WC1Xl/eQgKy5xv6gL+Kgd/+w961Kr3u+DzdAmwD/5Zq+avALX/UHXP+6g7eaVw26+rZovplJ0zRfAEQXtVs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLzUFSCk3MIe+OvRNrJZ2kdWzM/vdjtGt7HV/aXjlKwcTRzDNvj2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdx8fFaYGXNMzov1qYWwQiHwREuUUihGGNmIu88JsI6s6SC9FxIkZvKOixRe1qiWBI+M1YqJeRSkpJThTtLQZr9u61gasxiCAkYi05ydtcFZNApOSwkYKWTFQZ0XNUGtKwQMlBUEWuJC/pco1tDAg4/1+SwgGwmlccEfFgrRs+MqyABXFllCoQsuJq1eYmVhGwDlVxRVVeQnadpAmFt2UjX1RQdNGwnK8uOxmmT7FLwC7LfLYPXY6bNhP16a7RHz9iTNOWvw0v1dZ6j97NaiR2bkEQuUQfGS2sV5VExevJstDlOwEyfMI+0O3YTqA3p0Ncq9HDSOckFU8DK/719K+bb3SF9cKTnkERqZOhLdrWDLcfTcnXyZJmSlvdvc/BkUEwRI6OVJPUv7KeI7zrBMDcVu7Kl0d+cytn4dHwSP+widygDFhfha272RifpyelgnA7Sn+7Hb7Ozn7Pzt8M0Tf+EBFZVrKbrxkKGWGWgoPrn2hb/QZzmJayb4QKDJOX7Bp0GmqYnJK1I46dtm3/iFm8i4iw9P272a72Uioq4uO7NAvUP36/V0Tnj/pqsfvjQhj9mgFpQ1MNBqX15W6THvHYU1nHDrQbS0qDVZw8THv8KQ2l4Nc6xXYmhhAxGh4vSo1tut2TtFGRQhmB9Nhr5IOek5wNp7dBY3tRzreTUczuPpKXRcgwcZpvGHVPVsnGQzH76LX1AHv+u1j6q24glyoI3WcPnmYnGHQO3FvUdzXXkbzmG498n8oJ8VBcmryvUId6lmBknXliLqfRYCKNFKDEqWX46HAtvMadZ1wZD8agf9Z2pUNQeeUsq0gufPeqBeLidzSgnqcQfOPUUcPLjlrnn5+cjxt5EmysKZT0VDq3Zw+dRGGntW+0ObyCBgK7yt7M7dEvKsbulV0KNInjUNTdPDTdou8e2oncvjbjZFOWoPfba8eLq4404HaaQ9JrjH6Q8url+f/nb3SV75fZqr2g8TIdp3ITGh0rqXqArDLvXRdeZB9e72Q/q//Al0jV4wFUYWSUpjm4kbNON3cPB+2SSQGl8YPFmw634u1NNw+L2ScDDWJDn2PtHwQLXvSfMUqqaYwK/LV7Bdm+NPXTCB0eMjUsi2Q4cB2xtLvIcbT/A0VY8WC1Xl/eQgKy5xv6gL+Kgd/+w961Kr3u+DzdAmwD/5Zq+avALX/UHXP+6g7eaVw26+rZovplJ0zRfAEQXtVs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"}},v={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,t.jsx)(c(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.e95152b3.js b/assets/js/a2bc1463.e95152b3.js new file mode 100644 index 000000000..993abce93 --- /dev/null +++ b/assets/js/a2bc1463.e95152b3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>y,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r4zgQ/is6fboFJ3H6sseZ49iylFK2XBfaY2HbUGR7Ek8jS1pJdhKC//syspM4Tdu7HstyUNp65pm3RzMjrbkXM8eTO/5RKy8y7/gk4jm4zKLxqBVP+G0BrNOyK3SenX2+ZFAavQDr2EpXzGtmwVuEGphgkjB6yrLOY8SM1TXmqGZMsEyXxkIBymENrEZYEFZIyUQtUIpUwtaSoSL/diNItZ4PecS1ASsou8ucJ7xTUlgecSOsKMGDparWXIkSeMIllkhapIK+VWBXPOIWvlVoIefJVEgHEXd+JQk91bbkEYelkToHnnhbkTYroBQ8WfNSLLGsSp6cxnHE/cqQkarKFCxvyE6UhhyN4ybapuDmaH5YBi/HjJsJ+XVGKweOsEdxTH/2D9VVWQbOTSvJtmzyKHAJyhNeGCMxC4rRoyOj9WECOn2ELNBuyY3HNqQFV0nfwwlrBRWMHkr3z/atmE53i3TeoprxKFAjfF+yrZ2bYpwWy6NHQ5S0vL/NwaMGlgIERkuB8j/YpwAfOsEw0yW5MoVWb07lZHw8Pgo/5CKzIDzkZ/45Nzujo/joeDCOB/Fvt+P3ycnvyen7YRzHX3nEl2WopuvGXPhQpUcv+9+VyX9CnOYprJvhHLxA6foGnYY3TU+ISqKCh02bP1CLNwFx8lyz3+gSfEH7ZwHKs4XVahYxI0E4YN6umJgJVEwKD/aXHzcFYK22r/P4tsxeo+Akjh/GWxJOD0m4VLWQmIftfavnoH5upf3wvg1/2AbYgoKe7xXbl7dFOsgqi34V1vxyIAwOWn1yN6EdSMRquh9m0N4LvuAJH+3fFg5svbkqKit5wgvvjUtGI2HMUBu6pmZKitTRLI+EwVFN8/gU7byYoZoNXrWa7JK+IWJb7vZS3y1Mg5+ANmbHTB/VXSIFiJyWf0PfUx2MO76uDagbnKnAdj3mh1c6OoYuqHOdVSUoH06eTbVlT6xZKhzkTCvmCwhKkh8Px8wZyHDaNc2Q3at7RQ3NKgd0sUhUc5fcqwG7u55OMUMh2RdIHXqY/LphbrFYHDD2LthcoC+qlFkwegefBWGgtW+1/XjHI+7Blu56egO2xgy6U3oh1CiAR90o0KKhdm5X/0b04akRtabEDJSDXvOeXXy+YjU7HsY86rXHv0h6dHX58fyvm3PyS+3YHtJ4GA/jcH1o50uheqEuwG+fZF0n7x3wejfY/8PnW9fiHpZ+ZKTAMOqBsHU3pnd7j7pJxAvtPInXa2rGv61sGhK37yga3hwdxd69pOaw6r37aiErihlG9wVs90DbQSf0YZGwYalEm5GjgK3NWZaB6Qc42KJ7q+ji/JZHXFRUY3/U52HUu3/I+0alVj3f+zugTYB+U03PGvxBR/0JVn9u4a3mRYOuvg2aTmbSNM13cAohxA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r4zgQ/is6fboFJ3H6sseZ49iylFK2XBfaY2HbUGR7Ek8jS1pJdhKC//syspM4Tdu7HstyUNp65pm3RzMjrbkXM8eTO/5RKy8y7/gk4jm4zKLxqBVP+G0BrNOyK3SenX2+ZFAavQDr2EpXzGtmwVuEGphgkjB6yrLOY8SM1TXmqGZMsEyXxkIBymENrEZYEFZIyUQtUIpUwtaSoSL/diNItZ4PecS1ASsou8ucJ7xTUlgecSOsKMGDparWXIkSeMIllkhapIK+VWBXPOIWvlVoIefJVEgHEXd+JQk91bbkEYelkToHnnhbkTYroBQ8WfNSLLGsSp6cxnHE/cqQkarKFCxvyE6UhhyN4ybapuDmaH5YBi/HjJsJ+XVGKweOsEdxTH/2D9VVWQbOTSvJtmzyKHAJyhNeGCMxC4rRoyOj9WECOn2ELNBuyY3HNqQFV0nfwwlrBRWMHkr3z/atmE53i3TeoprxKFAjfF+yrZ2bYpwWy6NHQ5S0vL/NwaMGlgIERkuB8j/YpwAfOsEw0yW5MoVWb07lZHw8Pgo/5CKzIDzkZ/45Nzujo/joeDCOB/Fvt+P3ycnvyen7YRzHX3nEl2WopuvGXPhQpUcv+9+VyX9CnOYprJvhHLxA6foGnYY3TU+ISqKCh02bP1CLNwFx8lyz3+gSfEH7ZwHKs4XVahYxI0E4YN6umJgJVEwKD/aXHzcFYK22r/P4tsxeo+Akjh/GWxJOD0m4VLWQmIftfavnoH5upf3wvg1/2AbYgoKe7xXbl7dFOsgqi34V1vxyIAwOWn1yN6EdSMRquh9m0N4LvuAJH+3fFg5svbkqKit5wgvvjUtGI2HMUBu6pmZKitTRLI+EwVFN8/gU7byYoZoNXrWa7JK+IWJb7vZS3y1Mg5+ANmbHTB/VXSIFiJyWf0PfUx2MO76uDagbnKnAdj3mh1c6OoYuqHOdVSUoH06eTbVlT6xZKhzkTCvmCwhKkh8Px8wZyHDaNc2Q3at7RQ3NKgd0sUhUc5fcqwG7u55OMUMh2RdIHXqY/LphbrFYHDD2LthcoC+qlFkwegefBWGgtW+1/XjHI+7Blu56egO2xgy6U3oh1CiAR90o0KKhdm5X/0b04akRtabEDJSDXvOeXXy+YjU7HsY86rXHv0h6dHX58fyvm3PyS+3YHtJ4GA/jcH1o50uheqEuwG+fZF0n7x3wejfY/8PnW9fiHpZ+ZKTAMOqBsHU3pnd7j7pJxAvtPInXa2rGv61sGhK37yga3hwdxd69pOaw6r37aiErihlG9wVs90DbQSf0YZGwYalEm5GjgK3NWZaB6Qc42KJ7q+ji/JZHXFRUY3/U52HUu3/I+0alVj3f+zugTYB+U03PGvxBR/0JVn9u4a3mRYOuvg2aTmbSNM13cAohxA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"}},y={},g=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.2a49d56a.js b/assets/js/a88a3db3.2a49d56a.js deleted file mode 100644 index d7440cfd9..000000000 --- a/assets/js/a88a3db3.2a49d56a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>q,frontMatter:()=>u,metadata:()=>f,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const u={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb+XQB2ZaTXMqJUpo24WouNEfjo9DEhLU0svay2t3bXTk2Rv+9zEqyZTsJLZTSL7Y0+8zOzDNv2oDnCwfJPUyxNJJ7dDCLIEOXWmG80AoSmBbIrlCiR9ah2OXnCTNWL0WGjq11xZ6FL5gvkPG5kMKvmdfMYqmXyDhzBlORi5T5Tj+3ugzwTuKGbJIzvkMIx5RmUqsFWqYQM8wgAm3QcvJrkkECWfCqcwoiMNzyEj1aimkDipcICXR3Pgq6QlBMhvsCDgOdXDGd73nFfMF9sO4ooDmyxiTdY/FbJSxmkHhbYQTOryVZc6I0kpzBlZE6Q0hyLh0B0gJLDskG/NoEpLdCLSCCXNuS+52krmd0vzNaOXSkcRrH9HeQmM7L1inmqjRF5/JKyvV3EEGqlUflSZMbI0UaqBt9daS+OXZIz79i6olHS0R70RhvxMT4seu44iHcBH5eFafcmV/NGdRRm5rs0r+tdBqfng3G8SD+fjq+SM4/JO8vhnEc/wkRrEpJum0OM0pwHYEXXu7e6yNYMLsHbCU1gc/j8zdoVNqzXFcq+xe5Q2u1fZuDl+zXvQiEkkLhY1cPj+fx+ePFNqD3xwFN1JJLkYUmneonVP9tPH3zvjF/nCjRgMI57AXblzdBOkwrK/w69PRqwI0YNOfJ/Yw6pURf6N08CHPAF5DAqOvj0aY3A2qgK+2ymxKVlZBA4b1xyWjkPF8ItRhwY4baoHJioSSfu2GqyxE3YrQcAxntnLoj4hpu9lzbMsSN+IRriLrI+6h2GhXIM7SBJaFyHZRbPm4NqjuxUIHN5fhoZk0L4WhW0nGm06pE5UNmWa4tO9Bmc+4wY1qFIUeHJD8bjrcTOqgO2YN6UHe6RFY5zCvJpFBPLnlQA3Z/m+ciFVyyP3DuhMfZu4655+fnI8ZOgs5H4YtqziwavYMvgjDQ2tfavpxABB5t6W7zO7RLkWKbpVdMjQJ41JY6T0OpY8kFZbcV/XSoRKUnRYrKYa84Lz9+vmFnwxiiXnH8DZdHN5Nfrn+7u6ZbqbyaFI2H8TAmkdHOl1z1DB2s1cPsbnZd+7/awm1le1z5kZFchA4OTG3a1rvfLl2IIOkv4FkEhXaeIJsN1eMXK+uaxN8qtNTjswiW3Ao+pwa430AmHD1n20X6Kkfvfm938gn7Z7v8xYC6/lXUvEsuK3qDCJ5wffBRUc/qqGti8rhBXKYpGt/TPZq7e8Pr6vrmenoNEfCKGOzPj6cwP9oHMvCia/uDpfGBfuvoFYUfqH4+4frHLbw5eVWhDbFDE02zuq7/AofehJw=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb+XQB2ZaTXMqJUpo24WouNEfjo9DEhLU0svay2t3bXTk2Rv+9zEqyZTsJLZTSL7Y0+8zOzDNv2oDnCwfJPUyxNJJ7dDCLIEOXWmG80AoSmBbIrlCiR9ah2OXnCTNWL0WGjq11xZ6FL5gvkPG5kMKvmdfMYqmXyDhzBlORi5T5Tj+3ugzwTuKGbJIzvkMIx5RmUqsFWqYQM8wgAm3QcvJrkkECWfCqcwoiMNzyEj1aimkDipcICXR3Pgq6QlBMhvsCDgOdXDGd73nFfMF9sO4ooDmyxiTdY/FbJSxmkHhbYQTOryVZc6I0kpzBlZE6Q0hyLh0B0gJLDskG/NoEpLdCLSCCXNuS+52krmd0vzNaOXSkcRrH9HeQmM7L1inmqjRF5/JKyvV3EEGqlUflSZMbI0UaqBt9daS+OXZIz79i6olHS0R70RhvxMT4seu44iHcBH5eFafcmV/NGdRRm5rs0r+tdBqfng3G8SD+fjq+SM4/JO8vhnEc/wkRrEpJum0OM0pwHYEXXu7e6yNYMLsHbCU1gc/j8zdoVNqzXFcq+xe5Q2u1fZuDl+zXvQiEkkLhY1cPj+fx+ePFNqD3xwFN1JJLkYUmneonVP9tPH3zvjF/nCjRgMI57AXblzdBOkwrK/w69PRqwI0YNOfJ/Yw6pURf6N08CHPAF5DAqOvj0aY3A2qgK+2ymxKVlZBA4b1xyWjkPF8ItRhwY4baoHJioSSfu2GqyxE3YrQcAxntnLoj4hpu9lzbMsSN+IRriLrI+6h2GhXIM7SBJaFyHZRbPm4NqjuxUIHN5fhoZk0L4WhW0nGm06pE5UNmWa4tO9Bmc+4wY1qFIUeHJD8bjrcTOqgO2YN6UHe6RFY5zCvJpFBPLnlQA3Z/m+ciFVyyP3DuhMfZu4655+fnI8ZOgs5H4YtqziwavYMvgjDQ2tfavpxABB5t6W7zO7RLkWKbpVdMjQJ41JY6T0OpY8kFZbcV/XSoRKUnRYrKYa84Lz9+vmFnwxiiXnH8DZdHN5Nfrn+7u6ZbqbyaFI2H8TAmkdHOl1z1DB2s1cPsbnZd+7/awm1le1z5kZFchA4OTG3a1rvfLl2IIOkv4FkEhXaeIJsN1eMXK+uaxN8qtNTjswiW3Ao+pwa430AmHD1n20X6Kkfvfm938gn7Z7v8xYC6/lXUvEsuK3qDCJ5wffBRUc/qqGti8rhBXKYpGt/TPZq7e8Pr6vrmenoNEfCKGOzPj6cwP9oHMvCia/uDpfGBfuvoFYUfqH4+4frHLbw5eVWhDbFDE02zuq7/AofehJw=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},j={},v=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,l.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function q(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.f9046360.js b/assets/js/a88a3db3.f9046360.js new file mode 100644 index 000000000..9b20b1364 --- /dev/null +++ b/assets/js/a88a3db3.f9046360.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),p=s(41429),m=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3HaXocZw7BuLW7FFethzTBgbVAoNh3rKks6Sc4LAv/3gbKdOElb7IDhsC+JTZEin0fkY23A87mD5AEmWBrJPTqYRpChS60wXmgFCUwKZFco0SPrvNjlpxtmrF6IDB1b64othS+YL5DxmZDCr5nXzGKpF8g4cwZTkYuU+S4+t7oM7p3FDdlNzvjOQzimNJNazdEyhZhhBhFog5ZTXTcZJJCFqrqiIALDLS/RoyVMG1C8REig2/NJ0BaCMBnuCzgEenPFdL5XFfMF9yG7I0AzZE1K2sfil0pYzCDxtsIInF9LyuZEaSQVgysjdYaQ5Fw6ckgLLDkkG/BrEzy9FWoOEeTaltzvLHU9pf2d0cqho4jTOKa/g4PpqmyLYq5KU3Qur6RcfwcRpFp5VJ4iuTFSpIG60WdH4ZvjgvTsM6aeeLREtBdN8sZMjB+Xjise4Cbwy6o45c78Zs6gjtqjyS7920Gn8enZYBwP4u8n44vk/Ifk/cUwjuO/IYJVKSm2PcOMDriOwAsvd+/1kVtIu+fYWmpyPn+Jxntdoi+EmrMlKs+WVqt5xIxE7pB5u2Z8zoVixLT9D1lFa7V9m52vq6zuoRZKCoVPXQ89ncfx03hLwvkbvaS0Z7muVPZtob6U/21A508XW0DvjwHdqAWXIgtKNdHPqL4tnn5636Q/7lbROIV12APbtzcgHaaVFX4dhG014EYMmvXkYUpyQZ2id6IYxNAXkMCoE7PRpieENdCWdtFJZWUlJFB4b1wyGnFjhtqgcmKuJJ+5YarLETditBhDHR16O8/nQs0Hb0ZNdxDuieaGyT0gWz65ER9xDVHHU9+rFfACeYY2cCpUrkNwy96dQXUv5ipwvxgfyfykEI4+L7Sc6bQqUfnQByzXlh1Esxl3mDGtwneBFsl+NhxvP2ohdMge1aOieWWVw7ySTAr17JJHNWAPd3kuUsEl+wtnTnicvuuYWy6XR4ydhJgPwhfVjFk0euc+D8ZAaz9q+3ICEXi0pbvL79EuRIrtKb2SahScR+1g8DQMBpZc0Om2pp8Pg6hRpUhROey18uWHT7dswc6GMUS99vgXRY9ub369/v3+mvaldmwOaTyMhzGZjHa+5KqX6uAucni+m92U/6+uLm1ve1z5kZFchIkPTG3aUX3Y3lQggqR/a5lGUGjnyWWzoY7808q6JvOXCi1pwjSCBbeCz2gEHjaQCUfP2fb28SpH7/5oLzIn7OsuQC8C6iZY0fguuKzoDSJ4xvXBTaye1lE3xlRx43GZpmh8L/ZIp/fE7ur69npyDRHwihjsK8hzUJD2gRK8WNq+tDQ10C+p3IsBP1L/fMT1T1v3ZuXVgBZi5000Teu6/gf6A/D2",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3HaXocZw7BuLW7FFethzTBgbVAoNh3rKks6Sc4LAv/3gbKdOElb7IDhsC+JTZEin0fkY23A87mD5AEmWBrJPTqYRpChS60wXmgFCUwKZFco0SPrvNjlpxtmrF6IDB1b64othS+YL5DxmZDCr5nXzGKpF8g4cwZTkYuU+S4+t7oM7p3FDdlNzvjOQzimNJNazdEyhZhhBhFog5ZTXTcZJJCFqrqiIALDLS/RoyVMG1C8REig2/NJ0BaCMBnuCzgEenPFdL5XFfMF9yG7I0AzZE1K2sfil0pYzCDxtsIInF9LyuZEaSQVgysjdYaQ5Fw6ckgLLDkkG/BrEzy9FWoOEeTaltzvLHU9pf2d0cqho4jTOKa/g4PpqmyLYq5KU3Qur6RcfwcRpFp5VJ4iuTFSpIG60WdH4ZvjgvTsM6aeeLREtBdN8sZMjB+Xjise4Cbwy6o45c78Zs6gjtqjyS7920Gn8enZYBwP4u8n44vk/Ifk/cUwjuO/IYJVKSm2PcOMDriOwAsvd+/1kVtIu+fYWmpyPn+Jxntdoi+EmrMlKs+WVqt5xIxE7pB5u2Z8zoVixLT9D1lFa7V9m52vq6zuoRZKCoVPXQ89ncfx03hLwvkbvaS0Z7muVPZtob6U/21A508XW0DvjwHdqAWXIgtKNdHPqL4tnn5636Q/7lbROIV12APbtzcgHaaVFX4dhG014EYMmvXkYUpyQZ2id6IYxNAXkMCoE7PRpieENdCWdtFJZWUlJFB4b1wyGnFjhtqgcmKuJJ+5YarLETditBhDHR16O8/nQs0Hb0ZNdxDuieaGyT0gWz65ER9xDVHHU9+rFfACeYY2cCpUrkNwy96dQXUv5ipwvxgfyfykEI4+L7Sc6bQqUfnQByzXlh1Esxl3mDGtwneBFsl+NhxvP2ohdMge1aOieWWVw7ySTAr17JJHNWAPd3kuUsEl+wtnTnicvuuYWy6XR4ydhJgPwhfVjFk0euc+D8ZAaz9q+3ICEXi0pbvL79EuRIrtKb2SahScR+1g8DQMBpZc0Om2pp8Pg6hRpUhROey18uWHT7dswc6GMUS99vgXRY9ub369/v3+mvaldmwOaTyMhzGZjHa+5KqX6uAucni+m92U/6+uLm1ve1z5kZFchIkPTG3aUX3Y3lQggqR/a5lGUGjnyWWzoY7808q6JvOXCi1pwjSCBbeCz2gEHjaQCUfP2fb28SpH7/5oLzIn7OsuQC8C6iZY0fguuKzoDSJ4xvXBTaye1lE3xlRx43GZpmh8L/ZIp/fE7ur69npyDRHwihjsK8hzUJD2gRK8WNq+tDQ10C+p3IsBP1L/fMT1T1v3ZuXVgBZi5000Teu6/gf6A/D2",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,l.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.0275f043.js b/assets/js/bbdfc22d.0275f043.js deleted file mode 100644 index 5c7173404..000000000 --- a/assets/js/bbdfc22d.0275f043.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=a(85893),t=a(11151),r=a(58219),l=(a(62316),a(51039)),n=a.n(l),c=(a(82723),a(9487)),m=(a(41429),a(5397)),o=a(4667),p=a(9472),d=a(85162);const h={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:"eJztV21v2zYQ/ivcfVoNxW9xXyAMQ9+7oMUSLCn2wTECijpZTCSSJak4nqH/Phxl2bKTNnXRb9uXRD7eHe+Ox+c5rsDzuYN4ChdYmoJ7dDCLIEUnrDReagUxXOTI2mX2xiInOXt1dsJ4UeiFY5VD65jXTNAiMlE5r0v5D08KZL51HLFFLkXOHNpbZNyxpKjQWKm8Y5m2bI4KLfdSzVmqRVUiLSykz5mxmGImFabMeVsJX1l0ffbZaMVcJQQ6l1XFZqcmDKlVxHyOIVCLvrLKMc4qJb9UyHq9VvtKpr0e8zn3THDFEqR0UspmHRB2wkk4rWkVHDuDQmaSlNud++xSXape77MpNE/ZUlfMpBmTik1TTKo5O3v7fvZr7r1x8WDgPJ9LNT/ixvS1QeXkXBU8cX2hywE5KLMByUoprObGDIIPk2ZPWI4Wg3uKObV8wRYynaN3jKuUCW2WTOgjbWWquMeIGT5HpqoyQct0RuGXfcYLpzdOgg3l92xCGmdv3/d6lwoi0CYci1YnKcTQHHGbMERg8UuFzr/W6RLiFQitPCpPn9yYQopgOrh21EorcCLHktOXXxqEGHRyjcJDBMbSRl6io9VMFtjRct5KNYcIMm1L7iGGJlKIAO94aUh5LWKohE4xZcFFHYGX/hFfG8nWlwsfm4MlP0r7H3UTTOu9e/VDnroe6gioO9C6jjNuLV9CBNJj6R6vs9WH10agpr2x5LI41PZaY4L4shFQn4fK8vLgIK41sgRDVU2u1cH2o/HxaDw6Ho3Jw/ru/HgZm9UDT9Tz0oT4+bxr3NzSrvFGsjEe1RHcHWgznkzqCJYHWj2nrRYHGh2/qCPIDzSaPKu3t3UPZ64SnS6v2mOqH1Nsr8Vjio0CIZi0mELsbYVB4IxWrjna8XBI//YocYdqiJc2NFQsf4HoZ8FgIybgvd9b2056nY//cEaVIqd2KtG53Y56wOSRBLp1k6qQCq/aolyNh8Orp1S5OoLJ8On94pyoW17INBDvhb5B9RMLgtZq++3Uutv7ZnsK9a4MYNVgDchGKazDTrJdeZOkQ1FZ6ZcQT1dwd8SNPGrW4+msnlHBfa6JG412IWLuc4hhcI8qw+RDaD1dQWULiOG7JgFu5OB2BLRVG8o5laupyE5AW/wy8iMSgK3z7WpFIOmYcuQp2lAbOoW/tjz+rq1ly8MPUuu2aPtk2XLlDv3tT5UPEFqHz6YtNQW22ZDNA/yxSbFlhA0hdDC+A/HTTu8QALf4OwqIOp5MAkY+HwXUO34RcGzyrJ7Vs5oKl+lQ5XXmpwbVuZw30/Dt6F6SF7l0TLqw3E6RzfhME++e9e50SYskP+6P2kmzuTPNjHmuyzCp0uBbSHXj4kt1xKanWSaF5AX7GxMnPW6HzcVica+1ngSbD9LnVcIsGr1Vnwdh6L+u1ebHEzp/tKU7zc7R3kqB63b+ylaDoDxYIwEXAQnaU12LXu4b0c0spEDlsHN3X304+8SO+0OIOrfoO0IefDp58+7P83fkle5hc0Sj/rA/DDSsnS+56mz0pnnOXGz7em+A24Da/2+k//YbaY0oHu/8wBRcBk4Jzbla08F0/+U0iyAnvoinsFqRz8+2qGsSf6nQEtnMIrjlVlKHBKqJWsgmDLvBJXVo04BHF7Q/qRdVg/57DFtHrcUrIdD4b+p2Ke3s9PwCIkjWr7tSp2Rj+YJefnwBMVzCJYRXInlo3hQ8zIsFV/MqQCs0folpeOXzXZq6CTS1/uigM1fLTpS7/NWkQn8psQcNfqOW/ojL3zfqzcpXDda1bbXpCGd1Xf8LTwfpAA==",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:"eJztV21v2zYQ/ivcfVoNxW9xXyAMQ9+7oMUSLCn2wTECijpZTCSSJak4nqH/Phxl2bKTNnXRb9uXRD7eHe+Ox+c5rsDzuYN4ChdYmoJ7dDCLIEUnrDReagUxXOTI2mX2xiInOXt1dsJ4UeiFY5VD65jXTNAiMlE5r0v5D08KZL51HLFFLkXOHNpbZNyxpKjQWKm8Y5m2bI4KLfdSzVmqRVUiLSykz5mxmGImFabMeVsJX1l0ffbZaMVcJQQ6l1XFZqcmDKlVxHyOIVCLvrLKMc4qJb9UyHq9VvtKpr0e8zn3THDFEqR0UspmHRB2wkk4rWkVHDuDQmaSlNud++xSXape77MpNE/ZUlfMpBmTik1TTKo5O3v7fvZr7r1x8WDgPJ9LNT/ixvS1QeXkXBU8cX2hywE5KLMByUoprObGDIIPk2ZPWI4Wg3uKObV8wRYynaN3jKuUCW2WTOgjbWWquMeIGT5HpqoyQct0RuGXfcYLpzdOgg3l92xCGmdv3/d6lwoi0CYci1YnKcTQHHGbMERg8UuFzr/W6RLiFQitPCpPn9yYQopgOrh21EorcCLHktOXXxqEGHRyjcJDBMbSRl6io9VMFtjRct5KNYcIMm1L7iGGJlKIAO94aUh5LWKohE4xZcFFHYGX/hFfG8nWlwsfm4MlP0r7H3UTTOu9e/VDnroe6gioO9C6jjNuLV9CBNJj6R6vs9WH10agpr2x5LI41PZaY4L4shFQn4fK8vLgIK41sgRDVU2u1cH2o/HxaDw6Ho3Jw/ru/HgZm9UDT9Tz0oT4+bxr3NzSrvFGsjEe1RHcHWgznkzqCJYHWj2nrRYHGh2/qCPIDzSaPKu3t3UPZ64SnS6v2mOqH1Nsr8Vjio0CIZi0mELsbYVB4IxWrjna8XBI//YocYdqiJc2NFQsf4HoZ8FgIybgvd9b2056nY//cEaVIqd2KtG53Y56wOSRBLp1k6qQCq/aolyNh8Orp1S5OoLJ8On94pyoW17INBDvhb5B9RMLgtZq++3Uutv7ZnsK9a4MYNVgDchGKazDTrJdeZOkQ1FZ6ZcQT1dwd8SNPGrW4+msnlHBfa6JG412IWLuc4hhcI8qw+RDaD1dQWULiOG7JgFu5OB2BLRVG8o5laupyE5AW/wy8iMSgK3z7WpFIOmYcuQp2lAbOoW/tjz+rq1ly8MPUuu2aPtk2XLlDv3tT5UPEFqHz6YtNQW22ZDNA/yxSbFlhA0hdDC+A/HTTu8QALf4OwqIOp5MAkY+HwXUO34RcGzyrJ7Vs5oKl+lQ5XXmpwbVuZw30/Dt6F6SF7l0TLqw3E6RzfhME++e9e50SYskP+6P2kmzuTPNjHmuyzCp0uBbSHXj4kt1xKanWSaF5AX7GxMnPW6HzcVica+1ngSbD9LnVcIsGr1Vnwdh6L+u1ebHEzp/tKU7zc7R3kqB63b+ylaDoDxYIwEXAQnaU12LXu4b0c0spEDlsHN3X304+8SO+0OIOrfoO0IefDp58+7P83fkle5hc0Sj/rA/DDSsnS+56mz0pnnOXGz7em+A24Da/2+k//YbaY0oHu/8wBRcBk4Jzbla08F0/+U0iyAnvoinsFqRz8+2qGsSf6nQEtnMIrjlVlKHBKqJWsgmDLvBJXVo04BHF7Q/qRdVg/57DFtHrcUrIdD4b+p2Ke3s9PwCIkjWr7tSp2Rj+YJefnwBMVzCJYRXInlo3hQ8zIsFV/MqQCs0folpeOXzXZq6CTS1/uigM1fLTpS7/NWkQn8psQcNfqOW/ojL3zfqzcpXDda1bbXpCGd1Xf8LTwfpAA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:a}=s;return a||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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,i.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,i.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template ."]}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsxs)(s.strong,{children:["Upload you pdf in ",(0,i.jsx)(s.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]})}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"stamp"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(d.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(d.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.80043bf4.js b/assets/js/bbdfc22d.80043bf4.js new file mode 100644 index 000000000..9d1550c34 --- /dev/null +++ b/assets/js/bbdfc22d.80043bf4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),r=a(58219),t=(a(62316),a(51039)),n=a.n(t),m=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),o=a(9472),p=a(85162);const h={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:"eJztV91v2zYQ/1e4e1oDxV9x00IYhn53QYslWFzswTECSjpJTCSSJSk7nqH/fTjKsmUnTeai2Mv2ksjHu+N98X53K3A8sxBOYYKlLrhDC7MAErSxEdoJJSGESY6sPWZvDXKis9cXZ4wXhVpYVlk0ljnFYjpEFlfWqVL8xaMCmWsVB2yRizhnFs0cGbcsKirURkhnWaoMy1Ci4U7IjCUqrkqkg4VwOdMGE0yFxIRZZ6rYVQZtj33RSjJbxTFam1bF5qbGDKFkwFyO3lCDrjLSMs4qKb5WyI6OWu5rkRwdMZdzx2IuWYTkTkLerA3CjjkRpzMlvWKrMRapIOa1rh67klfyiy4UT9hSVUwnKROSTROMqoxdvPsw+zl3Ttuw3+da95RGaUUmCx7ZXqzKPgmWaZ9opYiN4lr3vaxO0mcsR4NeLRmaGL5gC5Fk6CzjMmGx0ksWq2NlRCK5w4BpniGTVRmhYSolm8se44VVGyVehpw6HRPHxbsPvSsJASjtU6HkWQIhNGltnYQADH6t0Lo3KllCuIJYSYfS0SfXuhCxF+3fWCqfFdg4x5LTl1tqhBBUdIOxgwC0oYucQEunqSiww2WdETKDAFJlSu4ghMZQCADveKmJeU1iKGOVYMK8ijoAJ9wTujaUrS7rPzbJJD1Sue9V40Xrvbf0XZq6GuoAqDjQ2I4ybgxfQgDCYWmfjrNRh8cmRkV3Y8lFcajsjcII8VVDoDL3keXlwUbcKGQR+qjqXMmD5Yejk+FoeDIckYb10/n+MDanB2bU8VJ7+3nWFW4eaVd4Q9kID+sA7g6UGY3HdQDLA6Ve0FWLA4VOXtYB5AcKjU/r7Wvd6zPXkUqW122a6qcY22fxFGPDQB1MGEwgdKZCT7BaSdukdjQY0L89GNyBF8KiDfQUy58g+FFtsCFT471fW9tKepOPfrNalnFO5VSitbsV9YDIEw504yZkISRet0G5Hg0G188pcnUA44eCc6lKdDlh9wKlYwujZBYwXSC3yJxZMp5xIRldb35grNAYZR73+jDLHgvCeDC4Hm6C8Px+EM7knBci8RPHRN2i/Hc97V7vmuvJ1LvSd+ym4YJomPw57DjbpTdOWowrI9wSwukK7o65FsfNeTid1TOqOpcrGhC0st5i7nIIoX9vXvAjH0HWdAWVKSCER6cgrkV/PoQ62Oe2jmdCZsePSs22hl9ScJv47Zi/bflafELq+evodLkCEJTUHHmCxkeScvbHdvR530a+HV0enEa2Id6fL9rxYmdi2B++H5gBOiPAtEVzD9AbfH4AcjcutiC6wdAOLHZQcdqpNMKsFrKGHoRG47GHlRdDDxQnL33rH5/Ws3pWU+BS5aO89vxco7wUWbM0zIf3nJzkwjJh/XE7bDdbBi0Ge9K7QzgdEv2kN2wH8uaFNbM4vX4a6Gk/KIS8teGVPGbT8zQVseAF+xMjKxxux/LFYnGvtJ55mY/C5VXEDGq1Zc880ddfV2rz4xnlH01pz9NLNHMR47qcv3FV3zP3132Dx75vtFldk17tC9E7LkSM0mLnpb/+ePGZzdlJbwBB5x39A6P7n8/evv/98j3ppXfbJGnYG/QGfnZR1pVcdq562+x9k21l7029myb4/zL531sm133E4Z3r64ILjzu+IFdryJjur5izAHLClHAKqxWp/GKKuiby1woNAdIsgDk3gqrCw1HQNmrqXLe4pKpsiu54QvcTe1E1PX8PhQlnGonXcYzaPcrbhb2L88sJBBCt1+BSJSRj+IJWZL6AEK7gCvw6TRqa5Yv7wbrgMqt8Q4VGL+ELr1y+C063HpzWH52ezOWyY+UuajWu0F9y7EGBX6iMP+Hy1w17c/JNgXVsW25K4ayu678BOyFOAQ==",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:"eJztV91v2zYQ/1e4e1oDxV9x00IYhn53QYslWFzswTECSjpJTCSSJSk7nqH/fTjKsmUnTeai2Mv2ksjHu+N98X53K3A8sxBOYYKlLrhDC7MAErSxEdoJJSGESY6sPWZvDXKis9cXZ4wXhVpYVlk0ljnFYjpEFlfWqVL8xaMCmWsVB2yRizhnFs0cGbcsKirURkhnWaoMy1Ci4U7IjCUqrkqkg4VwOdMGE0yFxIRZZ6rYVQZtj33RSjJbxTFam1bF5qbGDKFkwFyO3lCDrjLSMs4qKb5WyI6OWu5rkRwdMZdzx2IuWYTkTkLerA3CjjkRpzMlvWKrMRapIOa1rh67klfyiy4UT9hSVUwnKROSTROMqoxdvPsw+zl3Ttuw3+da95RGaUUmCx7ZXqzKPgmWaZ9opYiN4lr3vaxO0mcsR4NeLRmaGL5gC5Fk6CzjMmGx0ksWq2NlRCK5w4BpniGTVRmhYSolm8se44VVGyVehpw6HRPHxbsPvSsJASjtU6HkWQIhNGltnYQADH6t0Lo3KllCuIJYSYfS0SfXuhCxF+3fWCqfFdg4x5LTl1tqhBBUdIOxgwC0oYucQEunqSiww2WdETKDAFJlSu4ghMZQCADveKmJeU1iKGOVYMK8ijoAJ9wTujaUrS7rPzbJJD1Sue9V40Xrvbf0XZq6GuoAqDjQ2I4ybgxfQgDCYWmfjrNRh8cmRkV3Y8lFcajsjcII8VVDoDL3keXlwUbcKGQR+qjqXMmD5Yejk+FoeDIckYb10/n+MDanB2bU8VJ7+3nWFW4eaVd4Q9kID+sA7g6UGY3HdQDLA6Ve0FWLA4VOXtYB5AcKjU/r7Wvd6zPXkUqW122a6qcY22fxFGPDQB1MGEwgdKZCT7BaSdukdjQY0L89GNyBF8KiDfQUy58g+FFtsCFT471fW9tKepOPfrNalnFO5VSitbsV9YDIEw504yZkISRet0G5Hg0G188pcnUA44eCc6lKdDlh9wKlYwujZBYwXSC3yJxZMp5xIRldb35grNAYZR73+jDLHgvCeDC4Hm6C8Px+EM7knBci8RPHRN2i/Hc97V7vmuvJ1LvSd+ym4YJomPw57DjbpTdOWowrI9wSwukK7o65FsfNeTid1TOqOpcrGhC0st5i7nIIoX9vXvAjH0HWdAWVKSCER6cgrkV/PoQ62Oe2jmdCZsePSs22hl9ScJv47Zi/bflafELq+evodLkCEJTUHHmCxkeScvbHdvR530a+HV0enEa2Id6fL9rxYmdi2B++H5gBOiPAtEVzD9AbfH4AcjcutiC6wdAOLHZQcdqpNMKsFrKGHoRG47GHlRdDDxQnL33rH5/Ws3pWU+BS5aO89vxco7wUWbM0zIf3nJzkwjJh/XE7bDdbBi0Ge9K7QzgdEv2kN2wH8uaFNbM4vX4a6Gk/KIS8teGVPGbT8zQVseAF+xMjKxxux/LFYnGvtJ55mY/C5VXEDGq1Zc880ddfV2rz4xnlH01pz9NLNHMR47qcv3FV3zP3132Dx75vtFldk17tC9E7LkSM0mLnpb/+ePGZzdlJbwBB5x39A6P7n8/evv/98j3ppXfbJGnYG/QGfnZR1pVcdq562+x9k21l7029myb4/zL531sm133E4Z3r64ILjzu+IFdryJjur5izAHLClHAKqxWp/GKKuiby1woNAdIsgDk3gqrCw1HQNmrqXLe4pKpsiu54QvcTe1E1PX8PhQlnGonXcYzaPcrbhb2L88sJBBCt1+BSJSRj+IJWZL6AEK7gCvw6TRqa5Yv7wbrgMqt8Q4VGL+ELr1y+C063HpzWH52ezOWyY+UuajWu0F9y7EGBX6iMP+Hy1w17c/JNgXVsW25K4ayu678BOyFOAQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create Template"})}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,l.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,l.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,l.jsxs)(s.p,{children:["Upload you pdf in ",(0,l.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"stamp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(r.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Template created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.1615d374.js b/assets/js/bfe4b778.1615d374.js deleted file mode 100644 index cc0c42433..000000000 --- a/assets/js/bfe4b778.1615d374.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mwYAlhkFLJ4sNRbIkZccw9N+HoyRbdpysGbrtiyGR9/Y8d7o7r8HzuYPkGt7otCpReQeTCDJ0qRXGC60ggcsC2ZXJuEfWSbGz8TnjUuqlY5VD65jXrNSZyFeMq4xVjbgvkGXouZCO6Zxx5gymIhcpy1pDQ4hAG7ScfJ1nkECj2jmCCAy3vESPluJcg+IlQgKdganIIAJBcRruC9gP/vwNeQ6BdLH7gnumELMQ9QzbaMmOxW+VsJhB4m2FETi/kuTNidJIhAjwzkidISQ5l44E0gJLDska/MoESW+FmkMEubYl99uTup409tH5Vzpbkc5uqGOrFyJDNkOpl2wDm4Ls+MTSSO7RsWfcM4nceaYV9mQ7AM8hglQrTxQma+DGSJEGkkdfHXlb3w9dz75iGhi3lBIv0NFtQ/jfAyRyeKApARceNpRDHYHS/slmxgQRmcWFwGUoLCfmivlCuB3bOzw+zcWmKvo2atKRGVqqyKfZe/XVzfjxrNBjqOsIvPA7bqa9up3OqAzqmuQsOqOVaxg/juP71bH59NpqZa5KU3Qur6Rc/fTj0t0cHwa+hclddvzejU/fGyKrDenMP650HB+fDI7iQfzz5dHL5PSX5MXLYRzHf0IEd6Xc1hqQNeizF957B0JJoXDasTY9juPpSUvl6SH22koy7Se24FJkLBcoM0Y+3Q8kEK3V9h9W+iPxPQafIHfgTx8pHaU9y3Wlsv8b7qGIHgd4Oj3dQHxxH+K5aiijuXSpb1H9Fwi3ePrufeOeQt2tatEIhXvYAds/b0A6TCsr/CqMvLsBN2LQ3CfXExokJfpC07g0VTMjfQEJjLruMlr3+kwNZM8uuglaWQkJFN4bl4xGzvO5UPMBN2aoDSrqsJLP3DDV5YgbMVocAXnsIrog1hpiduLa0MON+IAriDrYfal2UhfIM7SBIkrGl+1UfNtRumFtf5R0k+T7hsP+OnCw3fe7/U4Dp3BzHbC1ufpsUF2QG8r04uie/UvyLly47nyFqmO5tmxPm824w4xpFfYTuqTzk+HRZk8KqkN2o27UhS6Rdq28kkwKdeuSGzVg15/zXKSCS/YHzpzwOHnWJXa5XN5L6POg8074opoxi0ZvxefhMGS9r7V5oY3Coy3d5/wC7UKk2BbRA65GQXjUfoY8DZ8hllxQ8bVHv+8rEeVSpKhcvwTO3o0/spNhDFGvdr8j5NHH89dvP128JatU/U2KjobxMKYjo50vueo52tty97O73naUf30pbj8mj3d+ZCQXoWME9Ov2a7+GXpUn/X14EkGhnSeR9Zpq7MrKuqbjbxVa6imTCBbcCj6jor5eQyYcPWebvfZB3M++dBsme9pqfRBQ1zIU9YsFlxW9QQS3uNrb8etJHXV9gyJuJF43cQ0uyc7Wwr1uX0edxlmaovGPyvbb6/jqEiKYtft6GVZ/sHxJ/xX4EhK4gRsI/2HIQOiK4XwNkqt5xeck35ilbscryly/Vd6GVtk+ELCDlOz20AYJ/RKugwq/Ui1+wNVvG/Hm5kGFltpOmtIzqev6L9WI3mE=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mwYAlhkFLJ4sNRbIkZccw9N+HoyRbdpysGbrtiyGR9/Y8d7o7r8HzuYPkGt7otCpReQeTCDJ0qRXGC60ggcsC2ZXJuEfWSbGz8TnjUuqlY5VD65jXrNSZyFeMq4xVjbgvkGXouZCO6Zxx5gymIhcpy1pDQ4hAG7ScfJ1nkECj2jmCCAy3vESPluJcg+IlQgKdganIIAJBcRruC9gP/vwNeQ6BdLH7gnumELMQ9QzbaMmOxW+VsJhB4m2FETi/kuTNidJIhAjwzkidISQ5l44E0gJLDska/MoESW+FmkMEubYl99uTup409tH5Vzpbkc5uqGOrFyJDNkOpl2wDm4Ls+MTSSO7RsWfcM4nceaYV9mQ7AM8hglQrTxQma+DGSJEGkkdfHXlb3w9dz75iGhi3lBIv0NFtQ/jfAyRyeKApARceNpRDHYHS/slmxgQRmcWFwGUoLCfmivlCuB3bOzw+zcWmKvo2atKRGVqqyKfZe/XVzfjxrNBjqOsIvPA7bqa9up3OqAzqmuQsOqOVaxg/juP71bH59NpqZa5KU3Qur6Rc/fTj0t0cHwa+hclddvzejU/fGyKrDenMP650HB+fDI7iQfzz5dHL5PSX5MXLYRzHf0IEd6Xc1hqQNeizF957B0JJoXDasTY9juPpSUvl6SH22koy7Se24FJkLBcoM0Y+3Q8kEK3V9h9W+iPxPQafIHfgTx8pHaU9y3Wlsv8b7qGIHgd4Oj3dQHxxH+K5aiijuXSpb1H9Fwi3ePrufeOeQt2tatEIhXvYAds/b0A6TCsr/CqMvLsBN2LQ3CfXExokJfpC07g0VTMjfQEJjLruMlr3+kwNZM8uuglaWQkJFN4bl4xGzvO5UPMBN2aoDSrqsJLP3DDV5YgbMVocAXnsIrog1hpiduLa0MON+IAriDrYfal2UhfIM7SBIkrGl+1UfNtRumFtf5R0k+T7hsP+OnCw3fe7/U4Dp3BzHbC1ufpsUF2QG8r04uie/UvyLly47nyFqmO5tmxPm824w4xpFfYTuqTzk+HRZk8KqkN2o27UhS6Rdq28kkwKdeuSGzVg15/zXKSCS/YHzpzwOHnWJXa5XN5L6POg8074opoxi0ZvxefhMGS9r7V5oY3Coy3d5/wC7UKk2BbRA65GQXjUfoY8DZ8hllxQ8bVHv+8rEeVSpKhcvwTO3o0/spNhDFGvdr8j5NHH89dvP128JatU/U2KjobxMKYjo50vueo52tty97O73naUf30pbj8mj3d+ZCQXoWME9Ov2a7+GXpUn/X14EkGhnSeR9Zpq7MrKuqbjbxVa6imTCBbcCj6jor5eQyYcPWebvfZB3M++dBsme9pqfRBQ1zIU9YsFlxW9QQS3uNrb8etJHXV9gyJuJF43cQ0uyc7Wwr1uX0edxlmaovGPyvbb6/jqEiKYtft6GVZ/sHxJ/xX4EhK4gRsI/2HIQOiK4XwNkqt5xeck35ilbscryly/Vd6GVtk+ELCDlOz20AYJ/RKugwq/Ui1+wNVvG/Hm5kGFltpOmtIzqev6L9WI3mE=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Document"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.8a6fea27.js b/assets/js/bfe4b778.8a6fea27.js new file mode 100644 index 000000000..a935e7e3e --- /dev/null +++ b/assets/js/bfe4b778.8a6fea27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/e2a6fad1.137eb6e8.js b/assets/js/e2a6fad1.137eb6e8.js deleted file mode 100644 index 34792c6fc..000000000 --- a/assets/js/e2a6fad1.137eb6e8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>g,toc:()=>b});var i=s(85893),r=s(11151),t=s(58219),n=(s(62316),s(51039)),l=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const h={id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v4zYM/lc4Pa2FE6e92x6MYditvTsUd1gLtIc9pEFOsWlbV1nSSXJ+LPD/PlC2E6dNiw7Y07CX1qFIivz4kdSWeV44lkzZpU7rCpV3bBaxDF1qhfFCK5awuxLhwiL3CL0WvLu5Ai6lXjmoHVoHXkOBCi1pKVxB1vuDxQaM1UuRCVVAxj0HX1pdFyV8rWrpheHWx7m21YgOv47hrhQOcolrsZAIFfpSZ/1lubbgSwShUlk7oRXoHJbcCl27zvnGoIug4g90n/DgauE5eSJbDiuRIViuCiTTPkxIKUHy51JU5M+N79W9Oj39YqTmGWx0DSbLQSiYZrioC7i5/DD7sfTeuCSOneeFUMWIGzPWBpUThZJ84caprmJyUOUxySqRWs2NiYMPk+UnUKLF4D7lCjLLVxRigd4BVxmk2mwg1SNtRaa4xwgMLxBUXS3QUga+xGoMXDq9cxJsFtzhz29J4+byw+npvWIR04YKJLS6yljCQsrYI7ASvlwIxe2GRczi9xqd/11nG5ZsWaqVR+Xp80jJSOzSEqvwRabCYkakyoVEFjFKHK1jEfPCSySGUZVYwvTiG6aeRcxYis0LdOQj2CXbXst5K1TBIkZXcs8S1gXa9B6f6DaPSHzkXGl/3LAP96UAuLU83J9rmaElPI95QpXNseJCDo4XWkvkVA5c88pQ9N7W2EQsaM5d3YJy5PrDvryondcVkBF0RoHjFD/3tUXoysh2vhddQV/l+IkfCE6AnIzhgqu2CzMMHZlr6lDqOdhue1LNQ3maBrZbwgLtXPEKmybaC8jlgcCUWnUqFlMUywOrnQj3hjvZwBTXRtjNPOO+E6S6MlxthgGIQglVzGsrm2bMmj2bnm2NFsCGVPc876pn0RmtXMvg88mE/h3ienkwbDADV6cpOpfXUm5+YNGwz7gxUqShWeNvrqXwvslebp9WfIyTAwbvJDsWsvKbOP9rnS7Pb4gxtZX/2EE3DWsrR16PCOBRDyJNwgOMhZJC4byHbX4+mczPCNsmYm8nPz2F70otuRRZ2D13+gHVvwgZWqvtsXT3yQ2v9+31FOq6CjARrUJSQSmcs4Nkh/I2SYdpbYXfsGS6ZesRN2LUnifTWTOLWLv5WMKMdiFi7kuWsPiFue3QLsPomm7b+rFXLShuRLw8Y3RpH9QtAddicxDaDiFuxCekO7vMh1oRE1SwEnmGNqAkVK6DcYfHtUF1KwoV0FyePRlB4Q0gXDjuM233M024R9Zh12WgVRhEdEjyN+MzcAZTkXekGANt9FtdIb1Z8lqCFOrBJfdqBNPrPBep4BL+xIUTHverfbVaPUHsJNh8FL6sF2DR6L16EYQB1qHV7scJrUG0lbvOb9EuRdo3zjNXxUE57qjO28XQ7ZRe9NtjI6KeFCkqhwNyvvt48xnejCcsGpDjFSHHn68u3v9x+568Er3aEp2NJ+MJiYieFVeDix6/FnOrK9iR9NFi3nXw/w/N/8xDs5sRHtc+NpILNVgo7RibPv/8nEWspImXTNl2S96/0IIm8fcaLY3LWcSoFAR2GJZRP2po7j3ghijYsmp0R5GQuqwpomPP1ybqjd6lKRo/UH+yUg7m8s317R2LWP+oqnRGNuQ4+I32n22QvKbMhxP0IUzQ7oOC74/UZhDF4WhtQ6W/FPhRg1+oaz7h5tedenvyrEEHX69N9Zo1TfM3nU39ng==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVt9v4zYM/lc4Pa2FE6e92x6MYditvTsUd1gLtIc9pEFOsWlbV1nSSXJ+LPD/PlC2E6dNiw7Y07CX1qFIivz4kdSWeV44lkzZpU7rCpV3bBaxDF1qhfFCK5awuxLhwiL3CL0WvLu5Ai6lXjmoHVoHXkOBCi1pKVxB1vuDxQaM1UuRCVVAxj0HX1pdFyV8rWrpheHWx7m21YgOv47hrhQOcolrsZAIFfpSZ/1lubbgSwShUlk7oRXoHJbcCl27zvnGoIug4g90n/DgauE5eSJbDiuRIViuCiTTPkxIKUHy51JU5M+N79W9Oj39YqTmGWx0DSbLQSiYZrioC7i5/DD7sfTeuCSOneeFUMWIGzPWBpUThZJ84caprmJyUOUxySqRWs2NiYMPk+UnUKLF4D7lCjLLVxRigd4BVxmk2mwg1SNtRaa4xwgMLxBUXS3QUga+xGoMXDq9cxJsFtzhz29J4+byw+npvWIR04YKJLS6yljCQsrYI7ASvlwIxe2GRczi9xqd/11nG5ZsWaqVR+Xp80jJSOzSEqvwRabCYkakyoVEFjFKHK1jEfPCSySGUZVYwvTiG6aeRcxYis0LdOQj2CXbXst5K1TBIkZXcs8S1gXa9B6f6DaPSHzkXGl/3LAP96UAuLU83J9rmaElPI95QpXNseJCDo4XWkvkVA5c88pQ9N7W2EQsaM5d3YJy5PrDvryondcVkBF0RoHjFD/3tUXoysh2vhddQV/l+IkfCE6AnIzhgqu2CzMMHZlr6lDqOdhue1LNQ3maBrZbwgLtXPEKmybaC8jlgcCUWnUqFlMUywOrnQj3hjvZwBTXRtjNPOO+E6S6MlxthgGIQglVzGsrm2bMmj2bnm2NFsCGVPc876pn0RmtXMvg88mE/h3ienkwbDADV6cpOpfXUm5+YNGwz7gxUqShWeNvrqXwvslebp9WfIyTAwbvJDsWsvKbOP9rnS7Pb4gxtZX/2EE3DWsrR16PCOBRDyJNwgOMhZJC4byHbX4+mczPCNsmYm8nPz2F70otuRRZ2D13+gHVvwgZWqvtsXT3yQ2v9+31FOq6CjARrUJSQSmcs4Nkh/I2SYdpbYXfsGS6ZesRN2LUnifTWTOLWLv5WMKMdiFi7kuWsPiFue3QLsPomm7b+rFXLShuRLw8Y3RpH9QtAddicxDaDiFuxCekO7vMh1oRE1SwEnmGNqAkVK6DcYfHtUF1KwoV0FyePRlB4Q0gXDjuM233M024R9Zh12WgVRhEdEjyN+MzcAZTkXekGANt9FtdIb1Z8lqCFOrBJfdqBNPrPBep4BL+xIUTHverfbVaPUHsJNh8FL6sF2DR6L16EYQB1qHV7scJrUG0lbvOb9EuRdo3zjNXxUE57qjO28XQ7ZRe9NtjI6KeFCkqhwNyvvt48xnejCcsGpDjFSHHn68u3v9x+568Er3aEp2NJ+MJiYieFVeDix6/FnOrK9iR9NFi3nXw/w/N/8xDs5sRHtc+NpILNVgo7RibPv/8nEWspImXTNl2S96/0IIm8fcaLY3LWcSoFAR2GJZRP2po7j3ghijYsmp0R5GQuqwpomPP1ybqjd6lKRo/UH+yUg7m8s317R2LWP+oqnRGNuQ4+I32n22QvKbMhxP0IUzQ7oOC74/UZhDF4WhtQ6W/FPhRg1+oaz7h5tedenvyrEEHX69N9Zo1TfM3nU39ng==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},x={},b=[{value:"Request",id:"request",level:2}];function j(e){const a={a:"a",code:"code",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from binary"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,i.jsx)(a.p,{children:(0,i.jsxs)(a.strong,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]})}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"signers",required:!0,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/e2a6fad1.d07ecd06.js b/assets/js/e2a6fad1.d07ecd06.js new file mode 100644 index 000000000..cb082075a --- /dev/null +++ b/assets/js/e2a6fad1.d07ecd06.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>p,default:()=>x,frontMatter:()=>h,metadata:()=>g,toc:()=>y});var i=s(85893),r=s(11151),t=s(58219),n=(s(62316),s(51039)),l=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),u=s(85162);const h={id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v4zYM/lc4vdwOcOK0t+0hGIbdej9Q3GEt0B72kAY52aZtXWVJJ8lJvcD/+0DZTpw0LW7Ynoa9tAlFUtRH8iOzZZ4Xjs0X7I1O6wqVd2wZsQxdaoXxQis2Z7clwoVF7hEGLXh9fQlcSr1xUDu0DryGAhVa0lK4gWzwB0kDxuq1yIQqIOOegy+trosSPle19MJw6+Nc22pCh5+nd+pOfTJS8wwaXYPJchAKFhkmdQHXb94tvy+9N24ex87zQqhiws1UG1ROFEryxE1TXcVkX+UxySqRWs2NiYMLk+UvoUSLwXvKFWSWb2AjsgK9A64ySLVpINUTbUWmuMcIDC8QVF0laEHn4EuspsCl0zsnwSbhDn/6gTSu37y7Uyxi2hAkQqvLjM1ZGlAcoNkIXyZCcduwiFn8WqPzv+msYfMtS7XyqDx9PAESiV1aYhU+kamwmFEacyGRRYyejdaxiHnhJVJOfWOQzZlOvmDqWcSMpdi8QEc+gt18O2g5b4UqWMToSu7ZnPWBtoPHR7rtUdmcOFfanzYcwn0uAG4tD/fnWmZoCc9TnlBlK6y4kKPjRGuJnNJxXNjCgeGWV+jRDvVMGfUanMFU5A1sSvQl2iDecOUheA8FnyA4agbS7l4wBWqWDHNeSw9rLmsE4eCOeVvjHZvCZSie/iRU0kEII91QiUrDi3DfytUhcS/i/nuis+bF3tIBt9jHLDDbhRCUwWNlJPfoYCOkpLhrh9k0VCg+8MpQQunaNmIH153KyCGGF7XzuoJwTW8EubYBEO5ri9BX9hQuuAKhUllnGEDINQFOrADb7dAUq1BebQvbLeUS7UrxCts22gvorgOBKbXqVSymKNYHVjsR7g13spEpPhhhm1XGfS9IdWW4asYBiEIJVaxqK9t2ynZoJX3XfhNUj5Dpk0RO/osg7SnjSf7rAGxJdU9mfT1adEYr19HU+WxG/w5x3Q2l3j24Ok3RubyWsvmORWMy5cZIkQZGjr+4jqf2TPo8R3biU8QzoqmdZNdXrPwizv98SNfn11QxtZV/20E/72orJ15PCODJACINuwOMhZJC4WqAbXU+m63OCNs2Yj/MfnwM36VacymyMNJv9T2qfxEytFbbU8/dP258ve+up1AfqgATlVV4VFAK5+zgsWN590iHaW2Fb9h8sWUPE27EpDufL5btMmIV+lLTNDbahYi5L9mcxc8MZ4d2HebTYtvlb5cSbk7sHtyIeH3G2uhYe7+wPGO13D/hhmDukDx4yA5PbsQHpAh7nMZaEROU3hJ5hjZgKlSug3GP3pVBdSMKFbBfn52ej8KF4wGXUAeB4Y+sw/KTgVaBtuiQ5K+mZ8NU6kpoCrTf3egqzKC8liCFunfzOzWBxVWei1RwCX9g4oTH/aq32WweIfYy2LwXvqwTsGj0Xr0IwgDr2Gr35SVtRmgrd5XfoF2LdGizJ66Kg3LcNwbvBmO/ZgyiX4+NqFClSFE5HJXy6/fXH2ENr6YzFo3K4xuCjj9eXrz9/eYt+aVy7JJ0Np1NZySicq64Gl11vLTnVlewK+qjbW3X8f/v+/9g3+/70uODj43kQo0ovyOaxdO/ApYRK4mT5gu23ZLvTzRCSfy1RkuEtozYmlvBE+rfxbKNhvYmZrrHhpLe5XFyS5GQuqwpolO/IoigOqPXaYrGj9Qfkf4Bc15f3dyyiA1rT6UzsiHHwW+0/9gFyWt6+Zi17gNr9R8o+OFINaMoDumsC5X+UuAnDX6mOv2AzS879e7kSYMevkGb8rVs2/YveQhc7g==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},p=void 0,g={id:"API-docs/createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`.",source:"@site/docs/API-docs/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`.",sidebar_label:"Create Document from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztV99v4zYM/lc4vdwOcOK0t+0hGIbdej9Q3GEt0B72kAY52aZtXWVJJ8lJvcD/+0DZTpw0LW7Ynoa9tAlFUtRH8iOzZZ4Xjs0X7I1O6wqVd2wZsQxdaoXxQis2Z7clwoVF7hEGLXh9fQlcSr1xUDu0DryGAhVa0lK4gWzwB0kDxuq1yIQqIOOegy+trosSPle19MJw6+Nc22pCh5+nd+pOfTJS8wwaXYPJchAKFhkmdQHXb94tvy+9N24ex87zQqhiws1UG1ROFEryxE1TXcVkX+UxySqRWs2NiYMLk+UvoUSLwXvKFWSWb2AjsgK9A64ySLVpINUTbUWmuMcIDC8QVF0laEHn4EuspsCl0zsnwSbhDn/6gTSu37y7Uyxi2hAkQqvLjM1ZGlAcoNkIXyZCcduwiFn8WqPzv+msYfMtS7XyqDx9PAESiV1aYhU+kamwmFEacyGRRYyejdaxiHnhJVJOfWOQzZlOvmDqWcSMpdi8QEc+gt18O2g5b4UqWMToSu7ZnPWBtoPHR7rtUdmcOFfanzYcwn0uAG4tD/fnWmZoCc9TnlBlK6y4kKPjRGuJnNJxXNjCgeGWV+jRDvVMGfUanMFU5A1sSvQl2iDecOUheA8FnyA4agbS7l4wBWqWDHNeSw9rLmsE4eCOeVvjHZvCZSie/iRU0kEII91QiUrDi3DfytUhcS/i/nuis+bF3tIBt9jHLDDbhRCUwWNlJPfoYCOkpLhrh9k0VCg+8MpQQunaNmIH153KyCGGF7XzuoJwTW8EubYBEO5ri9BX9hQuuAKhUllnGEDINQFOrADb7dAUq1BebQvbLeUS7UrxCts22gvorgOBKbXqVSymKNYHVjsR7g13spEpPhhhm1XGfS9IdWW4asYBiEIJVaxqK9t2ynZoJX3XfhNUj5Dpk0RO/osg7SnjSf7rAGxJdU9mfT1adEYr19HU+WxG/w5x3Q2l3j24Ok3RubyWsvmORWMy5cZIkQZGjr+4jqf2TPo8R3biU8QzoqmdZNdXrPwizv98SNfn11QxtZV/20E/72orJ15PCODJACINuwOMhZJC4WqAbXU+m63OCNs2Yj/MfnwM36VacymyMNJv9T2qfxEytFbbU8/dP258ve+up1AfqgATlVV4VFAK5+zgsWN590iHaW2Fb9h8sWUPE27EpDufL5btMmIV+lLTNDbahYi5L9mcxc8MZ4d2HebTYtvlb5cSbk7sHtyIeH3G2uhYe7+wPGO13D/hhmDukDx4yA5PbsQHpAh7nMZaEROU3hJ5hjZgKlSug3GP3pVBdSMKFbBfn52ej8KF4wGXUAeB4Y+sw/KTgVaBtuiQ5K+mZ8NU6kpoCrTf3egqzKC8liCFunfzOzWBxVWei1RwCX9g4oTH/aq32WweIfYy2LwXvqwTsGj0Xr0IwgDr2Gr35SVtRmgrd5XfoF2LdGizJ66Kg3LcNwbvBmO/ZgyiX4+NqFClSFE5HJXy6/fXH2ENr6YzFo3K4xuCjj9eXrz9/eYt+aVy7JJ0Np1NZySicq64Gl11vLTnVlewK+qjbW3X8f/v+/9g3+/70uODj43kQo0ovyOaxdO/ApYRK4mT5gu23ZLvTzRCSfy1RkuEtozYmlvBE+rfxbKNhvYmZrrHhpLe5XFyS5GQuqwpolO/IoigOqPXaYrGj9Qfkf4Bc15f3dyyiA1rT6UzsiHHwW+0/9gFyWt6+Zi17gNr9R8o+OFINaMoDumsC5X+UuAnDX6mOv2AzS879e7kSYMevkGb8rVs2/YveQhc7g==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",code:"code",h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from binary"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),"."]}),"\n",(0,i.jsxs)(a.p,{children:["Upload you pdf in ",(0,i.jsx)(a.a,{href:"https://staging-ap.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!0,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"signers",required:!0,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function x(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.a10c7ea2.js b/assets/js/f0ff4a36.a10c7ea2.js deleted file mode 100644 index a05ffc04a..000000000 --- a/assets/js/f0ff4a36.a10c7ea2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),c=(s(82723),s(9487)),m=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZZfkm7CMDTYsixrsRRLigFLjICSzhYTiWRJyolh6L8PR0m2bMdLA2z5YovHe3uO97YCx+cWohv4RSVlgdJZmAaQok2M0E4oCRFcZ8jO0bGWhZ1+vmAoeZyjZUtVMqeYQWcELpCl6LjILeOxKh3jzGpMxEwkLG2k+xCA0mg4ab9IIYI5uvYSAtDc8AIdGnJrBZIXCBG0DHcihQAEuaW5y2DXVxXfY+IuUqZma38hAINfS2EwhciZEgOwbpmTWisKnSMEgE86VylCNOO5JYYkw4JDtAK31J7TGSHnEMBMmYK7LgWfuNcSgf5tGGfJKNMxVNWUzFqtpEVLikZhSH/b/toySdDaWZmzdVAggERJR55HK+Ba5yLxF4N7S0Krfe9q2BQ9Q2qcqE220Xgtjl/PxcNoHGdffocqgJkg4us0ZM5pGw0GDaU0eT9RBWlzwr1enfUflEOkQir3ag06R26RWTGX61T04FSeonmrUNbZ/DoNtYfMi1abAG5KooFQBaAe5RaWb9J/r5DFiCRP0fGFt9bAjeFLqjiHhX05SofwPWsNCy7yF7ljxA8NoU0hnSn5gpnJ8cloOP7+/XArZA4LnXOHd1cNULpMDHKH6an7d42jcDTuDcNe+P56eBJNfoiOT/phGP4NATwV+QY8pNwhdN+pOZc6fQM71R5bJ9l3UweqigQm4WS/M627vVSOzVQp0+/+u8aExqhnE3UTh+fsd99SyFxIvGtb7N0knNyN14CO9wFdyAXPReqn17V6QPm2eLrmXW1+/7FEzeTvYQtsl16DtJiURrilH5NPPa5Fr76PbqY0fAp0mWrmq5+rLoMIBu3bD1admVoB6TOLduqWJu80cev4XMh5j2vdVxoltYmcx5bqccC1GCyGQBZbj64oanVgtvzadBUtPiK1lQZ2l6uZ7hly39QqOs+UF26CcalRUgH7UC6GezvAdSYsE9Zftxj9s7KZMmxHmsXcYsqUZC5Df0n0cX+43ly8aJ/dylt5pQpkpUUa17mQDza6lT12czmbiUTwnP2FsRUOp+/ayD0+Pu5F7MjLnAuXlTEzqNWGfe6JPqxdqfXhCAJwaAp7ObtCsxBJO2oPmBp45kGT5zzxed603Zb0YVeI8i4XCUqLncw8Pf/8iY37IQSd5PgGlwefLn4+++PqjLRSetVPNOyH/dC3cmVdwWXHUHfT3H3a1aZe/4ettElOh09uoHMufAV6sKumem6gs6hG3Z10GkCmrCOW1YpS6ovJq4rIX0s0VKPTABbcCPLPl1gqLH2n65XzINJ3fzbb6xE7sN4+63lba5IKbcHzkk4QwAMudxbqaloFbcGRazXHaZKgdh3ZvQa51WXOz64hAF5SnLqF/uALvfkg7c/6td0BagfotwoOCPxIz/0Rlz+t2eubgwINvpabYjStquofRhtqEg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZZfkm7CMDTYsixrsRRLigFLjICSzhYTiWRJyolh6L8PR0m2bMdLA2z5YovHe3uO97YCx+cWohv4RSVlgdJZmAaQok2M0E4oCRFcZ8jO0bGWhZ1+vmAoeZyjZUtVMqeYQWcELpCl6LjILeOxKh3jzGpMxEwkLG2k+xCA0mg4ab9IIYI5uvYSAtDc8AIdGnJrBZIXCBG0DHcihQAEuaW5y2DXVxXfY+IuUqZma38hAINfS2EwhciZEgOwbpmTWisKnSMEgE86VylCNOO5JYYkw4JDtAK31J7TGSHnEMBMmYK7LgWfuNcSgf5tGGfJKNMxVNWUzFqtpEVLikZhSH/b/toySdDaWZmzdVAggERJR55HK+Ba5yLxF4N7S0Krfe9q2BQ9Q2qcqE220Xgtjl/PxcNoHGdffocqgJkg4us0ZM5pGw0GDaU0eT9RBWlzwr1enfUflEOkQir3ag06R26RWTGX61T04FSeonmrUNbZ/DoNtYfMi1abAG5KooFQBaAe5RaWb9J/r5DFiCRP0fGFt9bAjeFLqjiHhX05SofwPWsNCy7yF7ljxA8NoU0hnSn5gpnJ8cloOP7+/XArZA4LnXOHd1cNULpMDHKH6an7d42jcDTuDcNe+P56eBJNfoiOT/phGP4NATwV+QY8pNwhdN+pOZc6fQM71R5bJ9l3UweqigQm4WS/M627vVSOzVQp0+/+u8aExqhnE3UTh+fsd99SyFxIvGtb7N0knNyN14CO9wFdyAXPReqn17V6QPm2eLrmXW1+/7FEzeTvYQtsl16DtJiURrilH5NPPa5Fr76PbqY0fAp0mWrmq5+rLoMIBu3bD1admVoB6TOLduqWJu80cev4XMh5j2vdVxoltYmcx5bqccC1GCyGQBZbj64oanVgtvzadBUtPiK1lQZ2l6uZ7hly39QqOs+UF26CcalRUgH7UC6GezvAdSYsE9Zftxj9s7KZMmxHmsXcYsqUZC5Df0n0cX+43ly8aJ/dylt5pQpkpUUa17mQDza6lT12czmbiUTwnP2FsRUOp+/ayD0+Pu5F7MjLnAuXlTEzqNWGfe6JPqxdqfXhCAJwaAp7ObtCsxBJO2oPmBp45kGT5zzxed603Zb0YVeI8i4XCUqLncw8Pf/8iY37IQSd5PgGlwefLn4+++PqjLRSetVPNOyH/dC3cmVdwWXHUHfT3H3a1aZe/4ettElOh09uoHMufAV6sKumem6gs6hG3Z10GkCmrCOW1YpS6ovJq4rIX0s0VKPTABbcCPLPl1gqLH2n65XzINJ3fzbb6xE7sN4+63lba5IKbcHzkk4QwAMudxbqaloFbcGRazXHaZKgdh3ZvQa51WXOz64hAF5SnLqF/uALvfkg7c/6td0BagfotwoOCPxIz/0Rlz+t2eubgwINvpabYjStquofRhtqEg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Document"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.f33dd953.js b/assets/js/f0ff4a36.f33dd953.js new file mode 100644 index 000000000..3a84bb4bf --- /dev/null +++ b/assets/js/f0ff4a36.f33dd953.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoA2ZYdJ92EYWiwZVnaYimWFAOWGAEtnS0mEsmSlB3D0H8fjpJs+SVJDWz5YkvkvT0P746nJTg+tRDdwm8qLnKUzsIogARtbIR2QkmI4CZFdoGONSLs7MslQ8nHGVq2UAVzihl0RuAMWYKOi8wyPlaFY5xZjbGYiJgltXYXAlAaDSfrlwlEMEXXbEIAmhueo0NDYS1B8hwhgkbgXiQQgKCwNHcpbMeqxg8Yu8uEqckqXgjA4LdCGEwgcqbAAKxbZGTWilxnCAHgk85UghBNeGZJIE4x5xAtwS20l3RGyCkEMFEm5669gk/cW4lA/9Efp/Eg1WMoyxG5tVpJi5YMDcKQ/jbjtUUco7WTImMrUiCAWElHkUdL4FpnIvYbvQdLSsvd6CrYxJ4hM05ULhs2DsXx+4V4HByP068foQxgImjxMAupc9pGvV69UpisG6ucrDnhDjdn/QPlEJmQyh1sQWfILTIrpnKVih6cyhI0b0Vllc2HWagiZF61XBO4LokaQhmAmssNLN9l/0EhGyOSPrHjC29lgRvDF1RxDnP7OkvP4dvrDXMuslelx4gf6oUmhXSq5Ctuhieng/7xj+/7G5Q5zHXGHd5f10BpMzbIHSZn7mWLg3Bw3OmHnfD9Tf80Gv4UnZx2wzD8BwJ4yrM1eEi4Q2ifU/1e6OQN/JQ7Yq1k304dKEtSGO7rTNcqR5cKOWVz6vlzo+Q0YHUZObNgfMqFZESn+eG/a1lojNqbwmuGDousff5CZkLifdOW74dheN9fkTDcJWF15Unl2EQVMnlbqPv8vwxoeH+8AnSyC+hSzngmEn+F36hHlG+Lp+3eVe53M1ZUQn4fNsC21yuQFuPCCLfws8JTh2vRqfaj2xHdwJQpqh4y/HDhUoig1xRAb9kaLEoge2bWjB6FyVo3Gde6qzRK6pEZH1tqRj2uRW/WhzLYlraOT4Wcdl7UGq3jvyaOKxo3UKwbsRafkDpxTVJbqh6IUuT+HijpfaK8ck3dlUZJPc8TP+vvjE03qbBMWL/dMOKTgE2UYVvabMwtJkxJ5lL0m7R+3O2vhj2v2mV38k5SsbLCIk04mZCPNrqTHXZ7NZmIWPCM/Y1jKxyO3jXMzefzHcaOvM6FcGkxZga1WotP/aKnta21ejmCABya3F5NrtHMRNxMJ8+46nnhXl0VPPZVUd9UzdKHbSXK0kzEKC228vjs4stnNmPH3RCCVnp8R9C9z5e/nv95fU52KR2rQ+p3w27o7z9lXc5ly1V7PN8+3OW6vv+HUb5OT4dPrqczLnzFerDLutpuoTXdR+1BfhRAqqwjkeWSkuqrycqSlr8VaKimRwHMuBEUny/JRFh6TlZz+rNI3/1Vj/xH7Jlvgr2RN9UmqdRmPCvoDQJ4xMXWV0g5KoOm5Ci0SuIsjlG7lu5OQ93oShfnNxAAL4indqk/+lKvH8j63rg2e0AVAP1SO9qr8DMd9ydc/LISr3aeVajxNdLE0agsy38BH6HWbA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoA2ZYdJ92EYWiwZVnaYimWFAOWGAEtnS0mEsmSlB3D0H8fjpJs+SVJDWz5YkvkvT0P746nJTg+tRDdwm8qLnKUzsIogARtbIR2QkmI4CZFdoGONSLs7MslQ8nHGVq2UAVzihl0RuAMWYKOi8wyPlaFY5xZjbGYiJgltXYXAlAaDSfrlwlEMEXXbEIAmhueo0NDYS1B8hwhgkbgXiQQgKCwNHcpbMeqxg8Yu8uEqckqXgjA4LdCGEwgcqbAAKxbZGTWilxnCAHgk85UghBNeGZJIE4x5xAtwS20l3RGyCkEMFEm5669gk/cW4lA/9Efp/Eg1WMoyxG5tVpJi5YMDcKQ/jbjtUUco7WTImMrUiCAWElHkUdL4FpnIvYbvQdLSsvd6CrYxJ4hM05ULhs2DsXx+4V4HByP068foQxgImjxMAupc9pGvV69UpisG6ucrDnhDjdn/QPlEJmQyh1sQWfILTIrpnKVih6cyhI0b0Vllc2HWagiZF61XBO4LokaQhmAmssNLN9l/0EhGyOSPrHjC29lgRvDF1RxDnP7OkvP4dvrDXMuslelx4gf6oUmhXSq5Ctuhieng/7xj+/7G5Q5zHXGHd5f10BpMzbIHSZn7mWLg3Bw3OmHnfD9Tf80Gv4UnZx2wzD8BwJ4yrM1eEi4Q2ifU/1e6OQN/JQ7Yq1k304dKEtSGO7rTNcqR5cKOWVz6vlzo+Q0YHUZObNgfMqFZESn+eG/a1lojNqbwmuGDousff5CZkLifdOW74dheN9fkTDcJWF15Unl2EQVMnlbqPv8vwxoeH+8AnSyC+hSzngmEn+F36hHlG+Lp+3eVe53M1ZUQn4fNsC21yuQFuPCCLfws8JTh2vRqfaj2xHdwJQpqh4y/HDhUoig1xRAb9kaLEoge2bWjB6FyVo3Gde6qzRK6pEZH1tqRj2uRW/WhzLYlraOT4Wcdl7UGq3jvyaOKxo3UKwbsRafkDpxTVJbqh6IUuT+HijpfaK8ck3dlUZJPc8TP+vvjE03qbBMWL/dMOKTgE2UYVvabMwtJkxJ5lL0m7R+3O2vhj2v2mV38k5SsbLCIk04mZCPNrqTHXZ7NZmIWPCM/Y1jKxyO3jXMzefzHcaOvM6FcGkxZga1WotP/aKnta21ejmCABya3F5NrtHMRNxMJ8+46nnhXl0VPPZVUd9UzdKHbSXK0kzEKC228vjs4stnNmPH3RCCVnp8R9C9z5e/nv95fU52KR2rQ+p3w27o7z9lXc5ly1V7PN8+3OW6vv+HUb5OT4dPrqczLnzFerDLutpuoTXdR+1BfhRAqqwjkeWSkuqrycqSlr8VaKimRwHMuBEUny/JRFh6TlZz+rNI3/1Vj/xH7Jlvgr2RN9UmqdRmPCvoDQJ4xMXWV0g5KoOm5Ci0SuIsjlG7lu5OQ93oShfnNxAAL4indqk/+lKvH8j63rg2e0AVAP1SO9qr8DMd9ydc/LISr3aeVajxNdLE0agsy38BH6HWbA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Document"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f864295c.27d8ad2d.js b/assets/js/f864295c.27d8ad2d.js deleted file mode 100644 index ab6db7d97..000000000 --- a/assets/js/f864295c.27d8ad2d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1344],{55833:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>j,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var t=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),l=s.n(r),c=(s(82723),s(9487)),m=(s(41429),s(5397)),d=s(4667),o=s(9472),p=s(85162);const h={id:"createtemplatewithbinary",title:"Create Template from binary",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.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v4zYQ/StTnhpDtpzsbg9CUTSb/Wiwi00AJ+jBMQKKGkncSCSXpOy4hv57MZRsK4mT5tBT0UsizxffPA4fuWGeF44lc3aFtam4R8cWEcvQCSuNl1qxhF2VCFs3nFnkZIfTy3PgVaVXDhqH1oHXIMiJIBrndS3/4mmF4LeFI1iVUpTg0C4RuIO0atBYqbyDXFsoUKHlXqoCMi2aGsmxkr4EYzHDXCrMwHnbCN9YdBO4NlqBa4RA5/Km2q3UwZBaReBLDEAt+sYqBxwaJX80CKPRNvpWZqMR+JJ7EFxBitRORt30gHAPZ3KjbtRodG0qzTNY6wZMloNUMM8wbQq4/PBp8XPpvXFJHDvPC6mKMTdmog0qJwtV8dRNhK5jKlDnMdlqKazmxsShhsnyIyjRYihPiDLLV7CSWYHeAVcZCG3WIPRYW5kp7jECwwsE1dQpWtA5dV1PgFdO74qEnJQ7/OUtRVx++DQa3SgWMW0C6VqdZyxh3QZuqSHyU6m4XbOIWfzRoPPvdbZmyYYJrTwqT591U3lpuPVxrm09zrjnZHaixDp8+bVBljCdfkfhWcSMpVW9REfeXFY4iHLeSlWwiFEx7lnCeghtxLz0h2LbRxN7wK+0P5xIO4DWvQiAW8vXrN0DeJan25ToaSmU+JIWM5Z422AwOKOV65o+mU7p36OD9mCAadp3w12tf2LRkHRuTCVF2Ln4u+u6fi3jnZk2/GnTeM9rE3p8X5784YyqRUk81egcLw5u1D7lHxoYMihVJRXebkm5PZlOb98Rc23E3k7fPSXnXC15JbNwnK/0Hap/kRC0VtuXWxsu77vlCep9XVGe4nXXVAgKfvag2aG9a9KhaKz0a5bMN+x+zI0cd/5kvmgXRLgvNZ1Jo11AzH3JEha/cESDstIszzessRVL2Ku0iBsZL48ZLboFNSPiOm4eQNsxxI38grRm3/kwKmKSNqxEnqENLEmV65Dc83FhUM1k0V0iy2P29MaRDqQL7q34drcOXRSPsoOsZaBVUHtykv3N5BicQSHzfigmQOI903UQeLovKqnuXHKjxjC/yHMpJK/gT0yd9LhX8dVq9YSxo5DzWfqyScGi0fvwIhgDrcOs3Y8jFjGPtnYX+QztUgrsd+mZpeIQHPejzkUYday5pN3tTb8/TqLRq6RA5XAwnKefL7/Cm8mURYPheAXk+Ov52cdvs49Ulcar26LjyXQyJRONZ83VYKGz7hWwE4Pc6hp2Q/pIqXcn+P9nxn/5mdHLhsd7H5uKyyCPYQw3vbLNn398LCJWkggmc7bZUPVrW7UtmX80aElBFxFbcitpEoJ+Rlv1ISm8wzVNZTdo4ytCQuFVQ4gOPV7aaJt0KgQaPwh/css8kOrLi9kVi1jav5FqnVEOFQ51o/1nB5I31PlQVO+CqPYfBH7rUusBiodq20GlvwT8YMKvNJ1fcP3bLrzzPJvQ07eNpv1atG37NwabR2E=",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/createtemplatewithbinary",title:"Create Template from binary",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.",source:"@site/docs/API-docs/createtemplatewithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplatewithbinary",permalink:"/docs/API-docs/createtemplatewithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplatewithbinary",title:"Create Template from binary",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.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v4zYQ/StTnhpDtpzsbg9CUTSb/Wiwi00AJ+jBMQKKGkncSCSXpOy4hv57MZRsK4mT5tBT0UsizxffPA4fuWGeF44lc3aFtam4R8cWEcvQCSuNl1qxhF2VCFs3nFnkZIfTy3PgVaVXDhqH1oHXIMiJIBrndS3/4mmF4LeFI1iVUpTg0C4RuIO0atBYqbyDXFsoUKHlXqoCMi2aGsmxkr4EYzHDXCrMwHnbCN9YdBO4NlqBa4RA5/Km2q3UwZBaReBLDEAt+sYqBxwaJX80CKPRNvpWZqMR+JJ7EFxBitRORt30gHAPZ3KjbtRodG0qzTNY6wZMloNUMM8wbQq4/PBp8XPpvXFJHDvPC6mKMTdmog0qJwtV8dRNhK5jKlDnMdlqKazmxsShhsnyIyjRYihPiDLLV7CSWYHeAVcZCG3WIPRYW5kp7jECwwsE1dQpWtA5dV1PgFdO74qEnJQ7/OUtRVx++DQa3SgWMW0C6VqdZyxh3QZuqSHyU6m4XbOIWfzRoPPvdbZmyYYJrTwqT591U3lpuPVxrm09zrjnZHaixDp8+bVBljCdfkfhWcSMpVW9REfeXFY4iHLeSlWwiFEx7lnCeghtxLz0h2LbRxN7wK+0P5xIO4DWvQiAW8vXrN0DeJan25ToaSmU+JIWM5Z422AwOKOV65o+mU7p36OD9mCAadp3w12tf2LRkHRuTCVF2Ln4u+u6fi3jnZk2/GnTeM9rE3p8X5784YyqRUk81egcLw5u1D7lHxoYMihVJRXebkm5PZlOb98Rc23E3k7fPSXnXC15JbNwnK/0Hap/kRC0VtuXWxsu77vlCep9XVGe4nXXVAgKfvag2aG9a9KhaKz0a5bMN+x+zI0cd/5kvmgXRLgvNZ1Jo11AzH3JEha/cESDstIszzessRVL2Ku0iBsZL48ZLboFNSPiOm4eQNsxxI38grRm3/kwKmKSNqxEnqENLEmV65Dc83FhUM1k0V0iy2P29MaRDqQL7q34drcOXRSPsoOsZaBVUHtykv3N5BicQSHzfigmQOI903UQeLovKqnuXHKjxjC/yHMpJK/gT0yd9LhX8dVq9YSxo5DzWfqyScGi0fvwIhgDrcOs3Y8jFjGPtnYX+QztUgrsd+mZpeIQHPejzkUYday5pN3tTb8/TqLRq6RA5XAwnKefL7/Cm8mURYPheAXk+Ov52cdvs49Ulcar26LjyXQyJRONZ83VYKGz7hWwE4Pc6hp2Q/pIqXcn+P9nxn/5mdHLhsd7H5uKyyCPYQw3vbLNn398LCJWkggmc7bZUPVrW7UtmX80aElBFxFbcitpEoJ+Rlv1ISm8wzVNZTdo4ytCQuFVQ4gOPV7aaJt0KgQaPwh/css8kOrLi9kVi1jav5FqnVEOFQ51o/1nB5I31PlQVO+CqPYfBH7rUusBiodq20GlvwT8YMKvNJ1fcP3bLrzzPJvQ07eNpv1atG37NwabR2E=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Template from binary"})}),"\n",(0,t.jsx)(l(),{method:"post",path:"/createtemplatewithbinary"}),"\n",(0,t.jsxs)(a.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,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents."]}),"\n",(0,t.jsx)(a.p,{children:(0,t.jsxs)(a.strong,{children:["Upload you pdf in ",(0,t.jsx)(a.a,{href:"https://staging-app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]})}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function j(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f864295c.75ec5e3a.js b/assets/js/f864295c.75ec5e3a.js new file mode 100644 index 000000000..34afda3a9 --- /dev/null +++ b/assets/js/f864295c.75ec5e3a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1344],{55833:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>x,toc:()=>b});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const h={id:"createtemplatewithbinary",title:"Create Template from binary",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.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v4zYQ/StTnppAtpxstgehKJrNfjTYxSaAE/TgGAZFjSRuJJIhKTuu4f9eDCXbSuK4W6DooeglkeeDfPM4fMMV87xwLJmwG6xNxT06No1Yhk5YabzUiiXspkTYuOHCIic7nF9fAq8qvXDQOLQOvAZBTgTROK9r+QdPKwS/WTiCRSlFCQ7tHIE7SKsGjZXKO8i1hQIVWu6lKiDToqmRHAvpSzAWM8ylwgyct43wjUU3hFujFbhGCHQub6rtTi0MqVUEvsQA1KJvrHLAoVHyoUE4Pt5Ez2R2fAy+5B4EV5AilZNRNR0g3MEZ3qk7dWsqzTNY6gZMloNUMMkwbQq4fv9x+mPpvXFJHHNjhtqgcrJQFU/dUOg6psQ6j8lWS2E1NyYOuSbLj6BEi2FZwpFZvoCFzAr0DrjKQGizBKEH2spMcY8RGF4gqKZO0YLOqdZ6CLxyertIyEm5w5/OKOL6/cc7xSKmTSBaq8uMJaw9tA0dRHgqFbdLFjGLDw06/05nS5asmNDKo/L0WTeVl4ZbH+fa1oOMe05mJ0qsw5dfGmQJ0+k3FJ5FzFja1Ut05M1lhb0o561UBYsYLcY9S1gHYR0xL/2+2PWzLt3jV9rvTyT+0bqDALi1fMnWOwCv8jRLiZ41hRJf0mLGEm8bDAZntHJt0aejEf17drmeNC11+Lahq+UPLOqTzo2ppAgnF39zbdXfy3hrpgN/WTQ+8tqEGt+Vp785o2pREk81OseLvQe1S/mLAvoMSlVJhbMNKbPT0Wj2lphbR+xsHzljXaMvSREWqDwsrFZFBKZC7hC8XQIvuFRA29t/kCu0VtvDVf89ZIdIOBuNZidbEt6+JOFSzXkls6BjN/oe1b9baX97325PUB/rivIUr9uiQlDwsyfF9u1tkQ5FY6VfsmSyYo8DbuSg9SeT6XpKXedLTcJktAuIuS9ZwuIDOhVGCl3oyYo1tmIJOyjD3Mh4fsLW0fNo53khVTE4mDXdlTAmmlsmnxSy5ZMb+RkJYcdTPypiko63RJ6hDZxKleuQ3LF3ZVCNZdHO2vkJezmYpQPpgnszo9rhTPP0WXaYAxloFYYiOcn+ZngCzqCQeddCQ6AZR+1Nc5DGaiXVvUvu1AAmV3kuheQV/I6pkx53426xWLxg7CjkfJK+bFKwaPQuvAjGQGs/a/vjiEXMo63dVT5GO5cCu1N6Zas4BMfdxeAiXAysuaTT7Uy/Pk+iRq2kQOWw18rnn66/wBzeDEcs6rXHd4COv1xefPg6/kDrUju2h3QyHA1HZKJ2rrnqbXXRPpe2CppbXcO2qZ+Nt+2N//899l97j3Vi4fHRx6biMkhoaL1Vp36T119p04iVJJTJhK1WtPatrdZrMj80aEllpxGbcyvp9IPGRhvNIbm8xyV1YttcgxtCQuFVQ4j2vfJINdukcyHQ+F74i0n0RM6vr8Y3LGJp95isdUY5tHBYN9p9tiB5Q5X3pfQ+SGn3QeA3LrXsoXiqsS1U+kvA9yb8TB35GZe/bMNbz6sJHX2baDqv6Xq9/hPtlKw3",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/createtemplatewithbinary",title:"Create Template from binary",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.",source:"@site/docs/API-docs/createtemplatewithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplatewithbinary",permalink:"/docs/API-docs/createtemplatewithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplatewithbinary",title:"Create Template from binary",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.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v4zYQ/StTnppAtpxstgehKJrNfjTYxSaAE/TgGAZFjSRuJJIhKTuu4f9eDCXbSuK4W6DooeglkeeDfPM4fMMV87xwLJmwG6xNxT06No1Yhk5YabzUiiXspkTYuOHCIic7nF9fAq8qvXDQOLQOvAZBTgTROK9r+QdPKwS/WTiCRSlFCQ7tHIE7SKsGjZXKO8i1hQIVWu6lKiDToqmRHAvpSzAWM8ylwgyct43wjUU3hFujFbhGCHQub6rtTi0MqVUEvsQA1KJvrHLAoVHyoUE4Pt5Ez2R2fAy+5B4EV5AilZNRNR0g3MEZ3qk7dWsqzTNY6gZMloNUMMkwbQq4fv9x+mPpvXFJHHNjhtqgcrJQFU/dUOg6psQ6j8lWS2E1NyYOuSbLj6BEi2FZwpFZvoCFzAr0DrjKQGizBKEH2spMcY8RGF4gqKZO0YLOqdZ6CLxyertIyEm5w5/OKOL6/cc7xSKmTSBaq8uMJaw9tA0dRHgqFbdLFjGLDw06/05nS5asmNDKo/L0WTeVl4ZbH+fa1oOMe05mJ0qsw5dfGmQJ0+k3FJ5FzFja1Ut05M1lhb0o561UBYsYLcY9S1gHYR0xL/2+2PWzLt3jV9rvTyT+0bqDALi1fMnWOwCv8jRLiZ41hRJf0mLGEm8bDAZntHJt0aejEf17drmeNC11+Lahq+UPLOqTzo2ppAgnF39zbdXfy3hrpgN/WTQ+8tqEGt+Vp785o2pREk81OseLvQe1S/mLAvoMSlVJhbMNKbPT0Wj2lphbR+xsHzljXaMvSREWqDwsrFZFBKZC7hC8XQIvuFRA29t/kCu0VtvDVf89ZIdIOBuNZidbEt6+JOFSzXkls6BjN/oe1b9baX97325PUB/rivIUr9uiQlDwsyfF9u1tkQ5FY6VfsmSyYo8DbuSg9SeT6XpKXedLTcJktAuIuS9ZwuIDOhVGCl3oyYo1tmIJOyjD3Mh4fsLW0fNo53khVTE4mDXdlTAmmlsmnxSy5ZMb+RkJYcdTPypiko63RJ6hDZxKleuQ3LF3ZVCNZdHO2vkJezmYpQPpgnszo9rhTPP0WXaYAxloFYYiOcn+ZngCzqCQeddCQ6AZR+1Nc5DGaiXVvUvu1AAmV3kuheQV/I6pkx53426xWLxg7CjkfJK+bFKwaPQuvAjGQGs/a/vjiEXMo63dVT5GO5cCu1N6Zas4BMfdxeAiXAysuaTT7Uy/Pk+iRq2kQOWw18rnn66/wBzeDEcs6rXHd4COv1xefPg6/kDrUju2h3QyHA1HZKJ2rrnqbXXRPpe2CppbXcO2qZ+Nt+2N//899l97j3Vi4fHRx6biMkhoaL1Vp36T119p04iVJJTJhK1WtPatrdZrMj80aEllpxGbcyvp9IPGRhvNIbm8xyV1YttcgxtCQuFVQ4j2vfJINdukcyHQ+F74i0n0RM6vr8Y3LGJp95isdUY5tHBYN9p9tiB5Q5X3pfQ+SGn3QeA3LrXsoXiqsS1U+kvA9yb8TB35GZe/bMNbz6sJHX2baDqv6Xq9/hPtlKw3",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},b=[{value:"Request",id:"request",level:2}];function f(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Template from binary"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplatewithbinary"}),"\n",(0,t.jsxs)(a.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,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents."]}),"\n",(0,t.jsxs)(a.p,{children:["Upload you pdf in ",(0,t.jsx)(a.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:"debug PDF"})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.006e5774.js b/assets/js/fa40969b.006e5774.js new file mode 100644 index 000000000..9422db364 --- /dev/null +++ b/assets/js/fa40969b.006e5774.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV11v2zYU/Ssc+9IGsi0nTroJw9CgzYKsxVokKQYsMQJaurbYUCRDUk4MQ/99uJRoybGTJkXXp74kFnk/eA4PL3mX1LGZpckFfafSsgDpLB1HNAObGq4dV5Im9MWLFyRMk/OFBptcylNwhsMcCCOCW0fUlGQhBJkwCxlRkriFhkt5KYd9srPzzrCpW0Wyyc7OpSSEkF47RlzOHGEGSFoaA9KJBeGSZN7TOuZK28d4uxjvjM8kc6UBcgo3JdjHQhq4KbkB4nIgC1UaYoOzj7eH8U5k75NRMwPWftMqdePsI44w4ltVaAEOsqfEy9kcyARAElumKVg7LYVYkHQV45a7nDAhApisBVHn3MecR3fazz01IzT2TGYeklREKDkDQ5hfBZ+ImqMDv4eQCi6fCygLXpOF34HSgulfShpRpcEw1NlJRhM6AxdEhKKiEdXMsAIcGBTpkkpWAE1oplJUFo0oR4Fq5nJ6X7XnOXj5rSvTKWIa5dKIBiJp4kwJEbVuITC+5cg5jSjcaaEyoMmUCYsGaQ4Fo8mS+vwJtc5wOUNLWRZ4jrxUV/loRFd7ZGqR+kUHqXQNVxvdGWs2pzMSqGyPa1VFK2IEL7gLtNyUYBZrKAOKBuZUmaILsiFhhbFgd7xAWPtxHAXEsiwmYGiFfszTlAzjzhLsNdffbQUP54yrMca1WkkLFm134xj/raugPUpkJTXPtXQgHdozrQVP/cTgi0Wn5eYC1OQLpF6PBsM4Xqc0YEvhOnbMGIaAuYPCft2/HkbpbwoKqWFuTWIBO/3zmF/v7k3yz38hJ1OOg8+LkDunbTIYNCOlEf1UFRjNcff8cNb/wHOGIaRyz46gBTALvqKtjqsHp0QG5kdRWWv4eRHqFRLvWrUE0oDiqoFQRVTdyjUsT4r/Rfkqiv7Iji+F3yq4h/BtzQYF4+Kr1hOAN81AkJDOlfxKmtH+we5w79fXwzXKHBRaMAdXZw1QnEwNMAfZoXs84m68u9cbxr349fnwIBn9luwf9OM4/pdG9K4QLXiaMQe0u0/Nd6mzH5Cn2jDriP2+dGjVZYdLrPxXoehd7cbx1QhNqoiO4tFm8TsFrYwjUjnC5owLNhHwy/erfmCM2qrmlqztK3gM1CgeXe2vQO1vgjqRcyZ4Rg4/nZBzdQ3yxyLqpnd1+s095bWRn6drYLvjNUgLaWm4W/j3zV2Pad6r55OLMd5xBbhcNY8j/yByOU3ooPtOGiybB1GF7w0w8/BcKo3o1HqmdV9pkFhFBJtYPK4DpvlgPqR4ga9bW8dmXM56j3qN2/WfIcc1jWso2lKl+XvAWtWQ1LVq3gs5MF8pK/yeKu/cUPdRg8Sq4ImfD7c897gl3PrpwI0XAZkqQ+55dxqUHPwkju/1h8RqSPm00U+f4Lv3TBX+xYpvCMHlNXY/PXLxcTrlKWeC/AMTyx2MXwbmbm9vNxh75X2OucvLCTGgVWs+84Oe1q7X6uMVjagDU9iP0zMwc56G+/uBVANvPGhOBUv9qWhqeRh6c98JVSp4CtJCR8eHx58+kDnZ68c06sjjCYsefDh5e/T32RHGRTnWmzTsx/3Y3xDKuoLJTqpjaFvDuqOcGlU0Pd/93V62B/5nd/qzO/3futOmcjm4cwMtGPfF3J+DZVOIL+i9hjUJvek4ormyDk2WS5TcZyOqCofrrgjrc8Yt3ohtX3QNi04XN2eixPy+Oj9g27RbrekYPwxH2+05HjxJL0+bnXtFntI8byUn1Hq56C4qLDZwU42rKBR7XGM9e5imoLu4N67ytfvw+OicRpSVuA3dS+baXzLND4y+dU3rt0+9APyLVG91+B2viPew+GNlXs886NDgC9bIz7iqqv8At5qkpg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV11v2zYU/Ssc+9IGsi0nTroJw9CgzYKsxVokKQYsMQJaurbYUCRDUk4MQ/99uJRoybGTJkXXp74kFnk/eA4PL3mX1LGZpckFfafSsgDpLB1HNAObGq4dV5Im9MWLFyRMk/OFBptcylNwhsMcCCOCW0fUlGQhBJkwCxlRkriFhkt5KYd9srPzzrCpW0Wyyc7OpSSEkF47RlzOHGEGSFoaA9KJBeGSZN7TOuZK28d4uxjvjM8kc6UBcgo3JdjHQhq4KbkB4nIgC1UaYoOzj7eH8U5k75NRMwPWftMqdePsI44w4ltVaAEOsqfEy9kcyARAElumKVg7LYVYkHQV45a7nDAhApisBVHn3MecR3fazz01IzT2TGYeklREKDkDQ5hfBZ+ImqMDv4eQCi6fCygLXpOF34HSgulfShpRpcEw1NlJRhM6AxdEhKKiEdXMsAIcGBTpkkpWAE1oplJUFo0oR4Fq5nJ6X7XnOXj5rSvTKWIa5dKIBiJp4kwJEbVuITC+5cg5jSjcaaEyoMmUCYsGaQ4Fo8mS+vwJtc5wOUNLWRZ4jrxUV/loRFd7ZGqR+kUHqXQNVxvdGWs2pzMSqGyPa1VFK2IEL7gLtNyUYBZrKAOKBuZUmaILsiFhhbFgd7xAWPtxHAXEsiwmYGiFfszTlAzjzhLsNdffbQUP54yrMca1WkkLFm134xj/raugPUpkJTXPtXQgHdozrQVP/cTgi0Wn5eYC1OQLpF6PBsM4Xqc0YEvhOnbMGIaAuYPCft2/HkbpbwoKqWFuTWIBO/3zmF/v7k3yz38hJ1OOg8+LkDunbTIYNCOlEf1UFRjNcff8cNb/wHOGIaRyz46gBTALvqKtjqsHp0QG5kdRWWv4eRHqFRLvWrUE0oDiqoFQRVTdyjUsT4r/Rfkqiv7Iji+F3yq4h/BtzQYF4+Kr1hOAN81AkJDOlfxKmtH+we5w79fXwzXKHBRaMAdXZw1QnEwNMAfZoXs84m68u9cbxr349fnwIBn9luwf9OM4/pdG9K4QLXiaMQe0u0/Nd6mzH5Cn2jDriP2+dGjVZYdLrPxXoehd7cbx1QhNqoiO4tFm8TsFrYwjUjnC5owLNhHwy/erfmCM2qrmlqztK3gM1CgeXe2vQO1vgjqRcyZ4Rg4/nZBzdQ3yxyLqpnd1+s095bWRn6drYLvjNUgLaWm4W/j3zV2Pad6r55OLMd5xBbhcNY8j/yByOU3ooPtOGiybB1GF7w0w8/BcKo3o1HqmdV9pkFhFBJtYPK4DpvlgPqR4ga9bW8dmXM56j3qN2/WfIcc1jWso2lKl+XvAWtWQ1LVq3gs5MF8pK/yeKu/cUPdRg8Sq4ImfD7c897gl3PrpwI0XAZkqQ+55dxqUHPwkju/1h8RqSPm00U+f4Lv3TBX+xYpvCMHlNXY/PXLxcTrlKWeC/AMTyx2MXwbmbm9vNxh75X2OucvLCTGgVWs+84Oe1q7X6uMVjagDU9iP0zMwc56G+/uBVANvPGhOBUv9qWhqeRh6c98JVSp4CtJCR8eHx58+kDnZ68c06sjjCYsefDh5e/T32RHGRTnWmzTsx/3Y3xDKuoLJTqpjaFvDuqOcGlU0Pd/93V62B/5nd/qzO/3futOmcjm4cwMtGPfF3J+DZVOIL+i9hjUJvek4ormyDk2WS5TcZyOqCofrrgjrc8Yt3ohtX3QNi04XN2eixPy+Oj9g27RbrekYPwxH2+05HjxJL0+bnXtFntI8byUn1Hq56C4qLDZwU42rKBR7XGM9e5imoLu4N67ytfvw+OicRpSVuA3dS+baXzLND4y+dU3rt0+9APyLVG91+B2viPew+GNlXs886NDgC9bIz7iqqv8At5qkpg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.0c2427ac.js b/assets/js/fa40969b.0c2427ac.js deleted file mode 100644 index 179ce80aa..000000000 --- a/assets/js/fa40969b.0c2427ac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/isc+6UNZFt2nHQThqFBmwVZi7VIUgxYYgS0dLLYUCRLUk4MQ/99OEq05dhpk6Lrp35JLPLenuPD492SOjazNLmkb1RalSCdpZOIZmBTw7XjStKEPnv2jIRtcrHQYJMreQbOcJgDYURw64jKSRZMkCmzkBEliVtouJJXctgne3tvDMvdypJN9vauJCGE9NZrxBXMEWaApJUxIJ1YEC5J5jWtY66yfbQ3QnvnfCaZqwyQM/hcgf2SSQOfK26AuALIQlWG2KDs7e2jvVPZ+2DUzIC13xSlbpW9xTFafK1KLcBB9hh7BZsDmQJIYqs0BWvzSogFSVc2brkrCBMigMnWIBqfB+jz+E77vcd6hFaeycxDkooIJWdgCPNR8KlocnTozxBSweVTAWVBa7rwJ1BZMP0rSSOqNBiGPDvNaEJn4AKJkFQ0opoZVoIDgyRdUslKoAnNVIrMohHlSFDNXEHvs/aiAE+/TWY6RUzLXBrRkEiaOFNBRK1bCLRvOeacRhTutFAZ0CRnwqJAWkDJaLKk3n9CrTNczlBSViXeI0/VlT8a0dUZmYakPuhAla7g6qA7a+3hdFZCKtfXta6jVWIEL7kLaflcgVlsoAwoWpi5MmUXZJuEFcaS3fESYR3EcRQQy6qcgqE16jGfpmQYd0KwN1x/twge9hnXE7RrtZIWLMqO4hj/bbJgfZXIimo+19KBdCjPtBY89RuDTxaVltsBqOknSD0fDZpxvHFpwFbCdeSYMQwBcwel/bp+s4zU3yYUpoa5DYoF7PTPE34z2p8WH//CnOQcF59moXBO22QwaFcqI/qpKtGa4+7p5qz/gfcMTUjlnmxBC2AWfEVbXVcPTokMzI9KZcPhp1loIiRetV4nkAYU1y2EOqLqVm5geZT9T8pXUdTH7PhS+K2EewjfTm9QMi6+Kj0FeNUuBArpQsmvuBkfHI6G+7++HG6kzEGpBXNwfd4Cxc3UAHOQHbkvWxzFo/3eMO7FLy+Gh8n4t+TgsB/H8b80onelWIOnGXNAu+fUflc6+wF+6i2xDtnvU4fW3exwiZX/OhS961EcX49RpI7oOB5vF78z0Mo4IpUjbM64YFMBv3y/6gfGqJ1sXidrdwRfAjWOx9cHK1AH26BO5ZwJnpGjD6fkQt2A/LGIuu5d4377THkj5PfpBtjuegPSQloZ7ha+v7nrMc17zX5yOcE3rgRXqLY58g2RK2hCB90+abBsG6Ia+w0w89AuVUZ0ar11bMblrMe07isNEquJYFOL13bANB/MhxQ9hojOMWtNYjbiWhcfzd8CVp8Wdleq7QAKYL721fidK6/cJuO9Bon33KdyPtzRwHFLuPXbAa0/VpIrQ+5pd0aOAvwmru/3h8RqSHneMqJPsJM9V6XvQbErEFze4DzTI5fv85ynnAnyD0wtdzB5HjJ3e3u7lbEXXueEu6KaEgNarcVnftGntau1+nhBI+rAlPZ9fg5mztPwIj/gauCFBy3PWep53lbnsPTqvhLyTvAUpIUOM49OPrwj+/2YRh1yPCLkwbvT18d/nx+jVaRXc0TDftyPfcVX1pVMdhydwHrUaybE3KiyneHun/VyfYF/Tps/p83/bdps65aDOzfQgnFfnP09WLaF9ZLeG0CTMGtOIloo61BkuUTKfTSirnG5mXKw3mbc4gu3nnNuYNGZyuZMVOif4rj0gGw7Pq1FJ/hhOMru9vHgTXp+1p7cC/KYYXhnckKll4tuUCHYkJt6Ukeh1GOMze5RmoLu4t56mjfet5PjCxpRVuExdJ+YG//EtD/Q+s6YNt+eJgD8i6neqfA7PhBvYfHHSrzZeVChxRekMT+Tuq7/A7Fak+w=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21v2zYQ/isc+6UNZFt2nHQThqFBmwVZi7VIUgxYYgS0dLLYUCRLUk4MQ/99OEq05dhpk6Lrp35JLPLenuPD492SOjazNLmkb1RalSCdpZOIZmBTw7XjStKEPnv2jIRtcrHQYJMreQbOcJgDYURw64jKSRZMkCmzkBEliVtouJJXctgne3tvDMvdypJN9vauJCGE9NZrxBXMEWaApJUxIJ1YEC5J5jWtY66yfbQ3QnvnfCaZqwyQM/hcgf2SSQOfK26AuALIQlWG2KDs7e2jvVPZ+2DUzIC13xSlbpW9xTFafK1KLcBB9hh7BZsDmQJIYqs0BWvzSogFSVc2brkrCBMigMnWIBqfB+jz+E77vcd6hFaeycxDkooIJWdgCPNR8KlocnTozxBSweVTAWVBa7rwJ1BZMP0rSSOqNBiGPDvNaEJn4AKJkFQ0opoZVoIDgyRdUslKoAnNVIrMohHlSFDNXEHvs/aiAE+/TWY6RUzLXBrRkEiaOFNBRK1bCLRvOeacRhTutFAZ0CRnwqJAWkDJaLKk3n9CrTNczlBSViXeI0/VlT8a0dUZmYakPuhAla7g6qA7a+3hdFZCKtfXta6jVWIEL7kLaflcgVlsoAwoWpi5MmUXZJuEFcaS3fESYR3EcRQQy6qcgqE16jGfpmQYd0KwN1x/twge9hnXE7RrtZIWLMqO4hj/bbJgfZXIimo+19KBdCjPtBY89RuDTxaVltsBqOknSD0fDZpxvHFpwFbCdeSYMQwBcwel/bp+s4zU3yYUpoa5DYoF7PTPE34z2p8WH//CnOQcF59moXBO22QwaFcqI/qpKtGa4+7p5qz/gfcMTUjlnmxBC2AWfEVbXVcPTokMzI9KZcPhp1loIiRetV4nkAYU1y2EOqLqVm5geZT9T8pXUdTH7PhS+K2EewjfTm9QMi6+Kj0FeNUuBArpQsmvuBkfHI6G+7++HG6kzEGpBXNwfd4Cxc3UAHOQHbkvWxzFo/3eMO7FLy+Gh8n4t+TgsB/H8b80onelWIOnGXNAu+fUflc6+wF+6i2xDtnvU4fW3exwiZX/OhS961EcX49RpI7oOB5vF78z0Mo4IpUjbM64YFMBv3y/6gfGqJ1sXidrdwRfAjWOx9cHK1AH26BO5ZwJnpGjD6fkQt2A/LGIuu5d4377THkj5PfpBtjuegPSQloZ7ha+v7nrMc17zX5yOcE3rgRXqLY58g2RK2hCB90+abBsG6Ia+w0w89AuVUZ0ar11bMblrMe07isNEquJYFOL13bANB/MhxQ9hojOMWtNYjbiWhcfzd8CVp8Wdleq7QAKYL721fidK6/cJuO9Bon33KdyPtzRwHFLuPXbAa0/VpIrQ+5pd0aOAvwmru/3h8RqSHneMqJPsJM9V6XvQbErEFze4DzTI5fv85ynnAnyD0wtdzB5HjJ3e3u7lbEXXueEu6KaEgNarcVnftGntau1+nhBI+rAlPZ9fg5mztPwIj/gauCFBy3PWep53lbnsPTqvhLyTvAUpIUOM49OPrwj+/2YRh1yPCLkwbvT18d/nx+jVaRXc0TDftyPfcVX1pVMdhydwHrUaybE3KiyneHun/VyfYF/Tps/p83/bdps65aDOzfQgnFfnP09WLaF9ZLeG0CTMGtOIloo61BkuUTKfTSirnG5mXKw3mbc4gu3nnNuYNGZyuZMVOif4rj0gGw7Pq1FJ/hhOMru9vHgTXp+1p7cC/KYYXhnckKll4tuUCHYkJt6Ukeh1GOMze5RmoLu4t56mjfet5PjCxpRVuExdJ+YG//EtD/Q+s6YNt+eJgD8i6neqfA7PhBvYfHHSrzZeVChxRekMT+Tuq7/A7Fak+w=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},f={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.6ea5e49f.js b/assets/js/runtime~main.9da10ccf.js similarity index 66% rename from assets/js/runtime~main.6ea5e49f.js rename to assets/js/runtime~main.9da10ccf.js index d7ec2abd3..ff0c13969 100644 --- a/assets/js/runtime~main.6ea5e49f.js +++ b/assets/js/runtime~main.9da10ccf.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,r,b,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,r,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,r,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&r&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"26c9597e",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"0c2427ac",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a10c7ea2",1344:"27d8ad2d",1477:"b31b2642",1512:"7ddd2ec3",1520:"6a911971",1531:"0275f043",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1615d374",2121:"c8df990c",2241:"e6e648f1",2245:"0f2754b5",2267:"a4846e2b",2362:"ebdb1814",2403:"1cc28782",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"71a25ebe",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"967ec4da",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"fcbda936",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"137eb6e8",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"2a49d56a",7917:"1a71e32c",7971:"b58420e2",8055:"27482879",8087:"fd9041fd",8106:"d9040225",8140:"901b2f91",8141:"6478079e",8163:"6e9541b8",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"583ba3e8",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"fd615a94",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"f9ece43f",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(r[e])r[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var b=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var r=t.o(e,a)?e[a]:void 0;if(0!==r)if(r)c.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>r=e[a]=[c,b]));c.push(r[2]=b);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",f.name="ChunkLoadError",f.type=b,f.request=d,r[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var r,b,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(r in f)t.o(f,r)&&(t.m[r]=f[r]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,r,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(r,d),r},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"f5814a5e",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"006e5774",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"f33dd953",1344:"75ec5e3a",1477:"b31b2642",1512:"7ddd2ec3",1520:"010e8daa",1531:"80043bf4",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"8a6fea27",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"971ddfe3",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"450477a3",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"72df1f77",6103:"ebc8482f",6113:"8e8c149c",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"d07ecd06",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"f9046360",7917:"da7ff0bb",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"544c0626",8140:"901b2f91",8141:"6478079e",8163:"f6ff51c6",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"21cb025d",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 086415ccb..05a33f8b9 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 708628ea5..6ff415657 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index e4120f81d..345a7cdcc 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 5c29f63b1..55e177dbb 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index c1c680af1..fb9432463 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index f38b9df5b..52eae885f 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 7eedf9760..524f45745 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index e0e4124dc..c9182718d 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index 2c8d2fff1..68a0f263c 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 287762f60..e11a1176f 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index a3da89a8b..b481518a0 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + @@ -14,6 +14,6 @@

The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.

Request​

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    contactdetails[]

  • Array [

    • objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    contactdetails[]

  • Array [

    • objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 1a1db0f83..d99ce084c 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -3,17 +3,17 @@ -Create Contact | OpenSign™ +Create Contact | OpenSign™ - +

Create Contact

POST 
/createcontact
-

The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.

+

The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.

Request​

Body

required

Provide below parameter to create contact

    name stringrequired
    email stringrequired
    phone stringrequired
-

Responses​

Contact created successfully!

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
+

Responses​

Contact created successfully!

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 050556a29..63fb4a35f 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -3,18 +3,18 @@ -Create Document | OpenSign™ +Create Document | OpenSign™ - +

Create Document

POST 
/createdocument
-

The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.

-

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

+

The Create Document API allows users to generate new documents by providing data with base64 encoded file.

+

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

Request​

-

Body

required

    file base64required
    title stringrequired
    description string
    note string

    signers

    object[]

    required

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string
    page number
    x number
    y number
    w number
    h number

  • ]

  • ]

    • folderId string
    send_email boolean
    email_subject string

    Custom mail subject for signature request

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

-

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
+

Body

required

    file base64required
    title stringrequired
    description string
    note string

    signers

    object[]

    required

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string
    page number
    x number
    y number
    w number
    h number

  • ]

  • ]

    • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

+

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithbinary/index.html b/docs/API-docs/createdocumentwithbinary/index.html index 8f3b6bf18..2429b0f72 100644 --- a/docs/API-docs/createdocumentwithbinary/index.html +++ b/docs/API-docs/createdocumentwithbinary/index.html @@ -3,18 +3,18 @@ -Create Document from binary | OpenSign™ +Create Document from binary | OpenSign™ - +

Create Document from binary

POST 
/createdocumentwithbinary
-

The Create Document API allows users to generate new documents by providing data through multipart/form-data. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.

-

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

+

The Create Document API allows users to generate new documents by providing data through multipart/form-data.

+

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

Request​

-

Body

required

    file binaryrequired
    title stringrequired
    description string
    note string
    signers arrayrequired
    folderId string
    send_email boolean
    email_subject string

    Custom mail subject for signature request

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

+

Body

required

    file binaryrequired
    title stringrequired
    description string
    note string
    signers arrayrequired
    folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 1831af30b..cd67ad92a 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -3,18 +3,18 @@ -Create Document from Template | OpenSign™ +Create Document from Template | OpenSign™ - +

Create Document from Template

POST 
/createdocument/:template_id
-

The Create Document API allows you to generate new documents by providing template_id.

+

The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at debug PDF or using the Create Template API.

Request​

Path Parameters

    template_id stringrequired

    objectId of Template

-

Body

required

    signers

    object[]

    required

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

    • folderId string
    send_email boolean
    email_subject string

    Custom mail subject for signature request

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

+

Body

required

    signers

    object[]

    required

  • Array [

    • role string
    email mail
    name string
    phone string

  • ]

    • folderId string
    send_email boolean

    This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.

    email_subject string

    Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

    email_body string

    Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.

Responses​

In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index d94a7cb27..d97263507 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -3,18 +3,18 @@ -Create Template | OpenSign™ +Create Template | OpenSign™ - +

Create Template

POST 
/createtemplate
-

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 .

-

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

+

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.

+

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.

Request​

Body

required

    file base64
    title string
    note string
    description string

    signers

    object[]

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string
    page number
    x number
    y number
    w number
    h number

  • ]

  • ]

-

Responses​

Template created successfully!

Schema

    objectId string
    message string
Loading...
+

Responses​

Template created successfully!

Schema

    objectId string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplatewithbinary/index.html b/docs/API-docs/createtemplatewithbinary/index.html index 9907a1571..cbe64459a 100644 --- a/docs/API-docs/createtemplatewithbinary/index.html +++ b/docs/API-docs/createtemplatewithbinary/index.html @@ -5,16 +5,16 @@ Create Template from binary | OpenSign™ - +

Create Template from binary

POST 
/createtemplatewithbinary

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.

-

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

+

Upload you pdf in debug PDF here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF

Request​

Body

required

    file binary
    title string
    description string
    note string
    signers array
-

Responses​

Template created successfully!

Schema

    objectId string
    message string
Loading...
+

Responses​

Template created successfully!

Schema

    objectId string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 4f6c9c5d5..87f77af22 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + @@ -14,6 +14,6 @@

The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed

Request​

Path Parameters

    template_id stringrequired

    ID of the template that needs to be deleted

-

Responses​

Template deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
+

Responses​

Template deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 500ac8f86..704698e48 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 9c425b0f5..ee008e3ea 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + @@ -14,6 +14,6 @@

The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.

Request​

Path Parameters

    contact_id stringrequired

    Provide objectId of contact to delete

-

Responses​

Contact deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
+

Responses​

Contact deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 6bac29bb3..fa0c5b682 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + @@ -14,6 +14,6 @@

The Delete document API allows you to remove specific document from your documents.

Request​

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

-

Responses​

Document deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
+

Responses​

Document deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index e07686250..095de04ad 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -3,15 +3,15 @@ -Draft Document | OpenSign™ +Draft Document | OpenSign™ - +

Draft Document

POST 
/draftdocument
-

The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.

+

The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at https://app.opensignlabs.com (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.

Features:​

  • Save Document Drafts: Securely save your documents in a draft state.
    • @@ -19,6 +19,6 @@

Request​

Body

required

    file base64
    title string
    description string
    note string

    signers

    object[]

  • Array [

    • email string
    name string
    phone string

  • ]

-

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
+

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 6d81721df..565e63785 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -14,6 +14,6 @@

The Draft Template API allows you to create customizable draft templates .The API returns a unique template_id that can be used to generate documents based on the specified template and url to edit template.

Request​

Body

required

    file base64
    title string
    note string
    description string
-

Responses​

Template created successfully!

Schema

    objectId number
    url string
Loading...
+

Responses​

Template created successfully!

Schema

    objectId number
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 1ef70f264..9f80a6290 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index e4e749fea..3259b29e8 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -3,15 +3,15 @@ -Get your details | OpenSign™ +Get your account details | OpenSign™ - + -

Get your details

+

Get your account details

GET 
/getuser
-

The Get User API enables you to get your own details.

+

The Get User API enables you to get your own account details.

Request​

Responses​

Successful operation

Schema

    objectId string
    name string
    email string
    phone string
    jobTitle string
    company string
    createdAt date
    updatedAt date
Loading...
diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 24092a7d6..6b4a9ff75 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 8f2d52109..2634f1946 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Contact API allows you to retrieve details about a specific contact.

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

-

Responses​

successful operation

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 78d4d8b80..5541cefdd 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Document API enables you to retrieve details about a specific document.

Request​

Path Parameters

    document_id stringrequired

    objectId of Document

-

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 7fc5f0609..9689a29b9 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 2e7f54fcc..08cc8c6a7 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index ce7f7ac04..86c27b902 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 5ed26a7b9..ea119e345 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + @@ -20,6 +20,6 @@

Authentication

Security Scheme Type:

apiKey

Header parameter name:

x-api-token

-

License

AGPL 3.0

+

License

AGPL v 3.0

\ No newline at end of file diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index b5c08d24e..48c8123c4 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + @@ -47,6 +47,6 @@

Request​

Body

Provide url to create Webhook

    url string
-

Responses​

Successful operation

Schema

    result string
Loading...
+

Responses​

Successful operation

Schema

    result string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 2efdba773..760133e17 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -3,15 +3,15 @@ -Update Document | OpenSign™ +Update Document | OpenSign™ - +

Update Document

PUT 
/document/:document_id
-

The Update Document API allows users to modify and update the details of a specific document.

+

The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.

Request​

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    description string
    folderId string
diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 42dcb15d0..14ac6e39f 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 07ecdf947..c9f79b86e 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index 6d8966f07..60b43c708 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 9987418e1..cc853a646 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 860c5c815..d14802986 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 771962eb2..5a0a7d0b8 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index 90049d90e..859b7021c 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 2b0b3d5f2..e120c7ccc 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index e949f6304..b9c33bd3a 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 58b8a6beb..647ba35fd 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATON INSTRUCTIONS | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 9c493183a..1fe2b045b 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 8f34056a9..7ca65df85 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 0b29a2fa3..fcbbe2dc9 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index 979febc62..b8d97b1e5 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign yourself | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 166f7ea2d..c7024a169 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index e769c7397..26e8d140d 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index b3de56f10..73efed03e 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 508f3b8d4..e6b9bd99c 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index b9712a2b4..be897e420 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index ad5c0adc9..c2b089aad 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 5da13e921..3414e456a 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index 85d2230ea..255a888f1 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index e012e3772..4e2d7dde8 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index 5ef9f1727..37d945536 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index e42fa28d5..22d4d90e1 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index 230d78f43..e91ce544c 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Settings/profile/index.html b/docs/help/Settings/profile/index.html index 14ba0f27d..5a58e0d48 100644 --- a/docs/help/Settings/profile/index.html +++ b/docs/help/Settings/profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index edd6c6c16..7fba9d722 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index e85f3f329..1eb9ba4d6 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send template to a signer | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 003075c55..865124ff0 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 46a74b2ce..25ddbd676 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index ffe733548..8add0980e 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 00d905fda..a01955942 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 0b31fbd8f..25d355889 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost Setup with Docker | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 74eb25581..83b0163b0 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index a3fcc0299..ed8e1d73b 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 87d09dc71..1e7ecf1af 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +