diff --git a/404.html b/404.html index 92cf341e5..dcf13d69c 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.804248b0.js b/assets/js/05632a52.804248b0.js deleted file mode 100644 index f59fe68fd..000000000 --- a/assets/js/05632a52.804248b0.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:()=>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.e48c3f6b.js b/assets/js/05632a52.e48c3f6b.js new file mode 100644 index 000000000..e9e7f50b8 --- /dev/null +++ b/assets/js/05632a52.e48c3f6b.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:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});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),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:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",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/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:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",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)(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)(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:"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)(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:"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)(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/13fdae3b.36ec8d9d.js b/assets/js/13fdae3b.36ec8d9d.js deleted file mode 100644 index 7f6889583..000000000 --- a/assets/js/13fdae3b.36ec8d9d.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:()=>x,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>j,toc:()=>b});var a=l(85893),o=l(11151),n=l(58219),t=(l(62316),l(51039)),i=l.n(t),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"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},x={},b=[{value:"Request",id:"request",level:2}];function f(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)(i(),{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)(n.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,o.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.f58acb33.js b/assets/js/13fdae3b.f58acb33.js new file mode 100644 index 000000000..0a20274ba --- /dev/null +++ b/assets/js/13fdae3b.f58acb33.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>b,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>j,toc:()=>x});var a=s(85893),o=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),r=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),p=s(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:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh8qFEUXTbAINmgWcBZ5cIyAksYS1xTJcijZhqG3fkk/rV9SDGX5lm5QFEVfbJlz5nKGM0feiiBLEulMPGJWWbsU80QUSLlXLihrRCoeKoRr1BgQdhh4/+kWpNZ2BRvbQLBQ9PbVzt54LRJhHXrJQW4LkYoeMmRJhEdy1hCSSLfi7WTCX6eJp02eI9Gi0bAPJRKRWxPQBMZL57TKo2H8hdhpKyivsJb8FDYORSps9gXzIBLhPIcJqk/pkRodjnAUvDKlSASuZe00Hw18+9oLoH1FenMhui4RQYWIVEYrg88Dqee3k8nzD6LrGPNu8u4luc+EHowNsLCNKS7+O17ovfWv0zrP/RoRLn6g8f1LGremlVoVcSIe7BLN/8vkOH3o03Op61qzn5F1TymCol2cUD0+70kS5o1XYSPS2VasL6VTl709nc27eSJqDJU9jDPXLEMlUjFe7Seb0LfoKYbgTUhFFYKjdDyWzo2sQ0OqNFpmNMptPZZOjdsr0SXnaAqyVKa8fNVrfqh5yn3tW3dS+b6B0qmPuBHJ0JhjVCIU32eFskAfm6jMwkbnXbvuHZqpKk1sdnslznXiEXVua2Q5CBXCAP/z9z+iR2HzpkYT4ixcwH3jwdkVel5vaQpYaFyrTONBXGhQF0JZayTSG1AmYOllQChUqYLUwF1RpoRcOpkprXh6GGbZ28PRANIIHisMFXo2feMRJBTYouahA23tkuMEC7IJto45djXDyvrlgktKQELWkDJIBIQ4uKCppMkRhrtIwHqQBtAE9M4rQpCqZvDCesDFQuWKA/OqeJkHqKWRJXKyBLhu7oLztlUFEnibNRSArG4iEc5YI4aeokEsaATXqsWeOB8WGKTSWEDZcIgEclsg7DaHaZgCMqQAjtOrHGNQCtIH0Niij7MXb5LlDpzllVZSg12c3C0HCl4aWlhf9wUNV7Nvn/OWdTPmKORmBE/myUx5WBpCHgCtzJLSJ3MJs/2YPWJGKuD822EfVqvViz14c+rzQYWqycCjswe/Mh7GrTl23/94IxIR0Nd0v5iib1WOuyX8Ss5xBI93QifzKHRYS6X7Hfv53IFFR6scDeGRLL3/8OkOWvhuNBHJ0eb/g4LHd7e/3Pw6veG4rDT9/l2NJqMJHzlLoZbmKNXp6/t8c7cHwf73L/udxARch7HTUkWljay2O4mcidXhL0ZlKfDRdptJws9edx0f/9agZ+2dJ6KVXsmMlWc275JBmFhTl7jh9uU5On5ptFI3vbqdvWpO9Pr65u7m4UYkQjZczLEmLqMm7h44wWAym6Pwp2LZ18CfrNt/6/AjN+4jbn7aw3vLVx12FAc0t3Dedd1furFgSg==",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:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh8qFEUXTbAINmgWcBZ5cIyAksYS1xTJcijZhqG3fkk/rV9SDGX5lm5QFEVfbJlz5nKGM0feiiBLEulMPGJWWbsU80QUSLlXLihrRCoeKoRr1BgQdhh4/+kWpNZ2BRvbQLBQ9PbVzt54LRJhHXrJQW4LkYoeMmRJhEdy1hCSSLfi7WTCX6eJp02eI9Gi0bAPJRKRWxPQBMZL57TKo2H8hdhpKyivsJb8FDYORSps9gXzIBLhPIcJqk/pkRodjnAUvDKlSASuZe00Hw18+9oLoH1FenMhui4RQYWIVEYrg88Dqee3k8nzD6LrGPNu8u4luc+EHowNsLCNKS7+O17ovfWv0zrP/RoRLn6g8f1LGremlVoVcSIe7BLN/8vkOH3o03Op61qzn5F1TymCol2cUD0+70kS5o1XYSPS2VasL6VTl709nc27eSJqDJU9jDPXLEMlUjFe7Seb0LfoKYbgTUhFFYKjdDyWzo2sQ0OqNFpmNMptPZZOjdsr0SXnaAqyVKa8fNVrfqh5yn3tW3dS+b6B0qmPuBHJ0JhjVCIU32eFskAfm6jMwkbnXbvuHZqpKk1sdnslznXiEXVua2Q5CBXCAP/z9z+iR2HzpkYT4ixcwH3jwdkVel5vaQpYaFyrTONBXGhQF0JZayTSG1AmYOllQChUqYLUwF1RpoRcOpkprXh6GGbZ28PRANIIHisMFXo2feMRJBTYouahA23tkuMEC7IJto45djXDyvrlgktKQELWkDJIBIQ4uKCppMkRhrtIwHqQBtAE9M4rQpCqZvDCesDFQuWKA/OqeJkHqKWRJXKyBLhu7oLztlUFEnibNRSArG4iEc5YI4aeokEsaATXqsWeOB8WGKTSWEDZcIgEclsg7DaHaZgCMqQAjtOrHGNQCtIH0Niij7MXb5LlDpzllVZSg12c3C0HCl4aWlhf9wUNV7Nvn/OWdTPmKORmBE/myUx5WBpCHgCtzJLSJ3MJs/2YPWJGKuD822EfVqvViz14c+rzQYWqycCjswe/Mh7GrTl23/94IxIR0Nd0v5iib1WOuyX8Ss5xBI93QifzKHRYS6X7Hfv53IFFR6scDeGRLL3/8OkOWvhuNBHJ0eb/g4LHd7e/3Pw6veG4rDT9/l2NJqMJHzlLoZbmKNXp6/t8c7cHwf73L/udxARch7HTUkWljay2O4mcidXhL0ZlKfDRdptJws9edx0f/9agZ+2dJ6KVXsmMlWc275JBmFhTl7jh9uU5On5ptFI3vbqdvWpO9Pr65u7m4UYkQjZczLEmLqMm7h44wWAym6Pwp2LZ18CfrNt/6/AjN+4jbn7aw3vLVx12FAc0t3Dedd1furFgSg==",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"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},b={},x=[{value:"Request",id:"request",level:2}];function f(e){const l={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"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)(l.p,{children:"Delete Webhook"})}),"\n",(0,a.jsx)(t(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(l.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(l.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)(l.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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.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)(l.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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.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)(l.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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.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 k(e={}){const{wrapper:l}={...(0,o.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.450477a3.js b/assets/js/1f73ca32.450477a3.js deleted file mode 100644 index 841c8284d..000000000 --- a/assets/js/1f73ca32.450477a3.js +++ /dev/null @@ -1 +0,0 @@ -"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.5c33accf.js b/assets/js/1f73ca32.5c33accf.js new file mode 100644 index 000000000..7ee100b80 --- /dev/null +++ b/assets/js/1f73ca32.5c33accf.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:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var n=s(85893),l=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=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/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",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/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",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"}},j={},f=[{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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,n.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,n.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,n.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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.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,n.jsxs)(p.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"User not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.bb3534e4.js b/assets/js/2304e9ae.bb3534e4.js deleted file mode 100644 index 7f2393b8d..000000000 --- a/assets/js/2304e9ae.bb3534e4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(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),r=s(11151),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfVoB2Zbz0mLCMCwrsiJr0QRzhgFzjICWzjITimRJyi8w9N+HI+VYttNgGYZiXwzr3u+5e0huwPPSQTaGX7Us0MIkgQJdboXxQivI4HaO7L1F7pFFE3Zxc8W4lHrp2FrXzGuWR/0s6PuQgDZoOQW4KiCDqI5aSMDilxqd/0UXa8g2B+lurF6IAtkUpV4ywy2v0KM9ygIJ5Fp5VJ5icGOkyEPGwYOjQBtw+RwrTv8oobBYUJvRW/EKqVW/NggZ6OkD5h4SMJYq9wId+UXbz2Sbbba2zluhSkhgpm3FfVeCK14ZSUYKl9s6mwQMt6h8RI8AeV0saJoEvPDhIwa9nxJ2DSl2vXlbYxA4o5WLHZyk6THEMUYLZ8Fcnefo3KyWcv3da2B9Gbwofn27Zj6czlcnD4aQ+39M4LcTxd35o7hBitXiduGfC7NzOklPTnvDtJe+ux2+zc5+yM7f9tM0/QsSWFWSfMMSZlBwH+JuR7z9rk3xDfI0h2YRtAI9F9LB0erR1jUJnD23WCNdoZ8LVbIlKs+WVqsyYUYid8i8XTNecqGY5B7tf7hpaK22L4P0usq6hBNKCoX3W1bdn6Xp/fAJhPNjEK7UgktRhFPyVj+i+raddtP7mP54xiIaBT3sNduVxyYd5rUVfg3ZeAOrHjeiF/XZeNJMEiBgNZ3yRrtQMfdzyGBwcOg7tAu0LkSprYQM5t4blw0G3Ji+NqicKJXkU9fPdTXgRgwWQ2iSQ2vneSlU2XvRa7Ire0TQRvT2in/CkBvxEdeQbLHpWiUgaKRz5HHzE6CJ/b67vy63uO9fFt3T5/jwAYJcqJkOVbTQXxtUI1GqMLjFEI6vYeGYcEFd6LyuUPmwRGymLTvwZlPusGBaMT/HoCT5aX/InMFczNr967M7daeIG6x2OKslk0I9uuxO9dj4ejYTueCS/YlTJzxOvt+OYLlcHkH/Jvh8EH5eT5lFo3fmZRCG+XS9nj7eQAIebeWuZyO0C5FjO+6vpBoE40HLKp4HVmHFBa1JK/r50IkglyJH5bDDg4sPN5/Ygp32U0g6e/YPih58unp/+Xl0SXFpr+OQhv20n4b7RjtfcdVJtfeEOpzuZndA/Lv3VrvLHld+YCQXgdWhoU1LyPH+K2ySwJz4mo1hs6Ft+cPKpiHxlxotkX2SwIJbwae0nuNJk2xpQAx+xDX1FIvu3VJ2Mpd1ZNTBCUcsjh4XeY7Gv2jbPVJurke3kMC0fSlWuiAfy5f0iuRLyOAO7iC8NylCYHmQb0ByVda8JPsYl9jLa4KiS/3HQP32D3W2Val1p8r9MyG2Qr/U2LMOP9LMPuL6pyfzqPmqQ4vt1poGOGma5m88h/Vw",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/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfVoB2Zbz0mLCMCwrsiJr0QRzhgFzjICWzjITimRJyi8w9N+HI+VYttNgGYZiXwzr3u+5e0huwPPSQTaGX7Us0MIkgQJdboXxQivI4HaO7L1F7pFFE3Zxc8W4lHrp2FrXzGuWR/0s6PuQgDZoOQW4KiCDqI5aSMDilxqd/0UXa8g2B+lurF6IAtkUpV4ywy2v0KM9ygIJ5Fp5VJ5icGOkyEPGwYOjQBtw+RwrTv8oobBYUJvRW/EKqVW/NggZ6OkD5h4SMJYq9wId+UXbz2Sbbba2zluhSkhgpm3FfVeCK14ZSUYKl9s6mwQMt6h8RI8AeV0saJoEvPDhIwa9nxJ2DSl2vXlbYxA4o5WLHZyk6THEMUYLZ8Fcnefo3KyWcv3da2B9Gbwofn27Zj6czlcnD4aQ+39M4LcTxd35o7hBitXiduGfC7NzOklPTnvDtJe+ux2+zc5+yM7f9tM0/QsSWFWSfMMSZlBwH+JuR7z9rk3xDfI0h2YRtAI9F9LB0erR1jUJnD23WCNdoZ8LVbIlKs+WVqsyYUYid8i8XTNecqGY5B7tf7hpaK22L4P0usq6hBNKCoX3W1bdn6Xp/fAJhPNjEK7UgktRhFPyVj+i+raddtP7mP54xiIaBT3sNduVxyYd5rUVfg3ZeAOrHjeiF/XZeNJMEiBgNZ3yRrtQMfdzyGBwcOg7tAu0LkSprYQM5t4blw0G3Ji+NqicKJXkU9fPdTXgRgwWQ2iSQ2vneSlU2XvRa7Ire0TQRvT2in/CkBvxEdeQbLHpWiUgaKRz5HHzE6CJ/b67vy63uO9fFt3T5/jwAYJcqJkOVbTQXxtUI1GqMLjFEI6vYeGYcEFd6LyuUPmwRGymLTvwZlPusGBaMT/HoCT5aX/InMFczNr967M7daeIG6x2OKslk0I9uuxO9dj4ejYTueCS/YlTJzxOvt+OYLlcHkH/Jvh8EH5eT5lFo3fmZRCG+XS9nj7eQAIebeWuZyO0C5FjO+6vpBoE40HLKp4HVmHFBa1JK/r50IkglyJH5bDDg4sPN5/Ygp32U0g6e/YPih58unp/+Xl0SXFpr+OQhv20n4b7RjtfcdVJtfeEOpzuZndA/Lv3VrvLHld+YCQXgdWhoU1LyPH+K2ySwJz4mo1hs6Ft+cPKpiHxlxotkX2SwIJbwae0nuNJk2xpQAx+xDX1FIvu3VJ2Mpd1ZNTBCUcsjh4XeY7Gv2jbPVJurke3kMC0fSlWuiAfy5f0iuRLyOAO7iC8NylCYHmQb0ByVda8JPsYl9jLa4KiS/3HQP32D3W2Val1p8r9MyG2Qr/U2LMOP9LMPuL6pyfzqPmqQ4vt1poGOGma5m88h/Vw",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Folder"})}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.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 folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\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:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(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)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\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)(d.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)(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)(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:"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)(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)(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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.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/2304e9ae.c5d650a9.js b/assets/js/2304e9ae.c5d650a9.js new file mode 100644 index 000000000..861f034b0 --- /dev/null +++ b/assets/js/2304e9ae.c5d650a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>k,frontMatter:()=>h,metadata:()=>u,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",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/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},j={},g=[{value:"Request",id:"request",level:2}];function f(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 Folder"})}),"\n",(0,l.jsx)(i(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.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 folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(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)(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",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(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": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\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)(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)(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:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.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)(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)(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)(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)(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 k(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.57dfdd1c.js b/assets/js/28b19cd2.57dfdd1c.js new file mode 100644 index 000000000..d564bd932 --- /dev/null +++ b/assets/js/28b19cd2.57dfdd1c.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:()=>f,contentTitle:()=>g,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),o=s(41429),d=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v28gR/yqTfXEc0JLtJH0QiuJSJ7gad6iNsw95sAVhSA6ptZe7vN2lZFbgWz9JP1o/STHLP6Jk2ZcAxb20wCFnLef/zM78djbCY+7E7E58NklVkPZOzCORkkusLL00WszE7ZLgwhJ6gp4KPl1fAipl1g5qU4E3kJMmyzSa1pD20iCu4aFyHkprVjKVOgdPRanQ00KmILXzhCmYDKpSGQwEGERkUtFbqcEvCTJjC6aJ0dGfPoCxEEuNtj4GWpGtwcuCgh2aKGVjktZcHAyZwG2n1rE0sFQyRapqqBylQZuDBDXE1HGnkFlT8GcLUnuyGSYE6OHu3bvPFFc5/Hr57t387dL70s2mUyzLiSlJO5lrhbGbJKaYpkxYptkxG1254P82nL1NHM7JvRaRMCUHURp9mYqZ6AzpfFhLv+yDJ1MRiRItFuTJcgY3QmNBYiZG8RWRkJzBEv1S7KfVxA+U+MsQ/N4QEQlLv1XSUipm3lYUCedrxWKdLErFBPRUKpOSmGWoHBMkSypQzDbC12Wg9FbqXESC04Z+fEJPGKTMRPm3s3iZnC/LWDTNvFVLzv/VpDWLSoz2pD3/iWWpZBKCMn1wbPpmpHNr7p3gyHMw5lFvSusjh8pyZL0kF9g7wq3NaC3WHC5Pxfj8BQHWsBPPPd769ylJTOU1ai+aSFCBUr0aokAwFvBg6IfuF1cSS2kT/JrWB0MQEzFxuTT6d6jPzt/zf+/PRNNEwksfTneLblRNi5subEydGZWS5Sp9TQMb4kini/0AxMYoQv2sKG+X0sFQ13stxpWUyKyG9ZL8kmw4XqP2EKQ7JokJHPcnpm6tnQD3r5QyrJSHFaqKQDq4F1ze92ICl1m4ku0Xwz92TBjRAuoUtIGjoG/hqlAcR9Pud2zS+mjL6QAtdTZLSgcTAvHQBR2spVJsN/ehtgkM8WO1ffX06g4FfDeGF5XzpoCgpmMKPY8Dgr6yBN1lm8AFapA6UVVKXaPlgHOXgs2mL4FFqIymgc2Gc0l2wYXYNNH2gHXtHITqa08sJSRXO1zDEW0Zh7MRKz2V0taLFH13kJiiRF2PDZC5ljpfVFY1zeRZ8W0z881xexamLmMs5H8gYmzOpb6yKdmD93WgDu0/9I2Cbs2F4VNPn7Ee909dFTHZZ6EOA5vndMcFKdaOr1oYxvwBVVKF0dh6BOwR387aVHaY6uMGOmgaDDz7+HJbW4z7WiiPhol3h184cKXRru3656en/L9dVy41uCpJyDnoidvGxNc6Jw+VVSD19qMMToTmgMr1fYpJeuPAcHtbS0dgtKqDlH5aR1CQcw5zHsXfPCVfn2a97O+d4csHef6Pp2R1fs2FU9nXJ9whAR102ptz7CE7+J3SBnAaJkCXlKxSqn6zM+CkVlLTok/I4vz0dHHO+W8i8eFgituMLXFF+sgDpimsZZqTd2EidIOGM9hXFaM9bXrUSwMJKqNzYCDHzUNaYCAROEMN/tcyStYa+73xu1aEjuenr8qtJ63g34vhh9PTRZIMQfx46J6sUMk0vBxuzSPpN3+Au1vnxup9q55NfSpC0XbQWbZE4bvY8XZ83jrpKKms9HWA3k8nWMqT9vvsbs6AtiC/NAziS+OCxYzBZ2K624emm1EjagSLtase0IcbJV59X2App6sz0UT71M5jLnV+8irXfOvGDYe6jeaOM1uEXMqfiEu0i9WYqntmLAl5anB0OIO/bCH9lz4PI+x918PoMVYeoPIz/Dso7jHuAHHHOHY+RqZC7KLP9kGzh6aE2EUJPdMwA7tnzqExd/axYdczE+LUFctVSZqRcii11dmz2feVVGLa8ccAoif/9z//FTj6ygg34Q1cVRZKsyabVSp0m0zRk4wVHXiCO8JCkXOqDg/WPDzHU5lLjwq6sQ8JlhhLJfnuMJlpR+ro+rkJfN0i7CMb3tG0IsVXDpQxj+EZawArb4qgo++8a2MfMzYpAoSY37s8Fx1Rz0J6iTrhJtOWXcSdEjUQP7BLyyMPZcHEjFgpy2QiWTA3CouJhwI15sTKImC7OQpdl3VgTcy7BmdUFRxhjQWRb13k5YCbwGe5otbxACXIo1SUQl6xiAgSkzLoCIXHbugUYgoLDEy8TCgIdR6tB8Xbh3DNWihYKQWl4YYmUTFYGeeWBXmL2oVlRgtjutQM4Sut4ZkVdKRYT+Be3+sbLpbKEReAkvrRze71CdwNZfaVYic9bRcR6/X62ZU/3uX5UfplFfMWxGz58nAYGsSYffhxLCLhyRbuKrshu5JJP8Jf0DkNxNOuzWP7dOmvN5byh30GbrlKJqQdjZrypx+vf4YVvJ+cimjU5L7B4OnPlxdf/n7zheVyU23v39nkdHIaXsjG+QL1SNX+lissgEa7kZ2LPFpS/H9F9geuyLp55OnJT0uFUo/AZztk7/bAvojEbLwVm0diyUN5dic2Gw7Yr/wU4uPfKrI80eeRWKGVGHNHv9uIVDr+Ox2mwYuV8PaX7glxDC8s2A7a3w9ZzRM2rCLaSfRI9d5Kr5k3UT9p2bSW4qI14OSW5WwlPANVDBRajk9JQqV/lXaMYq6vbm5FJPqXdBE2gMLimleGuBYzcS/uRdhghtYbtmR8vhEKdV4FPC9auQwQsOJMjdHFY0AX3R/s2cGY7MKO1hX+lx07yPBnvoc/Uf2Xgbz98iJDF9uemvMzb5rmP/4RMs8=",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 UI**](https://app.opensignlabs.com/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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v28gR/yqTfXEc0JLtJH0QiuJSJ7gad6iNsw95sAVhSA6ptZe7vN2lZFbgWz9JP1o/STHLP6Jk2ZcAxb20wCFnLef/zM78djbCY+7E7E58NklVkPZOzCORkkusLL00WszE7ZLgwhJ6gp4KPl1fAipl1g5qU4E3kJMmyzSa1pD20iCu4aFyHkprVjKVOgdPRanQ00KmILXzhCmYDKpSGQwEGERkUtFbqcEvCTJjC6aJ0dGfPoCxEEuNtj4GWpGtwcuCgh2aKGVjktZcHAyZwG2n1rE0sFQyRapqqBylQZuDBDXE1HGnkFlT8GcLUnuyGSYE6OHu3bvPFFc5/Hr57t387dL70s2mUyzLiSlJO5lrhbGbJKaYpkxYptkxG1254P82nL1NHM7JvRaRMCUHURp9mYqZ6AzpfFhLv+yDJ1MRiRItFuTJcgY3QmNBYiZG8RWRkJzBEv1S7KfVxA+U+MsQ/N4QEQlLv1XSUipm3lYUCedrxWKdLErFBPRUKpOSmGWoHBMkSypQzDbC12Wg9FbqXESC04Z+fEJPGKTMRPm3s3iZnC/LWDTNvFVLzv/VpDWLSoz2pD3/iWWpZBKCMn1wbPpmpHNr7p3gyHMw5lFvSusjh8pyZL0kF9g7wq3NaC3WHC5Pxfj8BQHWsBPPPd769ylJTOU1ai+aSFCBUr0aokAwFvBg6IfuF1cSS2kT/JrWB0MQEzFxuTT6d6jPzt/zf+/PRNNEwksfTneLblRNi5subEydGZWS5Sp9TQMb4kini/0AxMYoQv2sKG+X0sFQ13stxpWUyKyG9ZL8kmw4XqP2EKQ7JokJHPcnpm6tnQD3r5QyrJSHFaqKQDq4F1ze92ICl1m4ku0Xwz92TBjRAuoUtIGjoG/hqlAcR9Pud2zS+mjL6QAtdTZLSgcTAvHQBR2spVJsN/ehtgkM8WO1ffX06g4FfDeGF5XzpoCgpmMKPY8Dgr6yBN1lm8AFapA6UVVKXaPlgHOXgs2mL4FFqIymgc2Gc0l2wYXYNNH2gHXtHITqa08sJSRXO1zDEW0Zh7MRKz2V0taLFH13kJiiRF2PDZC5ljpfVFY1zeRZ8W0z881xexamLmMs5H8gYmzOpb6yKdmD93WgDu0/9I2Cbs2F4VNPn7Ee909dFTHZZ6EOA5vndMcFKdaOr1oYxvwBVVKF0dh6BOwR387aVHaY6uMGOmgaDDz7+HJbW4z7WiiPhol3h184cKXRru3656en/L9dVy41uCpJyDnoidvGxNc6Jw+VVSD19qMMToTmgMr1fYpJeuPAcHtbS0dgtKqDlH5aR1CQcw5zHsXfPCVfn2a97O+d4csHef6Pp2R1fs2FU9nXJ9whAR102ptz7CE7+J3SBnAaJkCXlKxSqn6zM+CkVlLTok/I4vz0dHHO+W8i8eFgituMLXFF+sgDpimsZZqTd2EidIOGM9hXFaM9bXrUSwMJKqNzYCDHzUNaYCAROEMN/tcyStYa+73xu1aEjuenr8qtJ63g34vhh9PTRZIMQfx46J6sUMk0vBxuzSPpN3+Au1vnxup9q55NfSpC0XbQWbZE4bvY8XZ83jrpKKms9HWA3k8nWMqT9vvsbs6AtiC/NAziS+OCxYzBZ2K624emm1EjagSLtase0IcbJV59X2App6sz0UT71M5jLnV+8irXfOvGDYe6jeaOM1uEXMqfiEu0i9WYqntmLAl5anB0OIO/bCH9lz4PI+x918PoMVYeoPIz/Dso7jHuAHHHOHY+RqZC7KLP9kGzh6aE2EUJPdMwA7tnzqExd/axYdczE+LUFctVSZqRcii11dmz2feVVGLa8ccAoif/9z//FTj6ygg34Q1cVRZKsyabVSp0m0zRk4wVHXiCO8JCkXOqDg/WPDzHU5lLjwq6sQ8JlhhLJfnuMJlpR+ro+rkJfN0i7CMb3tG0IsVXDpQxj+EZawArb4qgo++8a2MfMzYpAoSY37s8Fx1Rz0J6iTrhJtOWXcSdEjUQP7BLyyMPZcHEjFgpy2QiWTA3CouJhwI15sTKImC7OQpdl3VgTcy7BmdUFRxhjQWRb13k5YCbwGe5otbxACXIo1SUQl6xiAgSkzLoCIXHbugUYgoLDEy8TCgIdR6tB8Xbh3DNWihYKQWl4YYmUTFYGeeWBXmL2oVlRgtjutQM4Sut4ZkVdKRYT+Be3+sbLpbKEReAkvrRze71CdwNZfaVYic9bRcR6/X62ZU/3uX5UfplFfMWxGz58nAYGsSYffhxLCLhyRbuKrshu5JJP8Jf0DkNxNOuzWP7dOmvN5byh30GbrlKJqQdjZrypx+vf4YVvJ+cimjU5L7B4OnPlxdf/n7zheVyU23v39nkdHIaXsjG+QL1SNX+lissgEa7kZ2LPFpS/H9F9geuyLp55OnJT0uFUo/AZztk7/bAvojEbLwVm0diyUN5dic2Gw7Yr/wU4uPfKrI80eeRWKGVGHNHv9uIVDr+Ox2mwYuV8PaX7glxDC8s2A7a3w9ZzRM2rCLaSfRI9d5Kr5k3UT9p2bSW4qI14OSW5WwlPANVDBRajk9JQqV/lXaMYq6vbm5FJPqXdBE2gMLimleGuBYzcS/uRdhghtYbtmR8vhEKdV4FPC9auQwQsOJMjdHFY0AX3R/s2cGY7MKO1hX+lx07yPBnvoc/Uf2Xgbz98iJDF9uemvMzb5rmP/4RMs8=",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:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.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,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{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)(a.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)(u.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)(c.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)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.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)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(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}}.",example:""}}),(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}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.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)(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://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.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)(c.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.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)(c.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.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/28b19cd2.ecfb31d1.js b/assets/js/28b19cd2.ecfb31d1.js deleted file mode 100644 index 9933780ce..000000000 --- a/assets/js/28b19cd2.ecfb31d1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>f,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>x});var i=s(85893),t=s(11151),r=s(58219),l=(s(62316),s(51039)),n=s.n(l),o=(s(82723),s(9487)),m=s(41429),c=s(5397),d=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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1vGzcS/1cmfEkcrPXhJH0QikNyTtAzWpyN2kUfZEHgLme1dLjkluRK3hP2fy+G+ylZdhPg0Jc7IHC0w5nhfHHmR+6Z5xvHFkv22SRljto7toqYQJdYWXhpNFuwuwzh0iL3CB0XfLq5Aq6U2TmoTAnewAY1WuLRuAPRaYO4gofSeSis2Uoh9QY85oXiHtdSgNTOIxdgUigLZXhg4EFFKhW+kRp8hpAamxNPzB3+8B6MhVhqbqszwC3aCrzMMdihEQUZkzTm8t6QCdy12zrSBhYL4hCqgtKhCLs5SLiGGFtpAak1OS1bkNqjTXmCwD0s3779jHG5gd+u3r5dvcm8L9xiOuVFMTEFaic3WvHYTRKTTwUxFiI9I6NLF/wfwtnZROGc3GsWMVNQEKXRV4ItWGtI68NO+qwLnhQsYgW3PEePljK4Z5rnyBZsFF8WMUkZLLjP2HFaTfyAib8Kwe8MYRGz+EcpLQq28LbEiDlfKVLrZF4oYsDHQhmBbJFy5YghyTDnbLFnvioCp7dSb1jEKG3cjyn4yIOWBSv+NY+z5CIrYlbXq2ZbdP6fRlSkKjHao/b0kxeFkkkIyvTBken70Z6DuUtGkadgrKLOlMZHCpWlyHqJLoi3jIPN3FpeUbg85mP6MwqsISeeejz49ylJTOk1157VEcOcS/ViiALDWMGDwY/tF1USaWkS/NKuDwYhRiTmIjP6L7jnF+/o37s5q+uIeekD9bDoRtW0vm3DRtypUQItVelLO5AhDrVYHwcgNkYh10+K8i6TDvq6PmoxrsBEphXsMvQZ2kDece0haHfEEiM46k/E3Vg7AepfAlNeKg9brkoE6eCeUXnfswlcpeFINiuGPg5MGPEC1wK0gddhv7UrQ3G8nrbfsRHV60HSAbfY2ixR9CYE5r4LOthJpchu6kNNE+jjR9t21dNtdyrghzG8LJ03OYRtWqHQ8ygg3JcWoT1sE7jkGqROVCmwbbQUcOpSsN93JbAOlVHXsN9TLtGuqRDrOhoItNcBIVRfQ7GYoNweSPUkHAR72kgUHwtpq7XgviUkJi+4rsYGyI2WerMurarryZPiGzLzzXF7EqY2Y6TkfyBiZM6VvrYC7cnz2nOH9h/6Ro535tIQ1eNnXo37py7zGO2TUIeBTXO6lQLBK0dHLQxjWuAqKcNobDwC8ohOZ2VK20/1cQPtd+oNnH94vq2tx30tlEdNzIfDLxBcYbRruv7FbEb/HbpypcGVSYLOQcfcNCY61hv0UFoFUg+LMjgRmgNXrutTxNIZB4ba2046BKNVFbR00zqCHJ1zfEOj+Jun5MvTrNP9vTM8e5AX/3lMthc3VDilfXnCnVLQQqejOUcekoPfqa0Hp2ECtElJS6WqVwcDTmolNa67hKwvZrP1BeW/jtj7kyluMpbxLerXHrgQsJNig96FidAOGspgV1WE9rTpUC/2LFwZvQECctQ8pAUCEkEy1OB/LaNorbHfG78bhdzR/PRlMXjSKP6rGL6fzdZJ0gfxw6lzsuVKinBzuDNfUb/6G9wdnBtv75vtydTHPBRtC51lwxTW2YG3Y3rjpMOktNJXAXo/nvNCnjfri+WKAG2OPjME4gvjgsWEwRdsetiHpvtRI6oZqbXbDtCHE8VevF/wQk63c1ZHx9zO843Um/MXpVaDG7cU6iaaB84MCLmQPyOVaBurMVd7zciQ09Sg6FAGfx0g/ZcuDyPsvexg9Bgr91D5Cf7tN+4wbg9xxzh2NUamjB2iz+ZCc4SmGDtECZ1QPwPba86pMTf/UJPrqQlxaovlukBNSDmU2nZ+GuJKF5a7MghlH0DakXS48gowzT2YFon+bjLvgGVzYiZwr+/1rckDjExLBUrqr25xr89heZ2mMpFcwe8YO+lxuLLudrsnxXEWZH6SPitjuiabgX0TiKGCxlL9xxmLmEebu+v0Fu1WJl2Pf2araWCetn2AN9i2y39L+ngsROdSyQS1w9HJ/fTTzS+whXeTGYtGJ+EbjJ7+cnX55d+3X0gvnbwmSfPJbDIL1yjjfM71aKvjp5DwSjC6QB9ke3ST/f87yt/4jtI2LY+PflooLvUIoTSdeHmECFnEFuOnk1XEMurciyXb7ylgvxFeJvIfJVpq+6uIbbmVPKZjv9wzIR39Fn3LeLYS3vza4swzeOYV5qT9XSfW1IbDfbVpV1+xOnr3qVd11LVjMq3huGwMOL8jPYOGJ5OXpkkj8SlJsPAv8o5H3c317R2LWHfdysMzEbN8R+9KfMcW7J7ds/DMRRqapxSi75nielMG0McavTRFeEmZGo+gr2EEtT/Is5MxOZxNjSv0lxw7KfAjncOfsfpHz96sPCvQxrbjpvys6rr+E6+Afi4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={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 UI**](https://app.opensignlabs.com/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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1vGzcS/1cmfEkcrPXhJH0QikNyTtAzWpyN2kUfZEHgLme1dLjkluRK3hP2fy+G+ylZdhPg0Jc7IHC0w5nhfHHmR+6Z5xvHFkv22SRljto7toqYQJdYWXhpNFuwuwzh0iL3CB0XfLq5Aq6U2TmoTAnewAY1WuLRuAPRaYO4gofSeSis2Uoh9QY85oXiHtdSgNTOIxdgUigLZXhg4EFFKhW+kRp8hpAamxNPzB3+8B6MhVhqbqszwC3aCrzMMdihEQUZkzTm8t6QCdy12zrSBhYL4hCqgtKhCLs5SLiGGFtpAak1OS1bkNqjTXmCwD0s3779jHG5gd+u3r5dvcm8L9xiOuVFMTEFaic3WvHYTRKTTwUxFiI9I6NLF/wfwtnZROGc3GsWMVNQEKXRV4ItWGtI68NO+qwLnhQsYgW3PEePljK4Z5rnyBZsFF8WMUkZLLjP2HFaTfyAib8Kwe8MYRGz+EcpLQq28LbEiDlfKVLrZF4oYsDHQhmBbJFy5YghyTDnbLFnvioCp7dSb1jEKG3cjyn4yIOWBSv+NY+z5CIrYlbXq2ZbdP6fRlSkKjHao/b0kxeFkkkIyvTBken70Z6DuUtGkadgrKLOlMZHCpWlyHqJLoi3jIPN3FpeUbg85mP6MwqsISeeejz49ylJTOk1157VEcOcS/ViiALDWMGDwY/tF1USaWkS/NKuDwYhRiTmIjP6L7jnF+/o37s5q+uIeekD9bDoRtW0vm3DRtypUQItVelLO5AhDrVYHwcgNkYh10+K8i6TDvq6PmoxrsBEphXsMvQZ2kDece0haHfEEiM46k/E3Vg7AepfAlNeKg9brkoE6eCeUXnfswlcpeFINiuGPg5MGPEC1wK0gddhv7UrQ3G8nrbfsRHV60HSAbfY2ixR9CYE5r4LOthJpchu6kNNE+jjR9t21dNtdyrghzG8LJ03OYRtWqHQ8ygg3JcWoT1sE7jkGqROVCmwbbQUcOpSsN93JbAOlVHXsN9TLtGuqRDrOhoItNcBIVRfQ7GYoNweSPUkHAR72kgUHwtpq7XgviUkJi+4rsYGyI2WerMurarryZPiGzLzzXF7EqY2Y6TkfyBiZM6VvrYC7cnz2nOH9h/6Ro535tIQ1eNnXo37py7zGO2TUIeBTXO6lQLBK0dHLQxjWuAqKcNobDwC8ohOZ2VK20/1cQPtd+oNnH94vq2tx30tlEdNzIfDLxBcYbRruv7FbEb/HbpypcGVSYLOQcfcNCY61hv0UFoFUg+LMjgRmgNXrutTxNIZB4ba2046BKNVFbR00zqCHJ1zfEOj+Jun5MvTrNP9vTM8e5AX/3lMthc3VDilfXnCnVLQQqejOUcekoPfqa0Hp2ECtElJS6WqVwcDTmolNa67hKwvZrP1BeW/jtj7kyluMpbxLerXHrgQsJNig96FidAOGspgV1WE9rTpUC/2LFwZvQECctQ8pAUCEkEy1OB/LaNorbHfG78bhdzR/PRlMXjSKP6rGL6fzdZJ0gfxw6lzsuVKinBzuDNfUb/6G9wdnBtv75vtydTHPBRtC51lwxTW2YG3Y3rjpMOktNJXAXo/nvNCnjfri+WKAG2OPjME4gvjgsWEwRdsetiHpvtRI6oZqbXbDtCHE8VevF/wQk63c1ZHx9zO843Um/MXpVaDG7cU6iaaB84MCLmQPyOVaBurMVd7zciQ09Sg6FAGfx0g/ZcuDyPsvexg9Bgr91D5Cf7tN+4wbg9xxzh2NUamjB2iz+ZCc4SmGDtECZ1QPwPba86pMTf/UJPrqQlxaovlukBNSDmU2nZ+GuJKF5a7MghlH0DakXS48gowzT2YFon+bjLvgGVzYiZwr+/1rckDjExLBUrqr25xr89heZ2mMpFcwe8YO+lxuLLudrsnxXEWZH6SPitjuiabgX0TiKGCxlL9xxmLmEebu+v0Fu1WJl2Pf2araWCetn2AN9i2y39L+ngsROdSyQS1w9HJ/fTTzS+whXeTGYtGJ+EbjJ7+cnX55d+3X0gvnbwmSfPJbDIL1yjjfM71aKvjp5DwSjC6QB9ke3ST/f87yt/4jtI2LY+PflooLvUIoTSdeHmECFnEFuOnk1XEMurciyXb7ylgvxFeJvIfJVpq+6uIbbmVPKZjv9wzIR39Fn3LeLYS3vza4swzeOYV5qT9XSfW1IbDfbVpV1+xOnr3qVd11LVjMq3huGwMOL8jPYOGJ5OXpkkj8SlJsPAv8o5H3c317R2LWHfdysMzEbN8R+9KfMcW7J7ds/DMRRqapxSi75nielMG0McavTRFeEmZGo+gr2EEtT/Is5MxOZxNjSv0lxw7KfAjncOfsfpHz96sPCvQxrbjpvys6rr+E6+Afi4=",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:"Get Document",permalink:"/docs/API-docs/getdocument"}},g={},x=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.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,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.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)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.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)(d.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)(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)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.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)(d.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}}.",example:""}}),(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}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)(o.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)(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://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)(a.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)(o.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)(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",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)(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)(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)(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)(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 y(e={}){const{wrapper:a}={...(0,t.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/2c586be5.2035c76c.js b/assets/js/2c586be5.2035c76c.js new file mode 100644 index 000000000..75c942e6c --- /dev/null +++ b/assets/js/2c586be5.2035c76c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),t=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nTZra4Ir8Th1Yitkk1oY/lcyPng1lXnHeFvSbhefmvkd5FTJb5DCp2CdPpQCROk1Bw53UwkD9LZj10W5Jso+Zif2JZy6CS8mUTYfA22pAViVmAt0N8e548e9yLssxgsu/i3DX+3RbQt6zFGbUPUXtTZCzrPOgts47sY3o1cXHR8cuICiKcj52k/euac2JMnK2cznUPH2LrT5tJWm64HY+tPalzUPhj+USBdzZRTbJD26wrlWzGX7jRcjW46+Fikyqc+6FWN4P/517/diqgld1i/gNe1hkotUM9q3344K3ApqIGu15Ma3UfkZYHGFA0IaXHuulMzMXdVwPAWUlWQT0Uh6HgTmPLplN4NYYbwc+eAPtC+IHqFBd0KUCh16VoHFfDaqtLtEZ+whdKXMyIpAQ5T6jFEY8AgxiUocy5T8mH9OUlAaeASUFrUlRYGgYuSgF2j22wmUuHeRiWt5qmFkks+R9oscYEGSaGKHYJaTanUYlRR+wQu9SkiWs+iy8UO4SU1fTrGXRoJLRcFZjCvCUUCdIAg2CmxITOYkmdU0fYiRdO1PhR4hdrdC94/qosCKkV3ruAFedp93RIiq7k09FSGFFZQTSu+Sit6+d0eGW+GQLUbekbIdyYDKIS89O2yZ62Z/YxTIyx2QdZisbhxRz1cX/OtsHk9BY2V6tbN3aC70frL24+HdAGgLs3r2VvUVyKNj/uOPQ8d8GF4ibj35+OFwCvx1eYCehUKkaI02Hs3nn/75nu4gkfDI5b0buUPIPjw+9MX3/zw9hvCS6+AP3+j4dHwyGWGlLEll72tNtq+N49uL/W87xLfd4nvu8T3XeL7LvH7V23cd4nvu8T3XeL7LvF9l/i+S3zfJb7vEt93ie+7xPdd4luMet8lvu8S33eJ77vEYd8lvu8S//y6vatLPFT/yE86rAouZK8fwReAzzZ7x88TllOFeHzGrq8pQ/0TdYLQ8K81aiovnyfsimtByUZXXE5i2ZXqjZdIhb8XPuk/eEf7J97WXAVjo6ZOVWO/4rlTzq2w/SL2m9dv37GExdadUmW0RvMF9b7zBRuTT8pcn7yTrGtJ5q6XsOByXrsSKPN4qVrMa5uvl5ovXak5/OhVUrlselSu16A9K/SXGNu64K9U8fgOm7+14H5m54Ig2whNKjxfrVb/BUSDeZE=",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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nTZra4Ir8Th1Yitkk1oY/lcyPng1lXnHeFvSbhefmvkd5FTJb5DCp2CdPpQCROk1Bw53UwkD9LZj10W5Jso+Zif2JZy6CS8mUTYfA22pAViVmAt0N8e548e9yLssxgsu/i3DX+3RbQt6zFGbUPUXtTZCzrPOgts47sY3o1cXHR8cuICiKcj52k/euac2JMnK2cznUPH2LrT5tJWm64HY+tPalzUPhj+USBdzZRTbJD26wrlWzGX7jRcjW46+Fikyqc+6FWN4P/517/diqgld1i/gNe1hkotUM9q3344K3ApqIGu15Ma3UfkZYHGFA0IaXHuulMzMXdVwPAWUlWQT0Uh6HgTmPLplN4NYYbwc+eAPtC+IHqFBd0KUCh16VoHFfDaqtLtEZ+whdKXMyIpAQ5T6jFEY8AgxiUocy5T8mH9OUlAaeASUFrUlRYGgYuSgF2j22wmUuHeRiWt5qmFkks+R9oscYEGSaGKHYJaTanUYlRR+wQu9SkiWs+iy8UO4SU1fTrGXRoJLRcFZjCvCUUCdIAg2CmxITOYkmdU0fYiRdO1PhR4hdrdC94/qosCKkV3ruAFedp93RIiq7k09FSGFFZQTSu+Sit6+d0eGW+GQLUbekbIdyYDKIS89O2yZ62Z/YxTIyx2QdZisbhxRz1cX/OtsHk9BY2V6tbN3aC70frL24+HdAGgLs3r2VvUVyKNj/uOPQ8d8GF4ibj35+OFwCvx1eYCehUKkaI02Hs3nn/75nu4gkfDI5b0buUPIPjw+9MX3/zw9hvCS6+AP3+j4dHwyGWGlLEll72tNtq+N49uL/W87xLfd4nvu8T3XeL7LvH7V23cd4nvu8T3XeL7LvF9l/i+S3zfJb7vEt93ie+7xPdd4luMet8lvu8S33eJ77vEYd8lvu8S//y6vatLPFT/yE86rAouZK8fwReAzzZ7x88TllOFeHzGrq8pQ/0TdYLQ8K81aiovnyfsimtByUZXXE5i2ZXqjZdIhb8XPuk/eEf7J97WXAVjo6ZOVWO/4rlTzq2w/SL2m9dv37GExdadUmW0RvMF9b7zBRuTT8pcn7yTrGtJ5q6XsOByXrsSKPN4qVrMa5uvl5ovXak5/OhVUrlselSu16A9K/SXGNu64K9U8fgOm7+14H5m54Ig2whNKjxfrVb/BUSDeZE=",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 Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Document"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.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,a.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}}.",example:""}}),(0,a.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}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(r.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.5371fdc8.js b/assets/js/2c586be5.5371fdc8.js deleted file mode 100644 index 315dda335..000000000 --- a/assets/js/2c586be5.5371fdc8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),t=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={id:"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:"eJztGmtvGzfyr8zxSxpjJVuy8zjhcGia9HpGHwmaFMXBMlxqd6RlsktuSa6lraH/fhg+dleyZCdt0fhwygdHSw6H8yI5rxtm+cKwyQV7pdK6RGkNu0xYhibVorJCSTZh73KElxq5RYhQ8OLNOfCiUEsDtUFtwCpYoERNUBKXkEV8MGug0upaZEIuIOOWw1LYHGbc4NMzQJmqDDOYiwKHUzmVP1WF4hk0qoYqm4OQoGoNF0dHr3BWL+Cn86Ojyy9yayszOT7mVTVUFUojFrLgMzNMVXmcEWCVzR9DjhodppRLyDRfwlJkC7QGuMwgVVUDqRooLTLJLSZQ8QWCrMsZalBzsDmWQ+CFUS0StyaQrubw5tW/iOajo6+wUD3sGsHUVaW0xYxYsDm2EpkcHdGal6oslYSKa16iJRGqeUQwmcoBHB3ZpsLJ0RGcy0yk3KJxeGi0gx16UKKcQN9WmIq5CKAb/EhY5iLNHStLLi2prCp4ig5Uo6kwteIaNxGvEmgI8SuUKlKQKy1+U9LywsnxGrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaA/wSp1sYTkQUVE2kZCaUU0s0YhGte1GgCVcsEcqLqR6w0GmdmAa/NHU05ikW+dz+eva+N3UAMtSEy+1SEvTT+WguNmRMvOrHNeWEQxHxDliX/gL3dQLnzw4shfNVAhnNeFzYBYR8ZsLrGIfygLPCqKkTKZwXCXGkgO+a21jhwWg7mEAiRvHQ6fuNOExrgkIn5HDUdSJp0KKINBurIFLvjVypNNHIJSvYUPRrC0VG7tzPQX375ZSpvphJgyoiWKZtMWQsyZQn4OTKxKZuMEggDqymbwOn4WQRo6Pvp+Hn8XtL3aHQWv3P6Ho+mch02JVZ/UNax+sJCgdxYR267OwgDUSuOZ+Rp7qZRD+FFUfRA5wKLzJ/IVJVVXRilG7qTgkaGUzl23FteVndwTtN/Ptfx09uKoUG3M41FDmmQDMbD0gzpmkZbsmhi3UnwlBgSUljBC7Ofpwjx8NjqKNvi7Iw4w5KLYj9bbvrh8RTI2mLoybA72Hv48SgeGjv+1xY3T4mb92oGVtjiDpZakIfHV4+0LeaeEXN0h3DZ7GctADw8xlrCtth6Tmxl3N6hLpp9eAwFquJEuM/93MnZYPRkMD4Zn/Ug5kqXPACU5SDLBk3TNFMGnUSgfYECOnqE4oPrnQNycOdalTu8KefsdFDB+XC/owfyPfkds/gkd86hCX6be89KbjedBqsy3jwyHlVcGrwCD9/5fk2PTDdFdDTkQ6e5EmkgnmCC4GFGvuuQhDAgOWbH339/7CWTdIODsgzi8rqgUfoeOEn2R8tymGXDbdi+wPujJWRZAjvGd09kGZRluW/cT5CJT+Xfya4truxMrfabdgB4eNbdEbbTwMOjEOdyIcNEsA7YAtC4qAuucUX+shFKOu5vXQZblh8Nn0dT9M6y87lcKOKJhC9eB1/3cTBKomcTAY3cv+4WmX0kGhe4cjjS2lhVEjEi44QhAVOnOXDjg1JydZUsmhD7mMR/pbwSFLQUaK0bRZsON4mYytGJu+dzTD/caTkR4uGZTo+yOOljHJq+mLKSh4eXzbH7rWyOesou2zUGC0wtZr21sGsxXPasjGckaQJ2MVJHXi4yLPgMi26uR1xQY49VmiiF9EREMZxEfG6Wr7Zmw+R6h1F7JvrWFG+/aJNRalAIE4PfTRH0V4eg0ebcgkTM6PqfIcQFvQBjl5F7KfUCSlLldjxp0G4Sxinq8Ut3xJROpvH0BVnfswPBgQNs4/W42b4NAgsbmunLhXCUQoqyLnuJlIg1SqwMr2BfXLSSUklxh752b+3AV/fsQFH+/g2mcuRC3kyrKlNL6U457PZ9AsjDO+Y9yv7IMd94VjzcHzlGkar+MdrxohCof0vaI2T2n6EhvKb7m5IAfpEwwNMUK4vZ1gU+ctG85plQMKutVXL/Fd6Henj63aLuL9AxMfxxWu7T9tk07dMcpc987stxlE6bD023gazdB40lTFWUSRdKnmdswlKXfI/5Y5a4LdDYr1TWsMkNS5W0NDG5YSGfSEuP3xtK398wk+ZYcvoVSaOEPyXcWcJ81sywhLmol7L/JDw2YWr2HlPardJEjhVoCIdbN7mJUMZqIRcsCdEVmzCfHWcJwxUvKwJmW7n+KpuzddzwLlTtSIfKuB9tMp3wbFQrfhe2Vz0M64RRpvt3YqLEpeetxHfqpaJBi694Y3oI/bPFtusstIZORhpWQcYbQwegNt7BSHmR1gVFdriqhG7aMNOFdz37aAltd2oJHT1Zd0rvSOJa84YlTFgs++N7jECrT9dciook4/Jgn7r2vcIZ4pdhgKo8Tk+8/GQq3iuEGTodVbmSn7x+ND4djUenozFhCLn23y9HP3ubgk3DeEExDWbR6Rx06e0EXAZ4eJ9xRnjHNl/g/cb4bl/5qFfhMLmqi4xqGMj10FVxfn+tbsO+20djeI81rxO2up+ZlS/z+doUfFHg3EJdVaghVVqiftzP6DwY5sZnZ+uENfez1/xPsveMlLe8n7ufXVGvK3h+DlpPn68Tlt9P67/bsuNnJPbs6bp7Xbech6uZypqreG+t7wOMDwXBzVWRoSaH5PZ91V01dMMYlNnV9j0/U6pALndcNMJ0VfDYVEBhKsXAIaW5zJF82i56ddg7PzJEzJ7aIbxzVdx+xkoY8gp1jVM2hPN5zyt1ge8GCT1YV0uWCh65/a5M7a7xR8fhm2T0qF/Cd4X/NpUbSXDAYLGsClcbX4qiILrpXR9C+895fq0kiYD4XMaN738qXvrMmNswLNosLEPwHYfwkksQMi3q4KTPVUydwc1NawbOOtZruLkhraK+okd3vU66AdprY8C9q35EY4riemNVO4Tdwnast9S7OFfk4viBUMDoEyAWUsjFVa2L9Xp4yww7HX203G6JKeiOkPwfSIzIOZevdYZ658ltoV0u6J7Lw98uXcgRDJoaTZQ03v8Zn5zQf5u6aJuMAlLK7aZozLwuiuZvLPn4eOdu58sP777Q7vKm8vdi/NsqvR6/IZnV+pO92Xj517oYWDUgpQyi6Lxv25OskIWQeBXFdjU+ObkakWzXCTvbJb63qkSbk1UuSYhLreQigYr6KBCsboAvuJBAV5H+E6WJWit999vwaZTdJYSzDSE8uS2Ec+myyq5P7Z36gPKv5bS/vfXbE6mr0tmKj1uY8EBunm0w2x/3TBpMay1swyYXN2w14JUY+PnJxeX6MmEkWEW5gkoZRzG3OZuw41upA4P62oV+FzfedNmdrgivxPH1iK2TbWhj+ULIxeDOVZcd4W9JuF5+G+R3kVMlvkUKnYJ0+lAJE6TUHDndTCQP0tmPXRbk6yj5mJ/YlXLoJLydRNh+DXakBWJWYCPQ3x3nj570IuyLGCy7+LcNf3dFtC3rMUZtQ9Re1NkLOi86C2zjuxjejVxcND47cwHEs5HztE+fOyf27Ona2Uzn0DG26bS5tNW268HY5pMaF7UPhn8USFdz5RQbpP26QvlWLKQ7Ddej3R6gMG46qsSdTOe5bK12zZcZhaP0AtMkjZ8OR9Hv8od6CJTlpwuHvKx5XUAh5AffWHnxej4XqeAF/IwzIyx27vhyubxlzY/dmm+EzesZaKxUB75wg87k+6vaj8dkIahL83r+FvW1SOPtv2erYwd8HK4q7h2+aDFh6MvtRXR1FCJFabB3ubz45s13cA2nwxOW9I7uRxB9/N35y69/ePs14aWrwitpNDwZnrj0gTK25LK31VZv8LZ+e/nJQyvxoZX40Ep8aCU+tBI/vJLUoZX40Ep8aCU+tBIfWokPrcSHVuJDK/GhlfjQSnxoJd5h1IdW4kMr8aGV+NBKDIdW4kMr8efX7X2txKFERH7ScVVwIXtFa18lvNhuML5MWE5lxMkFu7mhDPVP1C5Aw7/WqKkGeZmwa64FJRtdBTKJtTkqSn1Aqg699En/wTvaP/G25sp8W4VXKi36FS+ccu6E7Vc637x++44lLPZ3lCqjNZovqUGaL9mEfFLmmqmdZF3fKncNZwWXi9rVyZjHSyVFXtt8sx75wdUjw49euY3LpkflZqHSs0J/ibGdC/5BFY9vsflnC+5n9i4Iso3QpMLL9Xr9Xx7BxPA=",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:"eJztGmtvGzfyr8zxSxpjJVuy8zjhcGia9HpGHwmaFMXBMlxqd6RlsktuSa6lraH/fhg+dleyZCdt0fhwygdHSw6H8yI5rxtm+cKwyQV7pdK6RGkNu0xYhibVorJCSTZh73KElxq5RYhQ8OLNOfCiUEsDtUFtwCpYoERNUBKXkEV8MGug0upaZEIuIOOWw1LYHGbc4NMzQJmqDDOYiwKHUzmVP1WF4hk0qoYqm4OQoGoNF0dHr3BWL+Cn86Ojyy9yayszOT7mVTVUFUojFrLgMzNMVXmcEWCVzR9DjhodppRLyDRfwlJkC7QGuMwgVVUDqRooLTLJLSZQ8QWCrMsZalBzsDmWQ+CFUS0StyaQrubw5tW/iOajo6+wUD3sGsHUVaW0xYxYsDm2EpkcHdGal6oslYSKa16iJRGqeUQwmcoBHB3ZpsLJ0RGcy0yk3KJxeGi0gx16UKKcQN9WmIq5CKAb/EhY5iLNHStLLi2prCp4ig5Uo6kwteIaNxGvEmgI8SuUKlKQKy1+U9LywsnxGrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaA/wSp1sYTkQUVE2kZCaUU0s0YhGte1GgCVcsEcqLqR6w0GmdmAa/NHU05ikW+dz+eva+N3UAMtSEy+1SEvTT+WguNmRMvOrHNeWEQxHxDliX/gL3dQLnzw4shfNVAhnNeFzYBYR8ZsLrGIfygLPCqKkTKZwXCXGkgO+a21jhwWg7mEAiRvHQ6fuNOExrgkIn5HDUdSJp0KKINBurIFLvjVypNNHIJSvYUPRrC0VG7tzPQX375ZSpvphJgyoiWKZtMWQsyZQn4OTKxKZuMEggDqymbwOn4WQRo6Pvp+Hn8XtL3aHQWv3P6Ho+mch02JVZ/UNax+sJCgdxYR267OwgDUSuOZ+Rp7qZRD+FFUfRA5wKLzJ/IVJVVXRilG7qTgkaGUzl23FteVndwTtN/Ptfx09uKoUG3M41FDmmQDMbD0gzpmkZbsmhi3UnwlBgSUljBC7Ofpwjx8NjqKNvi7Iw4w5KLYj9bbvrh8RTI2mLoybA72Hv48SgeGjv+1xY3T4mb92oGVtjiDpZakIfHV4+0LeaeEXN0h3DZ7GctADw8xlrCtth6Tmxl3N6hLpp9eAwFquJEuM/93MnZYPRkMD4Zn/Ug5kqXPACU5SDLBk3TNFMGnUSgfYECOnqE4oPrnQNycOdalTu8KefsdFDB+XC/owfyPfkds/gkd86hCX6be89KbjedBqsy3jwyHlVcGrwCD9/5fk2PTDdFdDTkQ6e5EmkgnmCC4GFGvuuQhDAgOWbH339/7CWTdIODsgzi8rqgUfoeOEn2R8tymGXDbdi+wPujJWRZAjvGd09kGZRluW/cT5CJT+Xfya4truxMrfabdgB4eNbdEbbTwMOjEOdyIcNEsA7YAtC4qAuucUX+shFKOu5vXQZblh8Nn0dT9M6y87lcKOKJhC9eB1/3cTBKomcTAY3cv+4WmX0kGhe4cjjS2lhVEjEi44QhAVOnOXDjg1JydZUsmhD7mMR/pbwSFLQUaK0bRZsON4mYytGJu+dzTD/caTkR4uGZTo+yOOljHJq+mLKSh4eXzbH7rWyOesou2zUGC0wtZr21sGsxXPasjGckaQJ2MVJHXi4yLPgMi26uR1xQY49VmiiF9EREMZxEfG6Wr7Zmw+R6h1F7JvrWFG+/aJNRalAIE4PfTRH0V4eg0ebcgkTM6PqfIcQFvQBjl5F7KfUCSlLldjxp0G4Sxinq8Ut3xJROpvH0BVnfswPBgQNs4/W42b4NAgsbmunLhXCUQoqyLnuJlIg1SqwMr2BfXLSSUklxh752b+3AV/fsQFH+/g2mcuRC3kyrKlNL6U457PZ9AsjDO+Y9yv7IMd94VjzcHzlGkar+MdrxohCof0vaI2T2n6EhvKb7m5IAfpEwwNMUK4vZ1gU+ctG85plQMKutVXL/Fd6Henj63aLuL9AxMfxxWu7T9tk07dMcpc987stxlE6bD023gazdB40lTFWUSRdKnmdswlKXfI/5Y5a4LdDYr1TWsMkNS5W0NDG5YSGfSEuP3xtK398wk+ZYcvoVSaOEPyXcWcJ81sywhLmol7L/JDw2YWr2HlPardJEjhVoCIdbN7mJUMZqIRcsCdEVmzCfHWcJwxUvKwJmW7n+KpuzddzwLlTtSIfKuB9tMp3wbFQrfhe2Vz0M64RRpvt3YqLEpeetxHfqpaJBi694Y3oI/bPFtusstIZORhpWQcYbQwegNt7BSHmR1gVFdriqhG7aMNOFdz37aAltd2oJHT1Zd0rvSOJa84YlTFgs++N7jECrT9dciook4/Jgn7r2vcIZ4pdhgKo8Tk+8/GQq3iuEGTodVbmSn7x+ND4djUenozFhCLn23y9HP3ubgk3DeEExDWbR6Rx06e0EXAZ4eJ9xRnjHNl/g/cb4bl/5qFfhMLmqi4xqGMj10FVxfn+tbsO+20djeI81rxO2up+ZlS/z+doUfFHg3EJdVaghVVqiftzP6DwY5sZnZ+uENfez1/xPsveMlLe8n7ufXVGvK3h+DlpPn68Tlt9P67/bsuNnJPbs6bp7Xbech6uZypqreG+t7wOMDwXBzVWRoSaH5PZ91V01dMMYlNnV9j0/U6pALndcNMJ0VfDYVEBhKsXAIaW5zJF82i56ddg7PzJEzJ7aIbxzVdx+xkoY8gp1jVM2hPN5zyt1ge8GCT1YV0uWCh65/a5M7a7xR8fhm2T0qF/Cd4X/NpUbSXDAYLGsClcbX4qiILrpXR9C+895fq0kiYD4XMaN738qXvrMmNswLNosLEPwHYfwkksQMi3q4KTPVUydwc1NawbOOtZruLkhraK+okd3vU66AdprY8C9q35EY4riemNVO4Tdwnast9S7OFfk4viBUMDoEyAWUsjFVa2L9Xp4yww7HX203G6JKeiOkPwfSIzIOZevdYZ658ltoV0u6J7Lw98uXcgRDJoaTZQ03v8Zn5zQf5u6aJuMAlLK7aZozLwuiuZvLPn4eOdu58sP777Q7vKm8vdi/NsqvR6/IZnV+pO92Xj517oYWDUgpQyi6Lxv25OskIWQeBXFdjU+ObkakWzXCTvbJb63qkSbk1UuSYhLreQigYr6KBCsboAvuJBAV5H+E6WJWit999vwaZTdJYSzDSE8uS2Ec+myyq5P7Z36gPKv5bS/vfXbE6mr0tmKj1uY8EBunm0w2x/3TBpMay1swyYXN2w14JUY+PnJxeX6MmEkWEW5gkoZRzG3OZuw41upA4P62oV+FzfedNmdrgivxPH1iK2TbWhj+ULIxeDOVZcd4W9JuF5+G+R3kVMlvkUKnYJ0+lAJE6TUHDndTCQP0tmPXRbk6yj5mJ/YlXLoJLydRNh+DXakBWJWYCPQ3x3nj570IuyLGCy7+LcNf3dFtC3rMUZtQ9Re1NkLOi86C2zjuxjejVxcND47cwHEs5HztE+fOyf27Ona2Uzn0DG26bS5tNW268HY5pMaF7UPhn8USFdz5RQbpP26QvlWLKQ7Ddej3R6gMG46qsSdTOe5bK12zZcZhaP0AtMkjZ8OR9Hv8od6CJTlpwuHvKx5XUAh5AffWHnxej4XqeAF/IwzIyx27vhyubxlzY/dmm+EzesZaKxUB75wg87k+6vaj8dkIahL83r+FvW1SOPtv2erYwd8HK4q7h2+aDFh6MvtRXR1FCJFabB3ubz45s13cA2nwxOW9I7uRxB9/N35y69/ePs14aWrwitpNDwZnrj0gTK25LK31VZv8LZ+e/nJQyvxoZX40Ep8aCU+tBI/vJLUoZX40Ep8aCU+tBIfWokPrcSHVuJDK/GhlfjQSnxoJd5h1IdW4kMr8aGV+NBKDIdW4kMr8efX7X2txKFERH7ScVVwIXtFa18lvNhuML5MWE5lxMkFu7mhDPVP1C5Aw7/WqKkGeZmwa64FJRtdBTKJtTkqSn1Aqg699En/wTvaP/G25sp8W4VXKi36FS+ccu6E7Vc637x++44lLPZ3lCqjNZovqUGaL9mEfFLmmqmdZF3fKncNZwWXi9rVyZjHSyVFXtt8sx75wdUjw49euY3LpkflZqHSs0J/ibGdC/5BFY9vsflnC+5n9i4Iso3QpMLL9Xr9Xx7BxPA=",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 Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Document"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.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,a.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}}.",example:""}}),(0,a.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}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(r.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.015e4a9a.js b/assets/js/377084eb.015e4a9a.js deleted file mode 100644 index d1592b05e..000000000 --- a/assets/js/377084eb.015e4a9a.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:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),m=(s(82723),s(9487)),c=s(41429),p=s(5397),o=s(4667),d=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/ivcfWoB+S1x004YhgZbkQUtlmDxMGCpEdDSWWIjkSxJ+QWG/vtw1ItlO7UbbAiwL7ZE3sO7e3Rv3IDjiYXwHiaY64w7tDANIEYbGaGdUBJCmKTIrtCxRoRd3l4znmVqadlaFcwpZtAZgQtkMTouMsv4TBWOcWY1RmIuIuZqcL89xjKLZoGMWzbLCtRGSGfZXBkWGeROyITFKipypOWlcCnTBmOcC4kxs84UkSsM2j4EoDQaTtZexxBCgq7RAQFobniODg25uQHJc4QQGnMeRAwBCHJTc5fCvu/XvzI1b41nLuWOScTYktczZHN0UYp0hsGvhTAYQ+hMgQFYt85IkxW5zsgQXOlMxQjhnGeWBKIUcw7hBtxae0lnhEwggLkyOXfVikygLKd0vNVKWrQEOBsO6W/XVFtEEVo7LzLW8gEBREo6lI7kudaZiPzG4Isl0ObQCjX7gpEj4gwd40Slslomfo/bW63ginuvQ1iNfpvJ3J7dJlAG4ISj1cMjtgDrH1rKCSWVOwFqP5AXLcmkLEbzUm5VQXXMwMoe5gXLLRHbOKwNJtPFKYpS57QNB4MGXFg0/UjlhFZLueP3MbJ8nqnGqgCsSKTPkxbNjeFrShCHuT3NplGnTI9QfR9hXxSyGXqzMOciOyk9Q3xfLzRc6FTJE2rGby7ORufv3o5IfiniBN2/8L/aPdS3m6iXVDoxZgueFWhZjxHvnIpZwKzjue6fCL5WnoxedRTKIp+h6aLblRZ9Nh6XAayfiXo7In6eCTp/VwaQPhM0vqAvxxN8Jm70ZFrdVSH90Hza8piUz0yLMr6WN2a3fMyUypDLrkJfxssAfBZhfOmOR9rZ8Oy8Nxr2hm8no4tw/GP45qI/HA7/hgBWuQ/vujXFddVrrGzeCx2/gJ5yX6xbiPeJIzrLAMZPtaM7laNLqYsvUTq2NEomAdMZcovMmTXjCReS0THmh/+uT6Ex6kT9e55l3YARMhMSH5pe/DAeDh9GLQnjQxImnb7E5qqQ8cu6+pT+4w6NHy5ah94cOnQtFzwTsR8BJ+oR5cv601XvKvWHESsqIb8PO8521ysnLUaFEW7tZ8NVj2vRq/bD+ymNXRQpqh4q/TDpUgih7byDTWeQLIHOM4tm1CxM1mnWXOu+0iipeGd8ZqlJDbgWgwX1nn1p63giZNI7ippu7b8jjisad7zYdjItPiK1spqkrlQ9AKfI/QhS0vtceXBN3Y1GSUXSE78YHbS0SSosE9ZvN0O7DwI/z++h2YxbjJmSzKXoN2n9vD9qbwse2mef5WdJycoKizTWZkI+2vCz7LH7m/lcRIJn7C+cWeFw+qphbrlcHjD22mOuhEuLGTOo1VY88Yue1i6qfXkNATg0ub2Z36FZiKgZwL6hauCFB3VW8MhnRT3BNEvv90EUpZmIUFrsxPHl1e0ntmDn/SEEnfD4DqMHn65/+fD73Qc6l8Kx+kij/rA/9HORsi7nsqOqe73b/7ibbX7/D66Cdbg7XLmBzrjwFcCTt6mz937bvgIIuxfBaQCpso5ENhsK0j9NVpa0/LVAQzViGsCCG8FnlBX3G4iFpee4vdR9k7lXf9T3w9fs+++UTzrTJLSkbPYzJIQAATzieu9iW05p/qqymqytJC6jCLXrYA9q9k7hu/owgQB44dLdavLoq0n9QKc/addumakMoF+qeE8CfqKI+ojrn1vxauebgNq/Rpo4mpZl+Q+LwMM3",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/ivcfWoB+S1x004YhgZbkQUtlmDxMGCpEdDSWWIjkSxJ+QWG/vtw1ItlO7UbbAiwL7ZE3sO7e3Rv3IDjiYXwHiaY64w7tDANIEYbGaGdUBJCmKTIrtCxRoRd3l4znmVqadlaFcwpZtAZgQtkMTouMsv4TBWOcWY1RmIuIuZqcL89xjKLZoGMWzbLCtRGSGfZXBkWGeROyITFKipypOWlcCnTBmOcC4kxs84UkSsM2j4EoDQaTtZexxBCgq7RAQFobniODg25uQHJc4QQGnMeRAwBCHJTc5fCvu/XvzI1b41nLuWOScTYktczZHN0UYp0hsGvhTAYQ+hMgQFYt85IkxW5zsgQXOlMxQjhnGeWBKIUcw7hBtxae0lnhEwggLkyOXfVikygLKd0vNVKWrQEOBsO6W/XVFtEEVo7LzLW8gEBREo6lI7kudaZiPzG4Isl0ObQCjX7gpEj4gwd40Slslomfo/bW63ginuvQ1iNfpvJ3J7dJlAG4ISj1cMjtgDrH1rKCSWVOwFqP5AXLcmkLEbzUm5VQXXMwMoe5gXLLRHbOKwNJtPFKYpS57QNB4MGXFg0/UjlhFZLueP3MbJ8nqnGqgCsSKTPkxbNjeFrShCHuT3NplGnTI9QfR9hXxSyGXqzMOciOyk9Q3xfLzRc6FTJE2rGby7ORufv3o5IfiniBN2/8L/aPdS3m6iXVDoxZgueFWhZjxHvnIpZwKzjue6fCL5WnoxedRTKIp+h6aLblRZ9Nh6XAayfiXo7In6eCTp/VwaQPhM0vqAvxxN8Jm70ZFrdVSH90Hza8piUz0yLMr6WN2a3fMyUypDLrkJfxssAfBZhfOmOR9rZ8Oy8Nxr2hm8no4tw/GP45qI/HA7/hgBWuQ/vujXFddVrrGzeCx2/gJ5yX6xbiPeJIzrLAMZPtaM7laNLqYsvUTq2NEomAdMZcovMmTXjCReS0THmh/+uT6Ex6kT9e55l3YARMhMSH5pe/DAeDh9GLQnjQxImnb7E5qqQ8cu6+pT+4w6NHy5ah94cOnQtFzwTsR8BJ+oR5cv601XvKvWHESsqIb8PO8521ysnLUaFEW7tZ8NVj2vRq/bD+ymNXRQpqh4q/TDpUgih7byDTWeQLIHOM4tm1CxM1mnWXOu+0iipeGd8ZqlJDbgWgwX1nn1p63giZNI7ippu7b8jjisad7zYdjItPiK1spqkrlQ9AKfI/QhS0vtceXBN3Y1GSUXSE78YHbS0SSosE9ZvN0O7DwI/z++h2YxbjJmSzKXoN2n9vD9qbwse2mef5WdJycoKizTWZkI+2vCz7LH7m/lcRIJn7C+cWeFw+qphbrlcHjD22mOuhEuLGTOo1VY88Yue1i6qfXkNATg0ub2Z36FZiKgZwL6hauCFB3VW8MhnRT3BNEvv90EUpZmIUFrsxPHl1e0ntmDn/SEEnfD4DqMHn65/+fD73Qc6l8Kx+kij/rA/9HORsi7nsqOqe73b/7ibbX7/D66Cdbg7XLmBzrjwFcCTt6mz937bvgIIuxfBaQCpso5ENhsK0j9NVpa0/LVAQzViGsCCG8FnlBX3G4iFpee4vdR9k7lXf9T3w9fs+++UTzrTJLSkbPYzJIQAATzieu9iW05p/qqymqytJC6jCLXrYA9q9k7hu/owgQB44dLdavLoq0n9QKc/addumakMoF+qeE8CfqKI+ojrn1vxauebgNq/Rpo4mpZl+Q+LwMM3",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",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{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 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)(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)(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)(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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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:"widgets"})}),(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:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)("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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)(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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(d.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)(p.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)(d.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)(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)(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)(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 v(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/377084eb.907e2796.js b/assets/js/377084eb.907e2796.js new file mode 100644 index 000000000..fb7c25594 --- /dev/null +++ b/assets/js/377084eb.907e2796.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),p=s(5397),o=s(4667),d=s(9472),h=s(85162);const u={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:"eJzVWN1u28YSfpXp3rQBaP04itMKRVHjNMgxWjRB7SJAHcFYkiNy4+XudncoWRB41yfpo/VJilmSMmU5dowWAXpjS8v5Zr4Zzt9qK0gWQcwvxQVWTkvCIBaJyDFkXjlS1oi5uCgRXiNBLwKnb89Aam3XATa2BrLgkbzCFUKOJJUOIFNbE0gIDjO1VBlQBx7t1AQI6FcIMkCqa3ReGQqwtB4yj5KUKSC3WV0hH68VleA85rhUBnMI5OuMao9hJBJhHXrJbM9yMRcFUm9DJMJJLysk9OzmVhhZoZiLns6VykUiFLvpJJXiru9nP4Bd7sgDlZLAIOaBvU4RlkhZiazD4++18piLOfkaExFoo9lSUJXTTARvnLY5ivlS6sACWYmVFPOtoI2LkuSVKUQiltZXktoTU4imWbD64KwJGBhwPJnwv32qoc4yDGFZa9jFQyQis4bQEMtL57TK4oPxh8Cg7SELm37AjDhwntWQak22xxzfh/m2J3gjo9dzcTP9f2qqcPy2EE0iSBGfHqq4BYT4YRdyRhlLj4B2LyiKNkxJ5+g/l1ttUj1EsOUDUbC5DcRtHnaEmbp6LEQlkQvz8bgH1wH9KLMVo+3a7Pn9ULBindmeVSKCKkyskx1aei83XCCEVXg8mt4+Rj1D+2kB+2ARUoy0sJJKPyqdIn7fHfSxcKU1j5iZvTg5nj7/+uWU5dcqL5D+gf/t00N7+4V6yq0Tc1hJXWOAI+C4S25mCQSSlRs9knw7eSZ9MzBo6ipFP0TvTnbo49msScTmiaiXU47PE0HPv24SUT4RNDvhNycLfCJuem9ZnbcpfdW/2uYhqViZAU1+Zt74/faRWqtRmqHB2MabRMQqwvyUHs6048nx86Pp5Gjy8mJ6Mp99M39xMppMJr+JRNxUMb270ZR3Xa9n2X+vXf4Z7DR3xYaN+G7gOJxNImb3jaNzWyGVPMXXaAjW3poiAadRBgTyG5CFVAZYjf/i35tT6L19pP89jdkwYZTRyuBVP4uvZpPJ1XQXhNlhEC4GcwmWtjb553X1PvsPOzS7Otk59OLQoTOzklrlcQW8sNdoPq8/Q/PUmj/MWNUKxediz9nheetkwKz2ijZxN7w5kk4dtc/nlwteuzhTbLdUxmWSSjEXu8k73g4WyUawPr/qV83a68Gwls6NrEPDzVvLNPCQGkunxiuePXelA8lCmeLoQdTilv85x7gN454Xt5PMqR+RR1kXpKFUtwCXKOMK0vD3pY3gLnRvHBpukjHwq+nBSHuHOrMV8lJMJUIv/tcff0ZEv8fHvPgC3tQenF2j511VmhyWGm9Uqu+7WQSUlcYQ9AaUISw8Z3OuCkVSx8HJdZxJJ1OlFWcSi1lGexgkYxjBuxKpRM+PvvQIEnJcoeYEBG3tNeshC7ImW0UbHWdYW3+9ZEoJSEjroAwGvrtgD0FTSpMh9O8iAetBGkBD6J1XAUGqioX5coPLpcoUK+ay8TIjqKSRBbKxBJg3R8F5u1I5BvA2rQNBsLqOjrDFCpFaF+NdZAQ/qBW2jvNhewnDHIqaVSSQ2RyhqyJ2w+SQYiBwbF5lGJUGkp5A4wp9zL34Jpe11uAsl7eSmu9Cw3fLishLE3gut4T6V7MLn/OWryXRRi43I3hv3htuwVAH5ATQylyH+XtzBJe7NHuHaVCEi6/6eliv1wd18Gwf81pRWafg0dlbXBEPY9UM4bsvz0QiCH0V3izP0a9U1u/XH7E5jsLjrunJLDa9bkHlGvv+LoAbkFYZmoCDFnX6+u1PsILno4lIBpX/CYTHP53979XP569YL3eatv6mo8loEldeG6iSZmBqeHO/W7fb29b9H7jld52M8IbGTksVm3sM3rZrzJe3m0ki5sM7/iIRpQ3EItttKgP+6nXT8PHvNXpu/4tErKRXMuWGd7kVuQr8Od/d1z8aua9+6a7+z+DTfy6415m+Vxtu1PF6IOZCJOIaN3d+s2gWvFq3DZvZthKnWYaOBtiDcbw3016/uhCJkDWV+4PiOg6K7gNrv5fX/gRpCfBfHmb3Ar7ljPoRN9/txNsnHwV0/vXSHKNF0zR/AzR9d9g=",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/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:"eJzVWN1u28YSfpXp3rQBaP04itMKRVHjNMgxWjRB7SJAHcFYkiNy4+XudncoWRB41yfpo/VJilmSMmU5dowWAXpjS8v5Zr4Zzt9qK0gWQcwvxQVWTkvCIBaJyDFkXjlS1oi5uCgRXiNBLwKnb89Aam3XATa2BrLgkbzCFUKOJJUOIFNbE0gIDjO1VBlQBx7t1AQI6FcIMkCqa3ReGQqwtB4yj5KUKSC3WV0hH68VleA85rhUBnMI5OuMao9hJBJhHXrJbM9yMRcFUm9DJMJJLysk9OzmVhhZoZiLns6VykUiFLvpJJXiru9nP4Bd7sgDlZLAIOaBvU4RlkhZiazD4++18piLOfkaExFoo9lSUJXTTARvnLY5ivlS6sACWYmVFPOtoI2LkuSVKUQiltZXktoTU4imWbD64KwJGBhwPJnwv32qoc4yDGFZa9jFQyQis4bQEMtL57TK4oPxh8Cg7SELm37AjDhwntWQak22xxzfh/m2J3gjo9dzcTP9f2qqcPy2EE0iSBGfHqq4BYT4YRdyRhlLj4B2LyiKNkxJ5+g/l1ttUj1EsOUDUbC5DcRtHnaEmbp6LEQlkQvz8bgH1wH9KLMVo+3a7Pn9ULBindmeVSKCKkyskx1aei83XCCEVXg8mt4+Rj1D+2kB+2ARUoy0sJJKPyqdIn7fHfSxcKU1j5iZvTg5nj7/+uWU5dcqL5D+gf/t00N7+4V6yq0Tc1hJXWOAI+C4S25mCQSSlRs9knw7eSZ9MzBo6ipFP0TvTnbo49msScTmiaiXU47PE0HPv24SUT4RNDvhNycLfCJuem9ZnbcpfdW/2uYhqViZAU1+Zt74/faRWqtRmqHB2MabRMQqwvyUHs6048nx86Pp5Gjy8mJ6Mp99M39xMppMJr+JRNxUMb270ZR3Xa9n2X+vXf4Z7DR3xYaN+G7gOJxNImb3jaNzWyGVPMXXaAjW3poiAadRBgTyG5CFVAZYjf/i35tT6L19pP89jdkwYZTRyuBVP4uvZpPJ1XQXhNlhEC4GcwmWtjb553X1PvsPOzS7Otk59OLQoTOzklrlcQW8sNdoPq8/Q/PUmj/MWNUKxediz9nheetkwKz2ijZxN7w5kk4dtc/nlwteuzhTbLdUxmWSSjEXu8k73g4WyUawPr/qV83a68Gwls6NrEPDzVvLNPCQGkunxiuePXelA8lCmeLoQdTilv85x7gN454Xt5PMqR+RR1kXpKFUtwCXKOMK0vD3pY3gLnRvHBpukjHwq+nBSHuHOrMV8lJMJUIv/tcff0ZEv8fHvPgC3tQenF2j511VmhyWGm9Uqu+7WQSUlcYQ9AaUISw8Z3OuCkVSx8HJdZxJJ1OlFWcSi1lGexgkYxjBuxKpRM+PvvQIEnJcoeYEBG3tNeshC7ImW0UbHWdYW3+9ZEoJSEjroAwGvrtgD0FTSpMh9O8iAetBGkBD6J1XAUGqioX5coPLpcoUK+ay8TIjqKSRBbKxBJg3R8F5u1I5BvA2rQNBsLqOjrDFCpFaF+NdZAQ/qBW2jvNhewnDHIqaVSSQ2RyhqyJ2w+SQYiBwbF5lGJUGkp5A4wp9zL34Jpe11uAsl7eSmu9Cw3fLishLE3gut4T6V7MLn/OWryXRRi43I3hv3htuwVAH5ATQylyH+XtzBJe7NHuHaVCEi6/6eliv1wd18Gwf81pRWafg0dlbXBEPY9UM4bsvz0QiCH0V3izP0a9U1u/XH7E5jsLjrunJLDa9bkHlGvv+LoAbkFYZmoCDFnX6+u1PsILno4lIBpX/CYTHP53979XP569YL3eatv6mo8loEldeG6iSZmBqeHO/W7fb29b9H7jld52M8IbGTksVm3sM3rZrzJe3m0ki5sM7/iIRpQ3EItttKgP+6nXT8PHvNXpu/4tErKRXMuWGd7kVuQr8Od/d1z8aua9+6a7+z+DTfy6415m+Vxtu1PF6IOZCJOIaN3d+s2gWvFq3DZvZthKnWYaOBtiDcbw3016/uhCJkDWV+4PiOg6K7gNrv5fX/gRpCfBfHmb3Ar7ljPoRN9/txNsnHwV0/vXSHKNF0zR/AzR9d9g=",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",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{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:"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)(t.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)(d.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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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:"widgets"})}),(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:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)("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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)(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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(d.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)(p.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)(d.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)(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)(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)(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 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/38c56221.7dc252fa.js b/assets/js/38c56221.7dc252fa.js deleted file mode 100644 index dfa39b1af..000000000 --- a/assets/js/38c56221.7dc252fa.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)),l=a.n(r),o=(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]( 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:"eJztV21v2zYQ/is39ksLyK/p9kEYhmZtVwQtmmDOMAyOEdDiSWJCkSpJ2dEM//fhKMmW3dRoimHAgH5JZPLuePcc757jhnmeORbP2RuTVAVq79giYgJdYmXppdEsZtc5whvLUw+dEJxfXQBqvlTooDYVeAOJRe4RuBZQcM0zBNFJC1J2Q7jO0WH7CxKuYYmQVtbnaAG1lUmOApY1cCGkzsDJTKN1waTUibGlsdzTjtQeLU+8XCGspcjQO/C5NVWWg6ksVA5tI5TyBIF7mEPufeni0YiX5dCUqMm64ks3TEyxeH5y+wU8T42FRJlKwAqtk0a/oHCkC0hIBwKDt4KQcN4iL5TUCD5HKK1J0Dkw6R6R0mLJKRijI+BKmTWFRYdwcKRMCt5y7STJQGpN0QBHB6RSc7UzNrzRN/rZs2fwG3JfWXTxjR4AzPgK9wkL+XMxzDCpLKoaHG3XBFZnx4HUwNtTnOceh8HQuRAwa1IRw7mjOHep8ebQBghpMfGqbjym8M+vLoaNfx+Nx/hG/2UqSr42nhIN1tAlohx3mWxVG3CHQPJrqRTk5LI3IAxIvz9ASX0PFhOUK6SLEhYtutJoRyGwiJkSG7AvBItZiBA7l1nELH6q0PlfjahZvGGJ0Z424g3jZalkElRHd46qYcNckmPB6Yv0pEVB9ZNKhSxiLTAsYl56hVRMvi6Rxcws7zCh00pL7niJjmwEvXjTSTlvpc5YxFJjC+5ZzJbc4U8vWcTwgRclCbdLgDoxAgWUImXb7sBTpnYre1MufOzyR3YOiv+brL3pWdhGTBv/rX7RlSETHax7K9xaXrOISY9Ff/0LMGPBpXqqE3cGl4iv2gXqBCEcXjw5nDuDsMQQSpkb/WT9yfRsMp2cTaZsu890c5G71N0ujahvO6BIzKEWF/rSCrS985bGKOS6bz7lyuFpw2xL+/sL722FYaEps4DxdDymf4fksetADT8IcFVC7TCtlKp/YNHXV9vpBDfLVN9PQza/k9O/H5LV9IqSU9knX5KOOCqrBt4MUEg/2JdTD1SpiRJuO8hup+PxrSBctxF7+Rh0M1Ogz4kY1gTg2hqdRVAq5A7B2xp4xqUGxT3afxFJtNbYx1DYx/w0z06B8HI8vp3sQPjxcxAu9IorKQLPXpt71P9tpP3jfXM8ufpQhHvStAImG6Gwzw6C7a83QToiYOlrFs837GHASzlo9uP5YruIGAFriKVK44LH3OcsZqODkiSiQbsKHXG+aW4tOzXBjHgpR6sJ20bH0s7zTOpscFJrsfd7Rtg28B14v2/MpXyP1JlbcPpSEZOU0xw59SSCg1L2+55+33bAd8T4GNftAT5mr+PJ9RE+6ujogGF6BDPfccVj7X8XVdfQd/2836IXR7236a8UfGoCUq37lyVqmqzC7VpNPnM/DJjtjNnFyJt50Fg40gZCSoBp5h/apPWz4QRciYlM2yIZAo2LVMA0JaeVCvNTMzPOL9NUJpIr+BOXTnpcPO+uyXq9/nwsDjrvpM+rJVgszV48C4vhDvW1dj9eUBLRFu4ynaFdyaTrpF84ahSER23p88T3OL1benWsRKWoZILaYa9Yz99dfYAVnA3HLOrVwlc4Pfpw8frtx9lbstu+Aijvw/FwHIjdOF9w3Tvq8NF0nN7eoPn9ifX9ifU/f2K13d/jgx+VikvdG6caDpsfjpX0NMqJ4+I522yoef1h1XZLy58qtESQi4ituJVUA4Eeo445qEvfY81i9ropocE1HU/iqmpI6GgqIOJrNM6TBEt/UrZPw1eXs2sWsWX7NiyMIB3L1/Ru5GsWsxt2w8IbkywEYgzrG6a4ziqeBboIdonweEVY9NnyPrBl+0GRdVu67nl5SKNNKPSXAntU4Wcqm/dY/7ITb3a+qNBi20lTBhfb7fYf685P4g==",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:"eJztV21v2zYQ/is39ksLyK/p9kEYhmZtVwQtmmDOMAyOEdDiSWJCkSpJ2dEM//fhKMmW3dRoimHAgH5JZPLuePcc757jhnmeORbP2RuTVAVq79giYgJdYmXppdEsZtc5whvLUw+dEJxfXQBqvlTooDYVeAOJRe4RuBZQcM0zBNFJC1J2Q7jO0WH7CxKuYYmQVtbnaAG1lUmOApY1cCGkzsDJTKN1waTUibGlsdzTjtQeLU+8XCGspcjQO/C5NVWWg6ksVA5tI5TyBIF7mEPufeni0YiX5dCUqMm64ks3TEyxeH5y+wU8T42FRJlKwAqtk0a/oHCkC0hIBwKDt4KQcN4iL5TUCD5HKK1J0Dkw6R6R0mLJKRijI+BKmTWFRYdwcKRMCt5y7STJQGpN0QBHB6RSc7UzNrzRN/rZs2fwG3JfWXTxjR4AzPgK9wkL+XMxzDCpLKoaHG3XBFZnx4HUwNtTnOceh8HQuRAwa1IRw7mjOHep8ebQBghpMfGqbjym8M+vLoaNfx+Nx/hG/2UqSr42nhIN1tAlohx3mWxVG3CHQPJrqRTk5LI3IAxIvz9ASX0PFhOUK6SLEhYtutJoRyGwiJkSG7AvBItZiBA7l1nELH6q0PlfjahZvGGJ0Z424g3jZalkElRHd46qYcNckmPB6Yv0pEVB9ZNKhSxiLTAsYl56hVRMvi6Rxcws7zCh00pL7niJjmwEvXjTSTlvpc5YxFJjC+5ZzJbc4U8vWcTwgRclCbdLgDoxAgWUImXb7sBTpnYre1MufOzyR3YOiv+brL3pWdhGTBv/rX7RlSETHax7K9xaXrOISY9Ff/0LMGPBpXqqE3cGl4iv2gXqBCEcXjw5nDuDsMQQSpkb/WT9yfRsMp2cTaZsu890c5G71N0ujahvO6BIzKEWF/rSCrS985bGKOS6bz7lyuFpw2xL+/sL722FYaEps4DxdDymf4fksetADT8IcFVC7TCtlKp/YNHXV9vpBDfLVN9PQza/k9O/H5LV9IqSU9knX5KOOCqrBt4MUEg/2JdTD1SpiRJuO8hup+PxrSBctxF7+Rh0M1Ogz4kY1gTg2hqdRVAq5A7B2xp4xqUGxT3afxFJtNbYx1DYx/w0z06B8HI8vp3sQPjxcxAu9IorKQLPXpt71P9tpP3jfXM8ufpQhHvStAImG6Gwzw6C7a83QToiYOlrFs837GHASzlo9uP5YruIGAFriKVK44LH3OcsZqODkiSiQbsKHXG+aW4tOzXBjHgpR6sJ20bH0s7zTOpscFJrsfd7Rtg28B14v2/MpXyP1JlbcPpSEZOU0xw59SSCg1L2+55+33bAd8T4GNftAT5mr+PJ9RE+6ujogGF6BDPfccVj7X8XVdfQd/2836IXR7236a8UfGoCUq37lyVqmqzC7VpNPnM/DJjtjNnFyJt50Fg40gZCSoBp5h/apPWz4QRciYlM2yIZAo2LVMA0JaeVCvNTMzPOL9NUJpIr+BOXTnpcPO+uyXq9/nwsDjrvpM+rJVgszV48C4vhDvW1dj9eUBLRFu4ynaFdyaTrpF84ahSER23p88T3OL1benWsRKWoZILaYa9Yz99dfYAVnA3HLOrVwlc4Pfpw8frtx9lbstu+Aijvw/FwHIjdOF9w3Tvq8NF0nN7eoPn9ifX9ifU/f2K13d/jgx+VikvdG6caDpsfjpX0NMqJ4+I522yoef1h1XZLy58qtESQi4ituJVUA4Eeo445qEvfY81i9ropocE1HU/iqmpI6GgqIOJrNM6TBEt/UrZPw1eXs2sWsWX7NiyMIB3L1/Ru5GsWsxt2w8IbkywEYgzrG6a4ziqeBboIdonweEVY9NnyPrBl+0GRdVu67nl5SKNNKPSXAntU4Wcqm/dY/7ITb3a+qNBi20lTBhfb7fYf685P4g==",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:"Note:",id:"note",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)(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.h3,{id:"note",children:"Note:"}),"\n",(0,i.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\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)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,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.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:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.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:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\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)(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:"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)(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,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.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)(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.dfda5b34.js b/assets/js/38c56221.dfda5b34.js new file mode 100644 index 000000000..5125cda84 --- /dev/null +++ b/assets/js/38c56221.dfda5b34.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:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>g,toc:()=>j});var n=a(85893),r=a(11151),t=a(58219),i=(a(62316),a(51039)),l=a.n(i),o=(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]( 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:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",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/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:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",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"}},f={},j=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function x(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,r.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:"Draft Document"})}),"\n",(0,n.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,n.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,n.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,n.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,n.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"note",children:"Note:"}),"\n",(0,n.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,n.jsx)(d.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.jsx)("span",{className:"openapi-schema__divider"}),(0,n.jsx)("span",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]})}),(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)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(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)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document created successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,n.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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.395b3964.js b/assets/js/38e3d9c8.395b3964.js deleted file mode 100644 index afa67c54a..000000000 --- a/assets/js/38e3d9c8.395b3964.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 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.e113e88d.js b/assets/js/38e3d9c8.e113e88d.js new file mode 100644 index 000000000..24dcd0143 --- /dev/null +++ b/assets/js/38e3d9c8.e113e88d.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:()=>c,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>u,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:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},l=void 0,u={id:"API-docs/opensign-api-v-1",title:"OpenSign API v1",description:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.",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:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.",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"}},c={},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:"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today."}),"\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:"OpenSign Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign 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:api@opensignlabs.com",children:"api@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:()=>u.z,ErrorBoundaryError:()=>C.aG,ErrorBoundaryErrorMessageFallback:()=>C.Ac,ErrorBoundaryTryAgainButton:()=>C.Cw,ErrorCauseBoundary:()=>C.QW,HtmlClassNameProvider:()=>f.FG,NavbarSecondaryMenuFiller:()=>h.Zo,PageMetadata:()=>f.d,ReactContextError:()=>p.i6,SkipToContentFallbackId:()=>O.u,SkipToContentLink:()=>O.l,ThemeClassNames:()=>c.k,ThemedComponent:()=>o.Z,UnlistedBannerMessage:()=>P.eU,UnlistedBannerTitle:()=>P.cI,UnlistedMetadata:()=>P.T$,composeProviders:()=>p.Qc,createStorageSlot:()=>a.WA,duplicates:()=>A.l,filterDocCardListItems:()=>i.MN,isMultiColumnFooterLinks:()=>S.a,isRegexpStringMatch:()=>_.F,listStorageKeys:()=>a._f,listTagsByLetters:()=>b.P,prefersReducedMotion:()=>d.n,processAdmonitionProps:()=>E.X,translateTagsPageTitle:()=>b.M,uniq:()=>A.j,useCollapsible:()=>u.u,useColorMode:()=>m.I,useContextualSearchFilters:()=>s._q,useCurrentSidebarCategory:()=>i.jA,useDocsPreferredVersion:()=>T.J,useEvent:()=>p.zX,usePluralForm:()=>l.c,usePrevious:()=>p.D9,usePrismTheme:()=>I.p,useSearchLinkCreator:()=>k,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),u=n(86043),c=n(35281),d=n(91442),p=n(902),f=n(10833),m=n(92949),h=n(13102),g=n(87524),b=n(35155),v=n(67294),y=n(52263),x=n(91980);const j="q";function w(){return(0,x.Nc)(j)}function k(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,y.default)(),{algolia:{searchPagePath:n}}=t;return(0,v.useCallback)((t=>`${e}${n}?${j}=${encodeURIComponent(t)}`),[e,n])}var S=n(42489),_=n(98022),A=n(67392),I=n(66412),T=n(60373),E=n(94697),O=n(55225),P=n(35835),C=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:()=>u});var r=n(67294),o=n(16550),a=n(20469),s=n(91980),i=n(67392),l=n(50012);function u(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 c(e){const{values:t,children:n}=e;return(0,r.useMemo)((()=>{const e=t??function(e){return u(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=c(e),[i,u]=(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,m]=p({queryString:n,groupId:o}),[h,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??h;return d({value:e,tabValues:s})?e:null})();(0,a.Z)((()=>{b&&u(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}`);u(e),m(e),g(e)}),[m,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:()=>c});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 u(){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 c(){const e=u();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,u=(0,s.default)(n?.url),c=(0,s.default)(r?.url);return n&&r?o.default.createElement(i.default,{alt:l(),sources:{light:u,dark:c},className:"openapi__logo"}):n||r?o.default.createElement(i.default,{alt:l(),sources:{light:u??c,dark:u??c},className:"openapi__logo"}):void 0}},9472:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>m});var r=n(67294),o=n(12466),a=n(70989),s=n(72389),i=n(86010),l=n(85564),u=n.n(l),c=n(85893);function d(e){let{className:t,block:n,selectedValue:a,selectValue:s,tabValues:l}=e;const u=[],{blockElementScrollPositionUntilNextRender:d}=(0,o.o5)(),p=e=>{const t=e.currentTarget,n=u.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=u.indexOf(e.currentTarget)+1;t=u[n]??u[0];break}case"ArrowLeft":{const n=u.indexOf(e.currentTarget)-1;t=u[n]??u[u.length-1];break}}t?.focus()},m=(0,r.useRef)(null),[h,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,c.jsxs)("div",{className:"openapi-tabs__schema-tabs-container",children:[h&&(0,c.jsx)("button",{className:"openapi-tabs__arrow left",onClick:()=>{m.current.scrollLeft-=90}}),(0,c.jsx)("ul",{ref:m,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,c.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>u.push(e),onKeyDown:f,onClick:p,...r,className:(0,i.default)("tabs__item","openapi-tabs__schema-item",r?.className,{active:a===t}),children:(0,c.jsx)("span",{className:"openapi-tabs__schema-label",children:n??t})},t)}))}),h&&(0,c.jsx)("button",{className:"openapi-tabs__arrow right",onClick:()=>{m.current.scrollLeft+=90}})]})}function p(e){let{lazy:t,children:n,selectedValue:o}=e;n=Array.isArray(n)?n:[n];const a=u()(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,c.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,c.jsxs)("div",{className:"openapi-tabs__schema-container",children:[(0,c.jsx)(d,{...e,...t}),(0,c.jsx)(p,{...e,...t})]})}function m(e){const t=(0,s.default)();return(0,c.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(){u(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),u=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,u=/CriOS\/[\d]+/.test(navigator.userAgent);if((u||a&&s||l)&&"undefined"!=typeof FileReader){var c=new FileReader;c.onloadend=function(){var e=c.result;e=u?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),o?o.location.href=e:location=e,o=null},c.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=u.saveAs=u,e.exports=u})?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,u=t.length;for(a||(a=o),i||(i=[]);++l0&&a(c)?n>1?e(c,n-1,a,s,i):r(i,c):s||(i[i.length]=c)}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/451a5132.95befe47.js b/assets/js/451a5132.95befe47.js new file mode 100644 index 000000000..e80c712f4 --- /dev/null +++ b/assets/js/451a5132.95befe47.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),d=(a(82723),a(9487)),o=a(41429),m=a(5397),p=a(4667),c=a(9472),h=a(85162);const x={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",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/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,r.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 folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\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:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(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)(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)(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)(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:"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:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(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)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\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:"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)(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)(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:"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:"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)(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)(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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,r.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/451a5132.aaf8cba0.js b/assets/js/451a5132.aaf8cba0.js deleted file mode 100644 index 460dc1afb..000000000 --- a/assets/js/451a5132.aaf8cba0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),d=(a(82723),a(9487)),o=a(41429),m=a(5397),c=a(4667),p=a(9472),h=a(85162);const u={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v4zYM/isaP+0AJ3HS9oYZw7Bi6IrsimuBdhiwNigUm4nVyJJOkvOCwP/9QNlpnJd27XC7L01N8eUh9YjkGjyfOkju4Q8tM7QwiiBDl1phvNAKErjLkdVn7Eo4z85vhgwLoxdoHVvpknnNLHorcI6MM0k6esImtclC+Jzp+leXnhluUfna3zCDCLRByynUMIMEaivyAREYbnmBHi3hW4PiBUICBx4EofxSol3BPnY9fsLUD7MtIIjA4pdSWMwgmXDpMALnVxJDcFtABLg0Ume4PU5zLDgka/ArQ3rOW6GmEAUD7tsSXPLCBGdQVdEzZikK4fehvhmHt+UOjIIvRVEWkJzFcbQBpcpijBaqFoZ+3ILgZsJ8MwQvx4yrEfl1RiuHjnQHcUw/uxfjyjRF5yalZM8EgAhSrTwqT/rcGCnScNB7cmS0PgRQ3y9RxZIbL+qQFl0pfUuPW8spYeGxcP9uv6HNe+/c5P1xvhw8GSpJzbfPofrvc6NwsWFrFe3z/Z2+/hwo7s5m4gb3ff1XZK4ct9ClFrnH7Nwfc7U1HMSDk04/7sQ/3fU/Jqc/J2cfu3Ec/wMRLAtJtg1NM+4DUi+8bH+XJvsOcVqCOsVHiw6qtlwoKRQ+bij+OIjjx/4J6VQRnB7j+q0u0OdCTdkClWcLq9U0YkYid8i8XTE+5UIxyT3aH77dI0BrtX29Wu9D9loVTqkKz0U4OyzCUM25FFmYHnd6hur7ZtoO7+vwBHWXE6JWCuewk2xbXifpMC2t8KswmZYdbkSnPk/uR9QCqbCaJtoU61Hmc0igtzPfHNr5ZriVVkICuffGJb0eN6arDSonpkryseumuuhxI3rzPlBP39V2nk+FmnZetRptMd9SXevS7SDftksjPiH1y6Ywba1mhOTIQweo6Huig3FTrmuD6lZMVSj2vH8wlO9y4Zhw4TjTaVmg8uHi2URbtmfNxtxhxrRiPsdwSPKTbp85g6mYNJzpsgf1oIjPrHRIY0UKNXPJg+qw++vJRKSCS/Y3jp3wOPpxU7nFYnFQsQ/B5lL4vBwzi0Zv1adBGMratnr++AAReLSFu57cop2LFJtbeiFULyj3mpfA0/ASsOCCbrcR/bZvRMyUIkXlsMXd88ubKzZnJ90YohY93gC6dzX8/eLz7QX5JTrWl9Tvxt04jAztfMFVK9Ql+s121xB5537X22f9f++ODV09Ln3PSC7Cqw3Jr5sXd9/eKEcR5Np5kq7XxKu/rKwqEtcLEb3DTDg+lq2V6MXcju6WRxHNcHVsb51zWdabYnQkbm20WRzfottseFvVEX1YQbqhLUWbV0uJ1jbnaYqmHeCgD+80s8uLO4iAl1TadreYhW7R/EPeN0dq1fK920ZqAPSXcjpq8Avx5ROufn1Wr09eNGjy22hT+UdVVX0F031hsA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v4zYM/isaP+0AJ3HS9oYZw7Bi6IrsimuBdhiwNigUm4nVyJJOkvOCwP/9QNlpnJd27XC7L01N8eUh9YjkGjyfOkju4Q8tM7QwiiBDl1phvNAKErjLkdVn7Eo4z85vhgwLoxdoHVvpknnNLHorcI6MM0k6esImtclC+Jzp+leXnhluUfna3zCDCLRByynUMIMEaivyAREYbnmBHi3hW4PiBUICBx4EofxSol3BPnY9fsLUD7MtIIjA4pdSWMwgmXDpMALnVxJDcFtABLg0Ume4PU5zLDgka/ArQ3rOW6GmEAUD7tsSXPLCBGdQVdEzZikK4fehvhmHt+UOjIIvRVEWkJzFcbQBpcpijBaqFoZ+3ILgZsJ8MwQvx4yrEfl1RiuHjnQHcUw/uxfjyjRF5yalZM8EgAhSrTwqT/rcGCnScNB7cmS0PgRQ3y9RxZIbL+qQFl0pfUuPW8spYeGxcP9uv6HNe+/c5P1xvhw8GSpJzbfPofrvc6NwsWFrFe3z/Z2+/hwo7s5m4gb3ff1XZK4ct9ClFrnH7Nwfc7U1HMSDk04/7sQ/3fU/Jqc/J2cfu3Ec/wMRLAtJtg1NM+4DUi+8bH+XJvsOcVqCOsVHiw6qtlwoKRQ+bij+OIjjx/4J6VQRnB7j+q0u0OdCTdkClWcLq9U0YkYid8i8XTE+5UIxyT3aH77dI0BrtX29Wu9D9loVTqkKz0U4OyzCUM25FFmYHnd6hur7ZtoO7+vwBHWXE6JWCuewk2xbXifpMC2t8KswmZYdbkSnPk/uR9QCqbCaJtoU61Hmc0igtzPfHNr5ZriVVkICuffGJb0eN6arDSonpkryseumuuhxI3rzPlBP39V2nk+FmnZetRptMd9SXevS7SDftksjPiH1y6Ywba1mhOTIQweo6Huig3FTrmuD6lZMVSj2vH8wlO9y4Zhw4TjTaVmg8uHi2URbtmfNxtxhxrRiPsdwSPKTbp85g6mYNJzpsgf1oIjPrHRIY0UKNXPJg+qw++vJRKSCS/Y3jp3wOPpxU7nFYnFQsQ/B5lL4vBwzi0Zv1adBGMratnr++AAReLSFu57cop2LFJtbeiFULyj3mpfA0/ASsOCCbrcR/bZvRMyUIkXlsMXd88ubKzZnJ90YohY93gC6dzX8/eLz7QX5JTrWl9Tvxt04jAztfMFVK9Ql+s121xB5537X22f9f++ODV09Ln3PSC7Cqw3Jr5sXd9/eKEcR5Np5kq7XxKu/rKwqEtcLEb3DTDg+lq2V6MXcju6WRxHNcHVsb51zWdabYnQkbm20WRzfottseFvVEX1YQbqhLUWbV0uJ1jbnaYqmHeCgD+80s8uLO4iAl1TadreYhW7R/EPeN0dq1fK920ZqAPSXcjpq8Avx5ROufn1Wr09eNGjy22hT+UdVVX0F031hsA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,r.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 folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\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:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(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)(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)(d.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)(c.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:"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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(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)("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)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\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:"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)(d.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)(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)(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:"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)(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)(c.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 v(e={}){const{wrapper:s}={...(0,r.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/52d5c0f9.24a25302.js b/assets/js/52d5c0f9.24a25302.js new file mode 100644 index 000000000..ce5e132a9 --- /dev/null +++ b/assets/js/52d5c0f9.24a25302.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>k,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=l(85893),n=l(11151),t=l(58219),i=(l(62316),l(51039)),o=l.n(i),d=(l(82723),l(9487)),r=l(41429),c=l(5397),m=l(4667),p=l(9472),h=l(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:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",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/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:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",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={},y=[{value:"Request",id:"request",level:2}];function g(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 Document"})}),"\n",(0,a.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,a.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(r.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,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(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)(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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Document 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)(d.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.4f2bfead.js b/assets/js/52d5c0f9.4f2bfead.js deleted file mode 100644 index a42633ea8..000000000 --- a/assets/js/52d5c0f9.4f2bfead.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:()=>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/5a2de241.5a92f5d2.js b/assets/js/5a2de241.5a92f5d2.js new file mode 100644 index 000000000..480f6cfab --- /dev/null +++ b/assets/js/5a2de241.5a92f5d2.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,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),h=s(85162);const x={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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",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)(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)(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",example:""}})]})]})})}),"\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)(o.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)(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)(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)(o.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)(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)(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)(o.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)(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)(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)(o.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)(c.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 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.7d7e666b.js b/assets/js/5a2de241.7d7e666b.js deleted file mode 100644 index 3707d071d..000000000 --- a/assets/js/5a2de241.7d7e666b.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:()=>j,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>f,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),d=(s(62316),s(51039)),n=s.n(d),r=(s(82723),s(9487)),m=s(41429),p=s(5397),c=s(4667),o=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/ivcfUoB2VZe2mLCMCzrijZo0RiNgwFLDIOWTjYbimRJyo5h6L8PR0m2YiduM3TbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xR/kmQJpNZifc88UYuYo6ik20ZIdi19LYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+d52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5ABKlWHpUnR9wYKdJA8uCLI2/r/dD19Aumnhi3lBIv0NHbmvBvAyRyeKApARceNvFCFYHS/tlmhgQRmcWFwGUoLCdmivm5cCzTaVkQvGon5c9zsamKro2KdGSGlipy395WG6oqAi/8A1OTTm1OppTqqiI5i85o5WpWT+J4vwI2t6upSObKNEXn8lLK1U8/LqX18bfAcZedvHfDs/eGCGlCOveHlU7ik9PecdyLX4+OXyVnPycvX/XjOP4LIrgv5LaeIGvqomWv/t85EEoKhZOWtclJHE9OGyrPHmOvqRbTXKMFlyJjuUCZMfLpfiCBaK22/7CaD8R3CD5BbsGfHSgdpT3Ldamy/xvuYxEdBng2eb2B+HIf4oWqKaPRM9J3qP4LhFs8Xfe+dk+hPqxqUQuF9/AAbPe8BukwLa3wqzDW7nvciF79PrkZ07Ao0M81jURThoBpvCUwaLvLYN3pMxWQPbtop2RpJSQw9964ZDDgxvS1QUXdU/Kp66e6GHAjBotjqKJdaef5TKhZ76DWeBv/FXFc0/gAxYZMbsQHXEHUktSVamb3HHmGNhBKqfu8nZNv2wRsON4dLu1s+b5xsbsgPDoAuv0fKI9C5TogavJ5aVBdkXGqhsXxntUR+RQuvG5dh8pkubZsR5tNucOMaRX2FHpJ56f9482+FFT77FbdqitdICsd5qVkUqg7l9yqHru5zHORCi7Znzh1wuP4qE3ncrncS+OLoPNO+Hk5ZRaN3orPwmHIdVdr84c2C4+2cJf5FdqFSLEpnSdcDYLwoLmqPA1XFQsuqOSao992lYhyKVJUrpv483fDj2zBTvsxRJ2a/Y6gBx8v3rz9dPWW7NIdqZN03I/7MR0Z7XzBVcfVzrq7m9/1tu/829txc4c83vuBkVyEthLAr5uWcAOdq5B0F+NxBHPtPIms11Rk11ZWFR1/LdFS4xlHsOBWUKShb2TC0XO2WXCfhH30uV012fN27EcBtZ1CUZtYcFmG7SqCO1ztLPvVuIradkER1xJv6rh6I7KztbA3Eqjb1RrnaYrGH5Tt9uDh9QgimDaLexG+AcDyJX008CUkcAu3ED5myEBohuF8DZKrWclnJF+bpSbHS8pct0PehQ7ZPBCwRyl52DprJPRLuB5V+IVK8QOuft2I12+eVGiobaUpPeOqqv4Gp4TgdA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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/ivcfUoB2VZe2mLCMCzrijZo0RiNgwFLDIOWTjYbimRJyo5h6L8PR0m2YiduM3TbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xR/kmQJpNZifc88UYuYo6ik20ZIdi19LYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+d52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5ABKlWHpUnR9wYKdJA8uCLI2/r/dD19Aumnhi3lBIv0NHbmvBvAyRyeKApARceNvFCFYHS/tlmhgQRmcWFwGUoLCdmivm5cCzTaVkQvGon5c9zsamKro2KdGSGlipy395WG6oqAi/8A1OTTm1OppTqqiI5i85o5WpWT+J4vwI2t6upSObKNEXn8lLK1U8/LqX18bfAcZedvHfDs/eGCGlCOveHlU7ik9PecdyLX4+OXyVnPycvX/XjOP4LIrgv5LaeIGvqomWv/t85EEoKhZOWtclJHE9OGyrPHmOvqRbTXKMFlyJjuUCZMfLpfiCBaK22/7CaD8R3CD5BbsGfHSgdpT3Ldamy/xvuYxEdBng2eb2B+HIf4oWqKaPRM9J3qP4LhFs8Xfe+dk+hPqxqUQuF9/AAbPe8BukwLa3wqzDW7nvciF79PrkZ07Ao0M81jURThoBpvCUwaLvLYN3pMxWQPbtop2RpJSQw9964ZDDgxvS1QUXdU/Kp66e6GHAjBotjqKJdaef5TKhZ76DWeBv/FXFc0/gAxYZMbsQHXEHUktSVamb3HHmGNhBKqfu8nZNv2wRsON4dLu1s+b5xsbsgPDoAuv0fKI9C5TogavJ5aVBdkXGqhsXxntUR+RQuvG5dh8pkubZsR5tNucOMaRX2FHpJ56f9482+FFT77FbdqitdICsd5qVkUqg7l9yqHru5zHORCi7Znzh1wuP4qE3ncrncS+OLoPNO+Hk5ZRaN3orPwmHIdVdr84c2C4+2cJf5FdqFSLEpnSdcDYLwoLmqPA1XFQsuqOSao992lYhyKVJUrpv483fDj2zBTvsxRJ2a/Y6gBx8v3rz9dPWW7NIdqZN03I/7MR0Z7XzBVcfVzrq7m9/1tu/829txc4c83vuBkVyEthLAr5uWcAOdq5B0F+NxBHPtPIms11Rk11ZWFR1/LdFS4xlHsOBWUKShb2TC0XO2WXCfhH30uV012fN27EcBtZ1CUZtYcFmG7SqCO1ztLPvVuIradkER1xJv6rh6I7KztbA3Eqjb1RrnaYrGH5Tt9uDh9QgimDaLexG+AcDyJX008CUkcAu3ED5myEBohuF8DZKrWclnJF+bpSbHS8pct0PehQ7ZPBCwRyl52DprJPRLuB5V+IVK8QOuft2I12+eVGiobaUpPeOqqv4Gp4TgdA==",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"}},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:"Update Template"})}),"\n",(0,l.jsx)(n(),{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)(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",example:""}})]})]})})}),"\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)(o.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)(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)(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)(o.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)(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)(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)(o.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)(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)(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)(o.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)(c.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)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.3b8abbdf.js b/assets/js/5c04ee3b.3b8abbdf.js deleted file mode 100644 index 0ede97705..000000000 --- a/assets/js/5c04ee3b.3b8abbdf.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:()=>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.a3248228.js b/assets/js/5c04ee3b.a3248228.js new file mode 100644 index 000000000..59ab84783 --- /dev/null +++ b/assets/js/5c04ee3b.a3248228.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:()=>b,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var l=a(85893),n=a(11151),o=a(58219),i=(a(62316),a(51039)),r=a.n(i),t=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=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:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",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:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",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={},j=[{value:"Request",id:"request",level:2}];function y(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 Webhook"})}),"\n",(0,l.jsx)(r(),{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)(o.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)(t.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:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(p.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)(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)(t.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)(t.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 g(e={}){const{wrapper:s}={...(0,n.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/5ce9853b.6d356e93.js b/assets/js/5ce9853b.6d356e93.js deleted file mode 100644 index d1dc07b5c..000000000 --- a/assets/js/5ce9853b.6d356e93.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV92P2zYM/1c0Pq2A83HX24sxDL3dDsWhxa5obthDLggUm07UkyVVkpMLDP/vA+XPfPTabdj2sJfAoUiK/JE/mi7B87WDeA6/6KTIUXkHiwhSdIkVxgutIIaP6FClzOLnAp1nOReSec0Kh5Zl2jIn1kqoNUsbF+NHBRFog5aTh7u089G4IA8QQfPvZ53uIS4h0cqj8vTIjZEiCdaTT46CKMElG8w5PZGdsJhS2O2dS5FCBBg8LyLwe4MQg159wsRDBMZSOF6gIwdDo7hslZ23Qq3JyzPPjSSRsXorUuwyYyKFqr3mjOUhbq11ACqgllmdB7jQOoLQ4ugE2hq9PgayftP8HSc67wJYuqJO76uB3BTONxdzX1js7gt+WOOHCcU8PvvJxueSCptzP2Y3XDGhElmkyDItpd5RqbfcCr6S6Bgryw5OL7zEqmJlSVmhXSqeY1VFvYDuOxCYjVaNisUExfbAqhNhb9jJBqb4bITdL1PuG0Gic8PVfhhA3aTLwsqqGh8g3CO6alrxb8FJTv7HWFYRhNghBhtI3yNb0WHPXm8LDAJntHI1NS+n08DQA8Ah+vbh8DLzLbpCnmVMXaPzY6BmCfHfFUmCzmWFlPvxQa5CSaFw2SazvJxOlxdTSrmK4OqfzQqt1fbPJjXTOfoNNeCOMttZrdYvp3Q1nS4vu4yuTjMa9YNSac8yXaiUiWw4Pplw4SzR1mJCr4pRPR8PDJrJmdZHNa0aQxOaKgyrepAyKZxnur8lzM//EtkzIGh7lOXXkL5aXnRI/3CK9J3acilSdv3hjj3oJ1Tf/Qs59xkOr/f19RTqcx7eijQoQlJBKZzDQbJDeZ2kw6Swwu8hnpfwPOJGjOrzeL6oFhFQq2raI4x2IWLuNxDDpJ8wQE7sFq0LPgorIYaN98bFkwk3ZqwNKuoYyVeO3qMTbsRkewFVdKztPF8LtR69aLXog54RsDV2B6F3CHIj3uEeohaZoVYEggq6QZ6iDShSvT72q9Fti/rR3nJ2Oel2k9O14WRrADh87YX3oFCZDpE3xbo3qGZirUKptxcn78KHjXBETTpuAwltFzbDI2u24g5TphXzGwyHJH89vmDOYCKypmPH7FE9KppPRJqskEwK9eRimhXz+ywTieCS/Y4rJzwuvm/LttvtTsr1Kti8FX5TrJhFo3v1dRCGmg6tuj+vIAKPNnf32QztViTYtMgXrpoE5UnDQ17vZW01GtGbYyOCXIoElcMBc67ffnjPtuz1eArRoDe/IejJ+7ub219nt+SXuFAX6WI8HU9JROzJuRpcdWa3P67xYDP/i58CDQ3CQmQkF2EchLzKhsnzwa5A+/uGaB7PoSypZX6jPYPEnwu0NCMWEbRbU5gQUcsfov4TUjPf1DGPHuhuUpdFTcWjwUj0ry2ukwSNf1F3OIk+3M8eIIJ2Zcx1GlYevqMvG76DGB7hEcKHEHmo1w+SlyC5Whd8Tfq1X6I9LwiI4cx4CjOjeaDM2iO1H0R5OEzqVOiXEjtr8COR7h3uf+rU65MvGjTYttpUvkVVVX8A0bQGKQ==",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/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV92P2zYM/1c0Pq2A83HX24sxDL3dDsWhxa5obthDLggUm07UkyVVkpMLDP/vA+XPfPTabdj2sJfAoUiK/JE/mi7B87WDeA6/6KTIUXkHiwhSdIkVxgutIIaP6FClzOLnAp1nOReSec0Kh5Zl2jIn1kqoNUsbF+NHBRFog5aTh7u089G4IA8QQfPvZ53uIS4h0cqj8vTIjZEiCdaTT46CKMElG8w5PZGdsJhS2O2dS5FCBBg8LyLwe4MQg159wsRDBMZSOF6gIwdDo7hslZ23Qq3JyzPPjSSRsXorUuwyYyKFqr3mjOUhbq11ACqgllmdB7jQOoLQ4ugE2hq9PgayftP8HSc67wJYuqJO76uB3BTONxdzX1js7gt+WOOHCcU8PvvJxueSCptzP2Y3XDGhElmkyDItpd5RqbfcCr6S6Bgryw5OL7zEqmJlSVmhXSqeY1VFvYDuOxCYjVaNisUExfbAqhNhb9jJBqb4bITdL1PuG0Gic8PVfhhA3aTLwsqqGh8g3CO6alrxb8FJTv7HWFYRhNghBhtI3yNb0WHPXm8LDAJntHI1NS+n08DQA8Ah+vbh8DLzLbpCnmVMXaPzY6BmCfHfFUmCzmWFlPvxQa5CSaFw2SazvJxOlxdTSrmK4OqfzQqt1fbPJjXTOfoNNeCOMttZrdYvp3Q1nS4vu4yuTjMa9YNSac8yXaiUiWw4Pplw4SzR1mJCr4pRPR8PDJrJmdZHNa0aQxOaKgyrepAyKZxnur8lzM//EtkzIGh7lOXXkL5aXnRI/3CK9J3acilSdv3hjj3oJ1Tf/Qs59xkOr/f19RTqcx7eijQoQlJBKZzDQbJDeZ2kw6Swwu8hnpfwPOJGjOrzeL6oFhFQq2raI4x2IWLuNxDDpJ8wQE7sFq0LPgorIYaN98bFkwk3ZqwNKuoYyVeO3qMTbsRkewFVdKztPF8LtR69aLXog54RsDV2B6F3CHIj3uEeohaZoVYEggq6QZ6iDShSvT72q9Fti/rR3nJ2Oel2k9O14WRrADh87YX3oFCZDpE3xbo3qGZirUKptxcn78KHjXBETTpuAwltFzbDI2u24g5TphXzGwyHJH89vmDOYCKypmPH7FE9KppPRJqskEwK9eRimhXz+ywTieCS/Y4rJzwuvm/LttvtTsr1Kti8FX5TrJhFo3v1dRCGmg6tuj+vIAKPNnf32QztViTYtMgXrpoE5UnDQ17vZW01GtGbYyOCXIoElcMBc67ffnjPtuz1eArRoDe/IejJ+7ub219nt+SXuFAX6WI8HU9JROzJuRpcdWa3P67xYDP/i58CDQ3CQmQkF2EchLzKhsnzwa5A+/uGaB7PoSypZX6jPYPEnwu0NCMWEbRbU5gQUcsfov4TUjPf1DGPHuhuUpdFTcWjwUj0ry2ukwSNf1F3OIk+3M8eIIJ2Zcx1GlYevqMvG76DGB7hEcKHEHmo1w+SlyC5Whd8Tfq1X6I9LwiI4cx4CjOjeaDM2iO1H0R5OEzqVOiXEjtr8COR7h3uf+rU65MvGjTYttpUvkVVVX8A0bQGKQ==",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"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(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:"Resend request mail"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,l.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.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)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(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."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "document not found or 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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.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 v(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/5ce9853b.969e89e9.js b/assets/js/5ce9853b.969e89e9.js new file mode 100644 index 000000000..f3c49b2da --- /dev/null +++ b/assets/js/5ce9853b.969e89e9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT92VRFHEdIzAS1EacIg+2IFC7oxVjLsnwIllY7Fu/pJ/WLymGe9HKUpy0RduHvhgyOdfDmTOzFfO8cCy9Za90FkpU3rFZwnJ0mRXGC61Yyt6hQ5WDxU8BnYeSCwleQ3BoYaktOFEooQrIWxPjO8USpg1aThYu895Ga4IssIS1//2k8y1LK5Zp5VF5+smNkSKL2pOPjoKomMtWWHL6RXrCYk5hdz7nImcJw2h5ljC/NchSphcfMfMsYcZSOF6gIwNDpbTqhJ23QhVk5YGXRtKRsXotcuwzA5GzunNzRHMft047AhVRW1pdRrjQOoLQ4ugA2ga9XQyk/bL9d5zpsg9g7kKT3hcDOQ/Ot465DxZ7f9EOtHZAKPD44CcrX0p62JL7MZxzBUJlMuQISy2l3tBTr7kVfCHRAVRVD6cXXmJdQ1VRVmjnipdY18nugPztHZiVVq2IxQzFek+rP8KdYn82UMUHI+x2nnPfHmS6NFxthwE0RToPVtb1eA/hHaKLthT/Fpxk5H+MZZ2wGDtLmY1Nv0O2pstd93obMB44o5VrWvPFdBo7dA9wlnw9OTzd+RZdkEc7pnmj4zTQdAn1vwtZhs4tg5Tb8V6uQkmhcN4lM38xnc5PppRynbDTfzYrtFbbP5vUjS7Rr6gAN5TZxmpVPJ3S6XQ6f9FndHqY0WhHlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjnkLLnHlz1bRVq2hiUUWyaogUpHAe9M5L5M//EtkjIGj7KMsvIX06P+mR/v4Q6Uu15lLkcHZ9Ce/1Papn/0LOuwyH7n3jnkJ9KONUJKKISUWheM/2kh2eN0k6zIIVfsvS24o9jLgRo+Y+vZ3Vs4RRqWraI4x2MWLuVyxlkx3DMDJi12hdtBGsZClbeW9cOplwY8baoKKKkXzhaI5OuBGT9Qmrk8fSzvNCqGL0pNZsF/QNAdtgtxd6jyA34g1uWdIhM5RKmKAHXSHP0UYU6b3e7Vajiw71R3vL0eWk300O14aDrYGx/bEX56BQSx0jbx/ryqC6EYWKT70+OZiFH1BmukRaZvwKoRP//dffokYXW6zEZ3AVLBi9QbsMErjKYSnxQSwkRmFOE9HBVgcy55CXEp2TNEw9FpZ7hFwUwnPZr5wZN3whpKDaJTFN2hYG5e/G8GGFfoWWrr6xCBxyXKOkkgep9T3Z8Rp48LqMPjo8N9reLymkBDgsghMKnQOH2KmgWnGVIXSFkFCfcwWoPFpjhUPgoiRhWpNxuRSZIMPUqJZntO8pXiA5S4DiJhTaZ3Vg9SI4D07LEBMhjyWib1JUiLkbwyuxxiZxOszRcyExhyKQiQQynSO0VUBpqBwWtKkYci8yjEad59aDxDXaWPjxJWnEgdFEKIJL4tfh25Ihb7lyxINNQN3T9PAZq2lWRh85347hTt0pmjpEhVQAUqh7l9IEuO3L7AMunPA4+7Zrxs1mc9CEz/d1Xgu/CguwaPROr4iHsWWH6v0/z1nCPNrSXS1v0K5Fhi0DfMbnJApPWprlzdrdNRs34uVjBeomKTJUDgekePb6+i2s4bvxlCUD2vmKgCdvL88vfr65ILtEc03/nYyn4ykdETGWXA1cHflse9y+g4+uv/iV1zJc3HWN5CIyfcyrakn6drAG0qfZihg8vWVVteAOf6EVko4/BbRE/7OEdQtxJP+ko0Zi9XsknjpvYh69J98kLkPDso9mHjF7o3GWZWj8k7LDIXN9dfOeJaz7Gih1HrdZvqGPVr5hKbtjdyx+48bOjJslnVdMclUEXpB8Y5cYnQcCYjgO7uM4aH9QZt2V2g6i3J8TTSr0lxI7qvADEcgb3P7Yizc3n1Vose2k6flmdV3/Ab3Xurs=",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/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT92VRFHEdIzAS1EacIg+2IFC7oxVjLsnwIllY7Fu/pJ/WLymGe9HKUpy0RduHvhgyOdfDmTOzFfO8cCy9Za90FkpU3rFZwnJ0mRXGC61Yyt6hQ5WDxU8BnYeSCwleQ3BoYaktOFEooQrIWxPjO8USpg1aThYu895Ga4IssIS1//2k8y1LK5Zp5VF5+smNkSKL2pOPjoKomMtWWHL6RXrCYk5hdz7nImcJw2h5ljC/NchSphcfMfMsYcZSOF6gIwNDpbTqhJ23QhVk5YGXRtKRsXotcuwzA5GzunNzRHMft047AhVRW1pdRrjQOoLQ4ugA2ga9XQyk/bL9d5zpsg9g7kKT3hcDOQ/Ot465DxZ7f9EOtHZAKPD44CcrX0p62JL7MZxzBUJlMuQISy2l3tBTr7kVfCHRAVRVD6cXXmJdQ1VRVmjnipdY18nugPztHZiVVq2IxQzFek+rP8KdYn82UMUHI+x2nnPfHmS6NFxthwE0RToPVtb1eA/hHaKLthT/Fpxk5H+MZZ2wGDtLmY1Nv0O2pstd93obMB44o5VrWvPFdBo7dA9wlnw9OTzd+RZdkEc7pnmj4zTQdAn1vwtZhs4tg5Tb8V6uQkmhcN4lM38xnc5PppRynbDTfzYrtFbbP5vUjS7Rr6gAN5TZxmpVPJ3S6XQ6f9FndHqY0WhHlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjnkLLnHlz1bRVq2hiUUWyaogUpHAe9M5L5M//EtkjIGj7KMsvIX06P+mR/v4Q6Uu15lLkcHZ9Ce/1Papn/0LOuwyH7n3jnkJ9KONUJKKISUWheM/2kh2eN0k6zIIVfsvS24o9jLgRo+Y+vZ3Vs4RRqWraI4x2MWLuVyxlkx3DMDJi12hdtBGsZClbeW9cOplwY8baoKKKkXzhaI5OuBGT9Qmrk8fSzvNCqGL0pNZsF/QNAdtgtxd6jyA34g1uWdIhM5RKmKAHXSHP0UYU6b3e7Vajiw71R3vL0eWk300O14aDrYGx/bEX56BQSx0jbx/ryqC6EYWKT70+OZiFH1BmukRaZvwKoRP//dffokYXW6zEZ3AVLBi9QbsMErjKYSnxQSwkRmFOE9HBVgcy55CXEp2TNEw9FpZ7hFwUwnPZr5wZN3whpKDaJTFN2hYG5e/G8GGFfoWWrr6xCBxyXKOkkgep9T3Z8Rp48LqMPjo8N9reLymkBDgsghMKnQOH2KmgWnGVIXSFkFCfcwWoPFpjhUPgoiRhWpNxuRSZIMPUqJZntO8pXiA5S4DiJhTaZ3Vg9SI4D07LEBMhjyWib1JUiLkbwyuxxiZxOszRcyExhyKQiQQynSO0VUBpqBwWtKkYci8yjEad59aDxDXaWPjxJWnEgdFEKIJL4tfh25Ihb7lyxINNQN3T9PAZq2lWRh85347hTt0pmjpEhVQAUqh7l9IEuO3L7AMunPA4+7Zrxs1mc9CEz/d1Xgu/CguwaPROr4iHsWWH6v0/z1nCPNrSXS1v0K5Fhi0DfMbnJApPWprlzdrdNRs34uVjBeomKTJUDgekePb6+i2s4bvxlCUD2vmKgCdvL88vfr65ILtEc03/nYyn4ykdETGWXA1cHflse9y+g4+uv/iV1zJc3HWN5CIyfcyrakn6drAG0qfZihg8vWVVteAOf6EVko4/BbRE/7OEdQtxJP+ko0Zi9XsknjpvYh69J98kLkPDso9mHjF7o3GWZWj8k7LDIXN9dfOeJaz7Gih1HrdZvqGPVr5hKbtjdyx+48bOjJslnVdMclUEXpB8Y5cYnQcCYjgO7uM4aH9QZt2V2g6i3J8TTSr0lxI7qvADEcgb3P7Yizc3n1Vose2k6flmdV3/Ab3Xurs=",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",li:"li",p:"p",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:"Resend request mail"})}),"\n",(0,n.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,n.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.ad06079f.js b/assets/js/70853c19.ad06079f.js new file mode 100644 index 000000000..5768886e5 --- /dev/null +++ b/assets/js/70853c19.ad06079f.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:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),l=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:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd6RlzSU3JFeyIOitX9JP65cUQ+5Kq7WjpIjrooD8YEnkGXJmeDgkz5I5PrWse82ucJxqfctGEUvQxkbkTmjFuuwiRbB8hqANFHnCHUKJhePzPnAp9RwWugCnA25e9hZGwjwVcQrCQmExIYQzYjpFAzhD5exQPX/+vPzeHaqhOmzBixczgXNMui9eDBUAwAFcpajAiqlCA6ETEh0XGSoHLhU2jABzIWU1QSvYvn//PnxZhg/6GzIPH7IuDFkYbsiiev9ESAzdr89eXZ70Ti9uLt+9bYAUz5qg0+OTXhOlXYk6l8gtgkGaErhKfETB/yqahnFtIcIYjf6QEkt915v2rWCbvg76b0577+57WiYm40JuAXsnx/23DyDzVKvtIc9/PTvtDVkduNr8GG05HrL+y+ITU1XA43KxLvonvcHF8cl5AxUb5O5BWIVaDdVLolaJbHJrzSZhoYR8KbHKYfbMelpmfRYVPFR9R4Twge7kQ0DAeFFVoC8kRhivkW89/h1j10+GrFtb9f7retR79jwae2pmo3uOf3G5WRG7jny50Vku8RMFZ0MwLmVJMvsJln1G/amm3legf4dDH61AVeIf5dTyUPU9kSnBWIpPFKsK83jlqhpxT6OnpVGV98+4JFXQRyEci5jO0XDKaD9hXUZ3+q/Cxb96I0TM4IcCrftFJwvWXTZeDOdGz0SC/gHgdHmhgo1xrJVD5ciQ57kUsZ+s/bsl6yWzcYoZp280izCY0Pvk0kh6m7hFjqxbnpcsYrkhb51ASwaFkfRRgqwzQk1ZxCbaZNzVW/CO0y5lXZY6l9tuu73QhTkony4HhZE/l5BWrDO2WkXMCecNSszNmGJfrajLoM21ssGHl53O/ZQMijhGayeFhHV2/0kmdodt0BbSPRT5Js7qzRZWMgG79kgunm0FKBSx6aYK6uZlp3PzQxnp0YPB6QxdKtQU5r7KGK2mEeRhMzuzAD7lQoHkDs2zx4sajdFmd9D/zLNdSTjqdG4O10k4vJ+Eq9qrl0uDPFkA3gnr7NOGvMuP3QEe3szXAR7dD/DSogGlHUx0oZKnDao59+5AjtZhfH8/jL6acSkSr11c6FtUTxtJfXoXpidX7zJfuOgQ8iF5kO9nW6HW20OQFuPCCLdg3esluzvguTgI/d3r0WoUMdoAmup4rq33mLuUdVl7vi7HFs0MjfUD+AK6rok8z1s6R0WHqORjS7WwzXPRnh2yVdREW8enQk0PdlqNNh4PKKshcVt+r9PHc/EbLlhUpaWOipig1UyRJ2h8Cmmx3m2OpV6V8qabuws9jTvR3oky6Wc5qgFdQ2jJZoesqY9doYx1hl7cShEq+F9//OktqnuLZ9QzOCsM5HqOho4CuuFMJN6JscSNmGbXahryTKK1cgFCOZwaOkYTMRWOh3cCFbaY53wspCAOEkyTtYEajW2L7okuRUNdXxsEDgnOUBJ1QWp9S+M4DbxwOvNzVDfKuTa3E3IpAg7jwgqF1oJFrExQpVzFCNWaRqQScgWoHJrcCIvARUbgiTaAk4mIBQ1MG87w2EHGFZ8iTRYB+U1ZyMP9wYLR48I6sFoWPhCaMUN0IUSFmNgWvBYzDIFTY4KOC4kJTAsaIoJYJwjlElMYKoExWgc5TS9i9INax40DiTM0nsN+JelohFxTYRBcgp5srS0N5AxXli4XwaFqadbpy42mM9bPkfBFC0jipDOJ5FAigBTqloTPA7he0+wKx1Y4HH1TEXY+n9/bT99u27wRLi3GYDDXG7upb/S7r26+/vEti5hDk9mzyQDNTMTVdegjc7Y9uF2WSx77cumvw2Gv/tw0oN0kRYzKYq24Hb85fwsz+K7VYVFta36Gw+23/Ve900GPxqWKFfbfYavT6lATFbiMq9pUg1K2vtySrZs7eLkp/3uxe/+S24vde7H7f8Ksvdi9Z89e7N6L3Xuxey92/69p9B+K3aXW4PDOtXPJhRdcSh05aCXXleRL+nNKKkr3mi2XY27x0sjVipo/FGhIghlFbMaN4GOSDq5Hq6hSKEhcucUF67JX4bFxcEETE1wWQexo6E4ksASL4zjG3O3E1oWe87PBBYvYuNTmM52QjeFz0u35nHUZEcfr/P5V7RVkal8yydW04FPCh3FJWOEFZaGuytx6Vab8QpFVXWpR83Jbrgmh0H8K7EGDH+mJ9RsuflrDQ89HDcrcVmhau9FqtfobnPcnwA==",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:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd6RlzSU3JFeyIOitX9JP65cUQ+5Kq7WjpIjrooD8YEnkGXJmeDgkz5I5PrWse82ucJxqfctGEUvQxkbkTmjFuuwiRbB8hqANFHnCHUKJhePzPnAp9RwWugCnA25e9hZGwjwVcQrCQmExIYQzYjpFAzhD5exQPX/+vPzeHaqhOmzBixczgXNMui9eDBUAwAFcpajAiqlCA6ETEh0XGSoHLhU2jABzIWU1QSvYvn//PnxZhg/6GzIPH7IuDFkYbsiiev9ESAzdr89eXZ70Ti9uLt+9bYAUz5qg0+OTXhOlXYk6l8gtgkGaErhKfETB/yqahnFtIcIYjf6QEkt915v2rWCbvg76b0577+57WiYm40JuAXsnx/23DyDzVKvtIc9/PTvtDVkduNr8GG05HrL+y+ITU1XA43KxLvonvcHF8cl5AxUb5O5BWIVaDdVLolaJbHJrzSZhoYR8KbHKYfbMelpmfRYVPFR9R4Twge7kQ0DAeFFVoC8kRhivkW89/h1j10+GrFtb9f7retR79jwae2pmo3uOf3G5WRG7jny50Vku8RMFZ0MwLmVJMvsJln1G/amm3legf4dDH61AVeIf5dTyUPU9kSnBWIpPFKsK83jlqhpxT6OnpVGV98+4JFXQRyEci5jO0XDKaD9hXUZ3+q/Cxb96I0TM4IcCrftFJwvWXTZeDOdGz0SC/gHgdHmhgo1xrJVD5ciQ57kUsZ+s/bsl6yWzcYoZp280izCY0Pvk0kh6m7hFjqxbnpcsYrkhb51ASwaFkfRRgqwzQk1ZxCbaZNzVW/CO0y5lXZY6l9tuu73QhTkony4HhZE/l5BWrDO2WkXMCecNSszNmGJfrajLoM21ssGHl53O/ZQMijhGayeFhHV2/0kmdodt0BbSPRT5Js7qzRZWMgG79kgunm0FKBSx6aYK6uZlp3PzQxnp0YPB6QxdKtQU5r7KGK2mEeRhMzuzAD7lQoHkDs2zx4sajdFmd9D/zLNdSTjqdG4O10k4vJ+Eq9qrl0uDPFkA3gnr7NOGvMuP3QEe3szXAR7dD/DSogGlHUx0oZKnDao59+5AjtZhfH8/jL6acSkSr11c6FtUTxtJfXoXpidX7zJfuOgQ8iF5kO9nW6HW20OQFuPCCLdg3esluzvguTgI/d3r0WoUMdoAmup4rq33mLuUdVl7vi7HFs0MjfUD+AK6rok8z1s6R0WHqORjS7WwzXPRnh2yVdREW8enQk0PdlqNNh4PKKshcVt+r9PHc/EbLlhUpaWOipig1UyRJ2h8Cmmx3m2OpV6V8qabuws9jTvR3oky6Wc5qgFdQ2jJZoesqY9doYx1hl7cShEq+F9//OktqnuLZ9QzOCsM5HqOho4CuuFMJN6JscSNmGbXahryTKK1cgFCOZwaOkYTMRWOh3cCFbaY53wspCAOEkyTtYEajW2L7okuRUNdXxsEDgnOUBJ1QWp9S+M4DbxwOvNzVDfKuTa3E3IpAg7jwgqF1oJFrExQpVzFCNWaRqQScgWoHJrcCIvARUbgiTaAk4mIBQ1MG87w2EHGFZ8iTRYB+U1ZyMP9wYLR48I6sFoWPhCaMUN0IUSFmNgWvBYzDIFTY4KOC4kJTAsaIoJYJwjlElMYKoExWgc5TS9i9INax40DiTM0nsN+JelohFxTYRBcgp5srS0N5AxXli4XwaFqadbpy42mM9bPkfBFC0jipDOJ5FAigBTqloTPA7he0+wKx1Y4HH1TEXY+n9/bT99u27wRLi3GYDDXG7upb/S7r26+/vEti5hDk9mzyQDNTMTVdegjc7Y9uF2WSx77cumvw2Gv/tw0oN0kRYzKYq24Hb85fwsz+K7VYVFta36Gw+23/Ve900GPxqWKFfbfYavT6lATFbiMq9pUg1K2vtySrZs7eLkp/3uxe/+S24vde7H7f8Ksvdi9Z89e7N6L3Xuxey92/69p9B+K3aXW4PDOtXPJhRdcSh05aCXXleRL+nNKKkr3mi2XY27x0sjVipo/FGhIghlFbMaN4GOSDq5Hq6hSKEhcucUF67JX4bFxcEETE1wWQexo6E4ksASL4zjG3O3E1oWe87PBBYvYuNTmM52QjeFz0u35nHUZEcfr/P5V7RVkal8yydW04FPCh3FJWOEFZaGuytx6Vab8QpFVXWpR83Jbrgmh0H8K7EGDH+mJ9RsuflrDQ89HDcrcVmhau9FqtfobnPcnwA==",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 v(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(o(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.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,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"created:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.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,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"signed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.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,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"completed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.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,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"declined:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.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,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.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)(m.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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.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,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.d6b7d755.js b/assets/js/70853c19.d6b7d755.js deleted file mode 100644 index 133112fcb..000000000 --- a/assets/js/70853c19.d6b7d755.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:()=>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.618d0da1.js b/assets/js/770b40a9.618d0da1.js new file mode 100644 index 000000000..7165a5dd9 --- /dev/null +++ b/assets/js/770b40a9.618d0da1.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:()=>f,contentTitle:()=>u,default:()=>b,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),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:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uo53nU6GmB4+yxhutr8izjfO2dN8UQyPeIFXD1jV9VDtFFchDF6vpe6IDuXXYpUFFeRbcPRvtVMX3KDNdIo2ivkDo4H//+VdgdBNniIZncFlZMHqOlsYlrnKYSFwIGo93p2mHvJTonFyCUB6nlnpfLqbCcxlqL020GTc8FVJQ/BBME9tCLwTdAN4X6Au0tPWdpek8xxlKCjuQWt+FiVkDr7wug4xWZ5hrezchlSLgkFZOKHQOHGJHQVVwlSF0dxGBtjTBo/JojRUOgYuSwBNtAScTkQk6mJLF8sxDyRWfIgmLgPQmL6yfAlanlfPgtKyCISSxRPSNiQoxdwP4RcywMZwWc/RcSMxhWtEREWQ6R2hzh8xQOaToPBgSLzIMhzrPrQeJM7Qh9sJNTiopwWhKasElvUX6d0sHecuVo9LeKNRdzdp9xmqajIOMnC8H8EF9UFcULJVDCgAp1J1LPqgDuFmH2XtMnfA4/r7Lh/l8vpMHz7c558IXVQoWjd7wpmExZE2fvv54ziLm0ZbucnJF762sG9EekDkM4GFb6ngWSl0741COvbpPoLIjRYbKYa8wnZ2/ewszOBrELOpl/hcoPHx78fPr365e07lUaZr8Gw3iQRymJu18yVVP1NaTta1SW8m72lTt/+kbty2BHhd+aCQXoRcEr6/aOn7Dtur4OGKFdp7WV6uUO/zdyrqm5ealSdU9F46s3bw173DZexmH+ZAlLNT2B7DtE3YDHdOHFYQNbSfqajIJbDhnWYamL2Cnz241q/PX1yxivPLFdi+4C72g/UGnd1tq2Tt7u0k0CtBfsumzhB8pVN7g8qc1vNl5kNDa16HpasZ1Xf8DCxQQMQ==",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:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uo53nU6GmB4+yxhutr8izjfO2dN8UQyPeIFXD1jV9VDtFFchDF6vpe6IDuXXYpUFFeRbcPRvtVMX3KDNdIo2ivkDo4H//+VdgdBNniIZncFlZMHqOlsYlrnKYSFwIGo93p2mHvJTonFyCUB6nlnpfLqbCcxlqL020GTc8FVJQ/BBME9tCLwTdAN4X6Au0tPWdpek8xxlKCjuQWt+FiVkDr7wug4xWZ5hrezchlSLgkFZOKHQOHGJHQVVwlSF0dxGBtjTBo/JojRUOgYuSwBNtAScTkQk6mJLF8sxDyRWfIgmLgPQmL6yfAlanlfPgtKyCISSxRPSNiQoxdwP4RcywMZwWc/RcSMxhWtEREWQ6R2hzh8xQOaToPBgSLzIMhzrPrQeJM7Qh9sJNTiopwWhKasElvUX6d0sHecuVo9LeKNRdzdp9xmqajIOMnC8H8EF9UFcULJVDCgAp1J1LPqgDuFmH2XtMnfA4/r7Lh/l8vpMHz7c558IXVQoWjd7wpmExZE2fvv54ziLm0ZbucnJF762sG9EekDkM4GFb6ngWSl0741COvbpPoLIjRYbKYa8wnZ2/ewszOBrELOpl/hcoPHx78fPr365e07lUaZr8Gw3iQRymJu18yVVP1NaTta1SW8m72lTt/+kbty2BHhd+aCQXoRcEr6/aOn7Dtur4OGKFdp7WV6uUO/zdyrqm5ealSdU9F46s3bw173DZexmH+ZAlLNT2B7DtE3YDHdOHFYQNbSfqajIJbDhnWYamL2Cnz241q/PX1yxivPLFdi+4C72g/UGnd1tq2Tt7u0k0CtBfsumzhB8pVN7g8qc1vNl5kNDa16HpasZ1Xf8DCxQQMQ==",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)(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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(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)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.cfe051cf.js b/assets/js/770b40a9.cfe051cf.js deleted file mode 100644 index d018f091f..000000000 --- a/assets/js/770b40a9.cfe051cf.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:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,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)),c=a(41429),o=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:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",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/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:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",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 b(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)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(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)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)(o.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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.12b39d5b.js b/assets/js/78b2b753.12b39d5b.js deleted file mode 100644 index 91a034a4c..000000000 --- a/assets/js/78b2b753.12b39d5b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,a)=>{a.r(l),a.d(l,{assets:()=>j,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>f,toc:()=>y});var s=a(85893),r=a(11151),i=a(58219),n=(a(62316),a(51039)),d=a.n(n),t=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivsfWoA2ZIdt9uEYViwZp2bYCmWDAOWGAYtnSw2FMmSlB3D0H8fTi+2HDvFug37kli8F97z3HMHbsHzpYP4Hn7WMkULswBSdIkVxgutIIa7HFmKEj2yxoVdfJwyLqVeO7bRJfO6s2e1fQgBaIOWU4JpCjE05sYKARhueYEeLd27BcULhBga81ykEICgiw33OTyvRi8+YeKnKdMZ2yW0+LkUFlOIvS0xAOc3klI6URiJEAA+GalThDjj0pFDkmPBId6C35ja01uhlhBApm3Bff8En3idJYbF1SjJ0nFuFlBVM7rWGa0cOko0jiL6d1itK5MEnctKyXaMQACJVh6VJ39ujBRJbQg/OQraHlfXgCbmLKXxormy4+Jrcfzy6MYfDK6nBqqgbU564U+l2QeNo/H5YBQNom/uRm/jyXfxm7fDKIr+hACeCkmxbR9T7pHyeuHl/rt3IJQUCucde/NxFM1HY6gqcpqconHQtpoJx5T2DAvjNwEjGrlQjqU6KQtUnmnbafBBDditLtDnQi3Zmoxrq9UyYEYid8i83TC+5EIxyT3aVw//qjFa4U1Gaq6CLUnjJayTKJqf76BOjqG2QAllpkuVDv87uaC12n6tVo7r+VIrJ9Fk/u0O3ptjeFO14lKk9Qrx+hHVq/8B3x7Nieup1EMBi8aptsMB2P55A9JhUlrhN/UiexpwIwaNPb6fkQ5IgHq/Auvl53OIIWyIDbe7tVcBpbOrbi2WVkIMuffGxWHIjRlqg8qJpZJ84YaJLkJuRLgaQRU893aeL4VaDr4YNduXf0sUNywegNhxyY24wg0EHUd9r3Zd58hpGxMrQmW6Dm6ZuzGobsVS1byvRkdL/S4XjmabzN0s1xpgmbbsWTRbcIcp04r5HGsjnZ8PR8wZTETWymfIHtSDohXASoe0gaVQjy6mxXB/k2UiEVyyP3DhhMfZ64659Xp9xNhZHfNe+LxcMItG792X9WFNaz9q93EGAXi0hbvJbtGuRIJtl164Kqydw3YoeFIPBRZcUHfbox+fB5FIpUhQOezJ+OL9x2u2YufDCIKePP5G0eH19KfLX28vKS/JsWnSaBgNIzoy2vmCq95V7/rPg+fd3e7n+5+9JVoJenzyoZFc1ENZA9q203QPu6dAvH9GzALItfNk3m5JNL9bWVV0/LlESyM7C2DFreALUun9FlLh6He6eye8COT1b+2T44ydfJGcrLmbJUWDtOKypC8I4BE3B++falYF3ThRWY39IknQ+F7k0a48WDjvLq8v7y4hAF4SRf1Jfqwnuf1BF5ws7HDEmxroL22bkwHfUy+vcPPDzr2xvBjQQuy8iaRZVVV/AenPm1U=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivsfWoA2ZIdt9uEYViwZp2bYCmWDAOWGAYtnSw2FMmSlB3D0H8fTi+2HDvFug37kli8F97z3HMHbsHzpYP4Hn7WMkULswBSdIkVxgutIIa7HFmKEj2yxoVdfJwyLqVeO7bRJfO6s2e1fQgBaIOWU4JpCjE05sYKARhueYEeLd27BcULhBga81ykEICgiw33OTyvRi8+YeKnKdMZ2yW0+LkUFlOIvS0xAOc3klI6URiJEAA+GalThDjj0pFDkmPBId6C35ja01uhlhBApm3Bff8En3idJYbF1SjJ0nFuFlBVM7rWGa0cOko0jiL6d1itK5MEnctKyXaMQACJVh6VJ39ujBRJbQg/OQraHlfXgCbmLKXxormy4+Jrcfzy6MYfDK6nBqqgbU564U+l2QeNo/H5YBQNom/uRm/jyXfxm7fDKIr+hACeCkmxbR9T7pHyeuHl/rt3IJQUCucde/NxFM1HY6gqcpqconHQtpoJx5T2DAvjNwEjGrlQjqU6KQtUnmnbafBBDditLtDnQi3Zmoxrq9UyYEYid8i83TC+5EIxyT3aVw//qjFa4U1Gaq6CLUnjJayTKJqf76BOjqG2QAllpkuVDv87uaC12n6tVo7r+VIrJ9Fk/u0O3ptjeFO14lKk9Qrx+hHVq/8B3x7Nieup1EMBi8aptsMB2P55A9JhUlrhN/UiexpwIwaNPb6fkQ5IgHq/Auvl53OIIWyIDbe7tVcBpbOrbi2WVkIMuffGxWHIjRlqg8qJpZJ84YaJLkJuRLgaQRU893aeL4VaDr4YNduXf0sUNywegNhxyY24wg0EHUd9r3Zd58hpGxMrQmW6Dm6ZuzGobsVS1byvRkdL/S4XjmabzN0s1xpgmbbsWTRbcIcp04r5HGsjnZ8PR8wZTETWymfIHtSDohXASoe0gaVQjy6mxXB/k2UiEVyyP3DhhMfZ64659Xp9xNhZHfNe+LxcMItG792X9WFNaz9q93EGAXi0hbvJbtGuRIJtl164Kqydw3YoeFIPBRZcUHfbox+fB5FIpUhQOezJ+OL9x2u2YufDCIKePP5G0eH19KfLX28vKS/JsWnSaBgNIzoy2vmCq95V7/rPg+fd3e7n+5+9JVoJenzyoZFc1ENZA9q203QPu6dAvH9GzALItfNk3m5JNL9bWVV0/LlESyM7C2DFreALUun9FlLh6He6eye8COT1b+2T44ydfJGcrLmbJUWDtOKypC8I4BE3B++falYF3ThRWY39IknQ+F7k0a48WDjvLq8v7y4hAF4SRf1Jfqwnuf1BF5ws7HDEmxroL22bkwHfUy+vcPPDzr2xvBjQQuy8iaRZVVV/AenPm1U=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},j={},y=[{value:"Request",id:"request",level:2}];function b(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components},{Details:a}=l;return a||function(e,l){throw new Error("Expected "+(l?"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)(l.p,{children:"Delete Folder"})}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,s.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,s.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(l.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"successful operation"})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{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)(l.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:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,s.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsxs)(l.ul,{children:["\n",(0,s.jsxs)(l.li,{children:["\n",(0,s.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,s.jsxs)(l.li,{children:["\n",(0,s.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsx)(p.default,{className:"openapi-tabs__schema",children:(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{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)(l.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"badge badge--info",children:(0,s.jsx)(l.p,{children:"oneOf"})}),(0,s.jsxs)(p.default,{children:[(0,s.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,s.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,s.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,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"folder not found."})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{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)(l.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",format:"string",example:"folder not found."}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"Invalid API token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{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)(l.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:l}={...(0,r.a)(),...e.components};return l?(0,s.jsx)(l,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.a9080331.js b/assets/js/78b2b753.a9080331.js new file mode 100644 index 000000000..b584e321f --- /dev/null +++ b/assets/js/78b2b753.a9080331.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var a=s(85893),i=s(11151),d=s(58219),r=(s(62316),s(51039)),n=s.n(r),t=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOZDUWyJGXHMPRvT7JH25MMRxdfYqdYt2F/Eovn+p3LR65FwMKL5Fr8YFRGTkwjkZFPnbRBGi0S8W5OkJGiQNCqwOnbc0ClzNLDylQQTC/PG/lQRMJYcsgOzjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8KzMRCcmBLYa5eJiNmX2gNJxnYHLYOHT0sZKOMpEEV1EkfFgpdullaRWJSNC9VSYjkeSoPCukcypRJGsRVrbRDE7qQkQiN67EsHtC99h4ScTsYpzm2WRuZ6KupxzWW6M9eXY0iWP+t5+tr9KUvM8rBZuKiEikRgfSgfXRWiXTRjD64NlofZhdC5or59hNkG3Ivhafi+PHOz/5ydLy3Io66pqTnYZjbrZGk3jyfDCOB/GX78Yvk5Ovkxcvh3Ec/yYicV8qtu36mGEg9htkUNvvnQOpldR021fvdhLHt+OJqGtWOjlWxkHXapAetAlApQ2rCLiMKLWHzKRVSTqAcf0M3ugBXJmSwlzqApYsXDqjiwisIvQEwa0AC5QaFAZyT27+VWOMpsucp7mO1jwaj2E9iePb5xuoJ4dQO6CMMjeVzob/3biQc8Z97qwc5vOpVp7EJ7dfbeC9OIR3rheoZNZQSDB3pJ/8D/i2aI6E51T3B1i2So1c7IHdPW9BekorJ8OqIbL7AVo5aOXJ9ZTngAfQbCmwIb8wF4kYtYUdrTe0Vwt25xY9LVZOiUTMQ7A+GY3Q2qGxpL0stMKZH6amHKGVo8VY1NFDbR+wkLoYfNJquk3/ikvcVnEPxKaWaOUFrUTU12hXq6PrOSGzMVdF6tw0xl3lLi3pK1nopu6L8QGpvyeVmpL4Jglzgl79z9//aCz69W7G4glcVg6sWZJjWkWdQa7oXs4UHbmYPGGpyHu1AqkDFQ4DQSYLGVABV4XZIUWLM6kkDxKrGbZ2sDOLfgjv5xTm5Fj0hSNAyGhBiucPlDF37CcYwCqYsonRU9LSuLucU4oAYVZ5qcl78ES9Cek56pSg70XELIYaSAdy1klPgLJk5dw4oDyXqWTHvDUO0wAlaiyIg0XAeXMVrDMLmZEHZ2aVD+CNqhogHLEkCi1ETZT5IbySC2qB82FGAaWiDIqKXTDPZgTdEjEMncGMfADL4WVKjVMf0AVQtCDXzF7TybxSCqzh7Zao+M7e7S07Cg61ZwJqE+pbsymfdYZv0CZGhqsh3OgbzcQOlSceACX1nU+Y7q83Y/aeZl4Gmj7t92G5XB7swbN9m9cyzKsZOLJma1c0h83W7JpvPp6JSARypb/Mr8gtZErdEj4Sc9QojzrOw7ThPCpRqnbHvntowPyjZEra0w5Dnb5++wYW8HwYi2hn8/9GwqM359+f/Xx1xn6Zadr9Gw/jYcxH1vhQot4J9Wr35fdwcddb6v5nz8SOXQLdh5FVKBu+bQCtO6K8FptXXrJ9IU4jMTc+sHi9nqGnX52qaz7+WJFjNp5GYoFO4owJ6HotMun5d7Z5Aj4K5Okv3WvyGRx9bB7NuadJzRy5QFXxl4jEHa32nrb1tI56puS0WvlpmpINO5YH1+DeXfLq7M3ZuzMRCay4RLskfdeQdPeDAxxNbJ+92xz4L18kRw2+4V5e0OrbjXoredSgg9hrc5GmdV3/BXeuT/Y=",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/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOZDUWyJGXHMPRvT7JH25MMRxdfYqdYt2F/Eovn+p3LR65FwMKL5Fr8YFRGTkwjkZFPnbRBGi0S8W5OkJGiQNCqwOnbc0ClzNLDylQQTC/PG/lQRMJYcsgOzjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8KzMRCcmBLYa5eJiNmX2gNJxnYHLYOHT0sZKOMpEEV1EkfFgpdullaRWJSNC9VSYjkeSoPCukcypRJGsRVrbRDE7qQkQiN67EsHtC99h4ScTsYpzm2WRuZ6KupxzWW6M9eXY0iWP+t5+tr9KUvM8rBZuKiEikRgfSgfXRWiXTRjD64NlofZhdC5or59hNkG3Ivhafi+PHOz/5ydLy3Io66pqTnYZjbrZGk3jyfDCOB/GX78Yvk5Ovkxcvh3Ec/yYicV8qtu36mGEg9htkUNvvnQOpldR021fvdhLHt+OJqGtWOjlWxkHXapAetAlApQ2rCLiMKLWHzKRVSTqAcf0M3ugBXJmSwlzqApYsXDqjiwisIvQEwa0AC5QaFAZyT27+VWOMpsucp7mO1jwaj2E9iePb5xuoJ4dQO6CMMjeVzob/3biQc8Z97qwc5vOpVp7EJ7dfbeC9OIR3rheoZNZQSDB3pJ/8D/i2aI6E51T3B1i2So1c7IHdPW9BekorJ8OqIbL7AVo5aOXJ9ZTngAfQbCmwIb8wF4kYtYUdrTe0Vwt25xY9LVZOiUTMQ7A+GY3Q2qGxpL0stMKZH6amHKGVo8VY1NFDbR+wkLoYfNJquk3/ikvcVnEPxKaWaOUFrUTU12hXq6PrOSGzMVdF6tw0xl3lLi3pK1nopu6L8QGpvyeVmpL4Jglzgl79z9//aCz69W7G4glcVg6sWZJjWkWdQa7oXs4UHbmYPGGpyHu1AqkDFQ4DQSYLGVABV4XZIUWLM6kkDxKrGbZ2sDOLfgjv5xTm5Fj0hSNAyGhBiucPlDF37CcYwCqYsonRU9LSuLucU4oAYVZ5qcl78ES9Cek56pSg70XELIYaSAdy1klPgLJk5dw4oDyXqWTHvDUO0wAlaiyIg0XAeXMVrDMLmZEHZ2aVD+CNqhogHLEkCi1ETZT5IbySC2qB82FGAaWiDIqKXTDPZgTdEjEMncGMfADL4WVKjVMf0AVQtCDXzF7TybxSCqzh7Zao+M7e7S07Cg61ZwJqE+pbsymfdYZv0CZGhqsh3OgbzcQOlSceACX1nU+Y7q83Y/aeZl4Gmj7t92G5XB7swbN9m9cyzKsZOLJma1c0h83W7JpvPp6JSARypb/Mr8gtZErdEj4Sc9QojzrOw7ThPCpRqnbHvntowPyjZEra0w5Dnb5++wYW8HwYi2hn8/9GwqM359+f/Xx1xn6Zadr9Gw/jYcxH1vhQot4J9Wr35fdwcddb6v5nz8SOXQLdh5FVKBu+bQCtO6K8FptXXrJ9IU4jMTc+sHi9nqGnX52qaz7+WJFjNp5GYoFO4owJ6HotMun5d7Z5Aj4K5Okv3WvyGRx9bB7NuadJzRy5QFXxl4jEHa32nrb1tI56puS0WvlpmpINO5YH1+DeXfLq7M3ZuzMRCay4RLskfdeQdPeDAxxNbJ+92xz4L18kRw2+4V5e0OrbjXoredSgg9hrc5GmdV3/BXeuT/Y=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"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)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(d.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(m.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(m.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:l}={...(0,i.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.40a02a7c.js b/assets/js/7b076186.40a02a7c.js deleted file mode 100644 index 7220730f2..000000000 --- a/assets/js/7b076186.40a02a7c.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:()=>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/7b076186.fc1c0045.js b/assets/js/7b076186.fc1c0045.js new file mode 100644 index 000000000..53cd1d8f5 --- /dev/null +++ b/assets/js/7b076186.fc1c0045.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:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),o=(s(62316),s(51039)),c=s.n(o),i=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const j={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:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",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/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:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",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 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 Contact"})}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.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,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)(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,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:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.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)(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)(d.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)(i.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)(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)(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:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.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)(m.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)(d.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)(i.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)(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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(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/8a725248.8323da14.js b/assets/js/8a725248.8323da14.js deleted file mode 100644 index 6e2ac0334..000000000 --- a/assets/js/8a725248.8323da14.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:()=>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.c367aea5.js b/assets/js/8a725248.c367aea5.js new file mode 100644 index 000000000..7d4ff3662 --- /dev/null +++ b/assets/js/8a725248.c367aea5.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:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>u,toc:()=>f});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),s(5397)),m=s(4667),d=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:"eJzVV+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",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:"eJzVV+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",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)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.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)(n.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)(d.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.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,l.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,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)(d.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)(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)(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)(d.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)(m.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)(d.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)(m.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 b(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/8a855f99.0316b8ef.js b/assets/js/8a855f99.0316b8ef.js new file mode 100644 index 000000000..93a170205 --- /dev/null +++ b/assets/js/8a855f99.0316b8ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(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),r=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),t=(s(82723),s(9487)),o=s(41429),p=s(5397),c=s(4667),m=s(9472),h=s(85162);const j={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XAorB0YS9rLUiuR+UFuqqGwcjg7xCa5K+2DKKUuD+7VGm98P2d8Wwi3IlgDKax8TQtMOoD6UquZOCURubhJkNP2fjOBXnbgb9N9n8F3CRwZd6knJnqxwv+dJX0uSx2zNzvcGcEfSeWmIp5kYUrQif/9519RozB5XZEOsbgewbvagTVzckzbQhcwUXQrM0V7bhmeRKXIe7UAqQOVjsdkIUsZhAKGl6khF1ZkUkkuRxYzrO2gV9F+AB+nFKbkeOsbRyCgoBkprmJQxtywnWBA1MFU8YyVzzA37mbCLiUgIKu91OQ9eKJOhfRU6JygS2oCxoHQQDqQs056AiErFp4YBzSZyFyyYe49J/IAldCiJD4sAfabUbDtXcGDM1ntA3ij6hgIn1gRhTZETVT4AfwiZ9QGzosFBSEVFVDWbCKB3BQEq1bkMHQBGfkAlo+XOUWjPggXQNGMXCzimMlJrRRYwxwhheIbVj+3bCg4oT3TWOtQl5o1fNYZntDxjEIsBnClrzSzOtSeuACU1Dc+vdIHcLkus4+UeRlo/LhrrPl8vtNQT7Z1XskwrTNwZM1Gr4yLsf366us/TzDBQK7y7ybn5GYyp1U3f+HMYRQerphT5JE5qRJStc36010F7iYlc9Keejx38ursDczg6WCESY9C/oXDwzenL16+PX/Jdpmy2v47HIwGo3gdMz5UQveO2rrG323c5WYAfJU7/4rFAt2GoVVCRlKP8S5XhNzdWjHBdHPdHyc4NT7w9nKZCU8fnGoaXv5ck2PKHyc4E06KjPnpcomF9Py7WN/nvxjn4/erK/MT2Pty2OtzR8eauXgmVB1vrwne0GLrndKMm6RjZHar3X/RHn5wwVY2+jsTlwdKq3GS52TDvbL9EXf24QITzFavjiq+a9CJOT+ExBxTvMIrjG+wyCHx4cDrS1RCl7UoWb41y3NE1Jya/hC6iUNo9YMD2wvI9nRqI+FPjmuvwg9cYq9p8eNavN35osIK2k6akzNumuYf0NMmBw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XAorB0YS9rLUiuR+UFuqqGwcjg7xCa5K+2DKKUuD+7VGm98P2d8Wwi3IlgDKax8TQtMOoD6UquZOCURubhJkNP2fjOBXnbgb9N9n8F3CRwZd6knJnqxwv+dJX0uSx2zNzvcGcEfSeWmIp5kYUrQif/9519RozB5XZEOsbgewbvagTVzckzbQhcwUXQrM0V7bhmeRKXIe7UAqQOVjsdkIUsZhAKGl6khF1ZkUkkuRxYzrO2gV9F+AB+nFKbkeOsbRyCgoBkprmJQxtywnWBA1MFU8YyVzzA37mbCLiUgIKu91OQ9eKJOhfRU6JygS2oCxoHQQDqQs056AiErFp4YBzSZyFyyYe49J/IAldCiJD4sAfabUbDtXcGDM1ntA3ij6hgIn1gRhTZETVT4AfwiZ9QGzosFBSEVFVDWbCKB3BQEq1bkMHQBGfkAlo+XOUWjPggXQNGMXCzimMlJrRRYwxwhheIbVj+3bCg4oT3TWOtQl5o1fNYZntDxjEIsBnClrzSzOtSeuACU1Dc+vdIHcLkus4+UeRlo/LhrrPl8vtNQT7Z1XskwrTNwZM1Gr4yLsf366us/TzDBQK7y7ybn5GYyp1U3f+HMYRQerphT5JE5qRJStc36010F7iYlc9Keejx38ursDczg6WCESY9C/oXDwzenL16+PX/Jdpmy2v47HIwGo3gdMz5UQveO2rrG323c5WYAfJU7/4rFAt2GoVVCRlKP8S5XhNzdWjHBdHPdHyc4NT7w9nKZCU8fnGoaXv5ck2PKHyc4E06KjPnpcomF9Py7WN/nvxjn4/erK/MT2Pty2OtzR8eauXgmVB1vrwne0GLrndKMm6RjZHar3X/RHn5wwVY2+jsTlwdKq3GS52TDvbL9EXf24QITzFavjiq+a9CJOT+ExBxTvMIrjG+wyCHx4cDrS1RCl7UoWb41y3NE1Jya/hC6iUNo9YMD2wvI9nRqI+FPjmuvwg9cYq9p8eNavN35osIK2k6akzNumuYf0NMmBw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\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:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(t.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 create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.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:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "folder 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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.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 b(e={}){const{wrapper:a}={...(0,r.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/8a855f99.32ed22a7.js b/assets/js/8a855f99.32ed22a7.js deleted file mode 100644 index 19e006eca..000000000 --- a/assets/js/8a855f99.32ed22a7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var l=s(85893),r=s(11151),n=s(58219),d=(s(62316),s(51039)),t=s.n(d),i=(s(82723),s(9487)),o=s(41429),m=s(5397),p=s(4667),c=s(9472),h=s(85162);const u={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZaTtNuEYVhWZJ2bogmaBAOWGAEtnWw2FMmSlB3D0H8fjpJsOXaMBVj3xS+8F949d/fwVuD51EFyB39omaGFcQQZutQK44VWkMDNDNmtybhHVquws6sR41LqhWNLXTKvWamDPK/lihfIuGMLlJK+DbeofG08yvoQgTZoOfkfZZBAGbzXxhCB4ZYX6NFSWCsgb5BALX4QGUQgKC7D/QyeB6snXzH1o4zpnK0dWvxWCosZJN6WGIHzS0kunSiMRIgAn4zUGUKSc+lIIZ1hwSFZgV+aoOmtUFOIINe24L57gk88eElgcjFM8+x4ZiZQVeP6WnT+d50tydV2oFdWz0WGbIJSL9g6ZQIztbgBEyJItfKoPPngxkiRBuQGXx05WnWC3eR518AVsBtHbRo1OgSxpQp4gY7sat3PAefXpaxw0cZZhcJ16vxaX1BVEXjhZafaE8Kuqkhi0RmtXB3xcRzvQurKNEXn8lKydX+9Br7DILWd9dq0/nx0xx8NLkaGIKpbPTvz+9xsjI7j45PeMO7FP94M3yWnPydv3/XjOP4bIngqJNk2U0HeoINb/b9zIJQUCh9a9B6O4/hhOGwwPd0H47Uu0M+EmrIFKs8WVqtpxIxE7pB5u2R8yoViknu0P/x3+KK12h5G5XWRHULhlFBYg3C6C0LLZNqzXJcqkNb3TvRQF+3Gczi904ef1um93U1vpOZciiwwudePqP7fQu65nkLdbm1RKwU5bCXbPa+TdJiWVvhleDCeetyIXi1P7sZExdQ3mp4aU4aA6elIYFCjOlit35YKyJedt29PaSUkMPPeuGQw4Mb0tUHlxFRJPnH9VBcDbsRgPoQqeq7tPJ8KNe0dtBpvYr8mfGsItzJYA8mNuMAlRC1AXa3mTZwhD1xcRUBl+7J5gc5b8LfpvsvguwQOhLtQuQ5RNPhfGlTXYqpC9ebDnSf4ZiYcEy6IM52WBSofOonl2rJn1mzCHWZMK+ZnGIR0ftIfMmcwFXnThH12r+4VzT8rHRLDS6EeXXKveuzuMs9FKrhkf+HECY/jN20JFovFDvRHweaD8LNywiwavVGfhsNQn67V+s8RRODRFu4yv0Y7Fyk25X7hqkFQHjSjxdMwWlhwQW3SHP323IgglyJF5bAzDGcfrj6xOTvpxxB1+uxfBD34NHp//vn6nPxSX9dFGvbjfhzebO18wVXnqq1d73l1VxuW+C6LYdPqHp/8wEguwuSHfFfN1LarDUSQbHbCcQQz7TyJVyvqqVsrq4qOv5VoiRfGEcy5FXxCTXy3gkw4+p2tl74X83zzpdmrjtje9XJvzO3MKhrYOZdlWHEieMTl1jJbjauoHVsKq5a/ry/v3ZCXjf0OLRPr1BZnaYrGH9Tt8uDV7Q1EMGlW0yIsv2D5grZlvoAE7uEewqJODgIphfMVSK6mJZ+Sfu2WyIaXVJouUz0Gpmp+UGJ7AdmmsDoT+qS89hr8Qi12gctf1+q15EWDBtpWm4ozrqrqH7urcWY=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZaTtNuEYVhWZJ2bogmaBAOWGAEtnWw2FMmSlB3D0H8fjpJsOXaMBVj3xS+8F949d/fwVuD51EFyB39omaGFcQQZutQK44VWkMDNDNmtybhHVquws6sR41LqhWNLXTKvWamDPK/lihfIuGMLlJK+DbeofG08yvoQgTZoOfkfZZBAGbzXxhCB4ZYX6NFSWCsgb5BALX4QGUQgKC7D/QyeB6snXzH1o4zpnK0dWvxWCosZJN6WGIHzS0kunSiMRIgAn4zUGUKSc+lIIZ1hwSFZgV+aoOmtUFOIINe24L57gk88eElgcjFM8+x4ZiZQVeP6WnT+d50tydV2oFdWz0WGbIJSL9g6ZQIztbgBEyJItfKoPPngxkiRBuQGXx05WnWC3eR518AVsBtHbRo1OgSxpQp4gY7sat3PAefXpaxw0cZZhcJ16vxaX1BVEXjhZafaE8Kuqkhi0RmtXB3xcRzvQurKNEXn8lKydX+9Br7DILWd9dq0/nx0xx8NLkaGIKpbPTvz+9xsjI7j45PeMO7FP94M3yWnPydv3/XjOP4bIngqJNk2U0HeoINb/b9zIJQUCh9a9B6O4/hhOGwwPd0H47Uu0M+EmrIFKs8WVqtpxIxE7pB5u2R8yoViknu0P/x3+KK12h5G5XWRHULhlFBYg3C6C0LLZNqzXJcqkNb3TvRQF+3Gczi904ef1um93U1vpOZciiwwudePqP7fQu65nkLdbm1RKwU5bCXbPa+TdJiWVvhleDCeetyIXi1P7sZExdQ3mp4aU4aA6elIYFCjOlit35YKyJedt29PaSUkMPPeuGQw4Mb0tUHlxFRJPnH9VBcDbsRgPoQqeq7tPJ8KNe0dtBpvYr8mfGsItzJYA8mNuMAlRC1AXa3mTZwhD1xcRUBl+7J5gc5b8LfpvsvguwQOhLtQuQ5RNPhfGlTXYqpC9ebDnSf4ZiYcEy6IM52WBSofOonl2rJn1mzCHWZMK+ZnGIR0ftIfMmcwFXnThH12r+4VzT8rHRLDS6EeXXKveuzuMs9FKrhkf+HECY/jN20JFovFDvRHweaD8LNywiwavVGfhsNQn67V+s8RRODRFu4yv0Y7Fyk25X7hqkFQHjSjxdMwWlhwQW3SHP323IgglyJF5bAzDGcfrj6xOTvpxxB1+uxfBD34NHp//vn6nPxSX9dFGvbjfhzebO18wVXnqq1d73l1VxuW+C6LYdPqHp/8wEguwuSHfFfN1LarDUSQbHbCcQQz7TyJVyvqqVsrq4qOv5VoiRfGEcy5FXxCTXy3gkw4+p2tl74X83zzpdmrjtje9XJvzO3MKhrYOZdlWHEieMTl1jJbjauoHVsKq5a/ry/v3ZCXjf0OLRPr1BZnaYrGH9Tt8uDV7Q1EMGlW0yIsv2D5grZlvoAE7uEewqJODgIphfMVSK6mJZ+Sfu2WyIaXVJouUz0Gpmp+UGJ7AdmmsDoT+qS89hr8Qi12gctf1+q15EWDBtpWm4ozrqrqH7urcWY=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(t(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\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:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(i.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 create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\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)(i.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",format:"string",example:"Hks2JpewIp"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\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)(i.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:"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:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.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",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "folder 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)(i.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.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/935f2afb.85de923e.js b/assets/js/935f2afb.e6a83f49.js similarity index 53% rename from assets/js/935f2afb.85de923e.js rename to assets/js/935f2afb.e6a83f49.js index d3aad6201..248362700 100644 --- a/assets/js/935f2afb.85de923e.js +++ b/assets/js/935f2afb.e6a83f49.js @@ -1 +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},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","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":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"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 OpenSign\u2122 Setup with Docker on Windows","href":"/docs/self-host/docker/run-locally-windows","docId":"self-host/docker/run-locally-windows","unlisted":false},{"type":"link","label":"Localhost OpenSign\u2122 Setup with Docker on Linux/MacOS","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false}],"href":"/docs/category/guides"},{"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":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","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 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},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","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},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","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/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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","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/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/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","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/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","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/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","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/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","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"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","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":"Installation 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/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"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/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the \'prev\' & \'next\' buttons at the top or click on any of the page previews loaded on the left side -","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":"OpenSign lets you digitally sign documents that dont need to be sent to anybody with ease. This feature is available in all the plans including OpenSign free. Navigate to \\"Sign yourself\\" from main menu or by clicking the button on the Dashboard","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":"- Navigate to OpenSign drive using the main menu or clicking this link.","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":"The Expired Documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","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/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"this feature is coming soon","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","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/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost OpenSign\u2122 Setup with Docker on Linux/MacOS","description":"Steps to run OpenSign\u2122 with docker in macos/linux:","sidebar":"selfhostSidebar"},"self-host/docker/run-locally-windows":{"id":"self-host/docker/run-locally-windows","title":"Localhost OpenSign\u2122 Setup with Docker on Windows","description":"Steps to run OpenSign\u2122 with docker on windows:","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","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 +"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},{"type":"link","label":"Navigate between pages of a document","href":"/docs/help/New-Document/navigate-between-pages","docId":"help/New-Document/navigate-between-pages","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":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false}],"href":"/docs/category/faqs"}],"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 OpenSign\u2122 Setup with Docker on Windows","href":"/docs/self-host/docker/run-locally-windows","docId":"self-host/docker/run-locally-windows","unlisted":false},{"type":"link","label":"Localhost OpenSign\u2122 Setup with Docker on Linux/MacOS","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false}],"href":"/docs/category/guides"},{"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":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","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 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},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/resendrequestmail","className":"api-method post","docId":"API-docs/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","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},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/createfolder","className":"api-method post","docId":"API-docs/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/getfolder","className":"api-method get","docId":"API-docs/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/updatefolder","className":"api-method put","docId":"API-docs/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/deletefolder","className":"api-method delete","docId":"API-docs/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/folderlist","className":"api-method get","docId":"API-docs/folderlist","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/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 UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/createfolder":{"id":"API-docs/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","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/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/deletefolder":{"id":"API-docs/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","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/folderlist":{"id":"API-docs/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","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/getfolder":{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","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":"Welcome to the OpenSign\u2122 API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you\'re a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign\u2122 and transform your digital document processes today.","sidebar":"apiSidebar"},"API-docs/resendrequestmail":{"id":"API-docs/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","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"},"API-docs/updatefolder":{"id":"API-docs/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","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":"Installation 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/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"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/navigate-between-pages":{"id":"help/New-Document/navigate-between-pages","title":"Navigate between pages of a document","description":"To navigate between pages of a document that you have uploaded either click on the \'prev\' & \'next\' buttons at the top or click on any of the page previews loaded on the left side -","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":"OpenSign lets you digitally sign documents that dont need to be sent to anybody with ease. This feature is available in all the plans including OpenSign free. Navigate to \\"Sign yourself\\" from main menu or by clicking the button on the Dashboard","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":"- Navigate to OpenSign drive using the main menu or clicking this link.","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":"The Expired Documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","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/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"this feature is coming soon","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","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/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost OpenSign\u2122 Setup with Docker on Linux/MacOS","description":"Steps to run OpenSign\u2122 with docker in macos/linux:","sidebar":"selfhostSidebar"},"self-host/docker/run-locally-windows":{"id":"self-host/docker/run-locally-windows","title":"Localhost OpenSign\u2122 Setup with Docker on Windows","description":"Steps to run OpenSign\u2122 with docker on windows:","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","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.1fef8831.js b/assets/js/a2bc1463.1fef8831.js new file mode 100644 index 000000000..4248fecee --- /dev/null +++ b/assets/js/a2bc1463.1fef8831.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=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 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:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",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:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",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"}},g={},f=[{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:"Get Contact list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,l.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,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:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.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)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.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:!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:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails[]"})})]})}),(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:"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)("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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,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)(o.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:"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)(o.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,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/a2bc1463.e95152b3.js b/assets/js/a2bc1463.e95152b3.js deleted file mode 100644 index 993abce93..000000000 --- a/assets/js/a2bc1463.e95152b3.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:()=>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.a78443ac.js b/assets/js/a88a3db3.a78443ac.js new file mode 100644 index 000000000..bd3268567 --- /dev/null +++ b/assets/js/a88a3db3.a78443ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var s=l(85893),t=l(11151),i=l(58219),n=(l(62316),l(51039)),r=l.n(n),d=(l(82723),l(9487)),m=l(41429),o=l(5397),c=l(4667),p=l(9472),h=l(85162);const x={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:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam7nkHOGa0GyDCK9EddYOy0Jg5gmIseQeeVIWSNScV0hnKNGQhis4OzdJThv5yrHACvbwEJRBVQhyJnSilZAFjzWdo4gITjMVKEyoMG/8LaO5sNKGMFlAXJroQIYC9qaEj0YxBxzkQjr0Euu6zIXqchjVUNRIhFOelkjoWdMa2FkjSIVQ8xbxSEUY3KSKnEf6OU52GKvKqBKUsweGNAMoUvJcTx+apTHXKTkG0xEoJXmbEHVTnMxuHTa5ijSQurABlmFtRTpWtDKRUvyypQiEYX1taTtSttOOX5w1gQM7HEymfDfvY0ZquyLgtBkGYZQNFqvnohEZNYQGmJP6ZxWWaRu/DGw+/qwIDv7iBkxj56JJtUl75aZ8cPScSkj3FT8tKxOZHC/uOeiTfqtyc/ocaeTycnzo+PJ0eTb6+OX6el36YuXo8lk8odIxLLW7NvvYc4b3CaCFOnte3tgFtPuGfYrLRufPkTjla2RKmVKWKAhWHhrygScRhkQyK9AllIZYKb9f8gqem/94+x8WWXtDmpltDJ4O5yh29PJ5PZ4Q8LpI2fJWILCNib/ulAfyv84oNPblxtALw4BXZq51CqPSnVt79B8XTy76alLf3haVWcUv4s9sLvrHciAWeMVraKwLY+kU0fd9/RmynLBJ8VuRTGKIVUiFeNBzMbrHSFsBYf080EqG69FKioiF9LxWDo3sg5NUKXRchZGma3H0qnx/Fi0yX3rQLJUpjx61Gu6hXDFNHdM7gHZ8Cmdeo0rkQw87Vr1Al6hzNFHTpUpbHTu2Xvr0Fyp0kTu58cHMv8edWZrZEFnrR/M//7zr+iR26yp0VA8Gk/gbePB2QX6otEgTQ6FxqWa6W4GSq3topuAZCGgrDWGoFegDGHpozirUpHUwKxwK2fSdTNSYWAzy94eds5jGMH7CqlCz5++8TxCc5yj5jMI2to7jkMWZEO2jjn6mmFh/V3BJSUgYdYEZTAECIiDC5pKmgxh2IsErAdpAA2hd14FBKlqNi6sBywKlSkOzJ3jZUZQSyNL5GQJcN17NwFvZ00gCFY3EQhnrBGpgxjn6AjO1Rw74LyYI0mlMYey4RAJZDZH6BuJYZgcZhgIHKdXGcaggaQn0DhHH89e3Emee+Asd7iSmmf57t5yIPLSBJ62XUHD1mzoc97yAI05crkawQfzwbAKQxOQD4BW5i6kH8wR3GyO2XucBUU4fTr0w2KxOOiDZ/s+rxRVzQw8Orv1K+Ni7Jpd983LM5EIQl+Ht8UV+rnKsG/Cz+QcR+Nxr3syi7qHtVS667Ef7zuwBmmVoQm4o1Jnr969gTk8H01EstP5/6Lg8ZvLny9+vbrguKw0Xf8djyajCS85G6iWZifVvWvm/dZdbwX8f3Ur7WWLcEljp6WKYh6ZWvcqfLO5hIpEpLsX0mkiKhuITdbrmQz4u9dty8ufGvQs99NEzKVXcsbqdrMWuQr8nG8ulp/l6Olv/R31GXzZ3fZBQIM4G1bmudQNv4lE3OHq3iW7nbbJoNBccWdxlmXoaMf3YATvzbHzizcX1xciEbJhBneHw10cDv0DJ3iwtP2p0dXAvzzAHnT4ns/Pa1z9sDHvvnzWoYc4WDNN07Zt/wGh7qWX",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-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:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam7nkHOGa0GyDCK9EddYOy0Jg5gmIseQeeVIWSNScV0hnKNGQhis4OzdJThv5yrHACvbwEJRBVQhyJnSilZAFjzWdo4gITjMVKEyoMG/8LaO5sNKGMFlAXJroQIYC9qaEj0YxBxzkQjr0Euu6zIXqchjVUNRIhFOelkjoWdMa2FkjSIVQ8xbxSEUY3KSKnEf6OU52GKvKqBKUsweGNAMoUvJcTx+apTHXKTkG0xEoJXmbEHVTnMxuHTa5ijSQurABlmFtRTpWtDKRUvyypQiEYX1taTtSttOOX5w1gQM7HEymfDfvY0ZquyLgtBkGYZQNFqvnohEZNYQGmJP6ZxWWaRu/DGw+/qwIDv7iBkxj56JJtUl75aZ8cPScSkj3FT8tKxOZHC/uOeiTfqtyc/ocaeTycnzo+PJ0eTb6+OX6el36YuXo8lk8odIxLLW7NvvYc4b3CaCFOnte3tgFtPuGfYrLRufPkTjla2RKmVKWKAhWHhrygScRhkQyK9AllIZYKb9f8gqem/94+x8WWXtDmpltDJ4O5yh29PJ5PZ4Q8LpI2fJWILCNib/ulAfyv84oNPblxtALw4BXZq51CqPSnVt79B8XTy76alLf3haVWcUv4s9sLvrHciAWeMVraKwLY+kU0fd9/RmynLBJ8VuRTGKIVUiFeNBzMbrHSFsBYf080EqG69FKioiF9LxWDo3sg5NUKXRchZGma3H0qnx/Fi0yX3rQLJUpjx61Gu6hXDFNHdM7gHZ8Cmdeo0rkQw87Vr1Al6hzNFHTpUpbHTu2Xvr0Fyp0kTu58cHMv8edWZrZEFnrR/M//7zr+iR26yp0VA8Gk/gbePB2QX6otEgTQ6FxqWa6W4GSq3topuAZCGgrDWGoFegDGHpozirUpHUwKxwK2fSdTNSYWAzy94eds5jGMH7CqlCz5++8TxCc5yj5jMI2to7jkMWZEO2jjn6mmFh/V3BJSUgYdYEZTAECIiDC5pKmgxh2IsErAdpAA2hd14FBKlqNi6sBywKlSkOzJ3jZUZQSyNL5GQJcN17NwFvZ00gCFY3EQhnrBGpgxjn6AjO1Rw74LyYI0mlMYey4RAJZDZH6BuJYZgcZhgIHKdXGcaggaQn0DhHH89e3Emee+Asd7iSmmf57t5yIPLSBJ62XUHD1mzoc97yAI05crkawQfzwbAKQxOQD4BW5i6kH8wR3GyO2XucBUU4fTr0w2KxOOiDZ/s+rxRVzQw8Orv1K+Ni7Jpd983LM5EIQl+Ht8UV+rnKsG/Cz+QcR+Nxr3syi7qHtVS667Ef7zuwBmmVoQm4o1Jnr969gTk8H01EstP5/6Lg8ZvLny9+vbrguKw0Xf8djyajCS85G6iWZifVvWvm/dZdbwX8f3Ur7WWLcEljp6WKYh6ZWvcqfLO5hIpEpLsX0mkiKhuITdbrmQz4u9dty8ufGvQs99NEzKVXcsbqdrMWuQr8nG8ulp/l6Olv/R31GXzZ3fZBQIM4G1bmudQNv4lE3OHq3iW7nbbJoNBccWdxlmXoaMf3YATvzbHzizcX1xciEbJhBneHw10cDv0DJ3iwtP2p0dXAvzzAHnT4ns/Pa1z9sDHvvnzWoYc4WDNN07Zt/wGh7qWX",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"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:l}=a;return l||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:"Delete Template"})}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.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,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(m.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(c.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{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)(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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.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,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.f9046360.js b/assets/js/a88a3db3.f9046360.js deleted file mode 100644 index 9b20b1364..000000000 --- a/assets/js/a88a3db3.f9046360.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:()=>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/ada7accb.1ad2d862.js b/assets/js/ada7accb.1ad2d862.js deleted file mode 100644 index 562e9b539..000000000 --- a/assets/js/ada7accb.1ad2d862.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(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),r=s(11151),t=s(58219),n=(s(62316),s(51039)),i=s.n(n),d=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYstOsm2FomhQpGm6i03QpCjQxAhoaWQxoUguOfIFhv69ICXb8iVBUyzyYoucC8+cmeFwCcQnDpJ7+E3LDC2MIsjQpVYYElpBAncFsksk1sjZ+c0V41LqmWMLXTHSzCJZgVNkGRIX0jE+1hUxzpzBVOQiZXkw7UEE2qDl3vFVBglMkBoRRGC45SUSWg9mCYqXCAk04keRQQTCozGcCtiFqMdPmNJVxnTO1g4tfq2ExQwSshVG4GghvUsnSiMRIsC5kTpDSHIunVdICyw5JEughQmaZIWaQAS5tiWn7g7OefCSgPl9MC7SYWHGUNcjf6wzWjl03tEwjv3fNlpXpSk6l1eSremACFKtCBV5fW6MFGkQ9J+cN1ruo2uC9sxZ74ZEc+SKizfHUQzGxXz4ZKCOWtq/hBy8zY3C2SoFdUgqKmoq5+2Q/hgq7s6exQ3u+vq/yFw17qBLLXLC7JwOudoYDuPhyfEgPo6/vxt8TE5/TM4+9uI4/gcimJfS27bFmnEKSEmQ7K4rk73DOZ2NtmssOqhrLzg9VIe3ukQqhJqwGSpiM6vVJGJGInfIyC4Yn3ChmOSE9rtvV6BorbavM/E2ZN3IhZJC4eOqCR9P4/hxsCbhdJ+EhiqmNLFcVyrrvUOgr1XpPp7Xwzt9/GEd3tl+eFdqyqXIwq19p59RvW8iu8dTc7yHul3OolEKctgKtrvfBOkwraygRZgR82NuxHEjT+5H/vb1daPb0RKGChWQQL9htb9cj5MavC87XY2bykpIoCAyLun3uTE9bVA5MVGSj10v1WWfG9GfDqCOdrUd8YlQk+NXrUYb7Lee34bCrQjWRHIjPuECohVBXa12DBbIwyVW+3Wug3FL27VBdSsmKpA+HewNy7tCOCZcEGc6rUpUFAqA5dqyHWs25g4zphWjAoPQ75/0BuvhHkx77EE9KN+2rHLoJ5sU6tklD+qY3V/nuUgFl+xvHDtBOPqwYm42m+0xdhRsLgUV1ZhZNHqjPgmbgdau1XpxBBEQ2tJd57dopyLFNksvHNUPyv22I3gaOgJLLnx2261fdo18hUqRonLYqeHzy5vPbMpOejFEnfL4D6D7n69+vfhye+H9+nJskjToxb04TD3tqOSqc9TmLbab2uWms7/tq62tS8I59Y3kIrRpiHLZttg9rN9dyebNNoqg0I68eLn0lfSXlXXtt79WaH0TjyKYciv42Jfu/RIy4fx3tn6UvRjghz/b990RO/j8O4h51WDKd9eUy8qvIIJnXGw9NutRHa16zMNq5OdpioY6lnu359YVdHlxBxHwyvPT7e3n0Nvth/d+ENV20zcA/K+/fw4a/ORz/AkXP6/VG8mLBm18K23P0Kiu638BpgwbBw==",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/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYstOsm2FomhQpGm6i03QpCjQxAhoaWQxoUguOfIFhv69ICXb8iVBUyzyYoucC8+cmeFwCcQnDpJ7+E3LDC2MIsjQpVYYElpBAncFsksk1sjZ+c0V41LqmWMLXTHSzCJZgVNkGRIX0jE+1hUxzpzBVOQiZXkw7UEE2qDl3vFVBglMkBoRRGC45SUSWg9mCYqXCAk04keRQQTCozGcCtiFqMdPmNJVxnTO1g4tfq2ExQwSshVG4GghvUsnSiMRIsC5kTpDSHIunVdICyw5JEughQmaZIWaQAS5tiWn7g7OefCSgPl9MC7SYWHGUNcjf6wzWjl03tEwjv3fNlpXpSk6l1eSremACFKtCBV5fW6MFGkQ9J+cN1ruo2uC9sxZ74ZEc+SKizfHUQzGxXz4ZKCOWtq/hBy8zY3C2SoFdUgqKmoq5+2Q/hgq7s6exQ3u+vq/yFw17qBLLXLC7JwOudoYDuPhyfEgPo6/vxt8TE5/TM4+9uI4/gcimJfS27bFmnEKSEmQ7K4rk73DOZ2NtmssOqhrLzg9VIe3ukQqhJqwGSpiM6vVJGJGInfIyC4Yn3ChmOSE9rtvV6BorbavM/E2ZN3IhZJC4eOqCR9P4/hxsCbhdJ+EhiqmNLFcVyrrvUOgr1XpPp7Xwzt9/GEd3tl+eFdqyqXIwq19p59RvW8iu8dTc7yHul3OolEKctgKtrvfBOkwraygRZgR82NuxHEjT+5H/vb1daPb0RKGChWQQL9htb9cj5MavC87XY2bykpIoCAyLun3uTE9bVA5MVGSj10v1WWfG9GfDqCOdrUd8YlQk+NXrUYb7Lee34bCrQjWRHIjPuECohVBXa12DBbIwyVW+3Wug3FL27VBdSsmKpA+HewNy7tCOCZcEGc6rUpUFAqA5dqyHWs25g4zphWjAoPQ75/0BuvhHkx77EE9KN+2rHLoJ5sU6tklD+qY3V/nuUgFl+xvHDtBOPqwYm42m+0xdhRsLgUV1ZhZNHqjPgmbgdau1XpxBBEQ2tJd57dopyLFNksvHNUPyv22I3gaOgJLLnx2261fdo18hUqRonLYqeHzy5vPbMpOejFEnfL4D6D7n69+vfhye+H9+nJskjToxb04TD3tqOSqc9TmLbab2uWms7/tq62tS8I59Y3kIrRpiHLZttg9rN9dyebNNoqg0I68eLn0lfSXlXXtt79WaH0TjyKYciv42Jfu/RIy4fx3tn6UvRjghz/b990RO/j8O4h51WDKd9eUy8qvIIJnXGw9NutRHa16zMNq5OdpioY6lnu359YVdHlxBxHwyvPT7e3n0Nvth/d+ENV20zcA/K+/fw4a/ORz/AkXP6/VG8mLBm18K23P0Kiu638BpgwbBw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(i(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\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:"folder_id",in:"path",description:"objectId of folder",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)(t.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)(d.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\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)(d.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)(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)(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:"folder 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)(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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "folder 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)(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)(c.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,r.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/ada7accb.2592b532.js b/assets/js/ada7accb.2592b532.js new file mode 100644 index 000000000..2ccd53eed --- /dev/null +++ b/assets/js/ada7accb.2592b532.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=s(85893),r=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\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:"folder_id",in:"path",description:"objectId of folder",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)(a.p,{children:"successful operation"})}),(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)(m.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",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.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)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder 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)(m.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",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "folder 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)(m.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,r.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/bbdfc22d.70967907.js b/assets/js/bbdfc22d.70967907.js new file mode 100644 index 000000000..58abc5cc1 --- /dev/null +++ b/assets/js/bbdfc22d.70967907.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=n(85893),i=n(11151),t=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=(n(41429),n(5397)),o=n(4667),m=n(9472),h=n(85162);const p={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(s.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.e7219e11.js b/assets/js/bbdfc22d.e7219e11.js deleted file mode 100644 index c7fb7b0dd..000000000 --- a/assets/js/bbdfc22d.e7219e11.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),i=n(11151),l=n(58219),r=(n(62316),n(51039)),t=n.n(r),d=(n(82723),n(9487)),o=(n(41429),n(5397)),c=n(4667),m=n(9472),h=n(85162);const p={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGmtvGzfyr/D4pY2wkiVHeZxwOFyS9lqjDwe1g+JgGS61HGmZ7JJbkmtpa+i/H4aP3ZUs2UlatLqDvthazoPzIjnkzB21bGHo5IpeQlHmzIKh1wnlYFItSiuUpBN6mQGJYPJGA8Nx8urtGWF5rpaGVAa0IVaRFIFA0spYVYjf2CwHYiPjhCwzkWbEgL4FwgyZ5RWUWkhryFxpsgAJmlkhF4SrtCoAAUthM1Jq4DAXEjgxVleprTSYAXlXKklMlaZgzLzKm5m8GELJhNgMnKAabKWlIYxUUvxaAen1IvaN4L0esRmzJGWSzADV4ahNEAg64swYwpR0jE0JqZgLRA68BlM5le/KXDFOalWRks+JkERVmlz1el/BrFqQd2e93vWXmbWlmZycsLIcqBKkEQuZs5kZpKo44YhY8vkTkoEGxwlF45otyVLwBVhDmOQkVWVNUtVXWnDJLCSkZAsgsipmoImao5TFgLDcqIaJo0E1no8R4+1X/3ZC93qvIVcd9hqIqcpSaQscdUCFox0mvR7SvFFFoSQpmWYFWAwBNY8MJojQRzPXJUx6PXImuUgxDBwnHG2xBx4VhUfUi2BXj7qhkgwxhNosmbTopjJnKThUDegSK25hk/EqITUy/gqkihJkSovflLQsd6a8BW1FynKSKqW5kE5Sb0FiLNMuLEslpI2jYQbyn2DYynghePAyisbRLIWQDmKA3LK8AhOkWiYkQ6l+glKDceEV+NrMyZSBWGR752P8fWXsBmNSGRSzK0WYS8OvldDAnXnBmW3OcgNEzDdsWbAP0JmNKLcHsHxAXteEw5xVuU2IsF8YYnUFA/KjsoSVZS5St9hxHWMoM1yifeflEBBBEMkK5+O3Wt0KDrgiuZjPQYO0BIGORYzCIB0GY+kIUL1CaZSRSaJkx9GjAen1mrldiP7yyy9TeTeVhEwpyjKlkyltUKY0IR6GITalk1FCwsBqSifk6emLiFDj9/PTl/F7id+j0Th+Z/h9OprKdZj01AljWVE+IAiC/3gh4qd3ncFBNzOOxTDAQfSfx0UImh5HG7EQsG4VeooKCSmsYLnZr1PEODy1Wsm2NBujZlAwke9Xy4EPT6cg1pZCzwbtOtujj2dxaOr4X1vaPEdt3qsZscLmD6jUoByeXh3RtpR7gcqlqiiZrPerFhAOT7FGsC21XqJanNkH3IXQw1MoSBUB4cDzsOG4P3rWPx2ejjsYc6ULFhCKos95v67rekpJaxHi9MezL7DD4y+ef/6sxhxzrlWxI7lxuUeLFXIB9zsmBD9gGjCLJ2SbrbXpqZdy8wy3irP6C+NZRdJwSHv8NhWrO2I6EMpRY1abZkqkQXjECYYnM0wmB2iEPtqRn/zww4m3TNIO9osimMv7Akfxu+8s2R0tigHng23crsG7owXhPCE7xncDOCdFUewb9wAM8an8+8DdG1Z2plb7QzsgHF50t4LtDPBwKERYJmQAhOggWwgaFlXONKwwfTVCSaf9vc1gK/Jj4LMYij53dWmfuxl4IcmX5yH1fBKCEuXZZIAjj9PdE7PLRMMCVo6Hv7OiMIKHy6Op0gzvqe6Wi5mnknkdriIm8V8pKwXeIXKw1o2CTQebQkzlaOj2+QzSDw9GTsQ4vNDpSBaB/sqB4KspLVg4eOkc2t/KZqCn9LqhMZBDaoF3aMkuYnLdiTLG0dKI7K4srXiZ4JCzGeQtrCNccGNHVQQUQnohohmGkZ+DstUWNADXO4LaK9GNprj7xZiMViO5MPEuummCLnW4w7mXCAn+CWIGJBKQWbN77wpyb6XO/Q5duX29M2A3BWOGRNIdVzxn07j6gq0fmQHxiENsrs9xsn0TBBU2PNO1C/IohBRFVXSeNiLXaLEinIJdcyElvk3FGbrevTcDWz0yQ3gd2jPBVI7cDZRrVXK1lG6Vk925T0A5vGXekez3LPONY8Xj/Z5lFKXqLqMdJwqi+rOkWUJm/xoakHPcv/EJwRMJQ1iaQmmBb23gI3eb14wLRWaVtUru38K7WIfn3y3p/gQfo8If5+WubH+Vp6dy5B86Cv8Uue+Vo3D+PDTvBrF2uyEccZImVJXunV3JM04n1L/ZxxdsmripwNjXitd0ckdTJS1Iiz/DQx+Snrw3WBu4oybNoGD4K4qI1YS5yJEVvrWBNjSh7v6LpQU0Ip1QNXsPqaUJJpclvr2CQR6ObnIXsYzVQi5oEu5ZdEL9yzVNKKxYUSJyGCIgU4W3H8diHWd8iFcz0vIy7kfzno988Mn4M9k40vVWOeWzOHU5rFu7tsyY1qym25Wb+FYcM3hP17zq5nU8voXFVCCmFx6NJlRYKLqz7PGaVp9u6RQUauKesD6V1rmFFZ88J9KVmZKfRRjepHfY/COt5KH3J9502Su8bACP2WC/fU5PiHuaHTwWMRHfacsW3Tl9cnNvzst9ZZZOJcBkqso5vvUD0wNX7fj8shaWClmeVq5a1+zmG5o1ojaajdYJXT2uzMpXxHwNh3yZw9ySqixBk1RpCfpJ96nlYJQ7HY/XCa0fV6/+n1TvBTpv+bh2P7viV1sY/CtkffpyndDscVm/bcpzf6Gw4+fr9qzbOstvZorXN3HfWj+GGA8VxDMg+Zk81xx0xxAzpXJgsju/u8E9wtlP3aYHmL+4AVMqafzmeDoc4r+tfWmjoI/V/6bYn9d/o8nH5yYP78x+GLOh+7tzu7G+zk6/NaUs0gx31gKM2dxcd5A8okDXbkLmQsJNNMrN6XB48wwtt07oeJdxLlQBNsNnqSXWTpdayUVCyhwYFqJ1TdiCCUlwev0H2gq0VvphrT9NsoeMMB4Ob0aNEZ7dN8KZdC89rsfjUn0A+edq2p3e+ulR1FXhUhqfolDhkRycbijbHfdKGkgrLWxNJ1d3dNVnpeh7+OTqen2NUWczhVl7qYyTmNmMTujJvSTeNdlghnh1Ryud0wl9cBdipTi5HdF1so1tLFsIueg/SHXdCn6BxvX22xC/TZpK8R1g1hSs08VKqECnZsBw30F7oM9+au8jX0fLx5vCzuS/NfF2Oh+z+Y0EfXtf35FydzLuq5juugy2SWBpqxFtkkz82aSNV20gNRlaTNBGLrM5HY9dCvBi5M7Kpy/dMTR+vr72Fu5syX7bRXvNlTNuUPi8BHkhFr4763a0I9MTBu+/CI7dPL6dC6/hW9Sb3U4IxPGng1EsLfmFNSB4ccZFjwcgNmLlQn7ADqA+uTqfz0UqWE5+hpkRFtrTcLlc3ouoJ47mG2GzakY0lKpFX7hBF3ZdqubjCboddGHO5xegb0UKIYr3THXikE/CdsFSt11EZ4ahf20T4fLNRQrSQGeBv/rm7ffkljwdDGnSWT4fIfTJ92dvvv7x4mvki8vVO2k0GA6GLntXxhZMdqZ64xvsLtuA3rpbNnvfsWvv2LV37No7du0du/aOXXvHrr1D0unYtXfs2jt27f2RVetj196xa2967Nojx669Y9fesWvv2LV37No7du0du/aOXXvHrr3/o669UDzCjOmkzJlwtURXbbgLZcCr7V6+64RmWCecXNG7O3w9fqfz9RqHf61AY5HxOqG3TAt8BXQlxiQW37Bc9QFqLDn4ikL/EudPfNS5Ot5WZRVrh57ilXPTg7jdUubb84tLmtBZ6DcsFEcazZbYi8iWdILZKXV9i87CruOMuWaSnMlF5Spo1PPFmiGrbLZZcPzgCo7hR6cQx2TdkXKzEulVwb+o2E6Cf2CN4juo/9mge8hegmDbiI0uvF6v1/8FPV9BJQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztGmtvGzfyr/D4pY2wkiVHeZxwOFyS9lqjDwe1g+JgGS61HGmZ7JJbkmtpa+i/H4aP3ZUs2UlatLqDvthazoPzIjnkzB21bGHo5IpeQlHmzIKh1wnlYFItSiuUpBN6mQGJYPJGA8Nx8urtGWF5rpaGVAa0IVaRFIFA0spYVYjf2CwHYiPjhCwzkWbEgL4FwgyZ5RWUWkhryFxpsgAJmlkhF4SrtCoAAUthM1Jq4DAXEjgxVleprTSYAXlXKklMlaZgzLzKm5m8GELJhNgMnKAabKWlIYxUUvxaAen1IvaN4L0esRmzJGWSzADV4ahNEAg64swYwpR0jE0JqZgLRA68BlM5le/KXDFOalWRks+JkERVmlz1el/BrFqQd2e93vWXmbWlmZycsLIcqBKkEQuZs5kZpKo44YhY8vkTkoEGxwlF45otyVLwBVhDmOQkVWVNUtVXWnDJLCSkZAsgsipmoImao5TFgLDcqIaJo0E1no8R4+1X/3ZC93qvIVcd9hqIqcpSaQscdUCFox0mvR7SvFFFoSQpmWYFWAwBNY8MJojQRzPXJUx6PXImuUgxDBwnHG2xBx4VhUfUi2BXj7qhkgwxhNosmbTopjJnKThUDegSK25hk/EqITUy/gqkihJkSovflLQsd6a8BW1FynKSKqW5kE5Sb0FiLNMuLEslpI2jYQbyn2DYynghePAyisbRLIWQDmKA3LK8AhOkWiYkQ6l+glKDceEV+NrMyZSBWGR752P8fWXsBmNSGRSzK0WYS8OvldDAnXnBmW3OcgNEzDdsWbAP0JmNKLcHsHxAXteEw5xVuU2IsF8YYnUFA/KjsoSVZS5St9hxHWMoM1yifeflEBBBEMkK5+O3Wt0KDrgiuZjPQYO0BIGORYzCIB0GY+kIUL1CaZSRSaJkx9GjAen1mrldiP7yyy9TeTeVhEwpyjKlkyltUKY0IR6GITalk1FCwsBqSifk6emLiFDj9/PTl/F7id+j0Th+Z/h9OprKdZj01AljWVE+IAiC/3gh4qd3ncFBNzOOxTDAQfSfx0UImh5HG7EQsG4VeooKCSmsYLnZr1PEODy1Wsm2NBujZlAwke9Xy4EPT6cg1pZCzwbtOtujj2dxaOr4X1vaPEdt3qsZscLmD6jUoByeXh3RtpR7gcqlqiiZrPerFhAOT7FGsC21XqJanNkH3IXQw1MoSBUB4cDzsOG4P3rWPx2ejjsYc6ULFhCKos95v67rekpJaxHi9MezL7DD4y+ef/6sxhxzrlWxI7lxuUeLFXIB9zsmBD9gGjCLJ2SbrbXpqZdy8wy3irP6C+NZRdJwSHv8NhWrO2I6EMpRY1abZkqkQXjECYYnM0wmB2iEPtqRn/zww4m3TNIO9osimMv7Akfxu+8s2R0tigHng23crsG7owXhPCE7xncDOCdFUewb9wAM8an8+8DdG1Z2plb7QzsgHF50t4LtDPBwKERYJmQAhOggWwgaFlXONKwwfTVCSaf9vc1gK/Jj4LMYij53dWmfuxl4IcmX5yH1fBKCEuXZZIAjj9PdE7PLRMMCVo6Hv7OiMIKHy6Op0gzvqe6Wi5mnknkdriIm8V8pKwXeIXKw1o2CTQebQkzlaOj2+QzSDw9GTsQ4vNDpSBaB/sqB4KspLVg4eOkc2t/KZqCn9LqhMZBDaoF3aMkuYnLdiTLG0dKI7K4srXiZ4JCzGeQtrCNccGNHVQQUQnohohmGkZ+DstUWNADXO4LaK9GNprj7xZiMViO5MPEuummCLnW4w7mXCAn+CWIGJBKQWbN77wpyb6XO/Q5duX29M2A3BWOGRNIdVzxn07j6gq0fmQHxiENsrs9xsn0TBBU2PNO1C/IohBRFVXSeNiLXaLEinIJdcyElvk3FGbrevTcDWz0yQ3gd2jPBVI7cDZRrVXK1lG6Vk925T0A5vGXekez3LPONY8Xj/Z5lFKXqLqMdJwqi+rOkWUJm/xoakHPcv/EJwRMJQ1iaQmmBb23gI3eb14wLRWaVtUru38K7WIfn3y3p/gQfo8If5+WubH+Vp6dy5B86Cv8Uue+Vo3D+PDTvBrF2uyEccZImVJXunV3JM04n1L/ZxxdsmripwNjXitd0ckdTJS1Iiz/DQx+Snrw3WBu4oybNoGD4K4qI1YS5yJEVvrWBNjSh7v6LpQU0Ip1QNXsPqaUJJpclvr2CQR6ObnIXsYzVQi5oEu5ZdEL9yzVNKKxYUSJyGCIgU4W3H8diHWd8iFcz0vIy7kfzno988Mn4M9k40vVWOeWzOHU5rFu7tsyY1qym25Wb+FYcM3hP17zq5nU8voXFVCCmFx6NJlRYKLqz7PGaVp9u6RQUauKesD6V1rmFFZ88J9KVmZKfRRjepHfY/COt5KH3J9502Su8bACP2WC/fU5PiHuaHTwWMRHfacsW3Tl9cnNvzst9ZZZOJcBkqso5vvUD0wNX7fj8shaWClmeVq5a1+zmG5o1ojaajdYJXT2uzMpXxHwNh3yZw9ySqixBk1RpCfpJ96nlYJQ7HY/XCa0fV6/+n1TvBTpv+bh2P7viV1sY/CtkffpyndDscVm/bcpzf6Gw4+fr9qzbOstvZorXN3HfWj+GGA8VxDMg+Zk81xx0xxAzpXJgsju/u8E9wtlP3aYHmL+4AVMqafzmeDoc4r+tfWmjoI/V/6bYn9d/o8nH5yYP78x+GLOh+7tzu7G+zk6/NaUs0gx31gKM2dxcd5A8okDXbkLmQsJNNMrN6XB48wwtt07oeJdxLlQBNsNnqSXWTpdayUVCyhwYFqJ1TdiCCUlwev0H2gq0VvphrT9NsoeMMB4Ob0aNEZ7dN8KZdC89rsfjUn0A+edq2p3e+ulR1FXhUhqfolDhkRycbijbHfdKGkgrLWxNJ1d3dNVnpeh7+OTqen2NUWczhVl7qYyTmNmMTujJvSTeNdlghnh1Ryud0wl9cBdipTi5HdF1so1tLFsIueg/SHXdCn6BxvX22xC/TZpK8R1g1hSs08VKqECnZsBw30F7oM9+au8jX0fLx5vCzuS/NfF2Oh+z+Y0EfXtf35FydzLuq5juugy2SWBpqxFtkkz82aSNV20gNRlaTNBGLrM5HY9dCvBi5M7Kpy/dMTR+vr72Fu5syX7bRXvNlTNuUPi8BHkhFr4763a0I9MTBu+/CI7dPL6dC6/hW9Sb3U4IxPGng1EsLfmFNSB4ccZFjwcgNmLlQn7ADqA+uTqfz0UqWE5+hpkRFtrTcLlc3ouoJ47mG2GzakY0lKpFX7hBF3ZdqubjCboddGHO5xegb0UKIYr3THXikE/CdsFSt11EZ4ahf20T4fLNRQrSQGeBv/rm7ffkljwdDGnSWT4fIfTJ92dvvv7x4mvki8vVO2k0GA6GLntXxhZMdqZ64xvsLtuA3rpbNnvfsWvv2LV37No7du0du/aOXXvHrr1D0unYtXfs2jt27f2RVetj196xa2967Nojx669Y9fesWvv2LV37No7du0du/aOXXvHrr3/o669UDzCjOmkzJlwtURXbbgLZcCr7V6+64RmWCecXNG7O3w9fqfz9RqHf61AY5HxOqG3TAt8BXQlxiQW37Bc9QFqLDn4ikL/EudPfNS5Ot5WZRVrh57ilXPTg7jdUubb84tLmtBZ6DcsFEcazZbYi8iWdILZKXV9i87CruOMuWaSnMlF5Spo1PPFmiGrbLZZcPzgCo7hR6cQx2TdkXKzEulVwb+o2E6Cf2CN4juo/9mge8hegmDbiI0uvF6v1/8FPV9BJQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(s.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.9ac115fd.js b/assets/js/bfe4b778.9ac115fd.js deleted file mode 100644 index d1ea55c93..000000000 --- a/assets/js/bfe4b778.9ac115fd.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:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=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/ivcfUoB2VZe2mHCMCxrizZo0RhNggFLDIOWTjYbimRJyo5h6L8PR0m2bCduMxQbsC+GTN3b89zx7rQCz6cOklt4o9OyQOUdjCLI0KVWGC+0ggSuZ8huTMY9slaKnQ8vGJdSLxwrHVrHvGaFzkS+ZFxlrKzF/QxZhp4L6ZjOGWfOYCpykbKsMdRnn3QQ5J75mXDBsFZy2Vr3ujXGWY4LZrjlBXq0LmJLXbKUK6U9S2dcTWuHuZDItEqRCV9H0AYtHEstco9ZHyLQBi0niBcZJFA7afFBBBtHkNyuQPECIYHW1lhkEIEgegz3M9jl7OINAd7yHjAqxCyAmmCDi+xY/FoKixkk3pYYgfNLSd6cKIxEiAAfjNQZQpJz6UggnWHBIVmBX5og6a1QU4gg17bgfnNSVaPaPjr/h86WpLMd6tDquciQTVDqDr8d5j0WRnKPjh1xzyRy55lW2JFtAbyACFKtPFGYrIAbI0UaSB58ceRttR+6nnzBNDBuKSVeoKO3NeHfBkjk8EBTAi48rCmHKgKl/bPNDAkiMotzgYtQz05MVV2fXdtbPD7PxboqujYq0pEZWqrIfXsbbaiqCLzwW6bGndocTyjVVUVyFp3RytWsnsTxfgWsb3VTkcyVaYrO5aWUy59+XErr42+B4y47ee+GZ+8NEdKEdO4PK53EJ6e947gX/3x9/Co5+yV5+aofx/FfEMFDITf1BGQNuuyF/50DoaRQOG5ZG5/E8fi0ofLsMfaaajHNNZpzKTKWC5QZI5/uBxKI1mr7D6v5QHyH4BPkFvzZgdKhJpzrUmX/NdzHIjoM8Gx8tob4ch/ihaopo8l0re9R/RsIN3i67n3tnkLdrmpRC4X3sAW2e16DdJiWVvhlGGsPPW5Er36f3I5oWBToZ5pGoinrOehnkMCg7S6DVafPVED27LydkqWVkMDMe+OSwYAb09cGFXVPySeun+piwI0YzI+hinalnedToaa9g1qjTfxXxHFN4xaKNZnciA+4hKglqSvVzO4Z8gxtIJRS93kzJ9+2CVhzvDtc2tnyfeNid0F4dAB0+z9QHoXKdUDU5PPSoLoi41QN8+M9q9fks9miWg+hMlmuLdvRZhPuMGNahT2FXtL5af94vaYF1T67U3fqShdIq15eSiaFunfJneqx28s8F6ngkv2JEyc8jo7adC4Wi700vgg674SflRNm0eiN+DQchlx3tdZ/aLPwaAt3mV+hnYsUm9J5wtUgCA+aq8rTcFWx4IJKrjn6fVeJKJciReW6iT9/N/zI5uy0H0PUqdnvCHrw8eL1209Xb8ku3ZE6Scf9uB/TkdHOF1x1XO2s2bv5XW36zv91K2/urscHPzCSi9DOAumrphXdQudSJd2FfBTBTDtPIqsVFfeNlVVFx19LtNTwRhHMuRV8QrfpdgWZcPScrRfrJ+k++tyuuOx5u/2jgNoOpag9zbksw1YXwT0udz4yqlEVtW2KIq4lXtdx9a7JzsbC3iiiLltrnKcpGn9Qttv7hzfXEMGk+WAowrcHWL6gjxW+gATu4A7CRxQZCE04nK9AcjUt+ZTka7PUXHlJmet25vvQmZsHAvYoJdstu0ZCv4TrUYVfqVI/4PK3tXj95kmFhtpWmtIzqqrqb4+1NuQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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/ivcfUoB2VZe2mHCMCxrizZo0RhNggFLDIOWTjYbimRJyo5h6L8PR0m2bCduMxQbsC+GTN3b89zx7rQCz6cOklt4o9OyQOUdjCLI0KVWGC+0ggSuZ8huTMY9slaKnQ8vGJdSLxwrHVrHvGaFzkS+ZFxlrKzF/QxZhp4L6ZjOGWfOYCpykbKsMdRnn3QQ5J75mXDBsFZy2Vr3ujXGWY4LZrjlBXq0LmJLXbKUK6U9S2dcTWuHuZDItEqRCV9H0AYtHEstco9ZHyLQBi0niBcZJFA7afFBBBtHkNyuQPECIYHW1lhkEIEgegz3M9jl7OINAd7yHjAqxCyAmmCDi+xY/FoKixkk3pYYgfNLSd6cKIxEiAAfjNQZQpJz6UggnWHBIVmBX5og6a1QU4gg17bgfnNSVaPaPjr/h86WpLMd6tDquciQTVDqDr8d5j0WRnKPjh1xzyRy55lW2JFtAbyACFKtPFGYrIAbI0UaSB58ceRttR+6nnzBNDBuKSVeoKO3NeHfBkjk8EBTAi48rCmHKgKl/bPNDAkiMotzgYtQz05MVV2fXdtbPD7PxboqujYq0pEZWqrIfXsbbaiqCLzwW6bGndocTyjVVUVyFp3RytWsnsTxfgWsb3VTkcyVaYrO5aWUy59+XErr42+B4y47ee+GZ+8NEdKEdO4PK53EJ6e947gX/3x9/Co5+yV5+aofx/FfEMFDITf1BGQNuuyF/50DoaRQOG5ZG5/E8fi0ofLsMfaaajHNNZpzKTKWC5QZI5/uBxKI1mr7D6v5QHyH4BPkFvzZgdKhJpzrUmX/NdzHIjoM8Gx8tob4ch/ihaopo8l0re9R/RsIN3i67n3tnkLdrmpRC4X3sAW2e16DdJiWVvhlGGsPPW5Er36f3I5oWBToZ5pGoinrOehnkMCg7S6DVafPVED27LydkqWVkMDMe+OSwYAb09cGFXVPySeun+piwI0YzI+hinalnedToaa9g1qjTfxXxHFN4xaKNZnciA+4hKglqSvVzO4Z8gxtIJRS93kzJ9+2CVhzvDtc2tnyfeNid0F4dAB0+z9QHoXKdUDU5PPSoLoi41QN8+M9q9fks9miWg+hMlmuLdvRZhPuMGNahT2FXtL5af94vaYF1T67U3fqShdIq15eSiaFunfJneqx28s8F6ngkv2JEyc8jo7adC4Wi700vgg674SflRNm0eiN+DQchlx3tdZ/aLPwaAt3mV+hnYsUm9J5wtUgCA+aq8rTcFWx4IJKrjn6fVeJKJciReW6iT9/N/zI5uy0H0PUqdnvCHrw8eL1209Xb8ku3ZE6Scf9uB/TkdHOF1x1XO2s2bv5XW36zv91K2/urscHPzCSi9DOAumrphXdQudSJd2FfBTBTDtPIqsVFfeNlVVFx19LtNTwRhHMuRV8QrfpdgWZcPScrRfrJ+k++tyuuOx5u/2jgNoOpag9zbksw1YXwT0udz4yqlEVtW2KIq4lXtdx9a7JzsbC3iiiLltrnKcpGn9Qttv7hzfXEMGk+WAowrcHWL6gjxW+gATu4A7CRxQZCE04nK9AcjUt+ZTka7PUXHlJmet25vvQmZsHAvYoJdstu0ZCv4TrUYVfqVI/4PK3tXj95kmFhtpWmtIzqqrqb4+1NuQ=",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"}},j={},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:"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)(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,t.jsx)(r.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",example:""}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.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)(r.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)(r.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)(r.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)(r.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 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/bfe4b778.b9b91e4e.js b/assets/js/bfe4b778.b9b91e4e.js new file mode 100644 index 000000000..c7d396005 --- /dev/null +++ b/assets/js/bfe4b778.b9b91e4e.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:()=>j,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",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-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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",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 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:"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",example:""}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.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 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/f0ff4a36.389c8736.js b/assets/js/f0ff4a36.389c8736.js new file mode 100644 index 000000000..b53c42125 --- /dev/null +++ b/assets/js/f0ff4a36.389c8736.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=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:"eJy9WO9u2zYQf5Urv6wFFP9J3LQThqHB2mVZi6VYUhRYagSUdLbYUCRLUnYMQ9/2JHu0PclwlGTLsZPU2NYvtkTef9797qgl83zqWHzFXuu0LFB5x8YRy9ClVhgvtGIxu8wRTtFDSwIn788AFU8kOljoErwGi94KnCFk6LmQDniiSw8cnMFUTEQKWcPdYxHTBi0n6WcZi9kUfbvJIma45QV6tGTWkileIItZS3AtMhYxQWYZ7nN211adfMbUn2WgJyt7WcQsfimFxYzF3pYYMecXksQ6URiJLGJ4a6TOkMUTLh0RpDkWnMVL5hcmUHor1JRFbKJtwX13BW95kBIz88swydPD3CSsqsak1hmtHDoSdDgY0N+mva5MU3RuUkpYBYVFLNXKk+XxknFjpEjDRv+zI6bltnW12xQ9S2K8qFW20djXj59Pxc3hUZJ/+JVVEZsIWtxPQu69cXG/36yUVvZSXZA0L/z+4lx4oBwiEUr7vSUYidwhODFVq1QMzmmZof1WoayzeT8JtYUQWKt1ANcl0bhQRUzP1YYvXyX/s0ZIEImfohMKbyWBW8sXVHEeC/d4lKzefbZrbSnqhwKx0ywsuJCPUieIr5qFNtdMrtUjakbPjw+HRy9fDIl+LrIp+n/hf727rW+z6E+k1HPMYMZliQ4OQlZyX1qMwHlemN5j5dDSk9G3HYWqLBK0Xe7Vyor7cDSqIrbYk+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YTFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INF7LYI6d32Ou6RdQu9eS9N9g30VFtkHbS8iz0Uzipio12t7UIX6HOhpjCnoWFutZpG0OCwtwvgUy4UUPztk/+u56G1eicGriO0n2XdhBFKCoXXbV+/Hg0G18NVEEbbQVjNTEp7mOhSZd/W1V36H3ZodH20cuj5tkNnasalyMIMeKlvUH1bf7rqfa1+O2NFTRT22Yaz3fXaSYdpaYVfhGHz9oAbcVDvx1djGuEoU3QzpYbp1OcsZv22APrLzmRaMZJnZ+3sWlrZGYW4MT1tUBF4S544alJ9bkR/Rr3nLrXzfCrU9OBBrvHa/guKcR3GDS/WncyIt0itrAlSl6qZqHPkYZCo6H2iA3MTunODikAyBH423GppH1GmukC6CvgcoSX/+8+/AkcbpJAXT+C8tGD0HC3NvVxlMJF4KxKJgZhTe1zdLBzyQqJzcgFCeZxa7hEyMRWey9A4qY5TbngipKBMIjJN3BY6yeh68DFHn6Olre8sAocMZygpAUFqfUNyvAZeel0EHW3pzLW9mZBJEXBISicUOgcOsWVBlXOVIrRnEYG2wBWg8miNFQ6Bi4KIJ9oCTiYiFSSYysby1EPBFZ8iKYuA7KYoGKtnIkMHViel8+C0LIMjpLFA9LWLCjFzPXgtZlg7Tov1JQwzmJYkIoJUZwhNFZEbKoMEnQdD6kWKQajz3HqQOEMbci+c5KSUEoym8hZc0rWqe7YkyFuuHPXl2qD2aFbhM1bTFSfoyPiiB5/UJ0UQDKVDSgAp1I2LP6kDuFql2UdMnPA4ftrWw3w+36qDZ5s8p8LnZQIWjV7zTcNiqJou++rlGYuYR1u488kF2plI29vLPTr7gbjfgB5PA+g1AyrV2Ku7DARAUqSoHHYg6uT0/TuYwVFvwKJO5X+Fwf13Zz+9+e3iDcklpKnrb9gb9AZh5NXOF1x1VHWv7nfrdrmG7v/hmt8gj8db3zeSiwDGwdllA6RXrHPzj7uX/HHEcu08kSyXCXf4wcqqouUvJVqC63HEZtwKsi+gbSYcPWerO/y9nj79vfkc8Azu+V6w0/IWSBWhaJjdWcxYxG5wcecLRTWmubdGUzKtpjhJUzS+w7vVKzcazumbSxYxXvp8E8VvAoo3DyR9p12b8F4bQL/UaXYy/EDH/RYXP67I6517GRr/WmqK0biqqn8ALkFNSQ==",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:"eJy9WO9u2zYQf5Urv6wFFP9J3LQThqHB2mVZi6VYUhRYagSUdLbYUCRLUnYMQ9/2JHu0PclwlGTLsZPU2NYvtkTef9797qgl83zqWHzFXuu0LFB5x8YRy9ClVhgvtGIxu8wRTtFDSwIn788AFU8kOljoErwGi94KnCFk6LmQDniiSw8cnMFUTEQKWcPdYxHTBi0n6WcZi9kUfbvJIma45QV6tGTWkileIItZS3AtMhYxQWYZ7nN211adfMbUn2WgJyt7WcQsfimFxYzF3pYYMecXksQ6URiJLGJ4a6TOkMUTLh0RpDkWnMVL5hcmUHor1JRFbKJtwX13BW95kBIz88swydPD3CSsqsak1hmtHDoSdDgY0N+mva5MU3RuUkpYBYVFLNXKk+XxknFjpEjDRv+zI6bltnW12xQ9S2K8qFW20djXj59Pxc3hUZJ/+JVVEZsIWtxPQu69cXG/36yUVvZSXZA0L/z+4lx4oBwiEUr7vSUYidwhODFVq1QMzmmZof1WoayzeT8JtYUQWKt1ANcl0bhQRUzP1YYvXyX/s0ZIEImfohMKbyWBW8sXVHEeC/d4lKzefbZrbSnqhwKx0ywsuJCPUieIr5qFNtdMrtUjakbPjw+HRy9fDIl+LrIp+n/hf727rW+z6E+k1HPMYMZliQ4OQlZyX1qMwHlemN5j5dDSk9G3HYWqLBK0Xe7Vyor7cDSqIrbYk+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YTFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INF7LYI6d32Ou6RdQu9eS9N9g30VFtkHbS8iz0Uzipio12t7UIX6HOhpjCnoWFutZpG0OCwtwvgUy4UUPztk/+u56G1eicGriO0n2XdhBFKCoXXbV+/Hg0G18NVEEbbQVjNTEp7mOhSZd/W1V36H3ZodH20cuj5tkNnasalyMIMeKlvUH1bf7rqfa1+O2NFTRT22Yaz3fXaSYdpaYVfhGHz9oAbcVDvx1djGuEoU3QzpYbp1OcsZv22APrLzmRaMZJnZ+3sWlrZGYW4MT1tUBF4S544alJ9bkR/Rr3nLrXzfCrU9OBBrvHa/guKcR3GDS/WncyIt0itrAlSl6qZqHPkYZCo6H2iA3MTunODikAyBH423GppH1GmukC6CvgcoSX/+8+/AkcbpJAXT+C8tGD0HC3NvVxlMJF4KxKJgZhTe1zdLBzyQqJzcgFCeZxa7hEyMRWey9A4qY5TbngipKBMIjJN3BY6yeh68DFHn6Olre8sAocMZygpAUFqfUNyvAZeel0EHW3pzLW9mZBJEXBISicUOgcOsWVBlXOVIrRnEYG2wBWg8miNFQ6Bi4KIJ9oCTiYiFSSYysby1EPBFZ8iKYuA7KYoGKtnIkMHViel8+C0LIMjpLFA9LWLCjFzPXgtZlg7Tov1JQwzmJYkIoJUZwhNFZEbKoMEnQdD6kWKQajz3HqQOEMbci+c5KSUEoym8hZc0rWqe7YkyFuuHPXl2qD2aFbhM1bTFSfoyPiiB5/UJ0UQDKVDSgAp1I2LP6kDuFql2UdMnPA4ftrWw3w+36qDZ5s8p8LnZQIWjV7zTcNiqJou++rlGYuYR1u488kF2plI29vLPTr7gbjfgB5PA+g1AyrV2Ku7DARAUqSoHHYg6uT0/TuYwVFvwKJO5X+Fwf13Zz+9+e3iDcklpKnrb9gb9AZh5NXOF1x1VHWv7nfrdrmG7v/hmt8gj8db3zeSiwDGwdllA6RXrHPzj7uX/HHEcu08kSyXCXf4wcqqouUvJVqC63HEZtwKsi+gbSYcPWerO/y9nj79vfkc8Azu+V6w0/IWSBWhaJjdWcxYxG5wcecLRTWmubdGUzKtpjhJUzS+w7vVKzcazumbSxYxXvp8E8VvAoo3DyR9p12b8F4bQL/UaXYy/EDH/RYXP67I6517GRr/WmqK0biqqn8ALkFNSQ==",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={},b=[{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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.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,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)(a.p,{children:"successful operation"})}),(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)(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:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.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:"folder"})}),(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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.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.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)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.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)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.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,i.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,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.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)(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)(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:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.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)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(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)(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:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.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)(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)(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)(h.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 y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.bdf7e411.js b/assets/js/f0ff4a36.bdf7e411.js deleted file mode 100644 index 041e63cfd..000000000 --- a/assets/js/f0ff4a36.bdf7e411.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:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=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:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",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:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",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 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)(t(),{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)(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)(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)(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)(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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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:"widgets"})}),(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:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(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)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)("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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(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)(a.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)(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)(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)(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/fa40969b.20ecf810.js b/assets/js/fa40969b.20ecf810.js deleted file mode 100644 index 17a9cd818..000000000 --- a/assets/js/fa40969b.20ecf810.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:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=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:"eJztWFtv2zYU/isc+9IGsi07TtoJw9Cgy4KsxVI0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEv/UHGegXSWDgKagI0N144rSSP64sULUk+Tm4UGG93JT+AMhykQRgS3jqgxSWoTZMQsJERJ4hYa7uSd7LbJ0dEfho3dypKNjo7uJCGEtNZjxKXMEWaAxLkxIJ1YEC5J4jWtYy63bbTXQ3uXsvXRqIkBa7/Jqq6UvcVjtPhOZVqAg+Q59lI2BTICkMTmcQzWjnMhFiRe2ZhxlxImBDHwNecGEmL5RDKXGyh99tHn+Vz7ued6hEqeycSnJBURSk7AEOaj4CMB3vqJxxxiweWhCSW11mhBXAokt2Dad5IGVGkwDHlxmdCITsDVi44koAHVzLAMHBgk1ZJKlgGNaKJiZAINKEdCaeZSus2ymxQ8XTaZ5BQxFdNoQGsgaeRMDgG1biHQvuWIOQ0ozLVQCdBozIRFgTiFjNFoSb3/iFpnuJygpMwz5L2nlg+spgMN6GoNS5PeJcZbokIHRRGschM8467O7GsOZrERaB1IFelYmawZZ5XHKsyMzXmGkZ2EYVAHLfNsBIYWqMd8plE3bIRg77n+bhE87DMsBmjXaiUtWJTthSH+21zI9W4gK7Z4TKUD6VCeaS147Cc6XywqLXcDUKMvEHtKGTTjeOnSgM2Fa8gxYxgmzB1k9mn9chjZu8sJhIa5DZbUudM/L/h973iUfv4LMRlzHDzMQuqctlGnU43kRrRjlaE1x93h5qz/gVsFTUjlDragBTALviitdpxPTokEzI+CsuTwYRbKCIlXLdYA0jqLYZVCEVA1kxu5PMv+F+ULIeojOr6afSvhjNq/tmtvMajHgNgbFmSMiyelRwBvq4GaazpV8gk3/ZPTXvf4zesuys94MgH3P/IvZ3f9bRaNMyHUDBIyZSIHS1rrozLAcz/T7ae2Qy2PQc93C1lDezWy0u71+0VAFwdqve4iPgcqHb8pApoeqNQ/xZVjEzhQr9vcHA4yLZiD4XVJ6WG9tMVjUn5/WZDJpbwym2VhpJQAJpsO/VlTBDQ2wBwkZ+5xpvXC3nGrG7bC1zfd06j/a3Ry2g7D8F8a0Hnm6V03EMwBbW706jvXyQ/wU+yINarldu3ZhJNLbBmG9ak57IXhsI8iRUD7YX/39PwEWhlHpHKETRkXbCTgl+93fIIxam85XIO1P4LHkuqH/eHJKqmT3aQu5ZQJnpCzj5fkRt2D/LEZNd270v3umvJSyM/TjWSb42WSFuLccLfwPe68xTRvlfPR7QCbpAxcqqoG2TfFLqUR7TR75c6yaooLivbMtG6ZcyMazQLTuq00SCxvgo0slvEO07wzxeq8LW0dm3A5aT2qNVjHf40YlzBuZLGu9Zq/Byz2FUhNqarhTIH5o7bA77HyyhV0VxoklhEP/LS7p+XnlnDrp2tsPAnIWBmypd24VKbgJ3H8uN0lVkPMxxV/2gTvPtcq87cWbEIFl/d4Y22R26vxmMecCfIPjCx3MHhZIzebzXYQe+V1LrhL8xExoNVafOIHPaxNrdXHKxpQByazV+NrMFMe1w3gA646XrhT7QoW+11RnfH10NttJWSp4DFICw0en118/ECm5Lgd0qBBj2cE3flw+e787+tztIt0LBep2w7boe8clHUZkw1XF7C+zpevAGOjsuqevr3ay/WG//mi8PNFYfWiUFUaB3PX0YJxX3w9b5dV4bylW48MUf2eMAhoqqxDkeUSKfLZiKLA4fIajPU04RZPsPVF+B4WjWu7bzhpRH01fUC2ul+vRQf4YTjK7vfxIPNffqpW7hV5zoPHXnDq2iwXzaDqYGtsigE2mmVxxhjL2bM4Bt3Me+fo3Ti/Ls5vaEBZ7tLNQ+HeHwrVD7S+N6bN06IMAP8i1HsVfsOS/h4Wv6/Ey5kHFar8amnEZ1AUxX+4PBYL",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/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:"eJztWFtv2zYU/isc+9IGsi07TtoJw9Cgy4KsxVI0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEv/UHGegXSWDgKagI0N144rSSP64sULUk+Tm4UGG93JT+AMhykQRgS3jqgxSWoTZMQsJERJ4hYa7uSd7LbJ0dEfho3dypKNjo7uJCGEtNZjxKXMEWaAxLkxIJ1YEC5J4jWtYy63bbTXQ3uXsvXRqIkBa7/Jqq6UvcVjtPhOZVqAg+Q59lI2BTICkMTmcQzWjnMhFiRe2ZhxlxImBDHwNecGEmL5RDKXGyh99tHn+Vz7ued6hEqeycSnJBURSk7AEOaj4CMB3vqJxxxiweWhCSW11mhBXAokt2Dad5IGVGkwDHlxmdCITsDVi44koAHVzLAMHBgk1ZJKlgGNaKJiZAINKEdCaeZSus2ymxQ8XTaZ5BQxFdNoQGsgaeRMDgG1biHQvuWIOQ0ozLVQCdBozIRFgTiFjNFoSb3/iFpnuJygpMwz5L2nlg+spgMN6GoNS5PeJcZbokIHRRGschM8467O7GsOZrERaB1IFelYmawZZ5XHKsyMzXmGkZ2EYVAHLfNsBIYWqMd8plE3bIRg77n+bhE87DMsBmjXaiUtWJTthSH+21zI9W4gK7Z4TKUD6VCeaS147Cc6XywqLXcDUKMvEHtKGTTjeOnSgM2Fa8gxYxgmzB1k9mn9chjZu8sJhIa5DZbUudM/L/h973iUfv4LMRlzHDzMQuqctlGnU43kRrRjlaE1x93h5qz/gVsFTUjlDragBTALviitdpxPTokEzI+CsuTwYRbKCIlXLdYA0jqLYZVCEVA1kxu5PMv+F+ULIeojOr6afSvhjNq/tmtvMajHgNgbFmSMiyelRwBvq4GaazpV8gk3/ZPTXvf4zesuys94MgH3P/IvZ3f9bRaNMyHUDBIyZSIHS1rrozLAcz/T7ae2Qy2PQc93C1lDezWy0u71+0VAFwdqve4iPgcqHb8pApoeqNQ/xZVjEzhQr9vcHA4yLZiD4XVJ6WG9tMVjUn5/WZDJpbwym2VhpJQAJpsO/VlTBDQ2wBwkZ+5xpvXC3nGrG7bC1zfd06j/a3Ry2g7D8F8a0Hnm6V03EMwBbW706jvXyQ/wU+yINarldu3ZhJNLbBmG9ak57IXhsI8iRUD7YX/39PwEWhlHpHKETRkXbCTgl+93fIIxam85XIO1P4LHkuqH/eHJKqmT3aQu5ZQJnpCzj5fkRt2D/LEZNd270v3umvJSyM/TjWSb42WSFuLccLfwPe68xTRvlfPR7QCbpAxcqqoG2TfFLqUR7TR75c6yaooLivbMtG6ZcyMazQLTuq00SCxvgo0slvEO07wzxeq8LW0dm3A5aT2qNVjHf40YlzBuZLGu9Zq/Byz2FUhNqarhTIH5o7bA77HyyhV0VxoklhEP/LS7p+XnlnDrp2tsPAnIWBmypd24VKbgJ3H8uN0lVkPMxxV/2gTvPtcq87cWbEIFl/d4Y22R26vxmMecCfIPjCx3MHhZIzebzXYQe+V1LrhL8xExoNVafOIHPaxNrdXHKxpQByazV+NrMFMe1w3gA646XrhT7QoW+11RnfH10NttJWSp4DFICw0en118/ECm5Lgd0qBBj2cE3flw+e787+tztIt0LBep2w7boe8clHUZkw1XF7C+zpevAGOjsuqevr3ay/WG//mi8PNFYfWiUFUaB3PX0YJxX3w9b5dV4bylW48MUf2eMAhoqqxDkeUSKfLZiKLA4fIajPU04RZPsPVF+B4WjWu7bzhpRH01fUC2ul+vRQf4YTjK7vfxIPNffqpW7hV5zoPHXnDq2iwXzaDqYGtsigE2mmVxxhjL2bM4Bt3Me+fo3Ti/Ls5vaEBZ7tLNQ+HeHwrVD7S+N6bN06IMAP8i1HsVfsOS/h4Wv6/Ey5kHFar8amnEZ1AUxX+4PBYL",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:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},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,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 list from status"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\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:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\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)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.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)(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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.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:"document[]"})})]})}),(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(o.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)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)("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)(d.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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\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)(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:s}={...(0,n.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/fa40969b.68747bab.js b/assets/js/fa40969b.68747bab.js new file mode 100644 index 000000000..b204f0336 --- /dev/null +++ b/assets/js/fa40969b.68747bab.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:()=>b,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",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/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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",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:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},b={},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,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 list from status"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\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:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\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)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.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)(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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.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:"document[]"})})]})}),(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(o.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)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)("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)(d.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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\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)(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 f(e={}){const{wrapper:s}={...(0,n.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/runtime~main.2eff245e.js b/assets/js/runtime~main.fa07c36e.js similarity index 83% rename from assets/js/runtime~main.2eff245e.js rename to assets/js/runtime~main.fa07c36e.js index 9732cfbd8..a6074b2df 100644 --- a/assets/js/runtime~main.2eff245e.js +++ b/assets/js/runtime~main.fa07c36e.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,d,r={},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 r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=f,e=[],t.O=(a,c,b,d)=>{if(!c){var r=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},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 d=Object.create(null);t.r(d);var r={};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=>r[a]=()=>e[a]));return r.default=()=>e,t.d(d,r),d},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",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",2939:"e21b07c7",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",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",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",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:"85de923e",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"20ecf810",339:"4b03478f",420:"086699e6",453:"61f3e45f",533:"2d5f5b1d",762:"88a79f65",792:"01714e3e",823:"81840a08",835:"6d377313",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"bdf7e411",1477:"b31b2642",1512:"7ddd2ec3",1520:"cfe051cf",1531:"e7219e11",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"9ac115fd",2121:"c8df990c",2207:"12b39d5b",2213:"d47dd20f",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"7dc252fa",2529:"2079a565",2535:"f3b6b0ab",2542:"6d356e93",2546:"665b04f4",2617:"56321ade",2832:"450477a3",2865:"fcf78bcd",2939:"c4b577ee",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"32ed22a7",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"c34b3560",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"5679ed95",4641:"1ad2d862",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"77d6969e",4918:"15f115ce",4955:"8f728b1e",4985:"c2841a57",5377:"5ed13db2",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"ecfb31d1",6103:"ebc8482f",6113:"36ec8d9d",6125:"9555c68b",6177:"64773b4f",6216:"0d890761",6344:"394ac727",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"aaf8cba0",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"f9046360",7964:"bb3534e4",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"015e4a9a",8140:"901b2f91",8141:"6478079e",8163:"7d7e666b",8215:"c6b04c16",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"4ee860f6",8784:"1c8480ac",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"a73dece2",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5371fdc8",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={},d="OpenSign-Docs:",t.l=(e,a,c,r)=>{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 d=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),d&&d.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","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865",e21b07c7:"2939","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","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",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var r=t.p+t.u(a),f=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+d+": "+r+")",f.name="ChunkLoadError",f.type=d,f.request=r,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,r=c[0],f=c[1],o=c[2],l=0;if(r.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{"use strict";var e,a,c,b,d,r={},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 r[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=r,t.c=f,e=[],t.O=(a,c,b,d)=>{if(!c){var r=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},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 d=Object.create(null);t.r(d);var r={};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=>r[a]=()=>e[a]));return r.default=()=>e,t.d(d,r),d},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",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",2939:"e21b07c7",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",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",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",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:"e6a83f49",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"68747bab",339:"4b03478f",420:"086699e6",453:"61f3e45f",533:"2d5f5b1d",762:"88a79f65",792:"01714e3e",823:"81840a08",835:"6d377313",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"389c8736",1477:"b31b2642",1512:"7ddd2ec3",1520:"618d0da1",1531:"70967907",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"b9b91e4e",2121:"c8df990c",2207:"a9080331",2213:"d47dd20f",2241:"e6e648f1",2245:"1fef8831",2267:"a4846e2b",2362:"ebdb1814",2403:"dfda5b34",2529:"2079a565",2535:"f3b6b0ab",2542:"969e89e9",2546:"665b04f4",2617:"56321ade",2832:"5c33accf",2865:"fcf78bcd",2939:"c4b577ee",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"0316b8ef",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"c34b3560",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"5679ed95",4641:"2592b532",4651:"e48c3f6b",4667:"c24bbf43",4682:"18721add",4772:"77d6969e",4918:"15f115ce",4955:"8f728b1e",4985:"c2841a57",5377:"5ed13db2",5507:"36c41078",5858:"86987606",5900:"e113e88d",6011:"6de743c9",6033:"57dfdd1c",6103:"ebc8482f",6113:"f58acb33",6125:"9555c68b",6177:"64773b4f",6216:"0d890761",6344:"394ac727",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"95befe47",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"a78443ac",7964:"c5d650a9",7971:"c367aea5",8055:"27482879",8087:"fd9041fd",8106:"907e2796",8140:"901b2f91",8141:"6478079e",8163:"5a92f5d2",8215:"c6b04c16",8468:"24a25302",8474:"f58804a4",8475:"d27b3009",8489:"fc1c0045",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"ad06079f",8781:"4ee860f6",8784:"1c8480ac",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"a73dece2",9035:"37598b09",9588:"a3248228",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"2035c76c",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={},d="OpenSign-Docs:",t.l=(e,a,c,r)=>{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 d=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),d&&d.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","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865",e21b07c7:"2939","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","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",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var r=t.p+t.u(a),f=new Error;t.l(r,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),r=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+d+": "+r+")",f.name="ChunkLoadError",f.type=d,f.request=r,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,r=c[0],f=c[1],o=c[2],l=0;if(r.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 fb4e29e7b..b66eda5d0 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 ba6a4d542..b064b0880 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 7e7a39b4a..568e927a5 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 ebace3ffb..b1ef3dcf2 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 5f83c11d7..d31e861b8 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 9b6287b80..2f96a3428 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 85e8aea6e..d057ee5fb 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 c1ea65f30..9823ec528 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 49ff9f361..ee5453b58 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 2c0fad13e..18e7f8af7 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 3ffd760c6..ecc2e0ee6 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index f36705e64..8bbdca80b 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 6f65275f8..40ca209b3 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 01713cf31..3b832a598 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index 80412691e..372b2f61a 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index e53f4bd9f..f1d8e87e3 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 3f28922c4..73068ecfd 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 5dd3214d8..73027d682 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 852c45dda..56be00919 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 8bf876a6a..0395d92d7 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index f0d9a4ccb..373b5f341 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index e9e8d4da8..84ede634e 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index bf37c9489..2d8103c9b 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 60acd5250..d85e1e565 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 6a673784b..8abf8b39e 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 790439e59..e84112a9a 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 455ccbcdb..c284b8aba 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 9a6a52955..daf9e27ad 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index dd942c2c6..fc47143af 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/getfolder/index.html b/docs/API-docs/getfolder/index.html index bd53e7c95..59c7cb137 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 59672f5e2..c258468f6 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 8644810e9..68f1e9d16 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 891aa9d19..009c11705 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -3,22 +3,22 @@ -OpenSign API v1 | OpenSign™ +OpenSign API v1 | OpenSign™ - +

Version: 1.0.0

OpenSign API v1

-

This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.

+

Welcome to the OpenSign™ API documentation! Our powerful and flexible API allows you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer looking to automate document workflows, a business seeking to enhance security, or an enterprise aiming for efficient contract management, our API provides robust solutions to meet your needs. Dive into our detailed guides, code examples, and best practices to start leveraging the full potential of OpenSign™ and transform your digital document processes today.

Some useful links:

Authentication

Security Scheme Type:

apiKey

Header parameter name:

x-api-token

- +

License

AGPL v 3.0

diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index 1ac025918..f0dfc944b 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 795e3c1bf..6a9d62c49 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™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 90925ac21..00986cdf0 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 33540cdcf..f6e6aefb6 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/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index b62fe9b52..c0f285865 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 21eade10f..af30ea0f3 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 693ac4b7b..9f18a34e8 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 f43ec54a2..2e17b2acf 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 245a43acf..3d73ed4ae 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 962c4abd8..5c7381892 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index a466e9461..116fdfcc7 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 0fb66910f..89dce9bf4 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 a6169908a..ba65c9b6a 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 c7ba16af8..e753e0043 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 2721a54ca..a933671da 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 cb8817db5..2310cd9ee 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 1ce5cecbd..f6597aeed 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index ad7b20ffe..287cf3314 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 552297bbd..98c560166 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/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index de2b42e2e..8103a28ff 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 318ea7a12..c3156ed15 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 2df2c9e74..ad158d1b7 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 020c0a0fd..8c8acf8a4 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 d0b593e8e..b96eabbb4 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 d97953440..060bec0ac 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 fbbfd9f87..6a445f9f0 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 bb45909e4..708447ff7 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 6e3b12871..65536b6c9 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 32299ec78..4929d1117 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 aaa88b639..bd6b70ee2 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 39c907ae9..84128f06f 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 e88126ae3..660387a9f 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 2bb61eca5..89340629b 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 a4d907b98..f19d5df52 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/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index f7ea12941..9d9ffc0fb 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 7d801508c..edb5a6c40 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 10528dc0d..c42d10cea 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/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index a8eb0f0c3..f0e598ec4 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 c7e4d167d..9cd33cb6c 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 b4f93a722..8cc624ad3 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 9f3094619..3d72c8eb6 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 e86a804a5..58ebb1d5c 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 398dd8642..557096e63 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/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index ff79339af..c61f5ca0a 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally-windows/index.html b/docs/self-host/docker/run-locally-windows/index.html index 335a17f85..831793303 100644 --- a/docs/self-host/docker/run-locally-windows/index.html +++ b/docs/self-host/docker/run-locally-windows/index.html @@ -5,7 +5,7 @@ Localhost OpenSign™ Setup with Docker on Windows | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 203edff10..abab67a53 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost OpenSign™ Setup with Docker on Linux/MacOS | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 0763a9f15..e727d54c7 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 1819932da..fb467e063 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index c93629958..b7b248f99 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 2e4bfce3c..014146638 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index a8815e633..2f49a8c50 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +