diff --git a/404.html b/404.html index acf6d39d2..8032fb694 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/28b19cd2.125130af.js b/assets/js/28b19cd2.125130af.js deleted file mode 100644 index 22abfda1a..000000000 --- a/assets/js/28b19cd2.125130af.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document from ID",permalink:"/docs/API-docs/getdocument"}},f={},g=[{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:"Create Document from Template"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\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)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.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.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:"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:"Accoutnant"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(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:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,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",format:"string",example:"Please setup template properly!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\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)(c.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/28b19cd2.b310fe5e.js b/assets/js/28b19cd2.b310fe5e.js new file mode 100644 index 000000000..5d0375170 --- /dev/null +++ b/assets/js/28b19cd2.b310fe5e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(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),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivsfVkDKH5L+0UYhmZZ0AUtlqDJsA+OYdDSSWJCkSxJ2fEM/ffhKMmWnbcF6AYYtkQ+PN7dc2/egOe5g3gKv+mkKlF5B7MIUnSJFcYLrSCGmwLZmUXukXUodnp1wbiUeuXYWlfMa5ajQksYhSuWdtLYYs2M1UuRCpUzj6WR3ONcpAOIQBs6IbS6SCGGJFzRnVwJX3RwkUIEhlteokdL6m5A8RIhhp5EiECQuob7Ag5t0Is7TPxFynTGbtozEIHF75WwmELsbYUROL+WJNaJ0kgC4IOROkWIMy4dAZICSw7xBvzaBKS3QuUQQaZtyX1/BR94kBKD+X28KJJJYRZQ17PmWnT+V52uSVSilUfl6ZEbI0USnDK8c6T65vGdjTHkE0su9AJdwIlcBfdsgdxavia/eCzd6wKsJm0fm7Yz5DRJdOUVVx7qCLDkQr7oiwDoC7jT+Kl9GyS6JCkNky/deqeRLRAJbAqtXkGPJyf0ORlDXUfghQ+r+9HVC5v5deu2+nn4vI9fEGsBvB89YcEZrVzjzcloRD/7cXihmKuSBJ1jHTgk0EpIyXL0rLKSCbXbFFnY5xYZl06zhmSCdMox7Qu0K+GQaSXXQUoX7hEr0TnHc4rlHxRmney3JkFxJyZ/PyTLyRURWdmXI+cpAd4bFw+HB/FDFpKBb5S2LWUufDWkZJWU63d7gSOUFArnHSHzyWg0nxD/dQQfnqS4YazgS1Q/ecbTlK1EmqN3jKu0JdARg11UMW2Z0r4tlLiFcKlVzqgSMl+gsIwSNJwMMfjDGEVrtX2r/64kcofMoa/MzpJG8Gs+/DAazcdbH358Kk2WXIo0tJkbfY/q3f9g7c62/vW+uZ5UfShDzLatRzSgsA97xvbXGyMdJpUVfh1a18MxN+K42Y+nM2oIJfpCUxM02gWNqYfFMNwvQ8NNrw7VQGLtsmuIIaG2OeI8z4XKj7kxA21QUUhJvnCUNENuxHA5Brq4U+yanNf4Z0+9XSsx4gtSzLXW91Ft4y2Qp2iDp4iTb7smd955ttekpl2/6TeVbU951Ci2F3fNYNsL+gV/VpMumQ6Kt3xcGlRU4wOby/Gj0eCmEI4JF7Y7T4fIYpm27OA0W3CHKdOKMjJs0vrJYMycwURkbVAO2K26Vde6RFY5zCrJpFD3Lr5Vx2x6mWUiEVyyv3DhhMfZ+4611Wr1iK2jcOaz8EW1YBaN3sHzsBgo7Z/avhxBBB5t6S6za7RLkXRV9JmrhgE8bFONJyHVOkLapU+Hhyj0pUhQOewlx+nnq6/sZDCCqBeY/0Ll4deLs/M/rs9JKoV2Q9F4MBqMQvvXzpdc9S46HEwzq8v+hLfHdW/U+u+m2jZhPD74oZFcqF67a/J6ejBeQARxf5CdRVBQHYinsNlQwP1pZV3T8vcKLRWRWQRLbgVfUIRPN5AKR8/pdk591uz339qh5Yg9MxM/qX9XBRSVgCWXFb1BBPe4PpjCQw62pYBUaxBnjQLHNyRnJ+FRHa+j7sRpkqDxL2L7hfPq8voGIli0I3UZhnawfEVTPl9BDLdwC+FPB0lo5l1a34DkKq/CBAGNXKpgvCKm+uXvPpS/9oEse9In+3WxMYW+ybAnD/xMQfcF179s4c3Oswda33Zo4mdW1/U/JrnFVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,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:"Create Document from Template"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\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)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.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.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:"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:"Accoutnant"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(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:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,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",format:"string",example:"Please setup template properly!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\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)(c.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/377084eb.67e6c7a4.js b/assets/js/377084eb.67e6c7a4.js new file mode 100644 index 000000000..f18e63fdb --- /dev/null +++ b/assets/js/377084eb.67e6c7a4.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:()=>v,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),m=(s(82723),s(9487)),p=s(41429),o=s(5397),d=s(4667),c=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:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FbWUop4OVFJVKiC0scfxgr27tztOiCL/92rWL/iSO7gP1Un9lHh2np23Z2Z2CySXHpJbmGNlS0no4T6CDH3qlCVlNCQwL1BcIIleRZxdXwpZlmbtxcbUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2TxWlEhrMMMc6UxE55cnVLt0E8gAmPRSfb2MoMElki9DYjASicrJHQc5ha0rBAS6N15UBlEoDhMK6mA3dgvfxUmH5wXVEgSGjHzHPUCRY6UFsh3OPxUK4cZJORqjMDTpmRLXlW2ZEfw2ZYmQ0hyWXpWSAusJCRboI0NmuSUXkIEuXGVpFail9A093y9t0Z79Aw4imP++dxVX6cpep/XpRjyARGkRhNqYn1pbanScDB99Aza7nthFo+YEifO8TWkWpOtmPP7ur+tBJ9liDqB59nvC135o+slNBHMFbF0/4oXgA9/hpQz6qOhN0BDgbRpIb+ZMkP3OigPOiIwgiHqLdcKIuuT6bS3Vnt0k9RUjL5a67fsDU4GfpsXyzdqqQM/B7R0Tm6YmISVf7s4HwOpX7P9aBCaJgJqC/DC/942Hwa/MDuj1+86io+OD2fxYfzjfHaanPyUvD+dxHH8D0TwXJWM7Zos6+rXG+2/a5t9BzvNrtqYUrt5gKZhwEl8st9Y8xG5RG5qnf3w3/UVOmfe4M2X7I9rqXSpND70E+LhJD55OB0Cer8f0KVeyVJlYY7PzRPq7xvP2Dy15veLpVqlcA6fBTuWt0FWSIXpJn+Y+FRAAkObTrejad9ABGHvdPugduWosz3JpdLLQ2ntxFjUXi11KReeu3wqrZquZsDT2GNaO0WbG85KG/jzobTqsPVr1MhW/YHcyV1YY61u7xQoeVRxIErnJoC7YK8sam7QkKrVbG87zQvlhfLhuN+VoWxhje6gxUJ6zITRggoMhyw/nsyGJR2gE3Gn7/SNqVDUHnmblEo/+eROH4rbqzxXqZKl+BsXXhHev+szt16v9zJ2EDAXiop6IRxa86K+DMKQ1jFq+DiACAhd5a/yG3Qrlfbz9yumpkF52vFYpoHHWEnF1e1EP++CmFelSlF7HDHv7OL6gziexBCNyPENLk8/XP5y/vHmnG9lerUlmk3iScwiazxVUo8Mjd9Uu6XdvvTj/+D91ZGd8JmmtpQqdGxI3rbrxtuXSRtBMn593UdQGE+sst0yRf9yZdOw+FONbgPJ7X0EK+mUXHBP3G4hU57/Z8NL6quZe/dn9yg7EN/+kPtiMH07a+7llSxr/oIInnCz85ps7puo72n2ttU4S1O0NMLuzVgeK8MguzifQ9P8C8k5/lQ=",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:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FbWUop4OVFJVKiC0scfxgr27tztOiCL/92rWL/iSO7gP1Un9lHh2np23Z2Z2CySXHpJbmGNlS0no4T6CDH3qlCVlNCQwL1BcIIleRZxdXwpZlmbtxcbUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2TxWlEhrMMMc6UxE55cnVLt0E8gAmPRSfb2MoMElki9DYjASicrJHQc5ha0rBAS6N15UBlEoDhMK6mA3dgvfxUmH5wXVEgSGjHzHPUCRY6UFsh3OPxUK4cZJORqjMDTpmRLXlW2ZEfw2ZYmQ0hyWXpWSAusJCRboI0NmuSUXkIEuXGVpFail9A093y9t0Z79Aw4imP++dxVX6cpep/XpRjyARGkRhNqYn1pbanScDB99Aza7nthFo+YEifO8TWkWpOtmPP7ur+tBJ9liDqB59nvC135o+slNBHMFbF0/4oXgA9/hpQz6qOhN0BDgbRpIb+ZMkP3OigPOiIwgiHqLdcKIuuT6bS3Vnt0k9RUjL5a67fsDU4GfpsXyzdqqQM/B7R0Tm6YmISVf7s4HwOpX7P9aBCaJgJqC/DC/942Hwa/MDuj1+86io+OD2fxYfzjfHaanPyUvD+dxHH8D0TwXJWM7Zos6+rXG+2/a5t9BzvNrtqYUrt5gKZhwEl8st9Y8xG5RG5qnf3w3/UVOmfe4M2X7I9rqXSpND70E+LhJD55OB0Cer8f0KVeyVJlYY7PzRPq7xvP2Dy15veLpVqlcA6fBTuWt0FWSIXpJn+Y+FRAAkObTrejad9ABGHvdPugduWosz3JpdLLQ2ntxFjUXi11KReeu3wqrZquZsDT2GNaO0WbG85KG/jzobTqsPVr1MhW/YHcyV1YY61u7xQoeVRxIErnJoC7YK8sam7QkKrVbG87zQvlhfLhuN+VoWxhje6gxUJ6zITRggoMhyw/nsyGJR2gE3Gn7/SNqVDUHnmblEo/+eROH4rbqzxXqZKl+BsXXhHev+szt16v9zJ2EDAXiop6IRxa86K+DMKQ1jFq+DiACAhd5a/yG3Qrlfbz9yumpkF52vFYpoHHWEnF1e1EP++CmFelSlF7HDHv7OL6gziexBCNyPENLk8/XP5y/vHmnG9lerUlmk3iScwiazxVUo8Mjd9Uu6XdvvTj/+D91ZGd8JmmtpQqdGxI3rbrxtuXSRtBMn593UdQGE+sst0yRf9yZdOw+FONbgPJ7X0EK+mUXHBP3G4hU57/Z8NL6quZe/dn9yg7EN/+kPtiMH07a+7llSxr/oIInnCz85ps7puo72n2ttU4S1O0NMLuzVgeK8MguzifQ9P8C8k5/lQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{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:"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)(p.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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)(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:!1,name:"Folder",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)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper: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/377084eb.795bb693.js b/assets/js/377084eb.795bb693.js deleted file mode 100644 index c5a380c95..000000000 --- a/assets/js/377084eb.795bb693.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:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),m=(s(82723),s(9487)),o=s(41429),p=s(5397),d=s(4667),c=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0d6EhVqYDQxh7HC/bu3u44EEX+79WsXzDJHdyH6qR+Sjw7z87bMzO7AZJLD8k1zLGypST0cBtBhj51ypIyGhKYFyjOkESvIk4uz4UsS/PoxdrUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2Txo6JCWIcZ5kpjJjy5OqXaoZ9ABMaik+zteQYJLJF6GxCBlU5WSOg4zA1oWSEk0LtzpzKIQHGYVlIB27GffxAmH5wXVEgSGjHzHPUCRY6UFsh3OPxSK4cZJORqjMDTumRLXlW2ZEfwyZYmQ0hyWXpWSAusJCQboLUNmuSUXkIEuXGVpFail9A0t3y9t0Z79Aw4iGP+eemqr9MUvc/rUgz5gAhSowk1sb60tlRpOJjeewZtdr0wi3tMiRPn+BpSrclWzPl93d9Wgk8yRJ3A0+yPha78weUSmgjmili6e8UzwIc/Q8oZ9cnQG6ChQNq0kN9NmaF7HZQHHREYwRD1lmsFkfXJdNpbqz26SWoqRl886rfsDU4Gfptny1dqqQM/B7R0Tq6ZmISVf7s4nwKpX7N9bxCaJgJqC/DM/942Hwa/MDuh1+86iA8O92fxfvzzfHacHP2SvD+exHH8D0TwVJWM7Zos6+rXG+2/a5v9ADvNttqYUtt5gKZhwFF8tNtY8xG5RG5qnf303/UVOmfe4M3X7I9rqXSpNN71E+LuKD66Ox4Cer8b0LleyVJlYY7PzQPqHxvP2Dy15neLpVqlcA4vgh3L2yArpMJ0kz9MfCoggaFNp5vRtG8ggrB3un1Qu3LU2Z7kUunlvrR2Yixqr5a6lAvPXT6VVk1XM+Bp7DGtnaL1FWelDfxpX1q13/o1amSr/kTu5C6ssVa3dwqUPKo4EKVzE8BdsBcWNTdoSNVqtrOd5oXyQvlw3O/KULawRrfQYiE9ZsJoQQWGQ5YfTmbDkg7QibjRN/rKVChqj7xNSqUffHKj98X1RZ6rVMlS/I0Lrwhv3/WZe3x83MnYXsCcKSrqhXBozbP6MghDWseo4WMPIiB0lb/Ir9CtVNrP32+YmgblacdjmQYeYyUVV7cT/boNYl6VKkXtccS8k7PLj+JwEkM0Isd3uDz9eP7b6aerU76V6dWWaDaJJzGLrPFUST0y9OJNlTtTifMP2yXePPfl/+Ad1pGe8ImmtpQqdG5I4qbryuvniRtBMn6F3UZQGE+sstkwVf9yZdOw+EuNbg3J9W0EK+mUXHBvXG8gU57/Z8OL6puZe/e5e5ztie9/0H01mL6tNff0SpY1f0EED7jeelU2t03U9zZ722qcpClaGmF3Zi2Pl2GgnZ3OoWn+BS/BAOQ=",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/get-template",title:"Get Template from ID",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 from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0d6EhVqYDQxh7HC/bu3u44EEX+79WsXzDJHdyH6qR+Sjw7z87bMzO7AZJLD8k1zLGypST0cBtBhj51ypIyGhKYFyjOkESvIk4uz4UsS/PoxdrUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2Txo6JCWIcZ5kpjJjy5OqXaoZ9ABMaik+zteQYJLJF6GxCBlU5WSOg4zA1oWSEk0LtzpzKIQHGYVlIB27GffxAmH5wXVEgSGjHzHPUCRY6UFsh3OPxSK4cZJORqjMDTumRLXlW2ZEfwyZYmQ0hyWXpWSAusJCQboLUNmuSUXkIEuXGVpFail9A0t3y9t0Z79Aw4iGP+eemqr9MUvc/rUgz5gAhSowk1sb60tlRpOJjeewZtdr0wi3tMiRPn+BpSrclWzPl93d9Wgk8yRJ3A0+yPha78weUSmgjmili6e8UzwIc/Q8oZ9cnQG6ChQNq0kN9NmaF7HZQHHREYwRD1lmsFkfXJdNpbqz26SWoqRl886rfsDU4Gfptny1dqqQM/B7R0Tq6ZmISVf7s4nwKpX7N9bxCaJgJqC/DM/942Hwa/MDuh1+86iA8O92fxfvzzfHacHP2SvD+exHH8D0TwVJWM7Zos6+rXG+2/a5v9ADvNttqYUtt5gKZhwFF8tNtY8xG5RG5qnf303/UVOmfe4M3X7I9rqXSpNN71E+LuKD66Ox4Cer8b0LleyVJlYY7PzQPqHxvP2Dy15neLpVqlcA4vgh3L2yArpMJ0kz9MfCoggaFNp5vRtG8ggrB3un1Qu3LU2Z7kUunlvrR2Yixqr5a6lAvPXT6VVk1XM+Bp7DGtnaL1FWelDfxpX1q13/o1amSr/kTu5C6ssVa3dwqUPKo4EKVzE8BdsBcWNTdoSNVqtrOd5oXyQvlw3O/KULawRrfQYiE9ZsJoQQWGQ5YfTmbDkg7QibjRN/rKVChqj7xNSqUffHKj98X1RZ6rVMlS/I0Lrwhv3/WZe3x83MnYXsCcKSrqhXBozbP6MghDWseo4WMPIiB0lb/Ir9CtVNrP32+YmgblacdjmQYeYyUVV7cT/boNYl6VKkXtccS8k7PLj+JwEkM0Isd3uDz9eP7b6aerU76V6dWWaDaJJzGLrPFUST0y9OJNlTtTifMP2yXePPfl/+Ad1pGe8ImmtpQqdG5I4qbryuvniRtBMn6F3UZQGE+sstkwVf9yZdOw+EuNbg3J9W0EK+mUXHBvXG8gU57/Z8OL6puZe/e5e5ztie9/0H01mL6tNff0SpY1f0EED7jeelU2t03U9zZ722qcpClaGmF3Zi2Pl2GgnZ3OoWn+BS/BAOQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template from ID",permalink:"/docs/API-docs/update-template"}},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:"Get Template from ID"})}),"\n",(0,t.jsx)(n(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(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/52d5c0f9.1927f21a.js b/assets/js/52d5c0f9.1927f21a.js deleted file mode 100644 index ef43b56a7..000000000 --- a/assets/js/52d5c0f9.1927f21a.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:()=>x,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>v});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),o=a.n(i),d=(a(82723),a(9487)),r=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete Document from ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsOU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl/Dc5WurlyJHpudfMfPTnOli55DXrDUHEVj8VguLOaTe1hiB82tJhpyojCQArozUOUJacOkIkJVYcUg34NcmIL0VagERFNpW3A8luOLhlhRMeTwvj7nLoWlmZNUZrRw6uuc4SehvP4A+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM5hL9ihvA3SYVZb4dehyVcjbsSoPU/vZtQpFfpS7wZEGAy+hBTivp3jzWAoNEBX2mU/NmorIYXSe+PSOHaeL4RajLgxY21QObFQks/dONNVzI2IlxMgo71TN0Rcy82ea1uGuBGfcQ1RH/kQ1Y2nEnmONrAkVKGDcsfHlUF1IxYqsLmcHAyx21I4Jlw47mMMmWWFtuyZNptzhznTivkSwyHJT8aT7UQOqmN2r+7Vja6Q1Q6LWjIp1KNL79WI3V0VhcgEl+wvnDvhcfauZ+7p6emAsaOg80n4sp4zi0bv4IsgDLQOtbYvRxCBR1u5q+IG7VJk2GXpFVNxAMddqfMslDpWXFB2O9Evz5Wo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTDUbczzvTU4PX+e5c2ue/+jRdvVqseVj43kIvRkiH3TNdMdDBZvOtyxswhK7TxBNhuqsC9WNg2Jv9VoqWtnESy5FXxOJX23gVw4es63C/PVaN/92e3eI/bd6/rFWPpmVNSJSy5reoMIHnH97JOhmTVR35HkbIs4yzI0fqB7MET3JtH5xeXF7QVEwGsibzgMHsMw6B7IwIuu7U+J1gf6baJXFH6iIviM65+38PbkVYUuxB5NNM2apvkHNsFmhA==",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 from ID",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 from ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsOU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl/Dc5WurlyJHpudfMfPTnOli55DXrDUHEVj8VguLOaTe1hiB82tJhpyojCQArozUOUJacOkIkJVYcUg34NcmIL0VagERFNpW3A8luOLhlhRMeTwvj7nLoWlmZNUZrRw6uuc4SehvP4A+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM5hL9ihvA3SYVZb4dehyVcjbsSoPU/vZtQpFfpS7wZEGAy+hBTivp3jzWAoNEBX2mU/NmorIYXSe+PSOHaeL4RajLgxY21QObFQks/dONNVzI2IlxMgo71TN0Rcy82ea1uGuBGfcQ1RH/kQ1Y2nEnmONrAkVKGDcsfHlUF1IxYqsLmcHAyx21I4Jlw47mMMmWWFtuyZNptzhznTivkSwyHJT8aT7UQOqmN2r+7Vja6Q1Q6LWjIp1KNL79WI3V0VhcgEl+wvnDvhcfauZ+7p6emAsaOg80n4sp4zi0bv4IsgDLQOtbYvRxCBR1u5q+IG7VJk2GXpFVNxAMddqfMslDpWXFB2O9Evz5Wo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTDUbczzvTU4PX+e5c2ue/+jRdvVqseVj43kIvRkiH3TNdMdDBZvOtyxswhK7TxBNhuqsC9WNg2Jv9VoqWtnESy5FXxOJX23gVw4es63C/PVaN/92e3eI/bd6/rFWPpmVNSJSy5reoMIHnH97JOhmTVR35HkbIs4yzI0fqB7MET3JtH5xeXF7QVEwGsibzgMHsMw6B7IwIuu7U+J1gf6baJXFH6iIviM65+38PbkVYUuxB5NNM2apvkHNsFmhA==",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 from ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},v=[{value:"Request",id:"request",level:2}];function I(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:"Delete Document from ID"})}),"\n",(0,l.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.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)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.a1f30bed.js b/assets/js/52d5c0f9.a1f30bed.js new file mode 100644 index 000000000..496cc6032 --- /dev/null +++ b/assets/js/52d5c0f9.a1f30bed.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>v,contentTitle:()=>j,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),d=(a(82723),a(9487)),c=a(41429),r=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZKTtMOEYVi2BF3QYAmWDAOWGAEtnSw2FMmSlGND0H8fjpJsOU6Cftj2xZaOz/HunntTA54vHaR3cKazukLlHcwjyNFlVhgvtIIUbktkZyjRI8t7FDu9vmBcSv3k2EbXzGtmsdIrZM5gJgqR7aCF1RWB7FbkphCBNmg5WbjIIYU83D8AIALDLa/QoyXvGlC8QoL1gAeRQwSCvDPcl/Dc5WurVyJHphdfMPMXOdPFziGvWWcOIrD4tRYWc0i9rTEC5zeSDDlRGUkAXBupc4S04NIRICux4pA24DcmIL0VagkRFNpW3I8luObhlhRMebQoj7jLoW3nZNUZrRw6uucoSehvP4AhHb2nOXN1lqFzRS3l5juIINPKE1NpA9wYKbLAZfzFkXpz6GbHBBFriXkvOuMDQS8FtHP/lzU5b34zx9BGQ65O/dtKR8nR8WSWTJLvb2cf05Mf0g8fp0mS/A0RrCtJukNSuUe61wsvd+/tAazL2RjYS1oCnyQnb9CotGeFrlX+L3KH1mr7Ngcv2W9HEQglhcKHoR4eTpKTh+NtQB8OA7pQKy5FHvrvVj+i+n/jGZv3nfnDRIkOFM5hL9ixvAvSYVZb4TehydcTbsSkO0/v5tQpFfpS7wZEGAy+hBTioZ3jZjQUWqAr7WoYG7WVkELpvXFpHDvPl0ItJ9yYqTaonFgqyRdumukq5kbEqxmQ0cGpGyKu42bPtS1D3IjPuIFoiHyM6sdTiTxHG1gSqtBBuefjyqC6EUsV2FzNDobYbSkcEy4cDzGGzLJCW/ZMmy24w5xpxXyJ4ZDkx9PZdiIH1Sm7V/fqRlfIaodFLZkU6tGl92rC7q6KQmSCS/YXLpzwOH83MPf09HTA2Pug80n4sl4wi0bv4MsgDLSOtbYv7yECj7ZyV8UN2pXIsM/SK6biAI77UudZKHWsuKDs9qKfnytR6UmRoXI4Ks7TT9eX7HiaQDQqjm9wOb68+PX895tzupXKq0vRbJpMExIZ7XzF1chQvzHPdittL7vNrmv/owXb16jHtY+N5CL0Yoi56ZvoDkYLNx3v1nkEpXaeIE1DlfWnlW1L4q81WurWeQQrbgVfUCnfNZALR8/5dlG+Gu27P/qd+55985p+MZahCRV14IrLmt4ggkfcPPtUaOdtNHQiOdshTrMMjR/pHgzPvQl0dn55fnsOEfCayBsPgccwBPoHMvCia/vTofOBftvoFYUfqQg+4+anLbw7eVWhD3FAE03ztm3/AYcFZAM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoB2ZKTtMOEYVi2BF3QYAmWDAOWGAEtnSw2FMmSlGND0H8fjpJsOU6Cftj2xZaOz/HunntTA54vHaR3cKazukLlHcwjyNFlVhgvtIIUbktkZyjRI8t7FDu9vmBcSv3k2EbXzGtmsdIrZM5gJgqR7aCF1RWB7FbkphCBNmg5WbjIIYU83D8AIALDLa/QoyXvGlC8QoL1gAeRQwSCvDPcl/Dc5WurVyJHphdfMPMXOdPFziGvWWcOIrD4tRYWc0i9rTEC5zeSDDlRGUkAXBupc4S04NIRICux4pA24DcmIL0VagkRFNpW3I8luObhlhRMebQoj7jLoW3nZNUZrRw6uucoSehvP4AhHb2nOXN1lqFzRS3l5juIINPKE1NpA9wYKbLAZfzFkXpz6GbHBBFriXkvOuMDQS8FtHP/lzU5b34zx9BGQ65O/dtKR8nR8WSWTJLvb2cf05Mf0g8fp0mS/A0RrCtJukNSuUe61wsvd+/tAazL2RjYS1oCnyQnb9CotGeFrlX+L3KH1mr7Ngcv2W9HEQglhcKHoR4eTpKTh+NtQB8OA7pQKy5FHvrvVj+i+n/jGZv3nfnDRIkOFM5hL9ixvAvSYVZb4TehydcTbsSkO0/v5tQpFfpS7wZEGAy+hBTioZ3jZjQUWqAr7WoYG7WVkELpvXFpHDvPl0ItJ9yYqTaonFgqyRdumukq5kbEqxmQ0cGpGyKu42bPtS1D3IjPuIFoiHyM6sdTiTxHG1gSqtBBuefjyqC6EUsV2FzNDobYbSkcEy4cDzGGzLJCW/ZMmy24w5xpxXyJ4ZDkx9PZdiIH1Sm7V/fqRlfIaodFLZkU6tGl92rC7q6KQmSCS/YXLpzwOH83MPf09HTA2Pug80n4sl4wi0bv4MsgDLSOtbYv7yECj7ZyV8UN2pXIsM/SK6biAI77UudZKHWsuKDs9qKfnytR6UmRoXI4Ks7TT9eX7HiaQDQqjm9wOb68+PX895tzupXKq0vRbJpMExIZ7XzF1chQvzHPdittL7vNrmv/owXb16jHtY+N5CL0Yoi56ZvoDkYLNx3v1nkEpXaeIE1DlfWnlW1L4q81WurWeQQrbgVfUCnfNZALR8/5dlG+Gu27P/qd+55985p+MZahCRV14IrLmt4ggkfcPPtUaOdtNHQiOdshTrMMjR/pHgzPvQl0dn55fnsOEfCayBsPgccwBPoHMvCia/vTofOBftvoFYUfqQg+4+anLbw7eVWhD3FAE03ztm3/AYcFZAM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},v={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.62506cb5.js b/assets/js/5a2de241.62506cb5.js deleted file mode 100644 index 679c95803..000000000 --- a/assets/js/5a2de241.62506cb5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),p=s(41429),m=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template from ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVkbpMGKxWgcDFhiGLR0splQJEtSdgxD/304SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbLj+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4KOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0nkIdWb0UGbIZSr1iW9oEso1nmyN2xD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7h152xxC17N7TD1F3FJKvEBHb+uA/z1BCg4PYUrAhT9bvFBFoLR/tZkRUURmcSlwFQrLiblifiEcy3RaFkSv2kv561xsq6JroyIdmaGlinydvcd7N+PDC/44gqqKwAv/xM20U7fTGZVBVZGcRWe0cnXEj+P4sDq2N6+pVubKNEXn8lLK9U8/Lt318fPEdzS5y44/udHpJ0PBaiCd+ZeVjuPjk94w7sXvx8N3yenPydt3/TiO/4QIHgu5qzXImpppo1c/dw6EkkLhtI3a9DiOpydNKE+fi15TSaa5YksuRcZygTJj5NP9wACitdr+w0p/Ad9L9IlyS/70hdJR2rNclyr7v+k+h+hlgqfT91uKbw8pXqo6ZDSWxvoB1X/BcMen697X7gnq06oWtVB4D0/Ids9rkgX6haZxaMoAiEZbAoO2eww2nT5SQQQO7bKdkKWVkMDCe+OSwcB5Phdq3uPG9LVBRR1U8pnrp7oYcCMGyyHQaHKYllb49TVFpSb+2ONG9GpcO/rciN9wDVFLqyvVTOIF8gxtCAEF+8tu6p23IdtGZX9UtJPi+5r//rh/tp13u/mTBk1wcx24Nbm4MqiuyQ1lcjk8sD8m78KF1y2IUFUs15btabMZd5gxrcL+QS/p/KQ/3O5BQbXP7tSdutYFstJhXkomhXpwyZ3qsdurPBep4JL9gTMnPE6O2sSuVquDhL4JOhfCL8oZs2j0TnweDkPWu1rbB9oYPNrCXeXXaJcixaaIvuFqEIQHzTXjabhmWHBBxdcc/bKvRCGXIkXluiVwdjH6zE76MUSd2v0OyIPPlx/Of78+J6tU/XWKhv24H9OR0c4XXHUc7S+xudUFu/y4n+XNrnP827tvc6c8PvqBkVyExhCCsGku/S10rkbSXXsnESy08ySy2VCp3VhZVXT8tUS7huR2EsGSW0FIQ2fIhKP/2XZ9/Sbtoy/tIslet0E/S6jtHIraxpLLkp4gggdc763y1aSK2vZBiGuJDzWu3pjs7CwcNPUqajXO0hSNf1F20umyo5sxRDBr1vIibPhg+Yo+CfgKEriDOwifKmQgNMdwvgHJ1bzkc5KvzdLvLwq+nGw=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-template",title:"Update Template from ID",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 from ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVkbpMGKxWgcDFhiGLR0splQJEtSdgxD/304SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbLj+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4KOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0nkIdWb0UGbIZSr1iW9oEso1nmyN2xD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7h152xxC17N7TD1F3FJKvEBHb+uA/z1BCg4PYUrAhT9bvFBFoLR/tZkRUURmcSlwFQrLiblifiEcy3RaFkSv2kv561xsq6JroyIdmaGlinydvcd7N+PDC/44gqqKwAv/xM20U7fTGZVBVZGcRWe0cnXEj+P4sDq2N6+pVubKNEXn8lLK9U8/Lt318fPEdzS5y44/udHpJ0PBaiCd+ZeVjuPjk94w7sXvx8N3yenPydt3/TiO/4QIHgu5qzXImpppo1c/dw6EkkLhtI3a9DiOpydNKE+fi15TSaa5YksuRcZygTJj5NP9wACitdr+w0p/Ad9L9IlyS/70hdJR2rNclyr7v+k+h+hlgqfT91uKbw8pXqo6ZDSWxvoB1X/BcMen697X7gnq06oWtVB4D0/Ids9rkgX6haZxaMoAiEZbAoO2eww2nT5SQQQO7bKdkKWVkMDCe+OSwcB5Phdq3uPG9LVBRR1U8pnrp7oYcCMGyyHQaHKYllb49TVFpSb+2ONG9GpcO/rciN9wDVFLqyvVTOIF8gxtCAEF+8tu6p23IdtGZX9UtJPi+5r//rh/tp13u/mTBk1wcx24Nbm4MqiuyQ1lcjk8sD8m78KF1y2IUFUs15btabMZd5gxrcL+QS/p/KQ/3O5BQbXP7tSdutYFstJhXkomhXpwyZ3qsdurPBep4JL9gTMnPE6O2sSuVquDhL4JOhfCL8oZs2j0TnweDkPWu1rbB9oYPNrCXeXXaJcixaaIvuFqEIQHzTXjabhmWHBBxdcc/bKvRCGXIkXluiVwdjH6zE76MUSd2v0OyIPPlx/Of78+J6tU/XWKhv24H9OR0c4XXHUc7S+xudUFu/y4n+XNrnP827tvc6c8PvqBkVyExhCCsGku/S10rkbSXXsnESy08ySy2VCp3VhZVXT8tUS7huR2EsGSW0FIQ2fIhKP/2XZ9/Sbtoy/tIslet0E/S6jtHIraxpLLkp4gggdc763y1aSK2vZBiGuJDzWu3pjs7CwcNPUqajXO0hSNf1F20umyo5sxRDBr1vIibPhg+Yo+CfgKEriDOwifKmQgNMdwvgHJ1bzkc5KvzdLvLwq+nGw=",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 from ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template from ID",permalink:"/docs/API-docs/delete-template"}},f={},y=[{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:"Update Template from ID"})}),"\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)(p.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",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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)(m.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)(m.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)(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)(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)(m.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)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.8cdfa423.js b/assets/js/5a2de241.8cdfa423.js new file mode 100644 index 000000000..6b300971a --- /dev/null +++ b/assets/js/5a2de241.8cdfa423.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:()=>x,default:()=>y,frontMatter:()=>u,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 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/ivcfUoB2ZaTtMX0aVkXpMGKxWgcDFhiGLR0splQJEtSdgxD/704SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbL38gzAWk1mF9wzxRi5gj1DBu0ZMfil1JYzCDxtsQInF9L8uZEYSSBwUcjdYaQ5Fw6EkgXWHBINuDXJkh6K9QcIsi1LbjfnVTVpLaPzv+qszXpPIU6snopMmQzlHrFtrQJZBvPNkfsiHsmkTvPtMKObEvgDUSQauVReXLEjZEiDUEe3DvytjmErmf3mHqKuKWUeIGO3tYB/3uCFBwewpSAC3+2eKGKQGn/ajMjoojM4lLgKhSWE3PF/EI4lum0LIhetZfy17nYVkXXRkU6MkNLFfk6e4/3bsaHF/xxBFUVgRf+iZtpp26nMyqDqiI5i85o5eqIH8fxYXVsb15TrcyVaYrO5aWU659+XLrr4+eJ72hylx1/dKPTj4aC1UA68y8rHcfHJ71h3Ivfj4fvktOfk7fv+nEc/wURPBZyV2uQNTXTRq9+7hwIJYXCaRu16XEcT0+aUJ4+F72mkkxzxZZciozlAmXGyKf7gQFEa7X9h5X+Ar6X6BPllvzpC6WjtGe5LlX2f9N9DtHLBE+n77cU3x5SvFR1yGgsjfUDqv+C4Y5P172v3RPUp1UtaqHwHp6Q7Z7XJAv0C03j0JQBEI22BAZt9xhsOn2kgggc2mU7IUsrIYGF98Ylg4HzfC7UvMeN6WuDijqo5DPXT3Ux4EYMlkOg0eQwLa3w62uKSk38sceN6NW4dvS5Eb/jGqKWVleqmcQL5BnaEAIK9ufd1DtvQ7aNyv6oaCfF9zX//XH/bDvvdvMnDZrg5jpwa3JxZVBdkxvK5HJ4YH9M3oULr1sQoapYri3b02Yz7jBjWoX9g17S+Ul/uN2Dgmqf3ak7da0LZKXDvJRMCvXgkjvVY7dXeS5SwSX7E2dOeJwctYldrVYHCX0TdC6EX5QzZtHonfg8HIasd7W2D7QxeLSFu8qv0S5Fik0RfcPVIAgPmmvG03DNsOCCiq85+mVfiUIuRYrKdUvg7GL0iZ30Y4g6tfsdkAefLj+c/3F9Tlap+usUDftxP6Yjo50vuOo42lti97O72XWMf3vnbe6Sx0c/MJKL0BAC+U1z2W+hcyWS7ro7iWChnSeRzYZK7MbKqqLjLyXaNSS3kwiW3ApCGjpCJhz9z7Zr6zdpH31uF0j2us35WUJtx1DULpZclvQEETzgem+FryZV1LYNQlxLfKhx9cZkZ2fhoJlXUatxlqZo/Iuyk053Hd2MIYJZs44XYbMHy1f0KcBXkMAd3EH4RCEDoSmG8w1IruYln5N8bZZ+XwGyH5nr",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-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/ivcfUoB2ZaTtMX0aVkXpMGKxWgcDFhiGLR0splQJEtSdgxD/704SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbL38gzAWk1mF9wzxRi5gj1DBu0ZMfil1JYzCDxtsQInF9L8uZEYSSBwUcjdYaQ5Fw6EkgXWHBINuDXJkh6K9QcIsi1LbjfnVTVpLaPzv+qszXpPIU6snopMmQzlHrFtrQJZBvPNkfsiHsmkTvPtMKObEvgDUSQauVReXLEjZEiDUEe3DvytjmErmf3mHqKuKWUeIGO3tYB/3uCFBwewpSAC3+2eKGKQGn/ajMjoojM4lLgKhSWE3PF/EI4lum0LIhetZfy17nYVkXXRkU6MkNLFfk6e4/3bsaHF/xxBFUVgRf+iZtpp26nMyqDqiI5i85o5eqIH8fxYXVsb15TrcyVaYrO5aWU659+XLrr4+eJ72hylx1/dKPTj4aC1UA68y8rHcfHJ71h3Ivfj4fvktOfk7fv+nEc/wURPBZyV2uQNTXTRq9+7hwIJYXCaRu16XEcT0+aUJ4+F72mkkxzxZZciozlAmXGyKf7gQFEa7X9h5X+Ar6X6BPllvzpC6WjtGe5LlX2f9N9DtHLBE+n77cU3x5SvFR1yGgsjfUDqv+C4Y5P172v3RPUp1UtaqHwHp6Q7Z7XJAv0C03j0JQBEI22BAZt9xhsOn2kgggc2mU7IUsrIYGF98Ylg4HzfC7UvMeN6WuDijqo5DPXT3Ux4EYMlkOg0eQwLa3w62uKSk38sceN6NW4dvS5Eb/jGqKWVleqmcQL5BnaEAIK9ufd1DtvQ7aNyv6oaCfF9zX//XH/bDvvdvMnDZrg5jpwa3JxZVBdkxvK5HJ4YH9M3oULr1sQoapYri3b02Yz7jBjWoX9g17S+Ul/uN2Dgmqf3ak7da0LZKXDvJRMCvXgkjvVY7dXeS5SwSX7E2dOeJwctYldrVYHCX0TdC6EX5QzZtHonfg8HIasd7W2D7QxeLSFu8qv0S5Fik0RfcPVIAgPmmvG03DNsOCCiq85+mVfiUIuRYrKdUvg7GL0iZ30Y4g6tfsdkAefLj+c/3F9Tlap+usUDftxP6Yjo50vuOo42lti97O72XWMf3vnbe6Sx0c/MJKL0BAC+U1z2W+hcyWS7ro7iWChnSeRzYZK7MbKqqLjLyXaNSS3kwiW3ApCGjpCJhz9z7Zr6zdpH31uF0j2us35WUJtx1DULpZclvQEETzgem+FryZV1LYNQlxLfKhx9cZkZ2fhoJlXUatxlqZo/Iuyk053Hd2MIYJZs44XYbMHy1f0KcBXkMAd3EH4RCEDoSmG8w1IruYln5N8bZZ+XwGyH5nr",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",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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/770b40a9.538d99ce.js b/assets/js/770b40a9.538d99ce.js new file mode 100644 index 000000000..6c1bd4746 --- /dev/null +++ b/assets/js/770b40a9.538d99ce.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),t=a(11151),i=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:"eJzdVl1PKzcQ/SvuPPVKS7KBe6m6T0UVpagIkEhVqRAhZ3c2GfDavrY3H4r2v1+Ns5ssREBVXfWhT5DxOfPlObPeQJAzD9k9jLGySgb0MEmgQJ87soGMhgzGcxQXGEQHEVfkgzi7vRRSKbP0Ym1qEYxwGBzhAoUUihGmFHIhScmpQhE6/wMxnpMXZa1z9i8VhbWwziyoQC+kFmaBbkG4jHyl9sxEoJZTRXomao/Oc8x8boxHUTpTCVyRD3y6Y4jlHLXIHcpoL0xeV6iDH0ACxqKTnMFlARnMMHQszh0SsNLJCgM6bs8GtKwQMlBUEZ8SN+ZrjW4NCTj8WpPDArJSKo8J+LBWjC6NqyABXFllCoQsuJpP8zlWErINVHJFVV1B9iVNEwhryyRdV1N00DBPVpYdjdIm2aXgn8l+twzejpk2E/brrdEePWOP05T/vBwOX+c5el/WSuw6CgnkRgfUgfHSWkV5PBg+eSZtDhMw0yfMY9sduwm0DenQ1yr0cNI5yQVTwMp/zN+a+YZ3SB8c6RkksTUy9C272mE1+n2qK398O+OejCmw9dDFnuDjP7vJY9a1CR+QOrTQZkv5zagC3fukMmJEHAam0EepzUOwPhsOu2isnUFuKmbfLPVH8XZJRhmZfeQ7mumojn97Oddxnt+L/WQQmiaBsL2AXS6PXWw+jHlhcRbe93WcHp8cjdKj9Kfx6DT7/HP25XSQpunfkMCqUsxt9VW099cF7X7XtvgP4jSvYf2Ret0HaPrdIa1I42On2cfjNH08ZUiTwOf0y6F2L/VCKiriKh+bZ9Q/fD/lonPmg8nqhw/b8Ifl0xYUz+FFsX37tsgKw9y02zxu8DCHDIavFrtHt+i2eu1UTyE+yBnp2ZG0dmAsak8zreTUs1qG0tJwMQLeih7z2lFY33EvtuWujqSlo202PUFY+gNZEW0xfVS7wecoWfKcPunSRHJb4o1FzYMeG7QYweF3mbwgH4+7T1u8LFEaJ16xxVR6LITRIswxHrL9ZDAS3mJOZXvPA/GgH/SdqZC/sbzVFelnnz3oI3F/U5aUk1TiL5x6Cjj5sevccrk86NinyLmgMK+nwqE1e/gsGmNb+6zdj0+QQEBX+Zvyjh8DebfH3gg1jOBhO70yj9OLlSS+3db0y2sST5OiHLXH3rydXdxeiZNBCklvOP5BysOry1/Pr+/O2SuP1/aKRoN0kLLJGh8qqXuBXryo2tF8cb+bvRT/p0+wViUBV2FolaQo8Nj1TSvee3gh3kkCc+MD2zcbHug/nWoaNm8fQizpgjxXu38KPeO693BbSFVzUOAX1RvY9oW1h074hyPGQnY/aZJOthxwyznLc7T9AAfLk73sNtTF+Ria5hua1/JN",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:"eJzdVl1PKzcQ/SvuPPVKS7KBe6m6T0UVpagIkEhVqRAhZ3c2GfDavrY3H4r2v1+Ns5ssREBVXfWhT5DxOfPlObPeQJAzD9k9jLGySgb0MEmgQJ87soGMhgzGcxQXGEQHEVfkgzi7vRRSKbP0Ym1qEYxwGBzhAoUUihGmFHIhScmpQhE6/wMxnpMXZa1z9i8VhbWwziyoQC+kFmaBbkG4jHyl9sxEoJZTRXomao/Oc8x8boxHUTpTCVyRD3y6Y4jlHLXIHcpoL0xeV6iDH0ACxqKTnMFlARnMMHQszh0SsNLJCgM6bs8GtKwQMlBUEZ8SN+ZrjW4NCTj8WpPDArJSKo8J+LBWjC6NqyABXFllCoQsuJpP8zlWErINVHJFVV1B9iVNEwhryyRdV1N00DBPVpYdjdIm2aXgn8l+twzejpk2E/brrdEePWOP05T/vBwOX+c5el/WSuw6CgnkRgfUgfHSWkV5PBg+eSZtDhMw0yfMY9sduwm0DenQ1yr0cNI5yQVTwMp/zN+a+YZ3SB8c6RkksTUy9C272mE1+n2qK398O+OejCmw9dDFnuDjP7vJY9a1CR+QOrTQZkv5zagC3fukMmJEHAam0EepzUOwPhsOu2isnUFuKmbfLPVH8XZJRhmZfeQ7mumojn97Oddxnt+L/WQQmiaBsL2AXS6PXWw+jHlhcRbe93WcHp8cjdKj9Kfx6DT7/HP25XSQpunfkMCqUsxt9VW099cF7X7XtvgP4jSvYf2Ret0HaPrdIa1I42On2cfjNH08ZUiTwOf0y6F2L/VCKiriKh+bZ9Q/fD/lonPmg8nqhw/b8Ifl0xYUz+FFsX37tsgKw9y02zxu8DCHDIavFrtHt+i2eu1UTyE+yBnp2ZG0dmAsak8zreTUs1qG0tJwMQLeih7z2lFY33EvtuWujqSlo202PUFY+gNZEW0xfVS7wecoWfKcPunSRHJb4o1FzYMeG7QYweF3mbwgH4+7T1u8LFEaJ16xxVR6LITRIswxHrL9ZDAS3mJOZXvPA/GgH/SdqZC/sbzVFelnnz3oI3F/U5aUk1TiL5x6Cjj5sevccrk86NinyLmgMK+nwqE1e/gsGmNb+6zdj0+QQEBX+Zvyjh8DebfH3gg1jOBhO70yj9OLlSS+3db0y2sST5OiHLXH3rydXdxeiZNBCklvOP5BysOry1/Pr+/O2SuP1/aKRoN0kLLJGh8qqXuBXryo2tF8cb+bvRT/p0+wViUBV2FolaQo8Nj1TSvee3gh3kkCc+MD2zcbHug/nWoaNm8fQizpgjxXu38KPeO693BbSFVzUOAX1RvY9oW1h074hyPGQnY/aZJOthxwyznLc7T9AAfLk73sNtTF+Ria5hua1/JN",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function 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:"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)(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)(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:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(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/770b40a9.923fd47f.js b/assets/js/770b40a9.923fd47f.js deleted file mode 100644 index f51a555b6..000000000 --- a/assets/js/770b40a9.923fd47f.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:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),t=a(11151),i=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:"eJzdVl1PKzcQ/SvuPPVKS7KBe6m6T0UVpagIkEhVqRAhZ3c2GfDavrY3H4r2v1+Ns5ssREBVXfWhT5DxOfPlObPeQJAzD9k9jLGySgb0MEmgQJ87soGMhgzGcxQXGEQHEVfkgzi7vRRSKbP0Ym1qEYxwGBzhAoUUihGmFHIhScmpQhE6/wMxnpMXZa1z9i8VhbWwziyoQC+kFmaBbkG4jHyl9sxEoJZTRXomao/Oc8x8boxHUTpTCVyRD3y6Y4jlHLXIHcpoL0xeV6iDH0ACxqKTnMFlARnMMHQszh0SsNLJCgM6bs8GtKwQMlBUEZ8SN+ZrjW4NCTj8WpPDArJSKo8J+LBWjC6NqyABXFllCoQsuJpP8zlWErINVHJFVV1B9iVNEwhryyRdV1N00DBPVpYdjdIm2aXgn8l+twzejpk2E/brrdEePWOP05T/vBwOX+c5el/WSuw6CgnkRgfUgfHSWkV5PBg+eSZtDhMw0yfMY9sduwm0DenQ1yr0cNI5yQVTwMp/zN+a+YZ3SB8c6RkksTUy9C272mE1+n2qK398O+OejCmw9dDFnuDjP7vJY9a1CR+QOrTQZkv5zagC3fukMmJEHAam0EepzUOwPhsOu2isnUFuKmbfLPVH8XZJRhmZfeQ7mumojn97Oddxnt+L/WQQmiaBsL2AXS6PXWw+jHlhcRbe93WcHp8cjdKj9Kfx6DT7/HP25XSQpunfkMCqUsxt9VW099cF7X7XtvgP4jSvYf2Ret0HaPrdIa1I42On2cfjNH08ZUiTwOf0y6F2L/VCKiriKh+bZ9Q/fD/lonPmg8nqhw/b8Ifl0xYUz+FFsX37tsgKw9y02zxu8DCHDIavFrtHt+i2eu1UTyE+yBnp2ZG0dmAsak8zreTUs1qG0tJwMQLeih7z2lFY33EvtuWujqSlo202PUFY+gNZEW0xfVS7wecoWfKcPunSRHJb4o1FzYMeG7QYweF3mbwgH4+7T1u8LFEaJ16xxVR6LITRIswxHrL9ZDAS3mJOZXvPA/GgH/SdqZC/sbzVFelnnz3oI3F/U5aUk1TiL5x6Cjj5sevccrk86NinyLmgMK+nwqE1e/gsGmNb+6zdj0+QQEBX+Zvyjh8DebfH3gg1jOBhO70yj9OLlSS+3db0y2sST5OiHLXH3rydXdxeiZNBCklvOP5BysOry1/Pr+/O2SuP1/aKRoN0kLLJGh8qqXuBXryo2tF8cb+bvRT/p0+wViUBV2FolaQo8Nj1TSvee3gh3kkCc+MD2zcbHug/nWoaNm8fQizpgjxXu38KPeO693BbSFVzUOAX1RvY9oW1h074hyPGQnY/aZJOthxwyznLc7T9AAfLk73sNtTF+Ria5hua1/JN",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:"eJzdVl1PKzcQ/SvuPPVKS7KBe6m6T0UVpagIkEhVqRAhZ3c2GfDavrY3H4r2v1+Ns5ssREBVXfWhT5DxOfPlObPeQJAzD9k9jLGySgb0MEmgQJ87soGMhgzGcxQXGEQHEVfkgzi7vRRSKbP0Ym1qEYxwGBzhAoUUihGmFHIhScmpQhE6/wMxnpMXZa1z9i8VhbWwziyoQC+kFmaBbkG4jHyl9sxEoJZTRXomao/Oc8x8boxHUTpTCVyRD3y6Y4jlHLXIHcpoL0xeV6iDH0ACxqKTnMFlARnMMHQszh0SsNLJCgM6bs8GtKwQMlBUEZ8SN+ZrjW4NCTj8WpPDArJSKo8J+LBWjC6NqyABXFllCoQsuJpP8zlWErINVHJFVV1B9iVNEwhryyRdV1N00DBPVpYdjdIm2aXgn8l+twzejpk2E/brrdEePWOP05T/vBwOX+c5el/WSuw6CgnkRgfUgfHSWkV5PBg+eSZtDhMw0yfMY9sduwm0DenQ1yr0cNI5yQVTwMp/zN+a+YZ3SB8c6RkksTUy9C272mE1+n2qK398O+OejCmw9dDFnuDjP7vJY9a1CR+QOrTQZkv5zagC3fukMmJEHAam0EepzUOwPhsOu2isnUFuKmbfLPVH8XZJRhmZfeQ7mumojn97Oddxnt+L/WQQmiaBsL2AXS6PXWw+jHlhcRbe93WcHp8cjdKj9Kfx6DT7/HP25XSQpunfkMCqUsxt9VW099cF7X7XtvgP4jSvYf2Ret0HaPrdIa1I42On2cfjNH08ZUiTwOf0y6F2L/VCKiriKh+bZ9Q/fD/lonPmg8nqhw/b8Ifl0xYUz+FFsX37tsgKw9y02zxu8DCHDIavFrtHt+i2eu1UTyE+yBnp2ZG0dmAsak8zreTUs1qG0tJwMQLeih7z2lFY33EvtuWujqSlo202PUFY+gNZEW0xfVS7wecoWfKcPunSRHJb4o1FzYMeG7QYweF3mbwgH4+7T1u8LFEaJ16xxVR6LITRIswxHrL9ZDAS3mJOZXvPA/GgH/SdqZC/sbzVFelnnz3oI3F/U5aUk1TiL5x6Cjj5sevccrk86NinyLmgMK+nwqE1e/gsGmNb+6zdj0+QQEBX+Zvyjh8DebfH3gg1jOBhO70yj9OLlSS+3db0y2sST5OiHLXH3rydXdxeiZNBCklvOP5BysOry1/Pr+/O2SuP1/aKRoN0kLLJGh8qqXuBXryo2tF8cb+bvRT/p0+wViUBV2FolaQo8Nj1TSvee3gh3kkCc+MD2zcbHug/nWoaNm8fQizpgjxXu38KPeO693BbSFVzUOAX1RvY9oW1h074hyPGQnY/aZJOthxwyznLc7T9AAfLk73sNtTF+Ria5hua1/JN",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 from ID",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function 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:"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)(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)(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:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(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/935f2afb.c7f1852d.js b/assets/js/935f2afb.c7f1852d.js new file mode 100644 index 000000000..660371866 --- /dev/null +++ b/assets/js/935f2afb.c7f1852d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your 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":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by providing template_id.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit 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/get-template":{"id":"API-docs/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"The Get User API enables you to get your own details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to capture document signature completion event","sidebar":"apiSidebar"},"API-docs/update-document":{"id":"API-docs/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.dce39788.js b/assets/js/935f2afb.dce39788.js deleted file mode 100644 index 8d6f72297..000000000 --- a/assets/js/935f2afb.dce39788.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document from ID","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document from ID","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document from ID","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template from ID","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template from ID","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template from ID","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create Contact","description":"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by providing template_id.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete Template from ID","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 from ID","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get Template from ID","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"The Get User API enables you to get your own details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document from ID","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allow you to save webhook url which is used to capture document signature completion event","sidebar":"apiSidebar"},"API-docs/update-document":{"id":"API-docs/update-document","title":"Update Document from ID","description":"The Update Document API allows users to modify and update the details of a specific document.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update Template from ID","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.9ba37594.js b/assets/js/a88a3db3.9ba37594.js deleted file mode 100644 index b53e02309..000000000 --- a/assets/js/a88a3db3.9ba37594.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>v});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),p=l(4667),c=l(9472),h=l(85162);const u={id:"delete-template",title:"Delete Template from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfWoA2ZKTNMP0adlidMaCpag9DJhjBLR0sthQJEueHBuG/vtAWrIVuw02YBj2yebxjnfPc2/aAfGVg3QOM6yM5IQOFhHk6DIrDAmtIIVZiewOJRKyTovdfpwwY/Va5OjYVtfsRVDJqETGl0IK2jLSzGKl18g4cwYzUYiMUWdfWF0F9U7ihmxSMH7UEI4pzaRWK7RMIeaYQwTaoOU+rkkOKeQhqi4oiMBwyysktB7TDhSvEFLo3nwS/gnhMRlOJZwCndwxXbyKilHJKXh3HtAS2d6lf8fil1pYzCElW2MEjrbSe3OiMtIHgxsjdY6QFlw6r5CVWHFId0BbEzTJCrWCCAptK05HSdMs/PvOaOXQeYvLJPE/J4npomyDYq7OMnSuqKXcfgcRZFoRKvKW3BgpskBd/Nl58915QHr5GTPyPFpPNIm9873YM34eOm54gJvCT5vykjvzi7mCJmpTk9/S20aXyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1tm8PcJ7iJgATJ47k5UwtuXym2ksYrXyfXb9CoNLFC1yr/F7lDa7V9m4Ov+W96CISSQuFTVw9P18n1080B0PtzQBO15lLkoUln+hnVf4un75727s8TJfZK4R5ege3L9yArpFIf+z30OZWQQtz1abzr9XgDETi0624K1FZCCiWRcWkcO+IroVYDbsxQG1ROrJTkSzfMdBVzI+L1CHz7OcxqK2g79cTssW8G3IjBPrQjA9yIX3ELUYesr9VOmxJ5jjawIFShg3GL98GgmoqVCmytR2czaVYK52ehv851VleoKGSOFdqyE2u25A5zplUYYv7Sy6+Go8MEDqZD9qge1VRXyGqHRS2ZFOrZpY9qwOYPRSEywSX7A5dOEC7edcy9vLycMXYRbD4IKusls2j0UX0VhIHWvtXhcAERENrKPRRTtGuRYZulb7iKg3LcljLPQiljxYXPbiv68dTIl5YUGSqHveK7/fDxnl0NE4h6xfE3Qo7vJz+Pf5uO/au+vPYpGg2TYeJFRjuquOo5Ol2bYe1N7k6zvDt25/9q27YVTrih2EguQqcGxnZtC84PyxUiSPuLdhFBqR15ld3O1+XvVjaNF3+p0W4hnS8iWHMr+NI3wnwHuXD+f35YmN/k6N2ndvdesH+2s78KqOtj5Zt4zWXtTxDBM25PPh6aRRN1zewj3mvcZhka6tmezVc/Tw5D7G58P56NoWn+AiRLQ84=",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/delete-template",title:"Delete Template from ID",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 from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfWoA2ZKTNMP0adlidMaCpag9DJhjBLR0sthQJEueHBuG/vtAWrIVuw02YBj2yebxjnfPc2/aAfGVg3QOM6yM5IQOFhHk6DIrDAmtIIVZiewOJRKyTovdfpwwY/Va5OjYVtfsRVDJqETGl0IK2jLSzGKl18g4cwYzUYiMUWdfWF0F9U7ihmxSMH7UEI4pzaRWK7RMIeaYQwTaoOU+rkkOKeQhqi4oiMBwyysktB7TDhSvEFLo3nwS/gnhMRlOJZwCndwxXbyKilHJKXh3HtAS2d6lf8fil1pYzCElW2MEjrbSe3OiMtIHgxsjdY6QFlw6r5CVWHFId0BbEzTJCrWCCAptK05HSdMs/PvOaOXQeYvLJPE/J4npomyDYq7OMnSuqKXcfgcRZFoRKvKW3BgpskBd/Nl58915QHr5GTPyPFpPNIm9873YM34eOm54gJvCT5vykjvzi7mCJmpTk9/S20aXyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1tm8PcJ7iJgATJ47k5UwtuXym2ksYrXyfXb9CoNLFC1yr/F7lDa7V9m4Ov+W96CISSQuFTVw9P18n1080B0PtzQBO15lLkoUln+hnVf4un75727s8TJfZK4R5ege3L9yArpFIf+z30OZWQQtz1abzr9XgDETi0624K1FZCCiWRcWkcO+IroVYDbsxQG1ROrJTkSzfMdBVzI+L1CHz7OcxqK2g79cTssW8G3IjBPrQjA9yIX3ELUYesr9VOmxJ5jjawIFShg3GL98GgmoqVCmytR2czaVYK52ehv851VleoKGSOFdqyE2u25A5zplUYYv7Sy6+Go8MEDqZD9qge1VRXyGqHRS2ZFOrZpY9qwOYPRSEywSX7A5dOEC7edcy9vLycMXYRbD4IKusls2j0UX0VhIHWvtXhcAERENrKPRRTtGuRYZulb7iKg3LcljLPQiljxYXPbiv68dTIl5YUGSqHveK7/fDxnl0NE4h6xfE3Qo7vJz+Pf5uO/au+vPYpGg2TYeJFRjuquOo5Ol2bYe1N7k6zvDt25/9q27YVTrih2EguQqcGxnZtC84PyxUiSPuLdhFBqR15ld3O1+XvVjaNF3+p0W4hnS8iWHMr+NI3wnwHuXD+f35YmN/k6N2ndvdesH+2s78KqOtj5Zt4zWXtTxDBM25PPh6aRRN1zewj3mvcZhka6tmezVc/Tw5D7G58P56NoWn+AiRLQ84=",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 from ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},v=[{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 from ID"})}),"\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)(c.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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.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,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:"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)(c.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)(p.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)(c.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)(p.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 g(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.b2817a74.js b/assets/js/a88a3db3.b2817a74.js new file mode 100644 index 000000000..c86d7e32e --- /dev/null +++ b/assets/js/a88a3db3.b2817a74.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>P,frontMatter:()=>u,metadata:()=>x,toc:()=>v});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),o=s(5397),c=s(4667),m=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:"eJzNVttu4zYQ/RV2njaAbMlJNkX11LQxtkaDZrF2UaCOEdDSyOKGIrnkyLFh6N8L0pKt2LtBCxRFn2yNznDmnLlQOyC+cpDOYYaVkZzQwSKCHF1mhSGhFaQwK5HdoURC1qHY7ccJM1avRY6ObXXNXgSVjEpkfCmkoC0jzSxWeo2MM2cwE4XIGHX+hdVVgHcWN2STgvEjQjimNJNardAyhZhjDhFog5b7vCY5pJCHrLqkIALDLa+Q0HpOO1C8QkihO/NJ+COE52Q4lXBKdHLHdPEqK0YlpxDdeUJLZPuQ/hyLX2phMYeUbI0RONpKH82JykifDG6M1DlCWnDpPCArseKQ7oC2JiDJCrWCCAptK05HS9Ms/PnOaOXQeY/LJPE/J4XpsmyTYq7OMnSuqKXcfgcRZFoRKvKe3BgpsiBd/Nl59915Qnr5GTPyOlovNIl98L3ZK36eOm54oJvCT5vykjvzi7mCJmpLk9/S206XyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1vW8PcF7iJgATJ43NzBgthXwFbS+PB18n1GzIqTazQtcr/Re3QWm3f1uBr8ZseA6GkUPjU9cPTdXL9dHMg9P6c0EStuRR5GNKZfkb13/Lph6d9+PNCiT0ovIdXZPv2PckKqdTHeQ9zTiWkEHdzGu96M95ABA7tutsCtZWQQklkXBrHjvhKqNWAGzPUBpUTKyX50g0zXcXciHg9Aj9+DrPaCtpOvTB77psBN2KwT+2oADfiV9xC1DHro9ptUyLP0QYVhCp0cG75PhhUU7FSQa316GwnzUrh/C70r3Od1RUqCpVjhbbsxJstucOcaRWWmH/p7VfD0WEDB9che1SPaqorZLXDopZMCvXs0kc1YPOHohCZ4JL9gUsnCBfvOuVeXl7OFLsIPh8ElfWSWTT6CF8FY5C173V4uIAICG3lHoop2rXIsK3SN0LFARy3rcyz0MpYceGr25p+PHXyrSVFhsphr/luP3y8Z1fDBKJec/yNlOP7yc/j36Zjf6pvr32JRsNkmHiT0Y4qrnqBTq7N0+rujlP5v7pl284m3FBsJBdhQoNSu3b05odLFSJI+xfsIoJSO/KQ3c734+9WNo03f6nRbiGdLyJYcyv40g/AfAe5cP5/frgov6nRu0/tnXvB/tld/VVC3fwqP7xrLmv/BBE84/bko6FZNFE3xD7jPeI2y9BQz/dsr/o9clhed+P78WwMTfMXkHRBTQ==",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/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:"eJzNVttu4zYQ/RV2njaAbMlJNkX11LQxtkaDZrF2UaCOEdDSyOKGIrnkyLFh6N8L0pKt2LtBCxRFn2yNznDmnLlQOyC+cpDOYYaVkZzQwSKCHF1mhSGhFaQwK5HdoURC1qHY7ccJM1avRY6ObXXNXgSVjEpkfCmkoC0jzSxWeo2MM2cwE4XIGHX+hdVVgHcWN2STgvEjQjimNJNardAyhZhjDhFog5b7vCY5pJCHrLqkIALDLa+Q0HpOO1C8QkihO/NJ+COE52Q4lXBKdHLHdPEqK0YlpxDdeUJLZPuQ/hyLX2phMYeUbI0RONpKH82JykifDG6M1DlCWnDpPCArseKQ7oC2JiDJCrWCCAptK05HS9Ms/PnOaOXQeY/LJPE/J4XpsmyTYq7OMnSuqKXcfgcRZFoRKvKe3BgpsiBd/Nl59915Qnr5GTPyOlovNIl98L3ZK36eOm54oJvCT5vykjvzi7mCJmpLk9/S206XyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1vW8PcF7iJgATJ43NzBgthXwFbS+PB18n1GzIqTazQtcr/Re3QWm3f1uBr8ZseA6GkUPjU9cPTdXL9dHMg9P6c0EStuRR5GNKZfkb13/Lph6d9+PNCiT0ovIdXZPv2PckKqdTHeQ9zTiWkEHdzGu96M95ABA7tutsCtZWQQklkXBrHjvhKqNWAGzPUBpUTKyX50g0zXcXciHg9Aj9+DrPaCtpOvTB77psBN2KwT+2oADfiV9xC1DHro9ptUyLP0QYVhCp0cG75PhhUU7FSQa316GwnzUrh/C70r3Od1RUqCpVjhbbsxJstucOcaRWWmH/p7VfD0WEDB9che1SPaqorZLXDopZMCvXs0kc1YPOHohCZ4JL9gUsnCBfvOuVeXl7OFLsIPh8ElfWSWTT6CF8FY5C173V4uIAICG3lHoop2rXIsK3SN0LFARy3rcyz0MpYceGr25p+PHXyrSVFhsphr/luP3y8Z1fDBKJec/yNlOP7yc/j36Zjf6pvr32JRsNkmHiT0Y4qrnqBTq7N0+rujlP5v7pl284m3FBsJBdhQoNSu3b05odLFSJI+xfsIoJSO/KQ3c734+9WNo03f6nRbiGdLyJYcyv40g/AfAe5cP5/frgov6nRu0/tnXvB/tld/VVC3fwqP7xrLmv/BBE84/bko6FZNFE3xD7jPeI2y9BQz/dsr/o9clhed+P78WwMTfMXkHRBTQ==",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={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"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)(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",example:"Bxh2aspHp3"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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)(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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function P(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.01268790.js b/assets/js/bfe4b778.01268790.js deleted file mode 100644 index cf20aab3f..000000000 --- a/assets/js/bfe4b778.01268790.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:()=>b,frontMatter:()=>h,metadata:()=>f,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)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document from ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQJ2mDFYjQJBiwxDFo6WUwokiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7rcHzuYPkFs50WpWovINJBBm61ArjhVaQwHWB7MZk3CPrrNjp+IJxKfXSscqhdcxrVupM5CvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4ySKDZ2gWCCAy3vESPlvJcg+IlQgKdg6nIIAJBeRruC9hP/uKMIodEutx9wT1TiFnIeoZttuTH4tdKWMwg8bbCCJxfSYrmRGkkQgT4aKTOEJKcS0cGaYElh2QNfmWCpbdCzSGCXNuS++1KXU8a/+j8e52taM9uqmOrFyJDNkOpl2wDm5Ls+MTSSO7RsQPumUTuPNMKe7YdgDcQQaqVJwqTNXBjpEgDyaN7R9HWT1PXs3tMA+OWjsQLdPS2IfzvARI5PNCUgAt/NpRDHYHS/tVuxgQRmcWFwGUQlhNzxXwh3I7vHR5fF2Kjir6PmvbIDC0p8nX+3t+7GT+aFXoMdR2BF34nzLSn2+mMZFDXZGfRGa1cw/hRHD9Vx+bqtWplrkpTdC6vpFz99OOOu1l+HvgWJnfZ0Sc3PvlkiKw2pVP/8qaj+Oh4cBgP4p+vD98lJ78kb98N4zj+EyJ4LOVWa0DeoM9eeO4tCCWFwmnH2vQojqfHLZUnz7HXKsm0V2zBpchYLlBmjGK6H0ggWqvtP1T6C/m9BJ8gd+BPXpCO0p7lulLZ/w33uYxeBngyPdlAfPsU4oVqKKO+dK0fUP0XCLd4+uF9E55S3VW1aIzCe9gB219vQJboC03t0FRND/QFJDDqqsdo3asjNUTg0C66DllZCQkU3huXjEbO87lQ8wE3ZqgNKqqgks/cMNXliBsxWhwCtSaHaWWFX10RKw3wxwE3YtDktYXPjfgNVxB1sPpWbScukGdoAwVE9pdt1zvvKNuwst8quk7xfcV/v90/W8771XynQFO6uQ7Y2rO4NKiuKAyd5OLwif9rii5ceN3FCqpiubZsbzebcYcZ0yrMH/SS1o+Hh5s5KGwdsjt1p650iTRL5ZVkUqgHl9ypAbu9zHORCi7ZHzhzwuPkoDvY5XL55EDfhD0fhS+qGbNo9NZ8HhbDqfd3bR5oYvBoS3eZX6FdiBRbEX0j1CgYj9prxtNwzbDkgsTXLv26v4kolyJF5foSOP04/syOhzFEPe1+R8qjzxcfzn+/OievpP7miA6H8TCmJaOdL7nqBdqfYnOrS3Zxtn/K623l+NeH3/ZSeXz0IyO5CJUhsLBub/0t9NSe9OfeSQSFdp5M1mvS2o2VdU3LXyu0K0huJxEsuBV8RuK+XUMmHP3PNvPrN3EffOkmSfa6EfpZQF3pUFQ3FlxW9AQRPOBqb5avJ3XU1Q/KuLH40OQ1uCY/Ww9PqnoddTtO0xSNf9F20iuz45triGDWzuVlGPHB8iV9E/AlJHAHdxC+VchBqI5hfQ2Sq3nF52TfuKXfX75rnZM=",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 from ID",description:"The Update Document API allows users to modify and update the details of a specific document.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document from ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQJ2mDFYjQJBiwxDFo6WUwokiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7rcHzuYPkFs50WpWovINJBBm61ArjhVaQwHWB7MZk3CPrrNjp+IJxKfXSscqhdcxrVupM5CvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4ySKDZ2gWCCAy3vESPlvJcg+IlQgKdg6nIIAJBeRruC9hP/uKMIodEutx9wT1TiFnIeoZttuTH4tdKWMwg8bbCCJxfSYrmRGkkQgT4aKTOEJKcS0cGaYElh2QNfmWCpbdCzSGCXNuS++1KXU8a/+j8e52taM9uqmOrFyJDNkOpl2wDm5Ls+MTSSO7RsQPumUTuPNMKe7YdgDcQQaqVJwqTNXBjpEgDyaN7R9HWT1PXs3tMA+OWjsQLdPS2IfzvARI5PNCUgAt/NpRDHYHS/tVuxgQRmcWFwGUQlhNzxXwh3I7vHR5fF2Kjir6PmvbIDC0p8nX+3t+7GT+aFXoMdR2BF34nzLSn2+mMZFDXZGfRGa1cw/hRHD9Vx+bqtWplrkpTdC6vpFz99OOOu1l+HvgWJnfZ0Sc3PvlkiKw2pVP/8qaj+Oh4cBgP4p+vD98lJ78kb98N4zj+EyJ4LOVWa0DeoM9eeO4tCCWFwmnH2vQojqfHLZUnz7HXKsm0V2zBpchYLlBmjGK6H0ggWqvtP1T6C/m9BJ8gd+BPXpCO0p7lulLZ/w33uYxeBngyPdlAfPsU4oVqKKO+dK0fUP0XCLd4+uF9E55S3VW1aIzCe9gB219vQJboC03t0FRND/QFJDDqqsdo3asjNUTg0C66DllZCQkU3huXjEbO87lQ8wE3ZqgNKqqgks/cMNXliBsxWhwCtSaHaWWFX10RKw3wxwE3YtDktYXPjfgNVxB1sPpWbScukGdoAwVE9pdt1zvvKNuwst8quk7xfcV/v90/W8771XynQFO6uQ7Y2rO4NKiuKAyd5OLwif9rii5ceN3FCqpiubZsbzebcYcZ0yrMH/SS1o+Hh5s5KGwdsjt1p650iTRL5ZVkUqgHl9ypAbu9zHORCi7ZHzhzwuPkoDvY5XL55EDfhD0fhS+qGbNo9NZ8HhbDqfd3bR5oYvBoS3eZX6FdiBRbEX0j1CgYj9prxtNwzbDkgsTXLv26v4kolyJF5foSOP04/syOhzFEPe1+R8qjzxcfzn+/OievpP7miA6H8TCmJaOdL7nqBdqfYnOrS3Zxtn/K623l+NeH3/ZSeXz0IyO5CJUhsLBub/0t9NSe9OfeSQSFdp5M1mvS2o2VdU3LXyu0K0huJxEsuBV8RuK+XUMmHP3PNvPrN3EffOkmSfa6EfpZQF3pUFQ3FlxW9AQRPOBqb5avJ3XU1Q/KuLH40OQ1uCY/Ww9PqnoddTtO0xSNf9F20iuz45triGDWzuVlGPHB8iV9E/AlJHAHdxC+VchBqI5hfQ2Sq3nF52TfuKXfX75rnZM=",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 from ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document from ID",permalink:"/docs/API-docs/deletedocument"}},j={},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 Document from ID"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,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/bfe4b778.ff1818b8.js b/assets/js/bfe4b778.ff1818b8.js new file mode 100644 index 000000000..38f106ce8 --- /dev/null +++ b/assets/js/bfe4b778.ff1818b8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var l=a(85893),t=a(11151),i=a(58219),d=(a(62316),a(51039)),n=a.n(d),r=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQN2mDFYjQOBiwxDFo6WUwpkiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7bcDzhYPkFt7rtCpReQfTCDJ0qRXGC60ggUmB7MZk3CPrrNj5+JJxKfXKscqhdcxrVupM5GvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4zSKDZ2gWCCAy3vESPlvLcgOIlQgKdg5nIIAJBeRruCzhM/vI9RQ6JdLn7gnumELOQ9RzbbMmPxa+VsJhB4m2FETi/lhTNidJIhAjwwUidISQ5l44M0gJLDskG/NoES2+FWkAEubYl97uVup42/tH5tzpb0579VMdWL0WGbI5Sr9gWNiXZ8YmlkdyjY0fcM4nceaYV9mw7AK8gglQrTxQmG+DGSJEGkkf3jqJtHqeu5/eYBsYtHYkX6OhtQ/jfAyRyeKApARf+bCmHOgKl/YvdjAkiMotLgasgLCcWivlCuD3fezy+LMRWFX0fNe2RGVpS5Mv8vb13c34yL/QY6joCL/xemFlPt7M5yaCuyc6iM1q5hvGTOH6sju3Va9XKXJWm6FxeSbn+6ccdd7P8NPAdTO6yk49ufPbREFltSuf++U0n8cnp4DgexD9Pjt8kZ78kr98M4zj+EyJ4KOVOa0DeoM9eeO4tCCWFwlnH2uwkjmenLZVnT7HXKsm0V2zJpchYLlBmjGK6H0ggWqvtP1T6M/k9B58gd+DPnpGO0p7lulLZ/w33qYyeB3g2O9tCfP0Y4qVqKKO+NNFfUP0XCHd4+uF9E55S3Ve1aIzCe9gD219vQJboC03t0FRND/QFJDDqqsdo06sjNUTg0C67DllZCQkU3huXjEbO84VQiwE3ZqgNKqqgks/dMNXliBsxWh4DtSaHaWWFX18TKw3whwE3YtDktYPPjfgN1xB1sPpWbScukGdoAwVE9udd17voKNuyctgquk7xfcX/sN0/Wc771XyvQFO6uQ7Y2rO4MqiuKQyd5PL4kf8JRRcuvO5iBVWxXFt2sJvNucOMaRXmD3pJ66fD4+0cFLYO2Z26U9e6RJql8koyKdQXl9ypAbu9ynORCi7ZHzh3wuP0qDvY1Wr16EBfhT0fhC+qObNo9M58ERbDqfd3bR9oYvBoS3eVX6NdihRbEX0j1CgYj9prxtNwzbDkgsTXLv16uIkolyJF5foSOP8w/sROhzFEPe1+R8qjT5fvLn6/viCvpP7miI6H8TCmJaOdL7nqBTqYYg9Pd7OrGP/60NteJo8PfmQkF6EiBPSb9rbfQk/lSX/enUZQaOfJZLMhjd1YWde0/LVCu4bkdhrBklvB5yTq2w1kwtH/bDu3fhP30edugmQvG52fBNSVDEX1YsllRU8QwRdcH8zw9bSOurpBGTcW75q8BhPys/PwqJrXUbfjPE3R+Gdtp73yOr6ZQATzdh4vw2gPlq/oW4CvIIE7uIPwjUIOQlUM6xuQXC0qviD7xi39/gJfGpsS",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.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQN2mDFYjQOBiwxDFo6WUwpkiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7bcDzhYPkFt7rtCpReQfTCDJ0qRXGC60ggUmB7MZk3CPrrNj5+JJxKfXKscqhdcxrVupM5GvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4zSKDZ2gWCCAy3vESPlvLcgOIlQgKdg5nIIAJBeRruCzhM/vI9RQ6JdLn7gnumELOQ9RzbbMmPxa+VsJhB4m2FETi/lhTNidJIhAjwwUidISQ5l44M0gJLDskG/NoES2+FWkAEubYl97uVup42/tH5tzpb0579VMdWL0WGbI5Sr9gWNiXZ8YmlkdyjY0fcM4nceaYV9mw7AK8gglQrTxQmG+DGSJEGkkf3jqJtHqeu5/eYBsYtHYkX6OhtQ/jfAyRyeKApARf+bCmHOgKl/YvdjAkiMotLgasgLCcWivlCuD3fezy+LMRWFX0fNe2RGVpS5Mv8vb13c34yL/QY6joCL/xemFlPt7M5yaCuyc6iM1q5hvGTOH6sju3Va9XKXJWm6FxeSbn+6ccdd7P8NPAdTO6yk49ufPbREFltSuf++U0n8cnp4DgexD9Pjt8kZ78kr98M4zj+EyJ4KOVOa0DeoM9eeO4tCCWFwlnH2uwkjmenLZVnT7HXKsm0V2zJpchYLlBmjGK6H0ggWqvtP1T6M/k9B58gd+DPnpGO0p7lulLZ/w33qYyeB3g2O9tCfP0Y4qVqKKO+NNFfUP0XCHd4+uF9E55S3Ve1aIzCe9gD219vQJboC03t0FRND/QFJDDqqsdo06sjNUTg0C67DllZCQkU3huXjEbO84VQiwE3ZqgNKqqgks/dMNXliBsxWh4DtSaHaWWFX18TKw3whwE3YtDktYPPjfgN1xB1sPpWbScukGdoAwVE9udd17voKNuyctgquk7xfcX/sN0/Wc771XyvQFO6uQ7Y2rO4MqiuKQyd5PL4kf8JRRcuvO5iBVWxXFt2sJvNucOMaRXmD3pJ66fD4+0cFLYO2Z26U9e6RJql8koyKdQXl9ypAbu9ynORCi7ZHzh3wuP0qDvY1Wr16EBfhT0fhC+qObNo9M58ERbDqfd3bR9oYvBoS3eVX6NdihRbEX0j1CgYj9prxtNwzbDkgsTXLv16uIkolyJF5foSOP8w/sROhzFEPe1+R8qjT5fvLn6/viCvpP7miI6H8TCmJaOdL7nqBTqYYg9Pd7OrGP/60NteJo8PfmQkF6EiBPSb9rbfQk/lSX/enUZQaOfJZLMhjd1YWde0/LVCu4bkdhrBklvB5yTq2w1kwtH/bDu3fhP30edugmQvG52fBNSVDEX1YsllRU8QwRdcH8zw9bSOurpBGTcW75q8BhPys/PwqJrXUbfjPE3R+Gdtp73yOr6ZQATzdh4vw2gPlq/oW4CvIIE7uIPwjUIOQlUM6xuQXC0qviD7xi39/gJfGpsS",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const 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:"Update Document"})}),"\n",(0,l.jsx)(n(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Update Document API allows users to modify and update the details of a specific document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{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 below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(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",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(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",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(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)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.8d7cce01.js b/assets/js/f0ff4a36.8d7cce01.js deleted file mode 100644 index aa7de3b35..000000000 --- a/assets/js/f0ff4a36.8d7cce01.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),o=(a(82723),a(9487)),m=a(41429),d=a(5397),c=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get Document from ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMtJ2mLCMCxY0sxrkRSLiwFLjICWThYbimRJyolh6NueZI+2JxmOkhw5TrYZ2PolsY53v/v/Zw2eLxwk13Cq06pE5R3MIsjQpVYYL7SCBKYFsnP0rGNhJx8nDBWfS3RspSvmNbPorcAlsgw9F9IxPteVZ5w5g6nIRcqyVnoIEWiDlhP6JIMEFui7R4jAcMtL9GjJrDUoXiIk0DHcigwiEGSW4b6Ap7bq+WdM/SRjOmepVp6nhGnxSyUsZpB4W2EEzq8koTpRGokQAT4YqTOEJOfSEUNaYMkhWYNfmcDprVALiCDXtuS+T8EHHlASMD+N50V6WJg51PWM1DqjlUNHQIdxTP+2zXVVmqJzeSXZJiYQAVlO0UjWwI2RIg0Po8+OhNa71jVeU/AswXjRqOyCsa8f787F3eHRvPj0M9QRTIUn6n4QLvygpBPEhfZ7IxiJ3CFzYqE2tUNY77TM0O6LdmlQXYmF+vP3P9ipFUsMUGJ/xwrvjUtGo5ZSWTlMdUlol/dqf7s+a2RzDNaQeaHqNwjcWr6icvdYun9O90VolV39W9qgriPwTUrBY2kk93jb6abH1CL3mJ34v8c6jA+PBuN4EL+djt8kx98mr98M4zj+DSJ4KCXJdq3LffCvU9p9Vyb7CnrqHbZeLW1YN7SaBI7j491W3Uw/pT3LdaWyb/67TkVr9bO18xiH5/T3cymUFApvu5lzexwf3x5tHHq969BELbkUWZjmU32H6uv601fvG/W7yRINU3iHLWf79MZJh2llhV+FtfEw4EYMmvfkekbTuERf6HbfhD3jC0hg1OV+tO7tmBoIzy67LVRZ2et95/lCqMWAGzPUBhXNKMnnjibBiBsxWo6BNHYWXVHUmsBs2fXY6Ea8R+r01u0+V7vtCuQ09shRoXIdhNtgdLMthHI53tmJ00I4Jlx47nwMaWW5tuyJNJtzhxnTivkCwyPRj4bjzSYPokN2o27UlS6RVQ5pf0mh7lxyowbs+jLPRSq4ZL/i3AmPs1dd5O7v73cidhBkzoUvqjmzaPQj+yIQQ1j7UpuPA4jAoy3dZX6FdinSbkK/oGoUmEdtndNtQLVackHZbUk/PBWiupMiReWwV5kn5x8/sKNhDFGvOP6FyaMPkx/PLq7OCJXKq0nReBgPYyIZ7XzJVU/R1uWVW12yyenTFK8f+/Z/uNbaIvX44EdGchE6MTi9brvoGnoHXNK/1WYRFNp5YlmvqbQ+WVnXRP5SoaVenUWw5FaQfaHVMuHod7a5xV709NUv7Vl3wJ4/+541vGs5Rf225LKiL4jgDldP7sx6Vkdd35FlDcdJmqLxPdmdObk1bM7PphABryhM/X6/C/3e/iD0Z+3aHgSNAfS3jl4Q+I6y/R5X32/Ym5cXBVr/Om6K0ayu678AAnwcXg==",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 from ID",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 from ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMtJ2mLCMCxY0sxrkRSLiwFLjICWThYbimRJyolh6NueZI+2JxmOkhw5TrYZ2PolsY53v/v/Zw2eLxwk13Cq06pE5R3MIsjQpVYYL7SCBKYFsnP0rGNhJx8nDBWfS3RspSvmNbPorcAlsgw9F9IxPteVZ5w5g6nIRcqyVnoIEWiDlhP6JIMEFui7R4jAcMtL9GjJrDUoXiIk0DHcigwiEGSW4b6Ap7bq+WdM/SRjOmepVp6nhGnxSyUsZpB4W2EEzq8koTpRGokQAT4YqTOEJOfSEUNaYMkhWYNfmcDprVALiCDXtuS+T8EHHlASMD+N50V6WJg51PWM1DqjlUNHQIdxTP+2zXVVmqJzeSXZJiYQAVlO0UjWwI2RIg0Po8+OhNa71jVeU/AswXjRqOyCsa8f787F3eHRvPj0M9QRTIUn6n4QLvygpBPEhfZ7IxiJ3CFzYqE2tUNY77TM0O6LdmlQXYmF+vP3P9ipFUsMUGJ/xwrvjUtGo5ZSWTlMdUlol/dqf7s+a2RzDNaQeaHqNwjcWr6icvdYun9O90VolV39W9qgriPwTUrBY2kk93jb6abH1CL3mJ34v8c6jA+PBuN4EL+djt8kx98mr98M4zj+DSJ4KCXJdq3LffCvU9p9Vyb7CnrqHbZeLW1YN7SaBI7j491W3Uw/pT3LdaWyb/67TkVr9bO18xiH5/T3cymUFApvu5lzexwf3x5tHHq969BELbkUWZjmU32H6uv601fvG/W7yRINU3iHLWf79MZJh2llhV+FtfEw4EYMmvfkekbTuERf6HbfhD3jC0hg1OV+tO7tmBoIzy67LVRZ2et95/lCqMWAGzPUBhXNKMnnjibBiBsxWo6BNHYWXVHUmsBs2fXY6Ea8R+r01u0+V7vtCuQ09shRoXIdhNtgdLMthHI53tmJ00I4Jlx47nwMaWW5tuyJNJtzhxnTivkCwyPRj4bjzSYPokN2o27UlS6RVQ5pf0mh7lxyowbs+jLPRSq4ZL/i3AmPs1dd5O7v73cidhBkzoUvqjmzaPQj+yIQQ1j7UpuPA4jAoy3dZX6FdinSbkK/oGoUmEdtndNtQLVackHZbUk/PBWiupMiReWwV5kn5x8/sKNhDFGvOP6FyaMPkx/PLq7OCJXKq0nReBgPYyIZ7XzJVU/R1uWVW12yyenTFK8f+/Z/uNbaIvX44EdGchE6MTi9brvoGnoHXNK/1WYRFNp5YlmvqbQ+WVnXRP5SoaVenUWw5FaQfaHVMuHod7a5xV709NUv7Vl3wJ4/+541vGs5Rf225LKiL4jgDldP7sx6Vkdd35FlDcdJmqLxPdmdObk1bM7PphABryhM/X6/C/3e/iD0Z+3aHgSNAfS3jl4Q+I6y/R5X32/Ym5cXBVr/Om6K0ayu678AAnwcXg==",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 from ID",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document from ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",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)(s.p,{children:"successful operation"})}),(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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"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)(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,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\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:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.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)(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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.a5657d8a.js b/assets/js/f0ff4a36.a5657d8a.js new file mode 100644 index 000000000..da028e9e6 --- /dev/null +++ b/assets/js/f0ff4a36.a5657d8a.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:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),c=s(41429),m=s(5397),o=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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Document"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\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:"document_id",in:"path",description:"objectId of Document",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)(l.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)(d.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(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)(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,t.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,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document 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)(d.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)(o.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 y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f864295c.a66a6d3d.js b/assets/js/f864295c.a66a6d3d.js new file mode 100644 index 000000000..9fc46abb7 --- /dev/null +++ b/assets/js/f864295c.a66a6d3d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1344],{55833:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>h,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>x});var t=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),n=s.n(l),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={id:"createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v2zgQ/StcnlpD/ki7vei02aAogi02AZxiD04QUNTImoYiGXJoxxvovxcjWY7yiR567MnUzJCc9/j46HtJah1lvpIX0HijCKK8ymQJUQf0hM7KXF7UIIa0OAmgOC6Oz0+FMsZto0gRQhTkhOYkCJ0iuQb/V4UBQcPCmdjWqGsRIWxAqCgKk8AHtBRF5YJYg4WgCO1alE6nBjixRaqFD1BChRZKESkkTSlAnIlv3lkRk9YQY5XMYae+DXQ2E1RD12gASsFGoUSyeJtATCZD9TWWk4mgWpHQyooCGE7JaPYNwaidQnHO2W7h6EFjhVw87KxsKSaTFAwv6QSUSIfkTGbS+Q6is6elzGVP15BnqAVaFXYykwFuE0T625U7md9L7SyBJR42yRB6FWheudBMS0WKw1HX0HQj2nmQuXTFd9AkM+kD70oIkbMVGhhVRQpo1zKTvJgimct9C20mCeml2vaJPl7IW0cvT4y4thDimw2oENROtg8NvMrTdcH0tFzKfGGAUuYUEnSB6J2NPegPiwX/PJH1I7mwtg5SMrs/ZDYmXXlvUHcnN/8ee9Q/y3gf5gM/VNrUFBCYkBTMS2TAnWp8h70m8jGfz/eRFMxMu+YRPWgNWrgeEF9/WCyuPzEtbSb/XHx6jvzUbpTBsrsZF+4G7C9ECyG48Dak8fbUb8+t3jUdFVY1PaiuqMvLR2DH8R5kA1Q7vlDexa4jRbXM5fyN+9WZEAtxdd+fwYHoSGqNdj1V3s+cB8uSNaqITPtceZxvjmR7xSvoFJB2Syamx343VR6nfWsPDCiP/wDvuUc2rsok8oHUoErWQ8vflesm7/GeebBLXPd+uzmSz80Zo8DYpQef6g2aPfXJ7Mf+xUmOf5wdDV7WH/pMXNpLu3RN54VsrQbtTcwv7VSszqoKNSoj/oMiIsHVu4G57Xb7jLH33ZwvSHUqRADvHsrXXbCjdTzr8PFeZpIgNPGsWkLYoB6uwytbzbvi+V7KSndShkYhn+4+9NfTSSwtgxpshJH4jr+cfxUfZwuZjcTxEy3Pv56efP53+ZlXZXn1R3Q0W8wWHGJ5NsqONjrpH8yDFVXBNeIg0ic2e7ihv1/kX/ci7y8pwR3NvVFoR67c+8jq9Xf6KpM1W06+kvf33Mm3YNqWw7cJwk7mq6tMblRA5p2/2my462w8N7BjDfTHOr3gTrjcJO7opXe+zYZJx1qDp1H5M89mjzoY4/nZ8kJmstj/nWhcyXN44W7d7GHITbbtD1PKj2c=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={id:"API-docs/createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/createtemplatewithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplatewithbinary",permalink:"/docs/API-docs/createtemplatewithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v2zgQ/StcnlpD/ki7vei02aAogi02AZxiD04QUNTImoYiGXJoxxvovxcjWY7yiR567MnUzJCc9/j46HtJah1lvpIX0HijCKK8ymQJUQf0hM7KXF7UIIa0OAmgOC6Oz0+FMsZto0gRQhTkhOYkCJ0iuQb/V4UBQcPCmdjWqGsRIWxAqCgKk8AHtBRF5YJYg4WgCO1alE6nBjixRaqFD1BChRZKESkkTSlAnIlv3lkRk9YQY5XMYae+DXQ2E1RD12gASsFGoUSyeJtATCZD9TWWk4mgWpHQyooCGE7JaPYNwaidQnHO2W7h6EFjhVw87KxsKSaTFAwv6QSUSIfkTGbS+Q6is6elzGVP15BnqAVaFXYykwFuE0T625U7md9L7SyBJR42yRB6FWheudBMS0WKw1HX0HQj2nmQuXTFd9AkM+kD70oIkbMVGhhVRQpo1zKTvJgimct9C20mCeml2vaJPl7IW0cvT4y4thDimw2oENROtg8NvMrTdcH0tFzKfGGAUuYUEnSB6J2NPegPiwX/PJH1I7mwtg5SMrs/ZDYmXXlvUHcnN/8ee9Q/y3gf5gM/VNrUFBCYkBTMS2TAnWp8h70m8jGfz/eRFMxMu+YRPWgNWrgeEF9/WCyuPzEtbSb/XHx6jvzUbpTBsrsZF+4G7C9ECyG48Dak8fbUb8+t3jUdFVY1PaiuqMvLR2DH8R5kA1Q7vlDexa4jRbXM5fyN+9WZEAtxdd+fwYHoSGqNdj1V3s+cB8uSNaqITPtceZxvjmR7xSvoFJB2Syamx343VR6nfWsPDCiP/wDvuUc2rsok8oHUoErWQ8vflesm7/GeebBLXPd+uzmSz80Zo8DYpQef6g2aPfXJ7Mf+xUmOf5wdDV7WH/pMXNpLu3RN54VsrQbtTcwv7VSszqoKNSoj/oMiIsHVu4G57Xb7jLH33ZwvSHUqRADvHsrXXbCjdTzr8PFeZpIgNPGsWkLYoB6uwytbzbvi+V7KSndShkYhn+4+9NfTSSwtgxpshJH4jr+cfxUfZwuZjcTxEy3Pv56efP53+ZlXZXn1R3Q0W8wWHGJ5NsqONjrpH8yDFVXBNeIg0ic2e7ihv1/kX/ci7y8pwR3NvVFoR67c+8jq9Xf6KpM1W06+kvf33Mm3YNqWw7cJwk7mq6tMblRA5p2/2my462w8N7BjDfTHOr3gTrjcJO7opXe+zYZJx1qDp1H5M89mjzoY4/nZ8kJmstj/nWhcyXN44W7d7GHITbbtD1PKj2c=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},f={},x=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Template from binary"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplatewithbinary"}),"\n",(0,t.jsxs)(a.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(r.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f864295c.d46b86b5.js b/assets/js/f864295c.d46b86b5.js deleted file mode 100644 index 7f242a0a6..000000000 --- a/assets/js/f864295c.d46b86b5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1344],{55833:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>h,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>x});var t=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),n=s.n(l),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={id:"createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v2zgQ/StcnlpD/ki7vei02aAogi02AZxiD04QUNTImoYiGXJoxxvovxcjWY7yiR567MnUzJCc9/j46HtJah1lvpIX0HijCKK8ymQJUQf0hM7KXF7UIIa0OAmgOC6Oz0+FMsZto0gRQhTkhOYkCJ0iuQb/V4UBQcPCmdjWqGsRIWxAqCgKk8AHtBRF5YJYg4WgCO1alE6nBjixRaqFD1BChRZKESkkTSlAnIlv3lkRk9YQY5XMYae+DXQ2E1RD12gASsFGoUSyeJtATCZD9TWWk4mgWpHQyooCGE7JaPYNwaidQnHO2W7h6EFjhVw87KxsKSaTFAwv6QSUSIfkTGbS+Q6is6elzGVP15BnqAVaFXYykwFuE0T625U7md9L7SyBJR42yRB6FWheudBMS0WKw1HX0HQj2nmQuXTFd9AkM+kD70oIkbMVGhhVRQpo1zKTvJgimct9C20mCeml2vaJPl7IW0cvT4y4thDimw2oENROtg8NvMrTdcH0tFzKfGGAUuYUEnSB6J2NPegPiwX/PJH1I7mwtg5SMrs/ZDYmXXlvUHcnN/8ee9Q/y3gf5gM/VNrUFBCYkBTMS2TAnWp8h70m8jGfz/eRFMxMu+YRPWgNWrgeEF9/WCyuPzEtbSb/XHx6jvzUbpTBsrsZF+4G7C9ECyG48Dak8fbUb8+t3jUdFVY1PaiuqMvLR2DH8R5kA1Q7vlDexa4jRbXM5fyN+9WZEAtxdd+fwYHoSGqNdj1V3s+cB8uSNaqITPtceZxvjmR7xSvoFJB2Syamx343VR6nfWsPDCiP/wDvuUc2rsok8oHUoErWQ8vflesm7/GeebBLXPd+uzmSz80Zo8DYpQef6g2aPfXJ7Mf+xUmOf5wdDV7WH/pMXNpLu3RN54VsrQbtTcwv7VSszqoKNSoj/oMiIsHVu4G57Xb7jLH33ZwvSHUqRADvHsrXXbCjdTzr8PFeZpIgNPGsWkLYoB6uwytbzbvi+V7KSndShkYhn+4+9NfTSSwtgxpshJH4jr+cfxUfZwuZjcTxEy3Pv56efP53+ZlXZXn1R3Q0W8wWHGJ5NsqONjrpH8yDFVXBNeIg0ic2e7ihv1/kX/ci7y8pwR3NvVFoR67c+8jq9Xf6KpM1W06+kvf33Mm3YNqWw7cJwk7mq6tMblRA5p2/2my462w8N7BjDfTHOr3gTrjcJO7opXe+zYZJx1qDp1H5M89mjzoY4/nZ8kJmstj/nWhcyXN44W7d7GHITbbtD1PKj2c=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={id:"API-docs/createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/createtemplatewithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplatewithbinary",permalink:"/docs/API-docs/createtemplatewithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplatewithbinary",title:"Create Template from binary",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v2zgQ/StcnlpD/ki7vei02aAogi02AZxiD04QUNTImoYiGXJoxxvovxcjWY7yiR567MnUzJCc9/j46HtJah1lvpIX0HijCKK8ymQJUQf0hM7KXF7UIIa0OAmgOC6Oz0+FMsZto0gRQhTkhOYkCJ0iuQb/V4UBQcPCmdjWqGsRIWxAqCgKk8AHtBRF5YJYg4WgCO1alE6nBjixRaqFD1BChRZKESkkTSlAnIlv3lkRk9YQY5XMYae+DXQ2E1RD12gASsFGoUSyeJtATCZD9TWWk4mgWpHQyooCGE7JaPYNwaidQnHO2W7h6EFjhVw87KxsKSaTFAwv6QSUSIfkTGbS+Q6is6elzGVP15BnqAVaFXYykwFuE0T625U7md9L7SyBJR42yRB6FWheudBMS0WKw1HX0HQj2nmQuXTFd9AkM+kD70oIkbMVGhhVRQpo1zKTvJgimct9C20mCeml2vaJPl7IW0cvT4y4thDimw2oENROtg8NvMrTdcH0tFzKfGGAUuYUEnSB6J2NPegPiwX/PJH1I7mwtg5SMrs/ZDYmXXlvUHcnN/8ee9Q/y3gf5gM/VNrUFBCYkBTMS2TAnWp8h70m8jGfz/eRFMxMu+YRPWgNWrgeEF9/WCyuPzEtbSb/XHx6jvzUbpTBsrsZF+4G7C9ECyG48Dak8fbUb8+t3jUdFVY1PaiuqMvLR2DH8R5kA1Q7vlDexa4jRbXM5fyN+9WZEAtxdd+fwYHoSGqNdj1V3s+cB8uSNaqITPtceZxvjmR7xSvoFJB2Syamx343VR6nfWsPDCiP/wDvuUc2rsok8oHUoErWQ8vflesm7/GeebBLXPd+uzmSz80Zo8DYpQef6g2aPfXJ7Mf+xUmOf5wdDV7WH/pMXNpLu3RN54VsrQbtTcwv7VSszqoKNSoj/oMiIsHVu4G57Xb7jLH33ZwvSHUqRADvHsrXXbCjdTzr8PFeZpIgNPGsWkLYoB6uwytbzbvi+V7KSndShkYhn+4+9NfTSSwtgxpshJH4jr+cfxUfZwuZjcTxEy3Pv56efP53+ZlXZXn1R3Q0W8wWHGJ5NsqONjrpH8yDFVXBNeIg0ic2e7ihv1/kX/ci7y8pwR3NvVFoR67c+8jq9Xf6KpM1W06+kvf33Mm3YNqWw7cJwk7mq6tMblRA5p2/2my462w8N7BjDfTHOr3gTrjcJO7opXe+zYZJx1qDp1H5M89mjzoY4/nZ8kJmstj/nWhcyXN44W7d7GHITbbtD1PKj2c=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Get Template from ID",permalink:"/docs/API-docs/get-template"}},f={},x=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Template from binary"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplatewithbinary"}),"\n",(0,t.jsxs)(a.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(r.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.7884c276.js b/assets/js/fa40969b.7884c276.js new file mode 100644 index 000000000..971c020a1 --- /dev/null +++ b/assets/js/fa40969b.7884c276.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var n=a(85893),l=a(11151),r=a(58219),i=(a(62316),a(51039)),t=a.n(i),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"Create Template",permalink:"/docs/API-docs/createtemplate"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(r.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.f99d92eb.js b/assets/js/fa40969b.f99d92eb.js deleted file mode 100644 index 48ce9a619..000000000 --- a/assets/js/fa40969b.f99d92eb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),r=a(58219),i=(a(62316),a(51039)),t=a.n(i),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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 from ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},f={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(r.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.39fd7480.js b/assets/js/runtime~main.a900e549.js similarity index 92% rename from assets/js/runtime~main.39fd7480.js rename to assets/js/runtime~main.a900e549.js index d5abc859f..182ca753f 100644 --- a/assets/js/runtime~main.39fd7480.js +++ b/assets/js/runtime~main.a900e549.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,r,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(r,d),r},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"dce39788",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"f99d92eb",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"8d7cce01",1344:"d46b86b5",1477:"b31b2642",1512:"7ddd2ec3",1520:"923fd47f",1531:"37f9a006",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"01268790",2121:"c8df990c",2241:"e6e648f1",2245:"cabe9392",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"a018c535",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"ddf2d459",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"125130af",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"af09ba9d",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"9ba37594",7971:"37040646",8055:"27482879",8087:"fd9041fd",8106:"795bb693",8140:"901b2f91",8141:"6478079e",8163:"62506cb5",8468:"1927f21a",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"3287cb7f",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"2b4fb8c8",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"c310197b",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,r,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(r,d),r},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"c7f1852d",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"7884c276",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a5657d8a",1344:"a66a6d3d",1477:"b31b2642",1512:"7ddd2ec3",1520:"538d99ce",1531:"37f9a006",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"ff1818b8",2121:"c8df990c",2241:"e6e648f1",2245:"cabe9392",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"a018c535",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"ddf2d459",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"b310fe5e",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"af09ba9d",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"b2817a74",7971:"37040646",8055:"27482879",8087:"fd9041fd",8106:"67e6c7a4",8140:"901b2f91",8141:"6478079e",8163:"8cdfa423",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"3287cb7f",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"2b4fb8c8",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"c310197b",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 9ab059aa4..790fc03ca 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 e4bea044c..5447666c1 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 1ae7d4d2f..9c31749cc 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 9de4a4c9c..c20ead47e 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 410bb14b6..2701b52f2 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 7a9c0d032..bf12de939 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 d45b4a51f..11c4a2230 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 4da908e65..b3dc4efbe 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 a039b388f..0149ae07c 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 91a51f005..29b607d23 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 9dd9c347b..5d2bc11f6 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 4440dc87e..d64a4f177 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 25b83cb3d..9eb601244 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,11 +5,11 @@ Create Document | OpenSign™ - + -

Create Document

+

Create Document

POST 

/createdocument

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

Request

diff --git a/docs/API-docs/createdocumentwithbinary/index.html b/docs/API-docs/createdocumentwithbinary/index.html index 148ebb6d6..bed0eeacb 100644 --- a/docs/API-docs/createdocumentwithbinary/index.html +++ b/docs/API-docs/createdocumentwithbinary/index.html @@ -5,11 +5,11 @@ Create Document from binary | OpenSign™ - + -

Create Document from binary

+

Create Document from binary

POST 

/createdocumentwithbinary

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

Request

diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index a8a272e55..fec2a5512 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,16 +5,16 @@ Create Document from Template | OpenSign™ - + -

Create Document from Template

+

Create Document from Template

POST 

/createdocument/:template_id

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

Request

Path Parameters

    template_id stringrequired

    objectId of Template

Body

required

    signers

    object[]

  • Array [

  • role string
    email mail
    name string
    phone string
  • ]

-

Responses

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

Schema

    objectId string
    url string
    message string
Loading...
+

Responses

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

Schema

    objectId string
    url string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 81614b3e7..43fd5bb5a 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,11 +5,11 @@ Create Template | OpenSign™ - + -

Create Template

+

Create Template

POST 

/createtemplate

The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique template_id that can be used to generate documents based on the specified template and url to edit template.

Request

diff --git a/docs/API-docs/createtemplatewithbinary/index.html b/docs/API-docs/createtemplatewithbinary/index.html index 93c63d9eb..511761572 100644 --- a/docs/API-docs/createtemplatewithbinary/index.html +++ b/docs/API-docs/createtemplatewithbinary/index.html @@ -5,15 +5,15 @@ Create Template from binary | OpenSign™ - + -

Create Template from binary

+

Create Template from binary

POST 

/createtemplatewithbinary

The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique template_id that can be used to generate documents based on the specified template and url to edit template.

Request

Body

required

    file binary
    title string
    description string
    note string
    signers array
-

Responses

Template created successfully!

Schema

    objectId number
    url string
Loading...
+

Responses

Template created successfully!

Schema

    objectId number
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index df66196a1..f219388a0 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -3,17 +3,17 @@ -Delete Template from ID | OpenSign™ +Delete Template | OpenSign™ - + -

Delete Template from ID

+

Delete Template

DELETE 

/template/:template_id

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

-

Request

+

Request

Path Parameters

    template_id stringrequired

    ID of the template that needs to be deleted

-

Responses

Template deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
+

Responses

Template deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index 2616403eb..3cdf5ed7c 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 f189bddd5..14d2bba2d 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 89a261c4d..69760f583 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -3,17 +3,17 @@ -Delete Document from ID | OpenSign™ +Delete Document | OpenSign™ - + -

Delete Document from ID

+

Delete Document

DELETE 

/document/:document_id

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

Request

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

-

Responses

Document deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
+

Responses

Document deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index e1c898bef..d4ac69e74 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -3,17 +3,17 @@ -Get Template from ID | OpenSign™ +Get Template | OpenSign™ - + -

Get Template from ID

+

Get Template

GET 

/template/:template_id

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

Request

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Responses

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
Loading...
+

Responses

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 2dc1ff904..11ce83a5d 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 52e6a6a0e..de672ff53 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 6aa8a2deb..1bdbf302b 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 0aae94fa6..89a5030df 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -3,17 +3,17 @@ -Get Document from ID | OpenSign™ +Get Document | OpenSign™ - + -

Get Document from ID

+

Get Document

GET 

/document/:document_id

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

Request

-

Path Parameters

    document_id stringrequired

    objectId of contact

-

Responses

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
Loading...
+

Path Parameters

    document_id stringrequired

    objectId of Document

+

Responses

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 7c8a1cbb7..2b7625112 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,11 +5,11 @@ Get Document list from status | OpenSign™ - + -

Get Document list from status

+

Get Document list from status

GET 

/documentlist/:doctype

Document Types:

Retrieve a list of documents based on type

@@ -54,6 +54,6 @@

Request

Path Parameters

    doctype stringrequired

    Possible values: [draftdocuments, signaturerequest, inprogressdocuments, completedocuments, expiredocuments, declinedocuments]

    The type of documents to retrieve

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses

successful operation

Schema

    result

    document[]

  • Array [

  • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
  • ]

Loading...
+

Responses

successful operation

Schema

    result

    document[]

  • Array [

  • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 54f7ff7b3..bbe69844b 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,15 +5,15 @@ Get Template list | OpenSign™ - + -

Get Template list

+

Get Template list

GET 

/templatelist

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.

Request

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses

successful operation

Schema

    result

    template[]

  • Array [

  • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
  • ]

Loading...
+

Responses

successful operation

Schema

    result

    template[]

  • Array [

  • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

  • Name string
  • ]

  • createdAt date
    updatedAt date
  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index a3c485672..3800ffbc6 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 4489d688e..69d671273 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index f9aa0bf78..25b57500c 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 04900843b..200ea390d 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -3,18 +3,18 @@ -Update Document from ID | OpenSign™ +Update Document | OpenSign™ - + -

Update Document from ID

+

Update Document

PUT 

/document/:document_id

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

Request

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

Body

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

    name string
    note string
    description string
    folderId string
-

Responses

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
+

Responses

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 269114082..2b2946dcb 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -3,18 +3,18 @@ -Update Template from ID | OpenSign™ +Update Template | OpenSign™ - + -

Update Template from ID

+

Update Template

PUT 

/template/:template_id

The Update Template API enables you to modify and update the details of a specific template.

Request

Path Parameters

    template_id stringrequired

    ID of the template that needs to be updated

Body

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

    name string
    note string
    description string
    folderId string
-

Responses

Template updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
+

Responses

Template updated successfully!

Schema

    objectId string
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index c6a303b2d..bb51a2182 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 e6e698b22..45242c9f0 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 746baee3e..06b24b9b2 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 5eb020e39..93a704c09 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 206b4d301..825623681 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 cf3eedb4f..e96c185d7 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 1df2b625c..277209f79 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 04bfc29f7..13428cc6c 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 418b8e8e0..786c0ff1d 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATON INSTRUCTIONS | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index fec9f8d71..2142adaa3 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 917fb119b..ec21d8665 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 375e7de2e..24b6cff38 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 45fe1e176..b8bbb53df 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 ccde2da9f..5170c0a22 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 191d244f3..d98a6c8f6 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 17aee9bd0..60399cae2 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 8aaf454e7..811556c34 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 1a5556345..63837e41f 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 c68ad722f..6275bbae8 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 f02d7f48b..538c41309 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 92449d174..1eb491a1a 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 6570837bf..03120d63a 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 e4d953c18..acd5fbd8d 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 2fda74112..556f8ef1d 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 9ef770cd9..647c36f54 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Settings/profile/index.html b/docs/help/Settings/profile/index.html index 7bf3bf551..ad857d917 100644 --- a/docs/help/Settings/profile/index.html +++ b/docs/help/Settings/profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index 0c138dd9b..6801f3665 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 50fe0875c..3048806c1 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 aec2592f5..e5365df84 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 6ebf5a50e..795c7a980 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 2367942f2..ba77c0562 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 564b83062..7be2c3554 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index b0e713960..aeeda2121 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost Setup with Docker | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 7621b6935..491a9e489 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 ec6e7f2ee..b1ce9c68d 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index f2d0ad44b..656cf1a96 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +