From c65d3cecf43fccd545a5b2ccc8cb44c46318e4d5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 17 Jan 2024 06:27:11 +0000 Subject: [PATCH] deploy: 2aebceda24e6aac58dbe9b6bf93f90c69713129f --- 404.html | 2 +- assets/js/05632a52.72ce6921.js | 1 - assets/js/05632a52.a139a053.js | 1 + assets/js/1f73ca32.6b4bf0ac.js | 1 - assets/js/1f73ca32.760fabc2.js | 1 + assets/js/2c586be5.073fe3de.js | 1 + assets/js/2c586be5.1277174c.js | 1 - assets/js/377084eb.951fd941.js | 1 + assets/js/377084eb.9a14b681.js | 1 - assets/js/52d5c0f9.13bbb31c.js | 1 + assets/js/52d5c0f9.2021ef58.js | 1 - assets/js/5a2de241.017914b9.js | 1 + assets/js/5a2de241.5942955c.js | 1 - assets/js/770b40a9.795c8a7a.js | 1 - assets/js/770b40a9.e45522a5.js | 1 + assets/js/7b076186.36b0ee4c.js | 1 - assets/js/7b076186.496e8402.js | 1 + assets/js/8a725248.350b9d87.js | 1 + assets/js/8a725248.7a441f87.js | 1 - assets/js/a2bc1463.96daf7b3.js | 1 - assets/js/a2bc1463.b1ad234a.js | 1 + assets/js/a88a3db3.18fa1b31.js | 1 + assets/js/a88a3db3.3e8883fd.js | 1 - assets/js/bbdfc22d.b692819f.js | 1 + assets/js/bbdfc22d.ec04bb2d.js | 1 - assets/js/bfe4b778.505e4272.js | 1 + assets/js/bfe4b778.edb497d1.js | 1 - assets/js/f0ff4a36.d8bbcdae.js | 1 - assets/js/f0ff4a36.ef830ef8.js | 1 + assets/js/fa40969b.adc233e1.js | 1 + assets/js/fa40969b.d78cd316.js | 1 - .../js/{runtime~main.29615506.js => runtime~main.2e73fb7f.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 3 +-- docs/API-docs/createcontact/index.html | 3 +-- docs/API-docs/createdocument/index.html | 3 +-- docs/API-docs/createtemplate/index.html | 3 +-- docs/API-docs/delete-template/index.html | 3 +-- docs/API-docs/deletecontact/index.html | 3 +-- docs/API-docs/deletedocument/index.html | 3 +-- docs/API-docs/get-template/index.html | 3 +-- docs/API-docs/get-user/index.html | 3 +-- docs/API-docs/getcontact/index.html | 3 +-- docs/API-docs/getdocument/index.html | 3 +-- docs/API-docs/getdocumentlist/index.html | 3 +-- docs/API-docs/gettemplatelist/index.html | 3 +-- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/update-document/index.html | 3 +-- docs/API-docs/update-template/index.html | 3 +-- docs/category/tutorial---basics/index.html | 2 +- docs/category/tutorial---extras/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- docs/self-host/intro/index.html | 2 +- docs/self-host/tutorial-basics/congratulations/index.html | 2 +- docs/self-host/tutorial-basics/create-a-blog-post/index.html | 2 +- docs/self-host/tutorial-basics/create-a-document/index.html | 2 +- docs/self-host/tutorial-basics/create-a-page/index.html | 2 +- docs/self-host/tutorial-basics/deploy-your-site/index.html | 2 +- docs/self-host/tutorial-basics/markdown-features/index.html | 2 +- docs/self-host/tutorial-extras/manage-docs-versions/index.html | 2 +- docs/self-host/tutorial-extras/translate-your-site/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 82 files changed, 67 insertions(+), 82 deletions(-) delete mode 100644 assets/js/05632a52.72ce6921.js create mode 100644 assets/js/05632a52.a139a053.js delete mode 100644 assets/js/1f73ca32.6b4bf0ac.js create mode 100644 assets/js/1f73ca32.760fabc2.js create mode 100644 assets/js/2c586be5.073fe3de.js delete mode 100644 assets/js/2c586be5.1277174c.js create mode 100644 assets/js/377084eb.951fd941.js delete mode 100644 assets/js/377084eb.9a14b681.js create mode 100644 assets/js/52d5c0f9.13bbb31c.js delete mode 100644 assets/js/52d5c0f9.2021ef58.js create mode 100644 assets/js/5a2de241.017914b9.js delete mode 100644 assets/js/5a2de241.5942955c.js delete mode 100644 assets/js/770b40a9.795c8a7a.js create mode 100644 assets/js/770b40a9.e45522a5.js delete mode 100644 assets/js/7b076186.36b0ee4c.js create mode 100644 assets/js/7b076186.496e8402.js create mode 100644 assets/js/8a725248.350b9d87.js delete mode 100644 assets/js/8a725248.7a441f87.js delete mode 100644 assets/js/a2bc1463.96daf7b3.js create mode 100644 assets/js/a2bc1463.b1ad234a.js create mode 100644 assets/js/a88a3db3.18fa1b31.js delete mode 100644 assets/js/a88a3db3.3e8883fd.js create mode 100644 assets/js/bbdfc22d.b692819f.js delete mode 100644 assets/js/bbdfc22d.ec04bb2d.js create mode 100644 assets/js/bfe4b778.505e4272.js delete mode 100644 assets/js/bfe4b778.edb497d1.js delete mode 100644 assets/js/f0ff4a36.d8bbcdae.js create mode 100644 assets/js/f0ff4a36.ef830ef8.js create mode 100644 assets/js/fa40969b.adc233e1.js delete mode 100644 assets/js/fa40969b.d78cd316.js rename assets/js/{runtime~main.29615506.js => runtime~main.2e73fb7f.js} (88%) diff --git a/404.html b/404.html index ce1362613..4fd57d584 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.72ce6921.js b/assets/js/05632a52.72ce6921.js deleted file mode 100644 index de723d2fd..000000000 --- a/assets/js/05632a52.72ce6921.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),c=s.n(n),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaW5tIu3u7K8fG6L+XWUm2HDttc4QDY1u78/LM26PZgOMLC/EtfFLS8dRZmAWQoU2N0E4oCTHc5Mgu0LFWgp1dXzJeFOrJsrWqmFPMoDMCl8gydFwUlvFEVY5xZjWmYi5Slja6QwhAaTScTF9mEMMCXXsHAWhueIkODSHagOQlQgyrAddi4NQjSghAEKQceYYGAjD4rRIGM4idqTAA69YF6VhR6gIhAFzpQmUI8ZwXlgTSHEsO8QbcWntJZ4RcQE2i3CvFBFFasZDD1Wq1gjrYQmmh3ousQ6K5y+F5xlTygKm7zJias110b4Y1gLkyJXf9kx14/fsoydNxrhOo6xm5tVpJi5YMjaOIfvbh2ipN0dp5VbBtcSDwwaJ0JM+1LkTqL8IHS0qbQ3RN1FRGQ2acaFx2yXh1HPkoyVfjB021+erz/zoDDwpZgkjq5yUXxXfoJ4gf24NhqkoydZ0r+Wook9HpaOw/ZCI1yB1mZ+6YmZ3SOBqfDkbRIPr5ZvQhnvwSv/8wjKLobwhgVfpo2q7MuPNROuGK/nOlsx/gp34u1nZ8ywV9hW4W6pq0JtHksBc7kpHKsbmqZPbT23UiGqPMv+fiiPu6F4CQhZB4343U/SSa3I+34bw/DOdSLnkhMs+ZN8RgPzacvnvXuD+sl2iEGoLdC7Z/3gRpMa2McGvPz31ijm9nRDYluly1vO4J3eUQQ9gWPtzsCLQGsmaWHdlXpiBid07bOAyt4wshFwOu9bBj44InlqYw5FqEyxGQvw7PlHLWpGUP1TY5XIvPuIbgv18qFKaQc+WV21RcaZRTsZA+kcvRAeHf5MIyYf11ptKqROl8UdlcGfZMmyXcYsaUZC5Hf0nnp8PR9nXpVYfsTt7JqSqRVRaJnAshH218Jwfs9mo+F6ngBfsLEysczt51mXt6ejrI2InXuRAurxJmUKud+MIf+rT2tbYPJxCAQ1Paq/kUzVKk2FbpBVehFw7bLqdhp05t6Lc7+vhcibquEClKi72+PLu4/sJOhxEEveb4H5DDL5efzr9Oz8kqtVdTotEwGkZ0pJV1JZc9R7Tc7F7Te5Xd7Ib1rfegtjEdrlyoCy787PlAN+3c3MIOVdxbPWYB5Mo6EthsqJn+NEVd0/G3Cg3N5iyAJTeCJ9S9txvIhKX/2Xa1eDHId3+0W8oJO77FHIXdDZmkCVvyoqInCOAR1/tbUz2rg27QvhvYSygab/uTvQVDW1wjcJamqF3v7oCE95js4vwGAuAVVaRPJ4+eTto/FMvRJOyjaQDQN8E5qvArtdVnXP+2FW9uXlTY7sKNNKViVtf1P8DFAqM=",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/getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaW5tIu3u7K8fG6L+XWUm2HDttc4QDY1u78/LM26PZgOMLC/EtfFLS8dRZmAWQoU2N0E4oCTHc5Mgu0LFWgp1dXzJeFOrJsrWqmFPMoDMCl8gydFwUlvFEVY5xZjWmYi5Slja6QwhAaTScTF9mEMMCXXsHAWhueIkODSHagOQlQgyrAddi4NQjSghAEKQceYYGAjD4rRIGM4idqTAA69YF6VhR6gIhAFzpQmUI8ZwXlgTSHEsO8QbcWntJZ4RcQE2i3CvFBFFasZDD1Wq1gjrYQmmh3ousQ6K5y+F5xlTygKm7zJias110b4Y1gLkyJXf9kx14/fsoydNxrhOo6xm5tVpJi5YMjaOIfvbh2ipN0dp5VbBtcSDwwaJ0JM+1LkTqL8IHS0qbQ3RN1FRGQ2acaFx2yXh1HPkoyVfjB021+erz/zoDDwpZgkjq5yUXxXfoJ4gf24NhqkoydZ0r+Wook9HpaOw/ZCI1yB1mZ+6YmZ3SOBqfDkbRIPr5ZvQhnvwSv/8wjKLobwhgVfpo2q7MuPNROuGK/nOlsx/gp34u1nZ8ywV9hW4W6pq0JtHksBc7kpHKsbmqZPbT23UiGqPMv+fiiPu6F4CQhZB4343U/SSa3I+34bw/DOdSLnkhMs+ZN8RgPzacvnvXuD+sl2iEGoLdC7Z/3gRpMa2McGvPz31ijm9nRDYluly1vO4J3eUQQ9gWPtzsCLQGsmaWHdlXpiBid07bOAyt4wshFwOu9bBj44InlqYw5FqEyxGQvw7PlHLWpGUP1TY5XIvPuIbgv18qFKaQc+WV21RcaZRTsZA+kcvRAeHf5MIyYf11ptKqROl8UdlcGfZMmyXcYsaUZC5Hf0nnp8PR9nXpVYfsTt7JqSqRVRaJnAshH218Jwfs9mo+F6ngBfsLEysczt51mXt6ejrI2InXuRAurxJmUKud+MIf+rT2tbYPJxCAQ1Paq/kUzVKk2FbpBVehFw7bLqdhp05t6Lc7+vhcibquEClKi72+PLu4/sJOhxEEveb4H5DDL5efzr9Oz8kqtVdTotEwGkZ0pJV1JZc9R7Tc7F7Te5Xd7Ib1rfegtjEdrlyoCy787PlAN+3c3MIOVdxbPWYB5Mo6EthsqJn+NEVd0/G3Cg3N5iyAJTeCJ9S9txvIhKX/2Xa1eDHId3+0W8oJO77FHIXdDZmkCVvyoqInCOAR1/tbUz2rg27QvhvYSygab/uTvQVDW1wjcJamqF3v7oCE95js4vwGAuAVVaRPJ4+eTto/FMvRJOyjaQDQN8E5qvArtdVnXP+2FW9uXlTY7sKNNKViVtf1P8DFAqM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact"})}),"\n",(0,t.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.a139a053.js b/assets/js/05632a52.a139a053.js new file mode 100644 index 000000000..608f031ef --- /dev/null +++ b/assets/js/05632a52.a139a053.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>I,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),c=s.n(i),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsa2ZeeZt5xntFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Fuzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4ub7MIIYluk4HAWhueIUODWW0BckrhBg6/b3IIABBGWnuCniepkoeMHWXGVM527s0+K0WBjOInakxAOs2JTm1otIlQgC41qXKEOKcl5YM0gIrDvEW3EZ7S2eEXEIAuTIVd0MJrrn3EoP+fZIU6bTQCTTNgsJaraRFS46mUUQ/h+naOk3R2rwu2a4jEPhiUTqy51qXIvWK8MESaHucXVs19c6QGyfakH0z3lxHMUmK9fRBQxPAV9//tzl4UMgSRIKfV1yU/wOfIH7sBONUVeTqulDyzanMJqeTqf+Qi9Qgd5iduZfc7EHTaHo6mkSj6OebyYd49kv8/sM4iqK/IYB15avppjLjzlfphCuHz7XOfkCc5rlZN/EdAYeAngtNQ6hZNDuexZ7ZUjmWq1pmP32/SURjlPn3XrwQvhkUIGQpJN73lLqfRbP76a6c98flXMoVL0XmF9WNekT5Y8sZhndt+OPzEq2R18NBsUN5W6TFtDbCbfxSXI+4FqNWH98uaNlU6ArVLVO/RV0BMYTdwYfb/QJtgLyZVb9ha1NCDIVz2sZhaB1fCrkcca3HSqO0YilLnlhiYci1CFcToHh9PnPqWduWg6x2zeFafMYNBH3RQ6tulRfIMzS+QULmyoO7VlxplHOxlL6Rq8nRwr8phGXCenWm0rpC6fyhslwZ9gzNEm4xY0oyV6BXkvx0PNm9ozx0zO7knZyrClltkZZzKeSjje/kiN1e5blIBS/ZX5hY4XDxru/c09PTUcdOPOZCuKJOmEGt9uZLL/RtHaJ2DycQgENT2at8jmYlUuxO6ZVQoTcOuyknstOktuu3F318DqKpK0WK0uJgLs8urr+w03EEwWA4/kPK4ZfLT+df5+fklcarPaLJOBpHJNLKuorLQSC6Uexf0wcnu92T9XtfPrrBdLh2oS658NzzhW473tzCPqt4cPVYBFAo68hgu6Vh+tOUTUPibzUa4uYigBU3gic0vbdbyISl/9nuavFqke/+6G4pJ+zlW8yLafckk8SwFS9reoIAHnFzeGtqFk3QE40Saw3O0hS1G0CP1uLBbrk4v4EAeE09GhL80RO8+0PeX0zrkPltAvTdBK8AfqWD/oyb33bmreZVQFdfb00tWjRN8w/aK65e",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/getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsa2ZeeZt5xntFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Fuzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4ub7MIIYluk4HAWhueIUODWW0BckrhBg6/b3IIABBGWnuCniepkoeMHWXGVM527s0+K0WBjOInakxAOs2JTm1otIlQgC41qXKEOKcl5YM0gIrDvEW3EZ7S2eEXEIAuTIVd0MJrrn3EoP+fZIU6bTQCTTNgsJaraRFS46mUUQ/h+naOk3R2rwu2a4jEPhiUTqy51qXIvWK8MESaHucXVs19c6QGyfakH0z3lxHMUmK9fRBQxPAV9//tzl4UMgSRIKfV1yU/wOfIH7sBONUVeTqulDyzanMJqeTqf+Qi9Qgd5iduZfc7EHTaHo6mkSj6OebyYd49kv8/sM4iqK/IYB15avppjLjzlfphCuHz7XOfkCc5rlZN/EdAYeAngtNQ6hZNDuexZ7ZUjmWq1pmP32/SURjlPn3XrwQvhkUIGQpJN73lLqfRbP76a6c98flXMoVL0XmF9WNekT5Y8sZhndt+OPzEq2R18NBsUN5W6TFtDbCbfxSXI+4FqNWH98uaNlU6ArVLVO/RV0BMYTdwYfb/QJtgLyZVb9ha1NCDIVz2sZhaB1fCrkcca3HSqO0YilLnlhiYci1CFcToHh9PnPqWduWg6x2zeFafMYNBH3RQ6tulRfIMzS+QULmyoO7VlxplHOxlL6Rq8nRwr8phGXCenWm0rpC6fyhslwZ9gzNEm4xY0oyV6BXkvx0PNm9ozx0zO7knZyrClltkZZzKeSjje/kiN1e5blIBS/ZX5hY4XDxru/c09PTUcdOPOZCuKJOmEGt9uZLL/RtHaJ2DycQgENT2at8jmYlUuxO6ZVQoTcOuyknstOktuu3F318DqKpK0WK0uJgLs8urr+w03EEwWA4/kPK4ZfLT+df5+fklcarPaLJOBpHJNLKuorLQSC6Uexf0wcnu92T9XtfPrrBdLh2oS658NzzhW473tzCPqt4cPVYBFAo68hgu6Vh+tOUTUPibzUa4uYigBU3gic0vbdbyISl/9nuavFqke/+6G4pJ+zlW8yLafckk8SwFS9reoIAHnFzeGtqFk3QE40Saw3O0hS1G0CP1uLBbrk4v4EAeE09GhL80RO8+0PeX0zrkPltAvTdBK8AfqWD/oyb33bmreZVQFdfb00tWjRN8w/aK65e",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete contact",permalink:"/docs/API-docs/deletecontact"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact"})}),"\n",(0,t.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function I(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.6b4bf0ac.js b/assets/js/1f73ca32.6b4bf0ac.js deleted file mode 100644 index 2648b2283..000000000 --- a/assets/js/1f73ca32.6b4bf0ac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),c=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZbtNN2EYWhWZEbSognmBAOWGAUtnW0mEsmSJ8eG4f8+HCU5it1syzD0iy3d3XNvvHvEDZCce0hu4cajg0kEGfrUKUvKaEjgeoFihCRYK06vzgVqOc3Ri7UpBRkxR+JHJ8yjFhmSVLnvQgTGopPs4zyDBOZIwX0EVjpZIKHjmBvQskBIYNWRVnXIPKCGCBQHXqDMAsLh11I5zCAhV2IEntY5Y7wqbI4QAa5sbjKEZCZzzwbpAgsJyQZobYMlOaXnsGVTGUAJ56e9muvuarVawXbCcbw12qNn5CCO+e95L8ZlmqL3szIXu/IggtRoQk1sL63NVRoUvXvPoM1hOmZ6jylxLxy7IVWFrMTcrv3EI5gZV0hqS54q+W2kHgbD6eLmgiv8HBr6Og8XBsWviAw/K6TKX4u/NzhFfF8Luqkp2NXVwuhXp3L89uTdj8NBfzBkFxdmeq0of7WXDJcM/2AKK/X6tehmNNhF6lASZqf0LSdPkEE8GHb6cSd+d90/SY5/St6edOM4/hMiWBWhn/WgZ5JCn6kqa/de2uw7xNnum5W8lC2z6n3Lhsfx8eEGBBbQhsTMlDr74f8bfnTOuL+vfT/2tpW30rnS+KVZ4S+cfFPG28MyzvVS5ioLfHbNpPN9K2mHpyr84dGoyqjixGeltuVVkR7T0ilaB0ptc2lyO2FqK5AWpubhwMG0gAR6c6SyYmWPbtlQculypl8i65Nez5OcKz3vSGu7zWLkcup5y3vSqt6yH9izSWHMbao68SyRXT+kVR9xDdE/Uz9XpvTMBHBd/aVFPVZzHXq37MPh50p5oXxQZyYtC9QUzlHMjBN7aDGVHjNhtKAFBiXLh92+8BZTNatHoCvu9J0emwJF6ZHZP1f6wSd3uiNuL2czlSqZiz9w6hXh5E3TucfHx4OOHQXMSNGinAqH1jyZz4MwtLWN2r0cQQSErvCXszG6pUqxPqUXQvWCca8ebJmGwcaK3hvR+30QD1quUtQeW6N4Orr6JIbdGKLWcPyLlHufzj+cfR6fsVcer+qI+t24G7PIGk+F1K1Ao+YyUV8k9o9387Sk//liUo8h4Yp6NpcqLFcoa1Mvxi00izGJYGE8sWiz4WG5cfl2y+KvJTpet0kES+kURw7LFjXDy5uUKc+KbHczebGYN7/Xl5wj8VKKD7g+2JalzEu2hG20qQ1O0xQttXQHXPaMEEZn1xCBLLnu9oo+hBWtH7iWRqXXLd/Ps6kS4F9O55uAn/mgPuL6l515pXkRsLsFVtbcisl2u/0LzPqaMw==",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-user",title:"Get your details",description:"The Get User API enables you to get your own details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZbtNN2EYWhWZEbSognmBAOWGAUtnW0mEsmSJ8eG4f8+HCU5it1syzD0iy3d3XNvvHvEDZCce0hu4cajg0kEGfrUKUvKaEjgeoFihCRYK06vzgVqOc3Ri7UpBRkxR+JHJ8yjFhmSVLnvQgTGopPs4zyDBOZIwX0EVjpZIKHjmBvQskBIYNWRVnXIPKCGCBQHXqDMAsLh11I5zCAhV2IEntY5Y7wqbI4QAa5sbjKEZCZzzwbpAgsJyQZobYMlOaXnsGVTGUAJ56e9muvuarVawXbCcbw12qNn5CCO+e95L8ZlmqL3szIXu/IggtRoQk1sL63NVRoUvXvPoM1hOmZ6jylxLxy7IVWFrMTcrv3EI5gZV0hqS54q+W2kHgbD6eLmgiv8HBr6Og8XBsWviAw/K6TKX4u/NzhFfF8Luqkp2NXVwuhXp3L89uTdj8NBfzBkFxdmeq0of7WXDJcM/2AKK/X6tehmNNhF6lASZqf0LSdPkEE8GHb6cSd+d90/SY5/St6edOM4/hMiWBWhn/WgZ5JCn6kqa/de2uw7xNnum5W8lC2z6n3Lhsfx8eEGBBbQhsTMlDr74f8bfnTOuL+vfT/2tpW30rnS+KVZ4S+cfFPG28MyzvVS5ioLfHbNpPN9K2mHpyr84dGoyqjixGeltuVVkR7T0ilaB0ptc2lyO2FqK5AWpubhwMG0gAR6c6SyYmWPbtlQculypl8i65Nez5OcKz3vSGu7zWLkcup5y3vSqt6yH9izSWHMbao68SyRXT+kVR9xDdE/Uz9XpvTMBHBd/aVFPVZzHXq37MPh50p5oXxQZyYtC9QUzlHMjBN7aDGVHjNhtKAFBiXLh92+8BZTNatHoCvu9J0emwJF6ZHZP1f6wSd3uiNuL2czlSqZiz9w6hXh5E3TucfHx4OOHQXMSNGinAqH1jyZz4MwtLWN2r0cQQSErvCXszG6pUqxPqUXQvWCca8ebJmGwcaK3hvR+30QD1quUtQeW6N4Orr6JIbdGKLWcPyLlHufzj+cfR6fsVcer+qI+t24G7PIGk+F1K1Ao+YyUV8k9o9387Sk//liUo8h4Yp6NpcqLFcoa1Mvxi00izGJYGE8sWiz4WG5cfl2y+KvJTpet0kES+kURw7LFjXDy5uUKc+KbHczebGYN7/Xl5wj8VKKD7g+2JalzEu2hG20qQ1O0xQttXQHXPaMEEZn1xCBLLnu9oo+hBWtH7iWRqXXLd/Ps6kS4F9O55uAn/mgPuL6l515pXkRsLsFVtbcisl2u/0LzPqaMw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(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",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.760fabc2.js b/assets/js/1f73ca32.760fabc2.js new file mode 100644 index 000000000..e811f64f3 --- /dev/null +++ b/assets/js/1f73ca32.760fabc2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),d=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function j(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.073fe3de.js b/assets/js/2c586be5.073fe3de.js new file mode 100644 index 000000000..360d8614c --- /dev/null +++ b/assets/js/2c586be5.073fe3de.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>h,default:()=>N,frontMatter:()=>u,metadata:()=>f,toc:()=>x});var t=s(85893),i=s(11151),r=s(58219),n=(s(62316),s(51039)),l=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const u={id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGCoG4cBEYC24BU9CALzoockmOTu5vdpR4V+N+LWZI2ZStFCvTWi0TNe76Z+agDeFk4SJZwqdOmRuUdrCLI0KWWjCetIIFFieKDRelRDFbi4vZKyKrSWycah9YJr0WBCi1bKdyKbIgn1nthrN5QRqoQmfRS+NLqpijF17qpPBlpfZxrW09Y+XUqFiU5kVe4o3WFokZf6mxIlmsrfImCVFo1jrQSOhcbaUk3rg++N+giUctHzkdeuIa85EjsK8WWMhRWqgLZdShTpNwgx3MpKo7nphCBNtwRaXWVQQLBBgcXiMDitwad/11ne0gOkGrlWZEc4ERnLHZpiXV44jIhAb1+wJRDGcu5PKFjbU4Vjqyct6QKiICDSQ8JrElJu4c2gmtZnzBtI7gcD/GE/lr7045zKhRaN9JJa+UeIiCPtTvh07YRePJc8wuQ7teMTTBgsMhiBom3DQaBM1q5ruPz2Yy/jjfv8mg6mAnXpCk6lzdVtf8JojHi0piK0jCs+MF1Pf8o3J2YZ/wPkD9JcCdrE3otH+j8r126Ob9l3Bpb/esA3huXxHEvmaa6hjGYpCpSeD8gdX8+m92fMZxtBL/Mfn2N2JXayIqycJ8L/YjqP0QJrdX2VIfP/YzT+y49l7qrAzIqrCpQZxT0cNTsWN416TBtLPk9JMsD7CbS0KTTJ8tVu4qgYwdIwGgXKpa+hATiV6fq0G7CUi8P3aCesHdeFqSKiTRmqg0qR4Wq5NrxMGJpKN6cAacaSpkzXB0iRwU9X4uhz8jn0vc7toqAeEwlygxtwIZUroNzj8KNQcUXGDDcnMFrNiYnyAX10F/HXMxvL7zFWjrMhFaBNFnJ8rfTM+EMppT3qzAVd+pOzXWNzOZ5U4mK1KNL7tRELG/ynFKSlfgT1448rn4ekNtut68QexN8PpEvm7WwaPSzeRGEAdax19OPNxCBR1u7m3yOdkPpcCHfSRUH47hfcJmGBcdaEk+3F/320okXrqIUlcPRSl58uv0i3k5nEI2W4wdKjr9cffh4Pf/IUXm9uhGdTWfTGYt4KWupRon69+hoMbNjmn661f/za7c/JI87H5tKkhrRa3fhy5cv41UEJVNAsoTDgbf+D1u1LYu/NWiZP1YRcMVcU2CPaLhCpoRH3PN0OvAnC87P5lXDdZx6mbfR4HSRpmj8yPwVxx4R1e3NfAERrPv/DLXO2IcDh7jR82NXpGy43zG5PAZy6R+4+EGl9qMqjlmnK5U/ufCTDu94uT7j/v2Teaf5rkMP32DNU1q1bfs3m/CYiw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={id:"API-docs/createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGCoG4cBEYC24BU9CALzoockmOTu5vdpR4V+N+LWZI2ZStFCvTWi0TNe76Z+agDeFk4SJZwqdOmRuUdrCLI0KWWjCetIIFFieKDRelRDFbi4vZKyKrSWycah9YJr0WBCi1bKdyKbIgn1nthrN5QRqoQmfRS+NLqpijF17qpPBlpfZxrW09Y+XUqFiU5kVe4o3WFokZf6mxIlmsrfImCVFo1jrQSOhcbaUk3rg++N+giUctHzkdeuIa85EjsK8WWMhRWqgLZdShTpNwgx3MpKo7nphCBNtwRaXWVQQLBBgcXiMDitwad/11ne0gOkGrlWZEc4ERnLHZpiXV44jIhAb1+wJRDGcu5PKFjbU4Vjqyct6QKiICDSQ8JrElJu4c2gmtZnzBtI7gcD/GE/lr7045zKhRaN9JJa+UeIiCPtTvh07YRePJc8wuQ7teMTTBgsMhiBom3DQaBM1q5ruPz2Yy/jjfv8mg6mAnXpCk6lzdVtf8JojHi0piK0jCs+MF1Pf8o3J2YZ/wPkD9JcCdrE3otH+j8r126Ob9l3Bpb/esA3huXxHEvmaa6hjGYpCpSeD8gdX8+m92fMZxtBL/Mfn2N2JXayIqycJ8L/YjqP0QJrdX2VIfP/YzT+y49l7qrAzIqrCpQZxT0cNTsWN416TBtLPk9JMsD7CbS0KTTJ8tVu4qgYwdIwGgXKpa+hATiV6fq0G7CUi8P3aCesHdeFqSKiTRmqg0qR4Wq5NrxMGJpKN6cAacaSpkzXB0iRwU9X4uhz8jn0vc7toqAeEwlygxtwIZUroNzj8KNQcUXGDDcnMFrNiYnyAX10F/HXMxvL7zFWjrMhFaBNFnJ8rfTM+EMppT3qzAVd+pOzXWNzOZ5U4mK1KNL7tRELG/ynFKSlfgT1448rn4ekNtut68QexN8PpEvm7WwaPSzeRGEAdax19OPNxCBR1u7m3yOdkPpcCHfSRUH47hfcJmGBcdaEk+3F/320okXrqIUlcPRSl58uv0i3k5nEI2W4wdKjr9cffh4Pf/IUXm9uhGdTWfTGYt4KWupRon69+hoMbNjmn661f/za7c/JI87H5tKkhrRa3fhy5cv41UEJVNAsoTDgbf+D1u1LYu/NWiZP1YRcMVcU2CPaLhCpoRH3PN0OvAnC87P5lXDdZx6mbfR4HSRpmj8yPwVxx4R1e3NfAERrPv/DLXO2IcDh7jR82NXpGy43zG5PAZy6R+4+EGl9qMqjlmnK5U/ufCTDu94uT7j/v2Teaf5rkMP32DNU1q1bfs3m/CYiw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},j={},x=[{value:"Request",id:"request",level:2}];function g(e){const a={code:"code",h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create document"})}),"\n",(0,t.jsx)(l(),{method:"post",path:"/createdocument"}),"\n",(0,t.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,t.jsx)(a.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,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)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\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:"Document 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)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.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)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function N(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.1277174c.js b/assets/js/2c586be5.1277174c.js deleted file mode 100644 index 9b885657d..000000000 --- a/assets/js/2c586be5.1277174c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>w,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var i=a(85893),n=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),o=(a(82723),a(9487)),c=a(41429),d=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv4zYQ/ivsnDaAYjvZ9iIURdNksQh2kQTrFD0kRpaWRtYkFMklKT9q+L8XQ0m2HDvtFuitFz/mPR9nPnINQc48pA9wZbK6Qh08TBLI0WeObCCjIYX7EsWlQxlQdFbi4u5aSKXMwovao/MiGDFDjY6tNC5E3sUT05WwzswpJz0TuQxShNKZelaKr1WtAlnpwrAwrjpl5deBuC/Ji0LhkqYKRYWhNHmXrDBOhBIF6UzVnowWphBz6cjUvg2+sugTUckXzkdB+JqC5EjsK8WCchRO6hmya1emyLhBjucz1BzPDyABY7kjMvo6hxSiDXYukICVTlYY0DGEa9CyQkhheSotnQbzghoSIIawRJmjgwQcfqvJYQ5pcDUm4MNKsY+nyiqEBHBplckR0kIqzwZZiZWEdA3cGFsGR3oGGzaV0SnlMrWnmR4sl8slbCZNHvThN5Ov2DczOnDJ6RqOYM7igzxm+oxZbNIxCoHQs7Ygzvi6mgQ4mAyQwpS0dCuu7ybCcaTwq/54HdHfmHDccUwzHcHe6qRzcsUoB6z8EZ/NJoFAIaK0f3xPU8YmGuwfShR4a7RvOj4fjfhrfyeu9uYGc+HrLEPvi1qp1Q+Q9BGX1irK4hgNn33T8/fC3Yh5+v4G8q1kNxHlM53/uczm53eMW+3Uvw4QgvXpcNhKBpmpoA8maUUanzqkns5Ho6czhnOTwI+jnw4Ru9ZzqSiPzHHPu/EfooTOGXesw10//fShSc+lLquITLu51Bg1q7vXbF/eNOkxqx2FVdz8/sqnDxPewIa3IAVrfMMVoYQUhgck4tHNOwaJB7XF3gc5Iz07ldYOuhVXcur5MIbS0nB+Fpe9K2XMcDWI7BW02xZLn5DX5R+ZijskXZjo3KJwa1HzBkYM52dweE+QF+Sjuuuv4VRm3lfeYio95sLoSOesZPn7wZnwFjMq2lEYiEf9qMemQr5niloJRfrFp4/6VDzcFgVlJJX4A6eeAk7edcgtFosDxE6iz0cKZT0VDq3Zmc+iMMLa99r+OYEEArrK3xZjdHPKug15I9UwGg/bAZdZHHCsJPHptqJfXzvxwCnKUHvsjeTFx7vP4v1gBElvOL6j5OHn68sPN+MPHJXHqzmis8FoMGIRD2UldS9Re8P3BjPfp+ntrv6fHwTtIgVchqFVknSPXpsNf3j9TJgkUDIFpA+wXvPU/+7UZsPibzU65o9JAlwx1xTZI+m2kCkhJ8+KfPsiePNY3n1p77ET8ValL7g6WPu5VDVbwiZZtwaXTczTe46xszj2dNg5XWQZ2tAzP2D0PVq8ux3fQwLT9oVSxUdPvJJi3GT3s4FE1oxun8peIpW1PxiqTqVXvSr2m21K5U8u/KjDzzzKn3D1y9a80bzpsH3cNdaM9GSz2fwFGf3yKw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv4zYQ/ivsnDaAYjvZ9iIURdNksQh2kQTrFD0kRpaWRtYkFMklKT9q+L8XQ0m2HDvtFuitFz/mPR9nPnINQc48pA9wZbK6Qh08TBLI0WeObCCjIYX7EsWlQxlQdFbi4u5aSKXMwovao/MiGDFDjY6tNC5E3sUT05WwzswpJz0TuQxShNKZelaKr1WtAlnpwrAwrjpl5deBuC/Ji0LhkqYKRYWhNHmXrDBOhBIF6UzVnowWphBz6cjUvg2+sugTUckXzkdB+JqC5EjsK8WCchRO6hmya1emyLhBjucz1BzPDyABY7kjMvo6hxSiDXYukICVTlYY0DGEa9CyQkhheSotnQbzghoSIIawRJmjgwQcfqvJYQ5pcDUm4MNKsY+nyiqEBHBplckR0kIqzwZZiZWEdA3cGFsGR3oGGzaV0SnlMrWnmR4sl8slbCZNHvThN5Ov2DczOnDJ6RqOYM7igzxm+oxZbNIxCoHQs7Ygzvi6mgQ4mAyQwpS0dCuu7ybCcaTwq/54HdHfmHDccUwzHcHe6qRzcsUoB6z8EZ/NJoFAIaK0f3xPU8YmGuwfShR4a7RvOj4fjfhrfyeu9uYGc+HrLEPvi1qp1Q+Q9BGX1irK4hgNn33T8/fC3Yh5+v4G8q1kNxHlM53/uczm53eMW+3Uvw4QgvXpcNhKBpmpoA8maUUanzqkns5Ho6czhnOTwI+jnw4Ru9ZzqSiPzHHPu/EfooTOGXesw10//fShSc+lLquITLu51Bg1q7vXbF/eNOkxqx2FVdz8/sqnDxPewIa3IAVrfMMVoYQUhgck4tHNOwaJB7XF3gc5Iz07ldYOuhVXcur5MIbS0nB+Fpe9K2XMcDWI7BW02xZLn5DX5R+ZijskXZjo3KJwa1HzBkYM52dweE+QF+Sjuuuv4VRm3lfeYio95sLoSOesZPn7wZnwFjMq2lEYiEf9qMemQr5niloJRfrFp4/6VDzcFgVlJJX4A6eeAk7edcgtFosDxE6iz0cKZT0VDq3Zmc+iMMLa99r+OYEEArrK3xZjdHPKug15I9UwGg/bAZdZHHCsJPHptqJfXzvxwCnKUHvsjeTFx7vP4v1gBElvOL6j5OHn68sPN+MPHJXHqzmis8FoMGIRD2UldS9Re8P3BjPfp+ntrv6fHwTtIgVchqFVknSPXpsNf3j9TJgkUDIFpA+wXvPU/+7UZsPibzU65o9JAlwx1xTZI+m2kCkhJ8+KfPsiePNY3n1p77ET8ValL7g6WPu5VDVbwiZZtwaXTczTe46xszj2dNg5XWQZ2tAzP2D0PVq8ux3fQwLT9oVSxUdPvJJi3GT3s4FE1oxun8peIpW1PxiqTqVXvSr2m21K5U8u/KjDzzzKn3D1y9a80bzpsH3cNdaM9GSz2fwFGf3yKw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={code:"code",h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsxs)(s.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(s.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,i.jsx)(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:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.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)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function w(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.951fd941.js b/assets/js/377084eb.951fd941.js new file mode 100644 index 000000000..9f217636a --- /dev/null +++ b/assets/js/377084eb.951fd941.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:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"get-template",title:"Get template by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0BOlJVKiC0scfxgr27tzsORJH/ezXrF3zJHdyH6qR+Sjw7z87rM7MbILn0kNzAHCtbSkIPdxFk6FOnLCmjIYF5geIMSfQq4uTqXMiyNE9erE0tyAiH5BSuUGRIUpVeyIWpSUjhLaYqV6mgDjwZrvHCo1uhkF4syhqtU5q8yI0TqUNJSi9FZtK6QhY/KSqEdZhhrjRmwpOrU6od+glEYCw6yd6eZ5DAEqm3ARFY6WSFhI7D3ICWFUICvTv3KoMIFIdpJRWwHfv5B2HywXlBhSShETPPUS9Q5EhpgXyHw8+1cphBQq7GCDytS7bkVWVLdgSfbWkyhCSXpWeFtMBKQrIBWtugSU7pJUSQG1dJaiV6CU1zx9d7a7RHz4CDOOafL131dZqi93ldiiEfEEFqNKEm1pfWlioNB9MHz6DNrhdm8YApceIcX0OqNdmKOb+v+9tK8FmGqBN4nv2x0JU/uFpCE8FcEUt3r3gB+PBnSDmjLgy9ARoKpE0L+d2UGbrXQXnQEaEjGKLecq0gsj6ZTntrtUc3SU3F6Msn/Za9wcnQ3+bF8rVa6tCfA1o6J9fcmISVf7s4F6GpX7P9YFAsEKFpIqC2CC8c6O3zYfANsxN6/b6D+OBwfxbvxz/PZ8fJ0S/J++NJHMf/QATPVcnYjmhZV8PeaP9d2+wH2Gm21cZttZ0HaBoGHMVHu+SajxpM5KbW2U//HbfQOfNG73zN/riWSpdK430/Je6P4qP74yGg97sBneuVLFUWZvncPKL+sfGMzVNrfrdYqlUK5/BFsGN5G2SFVJhu+oepTwUkMFB1uhlN/AYiCLun2wm1K0fs9iSXSi/3pbUTY1F7tdSlXHhm+lRaNV3NgCeyx7R2itbXnJU28Od9adV+69eIzFb9iczmLqyxVrd7CpQ8rjgQpXMTwF2wlxY1EzSkajXb2VDzQnmhfDju92UoW1ilW2ixkB4zYbSgAsMhyw8ns2FRB+hE3OpbfW0qFLVH3iil0o8+udX74uYyz1WqZCn+xoVXhHfv+sw9PT3tZGwvYM4UFfVCOLTmRX0ZhCGtY9TwsQcRELrKX+bX6FYq7WfwN0xNg/K062OZhj7GSiqubif6dRvEfVWqFLXHUeednF19FIeTGKJRc3yHy9OP57+dXlyf8q3cXm2JZpN4ErPIGk+V1CND/K4a9sJiLc4/bBd488LK/8FLrGt5wmea2lKqwNuQwk3HyZuXeRtBMn6H3UVQGE+sstlwo/7lyqZh8eca3RqSm7sIVtIpuWBm3GwgU57/Z8Ob6puZe/epe57tie9/0n01mJ7Umhm9kmXNXxDBI6633pXNXRP1zGZvW42TNEVLI+zOpOXhMoyzs9M5NM2/nPkBdw==",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 by 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 by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0BOlJVKiC0scfxgr27tzsORJH/ezXrF3zJHdyH6qR+Sjw7z87rM7MbILn0kNzAHCtbSkIPdxFk6FOnLCmjIYF5geIMSfQq4uTqXMiyNE9erE0tyAiH5BSuUGRIUpVeyIWpSUjhLaYqV6mgDjwZrvHCo1uhkF4syhqtU5q8yI0TqUNJSi9FZtK6QhY/KSqEdZhhrjRmwpOrU6od+glEYCw6yd6eZ5DAEqm3ARFY6WSFhI7D3ICWFUICvTv3KoMIFIdpJRWwHfv5B2HywXlBhSShETPPUS9Q5EhpgXyHw8+1cphBQq7GCDytS7bkVWVLdgSfbWkyhCSXpWeFtMBKQrIBWtugSU7pJUSQG1dJaiV6CU1zx9d7a7RHz4CDOOafL131dZqi93ldiiEfEEFqNKEm1pfWlioNB9MHz6DNrhdm8YApceIcX0OqNdmKOb+v+9tK8FmGqBN4nv2x0JU/uFpCE8FcEUt3r3gB+PBnSDmjLgy9ARoKpE0L+d2UGbrXQXnQEaEjGKLecq0gsj6ZTntrtUc3SU3F6Msn/Za9wcnQ3+bF8rVa6tCfA1o6J9fcmISVf7s4F6GpX7P9YFAsEKFpIqC2CC8c6O3zYfANsxN6/b6D+OBwfxbvxz/PZ8fJ0S/J++NJHMf/QATPVcnYjmhZV8PeaP9d2+wH2Gm21cZttZ0HaBoGHMVHu+SajxpM5KbW2U//HbfQOfNG73zN/riWSpdK430/Je6P4qP74yGg97sBneuVLFUWZvncPKL+sfGMzVNrfrdYqlUK5/BFsGN5G2SFVJhu+oepTwUkMFB1uhlN/AYiCLun2wm1K0fs9iSXSi/3pbUTY1F7tdSlXHhm+lRaNV3NgCeyx7R2itbXnJU28Od9adV+69eIzFb9iczmLqyxVrd7CpQ8rjgQpXMTwF2wlxY1EzSkajXb2VDzQnmhfDju92UoW1ilW2ixkB4zYbSgAsMhyw8ns2FRB+hE3OpbfW0qFLVH3iil0o8+udX74uYyz1WqZCn+xoVXhHfv+sw9PT3tZGwvYM4UFfVCOLTmRX0ZhCGtY9TwsQcRELrKX+bX6FYq7WfwN0xNg/K062OZhj7GSiqubif6dRvEfVWqFLXHUeednF19FIeTGKJRc3yHy9OP57+dXlyf8q3cXm2JZpN4ErPIGk+V1CND/K4a9sJiLc4/bBd488LK/8FLrGt5wmea2lKqwNuQwk3HyZuXeRtBMn6H3UVQGE+sstlwo/7lyqZh8eca3RqSm7sIVtIpuWBm3GwgU57/Z8Ob6puZe/epe57tie9/0n01mJ7Umhm9kmXNXxDBI6633pXNXRP1zGZvW42TNEVLI+zOpOXhMoyzs9M5NM2/nPkBdw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"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)(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,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 bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.9a14b681.js b/assets/js/377084eb.9a14b681.js deleted file mode 100644 index b74c0843f..000000000 --- a/assets/js/377084eb.9a14b681.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const u={id:"get-template",title:"Get template by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfWoBxZaTtMP0acHaZcaKpmg8DFgaBLR0sthIJEue/AJD/304ypJVu42LoSiwT7aO9/BenztugeTCQ3IHM6xsKQk93EeQoU+dsqSMhgRmBYprJNGpiKt3UyHL0qy82JhakBEOySlcosiQpCq9kHNTk5DCW0xVrlJBO/Cov8YLj26JQnoxL2u0TmnyIjdOpA4lKb0QmUnrClm8UlQI6zDDXGnMhCdXp1Q79COIwFh0kr2dZpDAAqmzARFY6WSFhI7D3IKWFUIC6zNp1RmZR9QQgeIwC5QZOojA4adaOcwgIVdjBJ42JWO8qmzJV+LaliZDSHJZelZIC6wkJFugjQ2a5JReQMOqMoAS9lF7tdCj9Xq9hibqXeky86CyzhUrqYDDMkxfCZP3eRRUSBIaMfNcgDmKHCktMPueAUSQG1dJaiUcUXPP13trtEfPgPM45p/PXfV1mqL3eV2KvjQQQWo0oSbWl9aWKg0H44+eQdtjL8z8I6bENXR8DanWZCvmUj/tbyvZV2A9+WOuK3/+LlRmpoilx1fsAT786VPOqLeGToD6AmnTQn43JffVk6A86IjQEQxRp1wriKxPxuPOWu3RjVJTMfpmpU/Z650MVDN7y7dqoQNVerR0Tm64MQkrf7o4b0NTP2X7o0ExR4SmiYDaIuw50Nnnw+AbZlf09H3n8fnF2SQ+i3+eTV4ml78kL16O4jj+ByJYVyVjd0TLdjXsjHbftc1+gJ3mUG3YVod5gKZhwGV8eUyu2aDBRG5qnf30/biFzpkTvfMl+8NaKl0qjQ/dlHi4jC8fXvYBvTgOaKqXslRZWCsznsg/Np6heWrNHxdLtUrtwvgs2KG8DbJCKsxuEYUFRAUk0FN1vB1M/AYiCGtwt55qVw7Y7UkulF6cSWtH3f4o5dwz08fSqvFyAjyRPaa1U7S55ay0gQ8X3IDMVv2JzOaTa5ADUTo3AbwL9saiZoKGVC0nRxtqVigvlA/H3eoOZQtb/QAt5tJjJowWVGA4ZPnFaNK/GQJ0JD7oD/rWVChqj7xRSqUfffJBn4m7mzxXqZKl+BvnXhHeP+syt1qtjjL2PGCuFRX1XDi0Zq++CMKQ1iGq/3gOERC6yt/kt+iWKu1m8FdMjYPyeNfHMg19jJVUXN2d6NdDEPdVqVLUHgedd3X97o24GMUQDZrjG1wev5n+9vrt7Wu+ldurLdFkFI9iFlnjqZJ6YIifeP1emG/E9NVhgbd7Vv4PHoW7lidc09iWUgXehhRud5y828/bCJLhO+w+gsJ4YpXtlhv1L1c2DYs/1eg2kNzdR7CUTsk5M+NuC5ny/D/r31Rfzdyz97vn2XPx7U+6LwbTkVozo5eyrPkLInjEzcG7srlvoo7Z/9nbr7nRmvt8lPTe8EO3VbhKU7Q0ODua6zzK+uF5/XoGTfMvvZlVrQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/get-template",title:"Get template by 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 by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfWoBxZaTtMP0acHaZcaKpmg8DFgaBLR0sthIJEue/AJD/304ypJVu42LoSiwT7aO9/BenztugeTCQ3IHM6xsKQk93EeQoU+dsqSMhgRmBYprJNGpiKt3UyHL0qy82JhakBEOySlcosiQpCq9kHNTk5DCW0xVrlJBO/Cov8YLj26JQnoxL2u0TmnyIjdOpA4lKb0QmUnrClm8UlQI6zDDXGnMhCdXp1Q79COIwFh0kr2dZpDAAqmzARFY6WSFhI7D3IKWFUIC6zNp1RmZR9QQgeIwC5QZOojA4adaOcwgIVdjBJ42JWO8qmzJV+LaliZDSHJZelZIC6wkJFugjQ2a5JReQMOqMoAS9lF7tdCj9Xq9hibqXeky86CyzhUrqYDDMkxfCZP3eRRUSBIaMfNcgDmKHCktMPueAUSQG1dJaiUcUXPP13trtEfPgPM45p/PXfV1mqL3eV2KvjQQQWo0oSbWl9aWKg0H44+eQdtjL8z8I6bENXR8DanWZCvmUj/tbyvZV2A9+WOuK3/+LlRmpoilx1fsAT786VPOqLeGToD6AmnTQn43JffVk6A86IjQEQxRp1wriKxPxuPOWu3RjVJTMfpmpU/Z650MVDN7y7dqoQNVerR0Tm64MQkrf7o4b0NTP2X7o0ExR4SmiYDaIuw50Nnnw+AbZlf09H3n8fnF2SQ+i3+eTV4ml78kL16O4jj+ByJYVyVjd0TLdjXsjHbftc1+gJ3mUG3YVod5gKZhwGV8eUyu2aDBRG5qnf30/biFzpkTvfMl+8NaKl0qjQ/dlHi4jC8fXvYBvTgOaKqXslRZWCsznsg/Np6heWrNHxdLtUrtwvgs2KG8DbJCKsxuEYUFRAUk0FN1vB1M/AYiCGtwt55qVw7Y7UkulF6cSWtH3f4o5dwz08fSqvFyAjyRPaa1U7S55ay0gQ8X3IDMVv2JzOaTa5ADUTo3AbwL9saiZoKGVC0nRxtqVigvlA/H3eoOZQtb/QAt5tJjJowWVGA4ZPnFaNK/GQJ0JD7oD/rWVChqj7xRSqUfffJBn4m7mzxXqZKl+BvnXhHeP+syt1qtjjL2PGCuFRX1XDi0Zq++CMKQ1iGq/3gOERC6yt/kt+iWKu1m8FdMjYPyeNfHMg19jJVUXN2d6NdDEPdVqVLUHgedd3X97o24GMUQDZrjG1wev5n+9vrt7Wu+ldurLdFkFI9iFlnjqZJ6YIifeP1emG/E9NVhgbd7Vv4PHoW7lidc09iWUgXehhRud5y828/bCJLhO+w+gsJ4YpXtlhv1L1c2DYs/1eg2kNzdR7CUTsk5M+NuC5ny/D/r31Rfzdyz97vn2XPx7U+6LwbTkVozo5eyrPkLInjEzcG7srlvoo7Z/9nbr7nRmvt8lPTe8EO3VbhKU7Q0ODua6zzK+uF5/XoGTfMvvZlVrQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.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.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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(p.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)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(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)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.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 bee"\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)(p.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)(o.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)(p.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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.13bbb31c.js b/assets/js/52d5c0f9.13bbb31c.js new file mode 100644 index 000000000..b39bf5325 --- /dev/null +++ b/assets/js/52d5c0f9.13bbb31c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),t=a(58219),d=(a(62316),a(51039)),i=a.n(d),r=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsxU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl7Dv8rXVS5Ej0/OvmPlpznSxc8hr1pqDCCx+q4XFHFJva4zA+bUkQ05URhIAV0bqHCEtuHQEyEqsOKQb8GsTkN4KtYAICm0r7ocSXPFwSwqmPJ6Xx9zl0DQzsuqMVg4d3XOcJPT3PIA+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM7hWbBDeRukw6y2wq9Dk69G3IhRe57ezahTKvSl3g2IMBh8CSnEfTvHm8FQaICutMt+bNRWQgql98alcew8Xwi1GHFjxtqgcmKhJJ+7caarmBsRLydARnunboi4lptnrm0Z4kZ8xjVEfeRDVDeeSuQ52sCSUIUOyh0fVwbVjViowOZycjDEbkvhmHDhuI8xZJYV2rI9bTbnDnOmFfMlhkOSn4wn24kcVMfsXt2rG10hqx0WtWRSqEeX3qsRu7sqCpEJLtlfOHfC4+xdz9zT09MBY0dB55PwZT1nFo3ewRdBGGgdam1fjiACj7ZyV8UN2qXIsMvSK6biAI67UudZKHWsuKDsdqJf9pWo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTC0vzHnazY938/xZte7/9Ga7SrV48rHRnIROjJEvula6Q4GazcdbthZBKV2niCbDdXXFyubhsTfarTUs7MIltwKPqeCvttALhw959t1+Wq07/7sNu8R++5l/WIsfSsq6sMllzW9QQSPuN77YGhmTdT3IznbIs6yDI0f6B6M0Gdz6Pzi8uL2AiLgNZE3HAWPYRR0D2TgRdeez4jWB/ptolcUfqIi+Izrn7fw9uRVhS7EHk00zZqm+QdMLWXL",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 by 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 by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsxU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl7Dv8rXVS5Ej0/OvmPlpznSxc8hr1pqDCCx+q4XFHFJva4zA+bUkQ05URhIAV0bqHCEtuHQEyEqsOKQb8GsTkN4KtYAICm0r7ocSXPFwSwqmPJ6Xx9zl0DQzsuqMVg4d3XOcJPT3PIA+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM7hWbBDeRukw6y2wq9Dk69G3IhRe57ezahTKvSl3g2IMBh8CSnEfTvHm8FQaICutMt+bNRWQgql98alcew8Xwi1GHFjxtqgcmKhJJ+7caarmBsRLydARnunboi4lptnrm0Z4kZ8xjVEfeRDVDeeSuQ52sCSUIUOyh0fVwbVjViowOZycjDEbkvhmHDhuI8xZJYV2rI9bTbnDnOmFfMlhkOSn4wn24kcVMfsXt2rG10hqx0WtWRSqEeX3qsRu7sqCpEJLtlfOHfC4+xdz9zT09MBY0dB55PwZT1nFo3ewRdBGGgdam1fjiACj7ZyV8UN2qXIsMvSK6biAI67UudZKHWsuKDsdqJf9pWo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTC0vzHnazY938/xZte7/9Ga7SrV48rHRnIROjJEvula6Q4GazcdbthZBKV2niCbDdXXFyubhsTfarTUs7MIltwKPqeCvttALhw959t1+Wq07/7sNu8R++5l/WIsfSsq6sMllzW9QQSPuN77YGhmTdT3IznbIs6yDI0f6B6M0Gdz6Pzi8uL2AiLgNZE3HAWPYRR0D2TgRdeez4jWB/ptolcUfqIi+Izrn7fw9uRVhS7EHk00zZqm+QdMLWXL",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 by ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},f={},b=[{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 by ID"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(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)(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)(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)(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)(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)(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)(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 v(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.2021ef58.js b/assets/js/52d5c0f9.2021ef58.js deleted file mode 100644 index 3a98b24c9..000000000 --- a/assets/js/52d5c0f9.2021ef58.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:()=>h,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),d=a.n(n),o=(a(82723),a(9487)),r=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const x={id:"deletedocument",title:"Delete document by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RoAmaDAOWGAEtnSw2FMmSlGND0H8fTi+2bCdZMXT7klinO95zz909VAWeLxzEd3Cuk7JA5R3MAkjRJVYYL7SCGG5zZOco0SNLOy92dj1lXEr95Nhal8xrZrHQS2TOYCIykWxdM6sLcrIbkxtDANqg5ZRhmkIMaXN+7wABGG55gR4toatA8QIhhtWIGzHy+hEVBCAIXY48RQsBWPxaCospxN6WGIDza0kxThRGIgSAKyN1ihBnXDpySHIsOMQV+LVpPL0VagE1ufImKCaYyomFGq9WqxXUwQZKj/VBpD0Uw30O++xdW70UKTI9/4KJn6ZMZ1tuvGZt5d8TfwCZtgX3Q8u2IJMfz/Nj7lKo6xlldUYrh47OOY4i+rdbQD8ZHdKUuTJJ0LmslHL9AwSQaOWpaXEF3Bgpkqat4RdH4dUhzJYJ6rGlIfCiTd4T9FxBW/i/rgi8+d2cUJ86SGf+9aDj6PhkNIlG0Y+3k3fx6fv47btxFEV/QQCrQlJs31Tukc71wsvtc33g1vZs6NhZanI+jU5foVFpzzJdqvQ7cofWavs6B8/lrwcVCCWFwod+Hh5Oo9OHk01Bbw8LmqollyJtpOCWNvL/rWeY3rfpDxslWqdWMHaKHdrbIh0mpRV+3ejNUGjiuxltSoE+11utajTK5xBD2K9zWA1EoQY60i57BSutJLXy3rg4DJ3nC6EWI27MuJcYyedunOgi5EaEywlQ0h7UDRHXcrMDbcMQN+IjriH4Z6WkWoXKdBPc8XFlUN2IhWrYXE4OROw2F44J17zua2w6yzJt2V40m3OHKdOK+Rybl2Q/GU82l0MTOmb36l7d6AJZ6TArJZNCPbr4Xo3Y3VWWiURwyf7EuRMeZ2965p6eng4YO2piPgifl3Nm0eit+6IxNrQOozYPRxCAR1u4q+wG7VIk2HXphVRh4xx2o86TZtSx4IK625l+2Q+i0ZMiQeVwMJxnH64v2ck4gmAwHN8AObyc/nbx6eaCTqXxals0GUfjiExGO19wNUi0f3nP12x6vt/jaru7/9GN302qx5UPjeSi2cim8qpbpTsYfAHEwxt2FkCunSeXqqL5+sPKuibz1xIt7ewsgCW3gs9poO8qSIWj3+nmunyx2jefu5v3iH3zZf1sLf0qKtrDJZclPUEAj7je+2CoZ3XQ7+O/BvsSjDbdrgBs0NAXTOtwliRo/ODdgWDvqN75xeXF7QUEwEtq1VB4Hhvh6X5QOc8SsQuoxUB/CdGzAT/RyH3E9c8b9/bNiwGbT8HWm9iY1XX9N2B8ugE=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={id:"API-docs/deletedocument",title:"Delete document by 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 by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RoAmaDAOWGAEtnSw2FMmSlGND0H8fTi+2bCdZMXT7klinO95zz909VAWeLxzEd3Cuk7JA5R3MAkjRJVYYL7SCGG5zZOco0SNLOy92dj1lXEr95Nhal8xrZrHQS2TOYCIykWxdM6sLcrIbkxtDANqg5ZRhmkIMaXN+7wABGG55gR4toatA8QIhhtWIGzHy+hEVBCAIXY48RQsBWPxaCospxN6WGIDza0kxThRGIgSAKyN1ihBnXDpySHIsOMQV+LVpPL0VagE1ufImKCaYyomFGq9WqxXUwQZKj/VBpD0Uw30O++xdW70UKTI9/4KJn6ZMZ1tuvGZt5d8TfwCZtgX3Q8u2IJMfz/Nj7lKo6xlldUYrh47OOY4i+rdbQD8ZHdKUuTJJ0LmslHL9AwSQaOWpaXEF3Bgpkqat4RdH4dUhzJYJ6rGlIfCiTd4T9FxBW/i/rgi8+d2cUJ86SGf+9aDj6PhkNIlG0Y+3k3fx6fv47btxFEV/QQCrQlJs31Tukc71wsvtc33g1vZs6NhZanI+jU5foVFpzzJdqvQ7cofWavs6B8/lrwcVCCWFwod+Hh5Oo9OHk01Bbw8LmqollyJtpOCWNvL/rWeY3rfpDxslWqdWMHaKHdrbIh0mpRV+3ejNUGjiuxltSoE+11utajTK5xBD2K9zWA1EoQY60i57BSutJLXy3rg4DJ3nC6EWI27MuJcYyedunOgi5EaEywlQ0h7UDRHXcrMDbcMQN+IjriH4Z6WkWoXKdBPc8XFlUN2IhWrYXE4OROw2F44J17zua2w6yzJt2V40m3OHKdOK+Rybl2Q/GU82l0MTOmb36l7d6AJZ6TArJZNCPbr4Xo3Y3VWWiURwyf7EuRMeZ2965p6eng4YO2piPgifl3Nm0eit+6IxNrQOozYPRxCAR1u4q+wG7VIk2HXphVRh4xx2o86TZtSx4IK625l+2Q+i0ZMiQeVwMJxnH64v2ck4gmAwHN8AObyc/nbx6eaCTqXxals0GUfjiExGO19wNUi0f3nP12x6vt/jaru7/9GN302qx5UPjeSi2cim8qpbpTsYfAHEwxt2FkCunSeXqqL5+sPKuibz1xIt7ewsgCW3gs9poO8qSIWj3+nmunyx2jefu5v3iH3zZf1sLf0qKtrDJZclPUEAj7je+2CoZ3XQ7+O/BvsSjDbdrgBs0NAXTOtwliRo/ODdgWDvqN75xeXF7QUEwEtq1VB4Hhvh6X5QOc8SsQuoxUB/CdGzAT/RyH3E9c8b9/bNiwGbT8HWm9iY1XX9N2B8ugE=",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 by ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},f={},y=[{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 by ID"})}),"\n",(0,l.jsx)(d(),{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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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 deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.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)(o.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)(o.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,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.017914b9.js b/assets/js/5a2de241.017914b9.js new file mode 100644 index 000000000..3f674fc44 --- /dev/null +++ b/assets/js/5a2de241.017914b9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const x={id:"update-template",title:"Update template by ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVmTtcGKxGgcDFhiGLR0splQJEtSdgxD/304SrKVOM2aodv8yaLu5XnujnenDXg+d5DcwBgLI7lHB5MIMnSpFcYLrSCB8QLZtcm4R9ZKsZPROUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVeQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/AU+znp+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4IOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0HkMdWb0UGbIZSr1iW9oEso1nmyN2wD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7hx52+xD17M7TD1F3FJKvEBHby9CwP+eIAWHhzAl4MKfLV6oIrjQ/tVmRkQRmcWlwFUoLCfmivmFcCzTaVkQvSqC024cX+diWxXdXFQR/KZlhpYq8nX2Hu7cjA8/8ocRVFUEXvhHbqadup3OqAyqiuQsOqOVqyN+GMf71bG9eU21MlemKTqXl1Kuf/px6a6Pnye+o8lddvjJjY4/GQpWA+nEv6x0GB8e9YZxL34/Hr5Ljn9O3r7rx3H8J0TwUEjSbS531tRMG736uXMglBQKp23UpodxPD1sQnn8XPSaSjLNFVtyKTKWC5QZI5/uBwYQrdX2H1b6C/heok+UW/LHL5SO0p7lulTZ/033OUQvEzyevt9SfLtP8VzVIaOxNNb3qP4Lhjs+Xfe+dk9QH1e1qIXCe3hEtntekyzQLzSNQ1MGQDTaEhi03WOw6fSRCiJwaJfthCythAQW3huXDAbO87lQ8x43pq8NKuqgks9cP9XFgBsxWA6BRpPDtLTCr68oKjXxhx43olfj2tHnRvyOa4haWl2pZhIvkGdoQwgo2F92U++sDVk7V/ZGRTspvq/5P+n9z7fzbjd/1KAJbq4DtyYXlwbVFbmhTC6He+vEmLwLF163IEJVsVxb9kSbzbjDjGkV9g96SedH/eF2DwqqfXarbtWVLpCVDvNSMinUvUtuVY/dXOa5SAWX7A+cOeFxctAmdrVa7SX0TdD5KPyinDGLRu/E5+EwZL2rtX2gjcGjLdxlfoV2KVJsiugbrgZBeNBcM56Ga4YFF1R8zdEvT5Uo5FKkqBx2LsbJx9FndtSPIerU7ndAHnw+/3B2cXVGVqn66xQN+3E/piOjnS+46ji6frxGsdmanZ8+zfFm1zf+7c23uVEeH/zASC5CWwgh2DRX/gY6FyPpLr2TCBbaeRLZbKjQrq2sKjr+WqJdQ3IziWDJrSCkoS9kwtH/bLu8fpP2wZd2jWSv25+fJdT2DUVNY8llSU8QwT2unyzy1aSK2uZBiGuJDzWu3pjs7CzstfQqajVO0hSNf1F20umxo+sxRDBrlvIi7Pdg+Yo+CPgKEriFWwgfKmQgtMZwvgHJ1bzkc5KvzdLvLwGgmrI=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/update-template",title:"Update template by 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 by ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVmTtcGKxGgcDFhiGLR0splQJEtSdgxD/304SrKVOM2aodv8yaLu5XnujnenDXg+d5DcwBgLI7lHB5MIMnSpFcYLrSCB8QLZtcm4R9ZKsZPROUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVeQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/AU+znp+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4IOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0HkMdWb0UGbIZSr1iW9oEso1nmyN2wD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7hx52+xD17M7TD1F3FJKvEBHby9CwP+eIAWHhzAl4MKfLV6oIrjQ/tVmRkQRmcWlwFUoLCfmivmFcCzTaVkQvSqC024cX+diWxXdXFQR/KZlhpYq8nX2Hu7cjA8/8ocRVFUEXvhHbqadup3OqAyqiuQsOqOVqyN+GMf71bG9eU21MlemKTqXl1Kuf/px6a6Pnye+o8lddvjJjY4/GQpWA+nEv6x0GB8e9YZxL34/Hr5Ljn9O3r7rx3H8J0TwUEjSbS531tRMG736uXMglBQKp23UpodxPD1sQnn8XPSaSjLNFVtyKTKWC5QZI5/uBwYQrdX2H1b6C/heok+UW/LHL5SO0p7lulTZ/033OUQvEzyevt9SfLtP8VzVIaOxNNb3qP4Lhjs+Xfe+dk9QH1e1qIXCe3hEtntekyzQLzSNQ1MGQDTaEhi03WOw6fSRCiJwaJfthCythAQW3huXDAbO87lQ8x43pq8NKuqgks9cP9XFgBsxWA6BRpPDtLTCr68oKjXxhx43olfj2tHnRvyOa4haWl2pZhIvkGdoQwgo2F92U++sDVk7V/ZGRTspvq/5P+n9z7fzbjd/1KAJbq4DtyYXlwbVFbmhTC6He+vEmLwLF163IEJVsVxb9kSbzbjDjGkV9g96SedH/eF2DwqqfXarbtWVLpCVDvNSMinUvUtuVY/dXOa5SAWX7A+cOeFxctAmdrVa7SX0TdD5KPyinDGLRu/E5+EwZL2rtX2gjcGjLdxlfoV2KVJsiugbrgZBeNBcM56Ga4YFF1R8zdEvT5Uo5FKkqBx2LsbJx9FndtSPIerU7ndAHnw+/3B2cXVGVqn66xQN+3E/piOjnS+46ji6frxGsdmanZ8+zfFm1zf+7c23uVEeH/zASC5CWwgh2DRX/gY6FyPpLr2TCBbaeRLZbKjQrq2sKjr+WqJdQ3IziWDJrSCkoS9kwtH/bLu8fpP2wZd2jWSv25+fJdT2DUVNY8llSU8QwT2unyzy1aSK2uZBiGuJDzWu3pjs7CzstfQqajVO0hSNf1F20umxo+sxRDBrlvIi7Pdg+Yo+CPgKEriFWwgfKmQgtMZwvgHJ1bzkc5KvzdLvLwGgmrI=",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 by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by 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)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(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/5a2de241.5942955c.js b/assets/js/5a2de241.5942955c.js deleted file mode 100644 index 6b580e21a..000000000 --- a/assets/js/5a2de241.5942955c.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:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),p=s(41429),m=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVmTpcGKxGgcDFhiGLR0splQJEtSfoGh/z6cXmw5TtKmyDZ/sqh7eZ67491pDZ5PHUS3MMTMSO7RwSiABF1shfFCK4hgOEN2YxLukTVS7GRwwVDxiUTHVjpnXrNMJyJdMa4SllfSfoYsQc+FdEynjDNnMBapiJmv7XQhAG3QcnJ1kUAElWrjBwIw3PIMPVqCuQbFM4QIlh1uRMfrB1QQgCCYM+QJWgjA4rdcWEwg8jbHAJxfSdJxIjOSTOLSSJ0gRCmXjgTiGWYcojX4lSklvRVqCgWJ8lIpIpjKianqLpfLJRTBBkrDZSySBorhfgaPw3hxSkGgmDQazM+4ZwoxcRTACdaBS96SRACpthn3LVrFqLKPzv+ukxXp7EIdWD0XCbIJSr1gmwwQyCa1TbmwA+6ZRO480wpbsg2BdxBArJVH5ckRN0aKuMx3796Rt/U+dD25x9hT8i1Vhxfo6O1lGfDvE2ynzZV/Nngpp5fav9rMgCgiszgXuChrnGqB+ZlwLNFxnhG9IoDTdhxf52JTFe1cFAH8oWWCli7H6+wt792E98/5cgBFEYAXfsfNuFW34wmVQVGQnEVntHJVxA/DcL86Nk2grlbm8jhG59JcytUvb5fu6vhp4lua3CWHn93g+LOhYNWQTvzLSofh4VGnH3bCj8P+h+j41+j9h24Yhn9DAMtMkm59uZO6ZproVc+tA6GkUDhuojY+DMPxYR3K46eiV1eSqa/YnEuRsFSgTBj5dG8YQLRW25+s9BfwvUSfKDfkj18oHaU9S3Wukv+b7lOIXiZ4PP64ofh+n+KFqkJGE3JI8+m/YLjl03bvK/cEdbeqRSVUjc8dsu3zimSGfqZpMpu8BESjLYJe0z1661YfKSAAh3beDOvcShrM3hsX9XrO86lQ0w43pttMU8knrhvrrMeN6M37QKPJYZxb4VfXFJWKeHvcb+lzI/7EFQTfXwqICAX763bqnTUha+bK3qhoJsWPNf9Hvf/pdt7u5jsNmuCmuuRW5+LKoLomN5TJeX9vnRiSd+HK1w2IsqpYqi17pM0m3GHCtCr3D3pJ50fd/mYlK1W77E7dqWudIcsdprlkUqgHF92pDru9SlMRCy7ZXzhxwuPooEnsYrHYS+i7Uudc+Fk+YRaN3opPy8My622tzQNtDB5t5q7Sa7RzEWNdRM+46pXCvfqa8bi8ZphxQcVXH/32WIlCLkWMymHrYpycD76wo24IQat2fwBy78vFp7PL6zOyStVfpajfDbshHRntfMZVy9HN7hrFJit2cfo4x+tt3/i3l/D6Rnlc+p6RXJRtoQzBur7yt9C6GFF76R0FMNPOk8h6TYV2Y2VR0PG3HO0KottRAHNuBSEt+0IiHP1PNsvrs7QPvjZrJHvd/vwkoaZvKGoacy5zeoIAHnD1aJEvRkXQNI+fRvwcjMrdbrfaoKEvi0rgU2WzMyQbW4m9AbLVOIljNP5F2VGrow9uhhDApP4EyMqvCbB8QZ8ffAER3MEdlF9oZKBsxOX5GiRX05xPSb4yS79/AMFp7ug=",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 by 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 by ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVmTpcGKxGgcDFhiGLR0splQJEtSfoGh/z6cXmw5TtKmyDZ/sqh7eZ67491pDZ5PHUS3MMTMSO7RwSiABF1shfFCK4hgOEN2YxLukTVS7GRwwVDxiUTHVjpnXrNMJyJdMa4SllfSfoYsQc+FdEynjDNnMBapiJmv7XQhAG3QcnJ1kUAElWrjBwIw3PIMPVqCuQbFM4QIlh1uRMfrB1QQgCCYM+QJWgjA4rdcWEwg8jbHAJxfSdJxIjOSTOLSSJ0gRCmXjgTiGWYcojX4lSklvRVqCgWJ8lIpIpjKianqLpfLJRTBBkrDZSySBorhfgaPw3hxSkGgmDQazM+4ZwoxcRTACdaBS96SRACpthn3LVrFqLKPzv+ukxXp7EIdWD0XCbIJSr1gmwwQyCa1TbmwA+6ZRO480wpbsg2BdxBArJVH5ckRN0aKuMx3796Rt/U+dD25x9hT8i1Vhxfo6O1lGfDvE2ynzZV/Nngpp5fav9rMgCgiszgXuChrnGqB+ZlwLNFxnhG9IoDTdhxf52JTFe1cFAH8oWWCli7H6+wt792E98/5cgBFEYAXfsfNuFW34wmVQVGQnEVntHJVxA/DcL86Nk2grlbm8jhG59JcytUvb5fu6vhp4lua3CWHn93g+LOhYNWQTvzLSofh4VGnH3bCj8P+h+j41+j9h24Yhn9DAMtMkm59uZO6ZproVc+tA6GkUDhuojY+DMPxYR3K46eiV1eSqa/YnEuRsFSgTBj5dG8YQLRW25+s9BfwvUSfKDfkj18oHaU9S3Wukv+b7lOIXiZ4PP64ofh+n+KFqkJGE3JI8+m/YLjl03bvK/cEdbeqRSVUjc8dsu3zimSGfqZpMpu8BESjLYJe0z1661YfKSAAh3beDOvcShrM3hsX9XrO86lQ0w43pttMU8knrhvrrMeN6M37QKPJYZxb4VfXFJWKeHvcb+lzI/7EFQTfXwqICAX763bqnTUha+bK3qhoJsWPNf9Hvf/pdt7u5jsNmuCmuuRW5+LKoLomN5TJeX9vnRiSd+HK1w2IsqpYqi17pM0m3GHCtCr3D3pJ50fd/mYlK1W77E7dqWudIcsdprlkUqgHF92pDru9SlMRCy7ZXzhxwuPooEnsYrHYS+i7Uudc+Fk+YRaN3opPy8My622tzQNtDB5t5q7Sa7RzEWNdRM+46pXCvfqa8bi8ZphxQcVXH/32WIlCLkWMymHrYpycD76wo24IQat2fwBy78vFp7PL6zOyStVfpajfDbshHRntfMZVy9HN7hrFJit2cfo4x+tt3/i3l/D6Rnlc+p6RXJRtoQzBur7yt9C6GFF76R0FMNPOk8h6TYV2Y2VR0PG3HO0KottRAHNuBSEt+0IiHP1PNsvrs7QPvjZrJHvd/vwkoaZvKGoacy5zeoIAHnD1aJEvRkXQNI+fRvwcjMrdbrfaoKEvi0rgU2WzMyQbW4m9AbLVOIljNP5F2VGrow9uhhDApP4EyMqvCbB8QZ8ffAER3MEdlF9oZKBsxOX5GiRX05xPSb4yS79/AMFp7ug=",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 by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",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 by ID"})}),"\n",(0,l.jsx)(r(),{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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.795c8a7a.js b/assets/js/770b40a9.795c8a7a.js deleted file mode 100644 index 4cd3218ff..000000000 --- a/assets/js/770b40a9.795c8a7a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),d=a(5397),p=a(4667),o=a(9472),h=a(85162);const u={id:"gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2njaAYsvJZovqqUGRpkGDJGhcFGhiBLQ0sphQJJekfIGhfy+GkmzZbuKiKPahT7aGcziHc1+D5zMHyROMsTSSe3QwiSBDl1phvNAKEhgXyK7Rs06F3Qrn2eXDDeNS6oVjK10xr5lFbwXOkXEmSUPnjM+5kHwqkfnu/gEbF8KxvFIp3c+l8CtmrJ6LDB3jiuk52rnARcBLuUVGDBWfSqFmrHJoHdlMC60dstzqkuFSOE+nGwRbFKhYapEHeabTqkTl3QAi0AYtJwY3GSQwQ9+hiDtEYLjlJXq05J41KF4iJLA85Uacev2GCiIQ5J4CeYYWIrD4tRIWM0i8rTAC51eSME6URiJEgEsjdYaQ5Fw6UkgLLDkka/ArEzS9FWoGNanyAEqIp3JipgbL5XIJdbShIkUpfEfia4V2tcOhs9GSyLUt+xRaivsMVFVO0e4wGMU9o+5NmG9gM64ndK8zWjl0pHsWx/Szm5muSlN0Lq8k24QTIki18qg86XNjpEjDwfDVEWh9SEBPXzENMbd0jReNSYuukr6nx63l9GDhsXTH8Y2Y0ms/wFFwDfd9yTbiy9EvU1W6s4eQCWPhSXp4xRbgwp9N2hPqTvsjoE6bKd1AftaS8vhDUB50WEgGgohj1ArvjUuGw84aFe4g1SWh7xfqmL0NyVDDemv5UcxUKM1/G5y7kM8f2X7VyKaIUNcR+CYIGz4vnX06DNwwu/Qf33cWn52fjuLT+Pvx6Evy+Yfk4ssgjuM/IYJlKQnb1ljWxrAz2n1XJvsGdup9tX5a7fsB6r53hJJC4UtXty9ncfxyQSp1BJ/ji8P6vVFzLkUWZsmYeup3/131orX6SHb1zfvG/OHzRaPUtPydx/blzSNL9IVux0kYIb6ABIZ7k8WhnXdjpbKyVyXO85lQs1NuzKDr+5JPHVXMkBsxnI+AOqPDtLLCrx7JF81z+4OpVxRG/IpUFUfHF9EXKtcB3D7x3qCiRA8Omo/gcDEQjgkXjrvZGoLFcm3ZHppNucOMacV8geGQ5OeDEXMGU5G3cR6wZ/WsHnWJNOSps0uh3lzyrE7Z032ei1Rwyf7AqRMeJ586zy0WiwOPnQTMtfBFNWUWjd6qz4IwuLWP2nycQAQebenu80faRtKul71jahiUh2328jRkL5ZcUHRb0Y/7IMomKVJUDnv5dnn9cMvOBzFEveT4B5SHtzc/Xd09XtGtlF5NiEaDeBCTyGjnS656hmil2/TXNjV34rveluL/dAdsq8Tj0g+N5CIUePD6ui3eJ9gp3kkEhXae5Os1JfTvVtY1iZtliEo6E45eu12H3nDVW9fmXFZkNKxy7+i2W9ZWdUIfVpAuJE+TOurK9m8NvhvFT7+1q9oJe+/1DYHdPrFDuVG4TFM0/ecctGrivOmH11djqOu/ADRuQ8A=",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/gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2njaAYsvJZovqqUGRpkGDJGhcFGhiBLQ0sphQJJekfIGhfy+GkmzZbuKiKPahT7aGcziHc1+D5zMHyROMsTSSe3QwiSBDl1phvNAKEhgXyK7Rs06F3Qrn2eXDDeNS6oVjK10xr5lFbwXOkXEmSUPnjM+5kHwqkfnu/gEbF8KxvFIp3c+l8CtmrJ6LDB3jiuk52rnARcBLuUVGDBWfSqFmrHJoHdlMC60dstzqkuFSOE+nGwRbFKhYapEHeabTqkTl3QAi0AYtJwY3GSQwQ9+hiDtEYLjlJXq05J41KF4iJLA85Uacev2GCiIQ5J4CeYYWIrD4tRIWM0i8rTAC51eSME6URiJEgEsjdYaQ5Fw6UkgLLDkka/ArEzS9FWoGNanyAEqIp3JipgbL5XIJdbShIkUpfEfia4V2tcOhs9GSyLUt+xRaivsMVFVO0e4wGMU9o+5NmG9gM64ndK8zWjl0pHsWx/Szm5muSlN0Lq8k24QTIki18qg86XNjpEjDwfDVEWh9SEBPXzENMbd0jReNSYuukr6nx63l9GDhsXTH8Y2Y0ms/wFFwDfd9yTbiy9EvU1W6s4eQCWPhSXp4xRbgwp9N2hPqTvsjoE6bKd1AftaS8vhDUB50WEgGgohj1ArvjUuGw84aFe4g1SWh7xfqmL0NyVDDemv5UcxUKM1/G5y7kM8f2X7VyKaIUNcR+CYIGz4vnX06DNwwu/Qf33cWn52fjuLT+Pvx6Evy+Yfk4ssgjuM/IYJlKQnb1ljWxrAz2n1XJvsGdup9tX5a7fsB6r53hJJC4UtXty9ncfxyQSp1BJ/ji8P6vVFzLkUWZsmYeup3/131orX6SHb1zfvG/OHzRaPUtPydx/blzSNL9IVux0kYIb6ABIZ7k8WhnXdjpbKyVyXO85lQs1NuzKDr+5JPHVXMkBsxnI+AOqPDtLLCrx7JF81z+4OpVxRG/IpUFUfHF9EXKtcB3D7x3qCiRA8Omo/gcDEQjgkXjrvZGoLFcm3ZHppNucOMacV8geGQ5OeDEXMGU5G3cR6wZ/WsHnWJNOSps0uh3lzyrE7Z032ei1Rwyf7AqRMeJ586zy0WiwOPnQTMtfBFNWUWjd6qz4IwuLWP2nycQAQebenu80faRtKul71jahiUh2328jRkL5ZcUHRb0Y/7IMomKVJUDnv5dnn9cMvOBzFEveT4B5SHtzc/Xd09XtGtlF5NiEaDeBCTyGjnS656hmil2/TXNjV34rveluL/dAdsq8Tj0g+N5CIUePD6ui3eJ9gp3kkEhXae5Os1JfTvVtY1iZtliEo6E45eu12H3nDVW9fmXFZkNKxy7+i2W9ZWdUIfVpAuJE+TOurK9m8NvhvFT7+1q9oJe+/1DYHdPrFDuVG4TFM0/ecctGrivOmH11djqOu/ADRuQ8A=",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 by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,t.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,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{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)(s.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsxs)(a,{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)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"template[]"})})]})}),(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)(s.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(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)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "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 bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.e45522a5.js b/assets/js/770b40a9.e45522a5.js new file mode 100644 index 000000000..cd390d25d --- /dev/null +++ b/assets/js/770b40a9.e45522a5.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:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),d=a(5397),p=a(4667),c=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvJ7hbVU4MiTYMGSYC4KNDECGhpZE9CkVyS8gWG/n0xtGQrMTYpimIf+pR4eA7nekbcQpBzD9k9TLCySgb0ME2gQJ87soGMhgwmCxQXGEQHEVfkgzi7vRRSKbPyYmNqEYxwGBzhEoUUihGmFHIpScmZQhG6+4disiAvylrnfL9UFDbCOrOkAr2QWpgluiXhKvKVOjATgVrOFOm5qD06zz7zhTEeRelMJXBNPvDpniFWC9QidyijvTB5XaEOfggJGItOcgSXBWQwx9CxOHZIwEonKwzouDxb0LJCyEBRRXxKXJgvNboNJODwS00OC8hKqTwm4MNGMbo0roIEcG2VKRCy4Go+zRdYSci2EDaWYbquZuigYaSsLFPHaZPsnfpnst/BZ9pM+V5vjfboGXuSpvzn5Tj4Os/R+7JWYl9DSCA3OqAOjJfWKsrjwejJM2l7HICZPWEeC+34mkA7lw59rUIPJ52TnDAFrPz7/J2Ze7pH+uBIzyGJpZGhb9nnDuvx7zNd+ZPbOddkQoGtx1ccCD7+s581Zl2b8A6pQwttdpTfjCrQvU0qI0bEYWAKvRfaIgTrs9Go88ZqGeamYvbNSr/nbx9kFI45eL6juY56+LfNuY7z/JbvJ4NihghNk0DYNWEfz2Pnnw9jbFichbfvO0lPTgfjdJD+NBl/zj7+nH36PEzT9G9IYF0p5rYaK9oedk6737UtvoOf5jWsP1av6wBNvzqkFWl87HT7eJKmj58Y0iTwMf10rN9LvZSKirjAJ+YZ9Q//nXrROfPOdPXdh5374/RpB4rn8CLZvn2XZIVhYdodHvd2WEAGo1fr3KNbdru8dqqnEh/knPR8IK0dGova01wrOfOsmJG0NFqOgTejx7x2FDZ3XItduuuBtDTYRdMThaU/kFXRJtNHtVt8gZJlz+GTLk0ktyneWNQ86LFAyzEcf43JC/LxuPugxWaJ0jjxii1m0mMhjBZhgfGQ7afDsfAWcyrbPg/Fg37Qd6ZC/rLyZlekn332oAfi/qYsKSepxF848xRw+mNXudVqdVSxD5FzQWFRz4RDaw7weTTGsvZZ+x8fIIGArvI35R0/AfJul33D1SiCR+30yjxOL1aSuLut6ZfXJJ4mRTlqj715O7u4vRKnwxSS3nD8g5BHV5e/nl/fnfOtPF67Fo2H6TBlkzU+VFL3HPE7ar9f29F80d/tQYr/04dXq5KA6zCySlIUeKz6thXvPbwQ7zSBhfGB7dstD/SfTjUNm3ePIZZ0QZ6zPTyHnnHTe64tparZKfCr6hvY9pV1gE75hyPGQnY/bZJOtuxwxznLc7R9B0fLk2/Zb6iL8wk0zVdLku97",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvJ7hbVU4MiTYMGSYC4KNDECGhpZE9CkVyS8gWG/n0xtGQrMTYpimIf+pR4eA7nekbcQpBzD9k9TLCySgb0ME2gQJ87soGMhgwmCxQXGEQHEVfkgzi7vRRSKbPyYmNqEYxwGBzhEoUUihGmFHIpScmZQhG6+4disiAvylrnfL9UFDbCOrOkAr2QWpgluiXhKvKVOjATgVrOFOm5qD06zz7zhTEeRelMJXBNPvDpniFWC9QidyijvTB5XaEOfggJGItOcgSXBWQwx9CxOHZIwEonKwzouDxb0LJCyEBRRXxKXJgvNboNJODwS00OC8hKqTwm4MNGMbo0roIEcG2VKRCy4Go+zRdYSci2EDaWYbquZuigYaSsLFPHaZPsnfpnst/BZ9pM+V5vjfboGXuSpvzn5Tj4Os/R+7JWYl9DSCA3OqAOjJfWKsrjwejJM2l7HICZPWEeC+34mkA7lw59rUIPJ52TnDAFrPz7/J2Ze7pH+uBIzyGJpZGhb9nnDuvx7zNd+ZPbOddkQoGtx1ccCD7+s581Zl2b8A6pQwttdpTfjCrQvU0qI0bEYWAKvRfaIgTrs9Go88ZqGeamYvbNSr/nbx9kFI45eL6juY56+LfNuY7z/JbvJ4NihghNk0DYNWEfz2Pnnw9jbFichbfvO0lPTgfjdJD+NBl/zj7+nH36PEzT9G9IYF0p5rYaK9oedk6737UtvoOf5jWsP1av6wBNvzqkFWl87HT7eJKmj58Y0iTwMf10rN9LvZSKirjAJ+YZ9Q//nXrROfPOdPXdh5374/RpB4rn8CLZvn2XZIVhYdodHvd2WEAGo1fr3KNbdru8dqqnEh/knPR8IK0dGova01wrOfOsmJG0NFqOgTejx7x2FDZ3XItduuuBtDTYRdMThaU/kFXRJtNHtVt8gZJlz+GTLk0ktyneWNQ86LFAyzEcf43JC/LxuPugxWaJ0jjxii1m0mMhjBZhgfGQ7afDsfAWcyrbPg/Fg37Qd6ZC/rLyZlekn332oAfi/qYsKSepxF848xRw+mNXudVqdVSxD5FzQWFRz4RDaw7weTTGsvZZ+x8fIIGArvI35R0/AfJul33D1SiCR+30yjxOL1aSuLut6ZfXJJ4mRTlqj715O7u4vRKnwxSS3nD8g5BHV5e/nl/fnfOtPF67Fo2H6TBlkzU+VFL3HPE7ar9f29F80d/tQYr/04dXq5KA6zCySlIUeKz6thXvPbwQ7zSBhfGB7dstD/SfTjUNm3ePIZZ0QZ6zPTyHnnHTe64tparZKfCr6hvY9pV1gE75hyPGQnY/bZJOtuxwxznLc7R9B0fLk2/Zb6iL8wk0zVdLku97",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 by ID",permalink:"/docs/API-docs/delete-template"}},j={},g=[{value:"Request",id:"request",level:2}];function v(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,t.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,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{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)(s.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.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)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"template[]"})})]})}),(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)(s.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(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)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "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 bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.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)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.36b0ee4c.js b/assets/js/7b076186.36b0ee4c.js deleted file mode 100644 index 820858b37..000000000 --- a/assets/js/7b076186.36b0ee4c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>v});var t=s(85893),l=s(11151),o=s(58219),n=(s(62316),s(51039)),i=s.n(n),r=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLLspB0mDMOyNuiMBk2wZBiwxAho6WSxpkiWpBwbhv77cHqzHCddMRQD9sWWqDvec8/dPeQOPF86iO/grVaeJ97BPIAUXWKF8UIriOE2R/YOJXpkrRE7v54xLqV+dGyrS+Y1s1joNTLOktYks7qgj7ZbWWi9Ctksqz2UZlKrJVqmEFPGmeHWi6SUvLf/3jGhMm0LTjgC5nPh6sAFX6FjwjPkbkux0wacz1FYZjHRNg0hAG3Q1r6zFGJojNq9IQDDLS/Qo6Xsd6B4gRDDZsSNGHm9QgUBCEo/R56ihQAsfi6FxRRib0sMwPmtJB8nCiMRAsCNkTpFiDMuHRkkORYc4h34raktvRVqCRWZ8topJpTKiaUKN5vNBqqgh9JCfRBph8Rwn8PT6lxbvRYpMr34hImfpUxnfQ16br4l+gCaogxX9umYfLrIp9ylUFVziuqMVg4d7TONIvo7xN+1VAM0Za5MEnQuK6XcfgdBTQMqT47cGCmSuqTjT468d8coGx6owJYawIsmdkfPc/ns0f+6IezmN3NKRWohnfsvO02j6eloEo2iH24nb+KzH+PXb8Ioiv6CADaFJN+2oin3SPt64eX+vToya0o2NGxXKjI+i85eZlFpzzJdqvQbUofWavtlCp4JXw3wCyWFwoeuGR7OorOHaZ/O6+N0ZmrNpUjrcb+lYfxv0xmG90344zKJxqjRioNkh+tNkg6T0gq/raVmqDHx3ZzGpECf671K1fLkc4hh3I7yeLeXgwpoQ7vupKu0kmTKe+Pi8dh5vhRqOeLGhJ22SL5wYaKLMTdivJ4Ahewg3RBtDTMHwHp+uBEfcAvBP0skZUqSXTu3bFwZVDdiqWou15Mj+bolVW+FPdVJWaDydV1Zpi174s0W3GHKtCKtrz/S+mk4Yc5gIrK2JUJ2r+7VjS6QlQ6zUjIp1MrF92rE7q6yTCSCS/YnLpzwOH/VMff4+HjE2Ent8174vFwwi0bvzZf1Yk3r0Kt/OYEAPNrCXWU3aNciwbZKL4Qa18bjttHpkKJmLbiQ+8Pgl6dO1HhSJKgcDlrz/P31JTsNIwgGzfEVkMeXs7cXH28uaFdqr6ZEkzAKI1oy2vmCq0Gg9lqwP1UPirvbj+z/9hLRDoHHjR8byUU96jWpu3ZG72Cffjw4tOcB5Np5MtjtqHH/sLKqaPlziZakYB7AmlvBFzQpdztIhaPntD+CX2Tz1e/taX7Cvvb8fzaRbsQVzfeay5LeIIAVbg9vINW8Crox/9dQX0LRRDvUlR4M3Ygag/MkQeMH345OgQMpfXdxeXF7AQHwkso01LNVrWftA6XzLA+HgBoM9EuInnX4iRrrA25/7s2bLy869FfLxprYmFdV9TdesPbc",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyLLspB0mDMOyNuiMBk2wZBiwxAho6WSxpkiWpBwbhv77cHqzHCddMRQD9sWWqDvec8/dPeQOPF86iO/grVaeJ97BPIAUXWKF8UIriOE2R/YOJXpkrRE7v54xLqV+dGyrS+Y1s1joNTLOktYks7qgj7ZbWWi9Ctksqz2UZlKrJVqmEFPGmeHWi6SUvLf/3jGhMm0LTjgC5nPh6sAFX6FjwjPkbkux0wacz1FYZjHRNg0hAG3Q1r6zFGJojNq9IQDDLS/Qo6Xsd6B4gRDDZsSNGHm9QgUBCEo/R56ihQAsfi6FxRRib0sMwPmtJB8nCiMRAsCNkTpFiDMuHRkkORYc4h34raktvRVqCRWZ8topJpTKiaUKN5vNBqqgh9JCfRBph8Rwn8PT6lxbvRYpMr34hImfpUxnfQ16br4l+gCaogxX9umYfLrIp9ylUFVziuqMVg4d7TONIvo7xN+1VAM0Za5MEnQuK6XcfgdBTQMqT47cGCmSuqTjT468d8coGx6owJYawIsmdkfPc/ns0f+6IezmN3NKRWohnfsvO02j6eloEo2iH24nb+KzH+PXb8Ioiv6CADaFJN+2oin3SPt64eX+vToya0o2NGxXKjI+i85eZlFpzzJdqvQbUofWavtlCp4JXw3wCyWFwoeuGR7OorOHaZ/O6+N0ZmrNpUjrcb+lYfxv0xmG90344zKJxqjRioNkh+tNkg6T0gq/raVmqDHx3ZzGpECf671K1fLkc4hh3I7yeLeXgwpoQ7vupKu0kmTKe+Pi8dh5vhRqOeLGhJ22SL5wYaKLMTdivJ4Ahewg3RBtDTMHwHp+uBEfcAvBP0skZUqSXTu3bFwZVDdiqWou15Mj+bolVW+FPdVJWaDydV1Zpi174s0W3GHKtCKtrz/S+mk4Yc5gIrK2JUJ2r+7VjS6QlQ6zUjIp1MrF92rE7q6yTCSCS/YnLpzwOH/VMff4+HjE2Ent8174vFwwi0bvzZf1Yk3r0Kt/OYEAPNrCXWU3aNciwbZKL4Qa18bjttHpkKJmLbiQ+8Pgl6dO1HhSJKgcDlrz/P31JTsNIwgGzfEVkMeXs7cXH28uaFdqr6ZEkzAKI1oy2vmCq0Gg9lqwP1UPirvbj+z/9hLRDoHHjR8byUU96jWpu3ZG72Cffjw4tOcB5Np5MtjtqHH/sLKqaPlziZakYB7AmlvBFzQpdztIhaPntD+CX2Tz1e/taX7Cvvb8fzaRbsQVzfeay5LeIIAVbg9vINW8Crox/9dQX0LRRDvUlR4M3Ygag/MkQeMH345OgQMpfXdxeXF7AQHwkso01LNVrWftA6XzLA+HgBoM9EuInnX4iRrrA25/7s2bLy869FfLxprYmFdV9TdesPbc",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"}},f={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Delete contact"})}),"\n",(0,t.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(o.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.496e8402.js b/assets/js/7b076186.496e8402.js new file mode 100644 index 000000000..a02054b85 --- /dev/null +++ b/assets/js/7b076186.496e8402.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>x,contentTitle:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>b});var s=t(85893),l=t(11151),n=t(58219),c=(t(62316),t(51039)),o=t.n(c),i=(t(82723),t(9487)),r=t(41429),d=t(5397),m=t(4667),p=t(9472),h=t(85162);const u={id:"deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyJbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRsy3FS9MMwYF9s6fgc7+65N23B84WDdArvtfI88w5mEeToMiuMF1pBCvclsg8o0SPrQOzydsK4lPrJsY2umdfMYqVXyDjLOkhhdUWHdieZa70cskkRNJRmUqsFWqYQc8aZ4daLrJZ8j//eMaEKbStOfkTMl8IFwxVfomPCM+RuQ7bz1jlforDMYqZtPoQItEEbdCc5pNCCurshAsMtr9Cjpei3oHiFkEJ3/ihyiEBQ9Ib7Ep5Tcmv1SuTI9PwzZn6SM13sA987BBFY/FILizmk3tYYgfMbSWacqIwkAK6N1DlCWnDpCJCVWHFIt+A3JiC9FWoBEbRM9CW45uGWFEw5npdj7nJomhlZdUYrh47uGScJ/R37v8tj62jOXJ1l6FxRS7n5DqJAAypPitwYKbLAY/zZkfb21MuWB2LVEutetLZ39LwUz8H7X9fku/nNnEMTdXnKL/3XlcbJ+HwwSgbJD/ejd+nFj+nbd8MkSf6GCNaVJN0uozn3SPd64eXhvTmBtSnrAztJQ+CL5OJ1FpX2rNC1yv9F6tBabb9OwQvmm57/Qkmh8HFXDI8XycXjeB/O29NwJmrFpchDj93rJar/Npy+ed+aP02TaEHhHI6C7cvbIB1mtRV+E/p7PeBGDNrzdDqjNqnQl/owGsJM8CWkEHetHG8P46AButCudvOithJSKL03Lo1j5/lCqMWAGzPUBpUTCyX53A0zXcXciHg1AjK5c+mOaGuZOXJszw834hNuINrF3Ud1g6lEnqMNHNGcDModGzcG1Z1YqMDlanQyvu5plHbTNNdZXaHyIa+s0JY902Zz7jBnWtGADYckPx+OmDOYiaIriSF7UA/qTlfIaodFLZkUaunSBzVg05uiEJngkv2Fcyc8zt7smHt6ejph7CzofBS+rOfMotEH+CIIA619rf3LGUTg0VbuprhDuxIZdll6xVQcwHFX6LQZqFgrLuRhGfzyXIkKT4oMlcNeaV5+vL1m58MEol5xfIPL8fXk/dXvd1d0K5VXm6LRMBkmJDLa+YqrnqFuFx9W2VFyt4eW/d9u7q4JPK59bCQXodUDqduuR6dwCD/tLe1ZBKV2ngDbLRXun1Y2DYm/1GhpFMwiWHEr+Jw6ZbqFXDh6zvcr+FU23/zRbfMz9q37/8VAdi2uqL9XXNb0BhEscXP8BdLMmmjX5uRqC7jMMjS+p3oyl4+G24er66v7K4iA10Rcf8Isw4TpHsjAi54dj57WB/ptolcUfqJUf8LNz3t4e/KqQhfiDk0szZqm+QcbN6Km",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={id:"API-docs/deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/ivcfVkDyJbspB0mDMOyNuiMBkuwZBgwxwho6WSxpkiWpBwbhv77cJRsy3FS9MMwYF9s6fgc7+65N23B84WDdArvtfI88w5mEeToMiuMF1pBCvclsg8o0SPrQOzydsK4lPrJsY2umdfMYqVXyDjLOkhhdUWHdieZa70cskkRNJRmUqsFWqYQc8aZ4daLrJZ8j//eMaEKbStOfkTMl8IFwxVfomPCM+RuQ7bz1jlforDMYqZtPoQItEEbdCc5pNCCurshAsMtr9Cjpei3oHiFkEJ3/ihyiEBQ9Ib7Ep5Tcmv1SuTI9PwzZn6SM13sA987BBFY/FILizmk3tYYgfMbSWacqIwkAK6N1DlCWnDpCJCVWHFIt+A3JiC9FWoBEbRM9CW45uGWFEw5npdj7nJomhlZdUYrh47uGScJ/R37v8tj62jOXJ1l6FxRS7n5DqJAAypPitwYKbLAY/zZkfb21MuWB2LVEutetLZ39LwUz8H7X9fku/nNnEMTdXnKL/3XlcbJ+HwwSgbJD/ejd+nFj+nbd8MkSf6GCNaVJN0uozn3SPd64eXhvTmBtSnrAztJQ+CL5OJ1FpX2rNC1yv9F6tBabb9OwQvmm57/Qkmh8HFXDI8XycXjeB/O29NwJmrFpchDj93rJar/Npy+ed+aP02TaEHhHI6C7cvbIB1mtRV+E/p7PeBGDNrzdDqjNqnQl/owGsJM8CWkEHetHG8P46AButCudvOithJSKL03Lo1j5/lCqMWAGzPUBpUTCyX53A0zXcXciHg1AjK5c+mOaGuZOXJszw834hNuINrF3Ud1g6lEnqMNHNGcDModGzcG1Z1YqMDlanQyvu5plHbTNNdZXaHyIa+s0JY902Zz7jBnWtGADYckPx+OmDOYiaIriSF7UA/qTlfIaodFLZkUaunSBzVg05uiEJngkv2Fcyc8zt7smHt6ejph7CzofBS+rOfMotEH+CIIA619rf3LGUTg0VbuprhDuxIZdll6xVQcwHFX6LQZqFgrLuRhGfzyXIkKT4oMlcNeaV5+vL1m58MEol5xfIPL8fXk/dXvd1d0K5VXm6LRMBkmJDLa+YqrnqFuFx9W2VFyt4eW/d9u7q4JPK59bCQXodUDqduuR6dwCD/tLe1ZBKV2ngDbLRXun1Y2DYm/1GhpFMwiWHEr+Jw6ZbqFXDh6zvcr+FU23/zRbfMz9q37/8VAdi2uqL9XXNb0BhEscXP8BdLMmmjX5uRqC7jMMjS+p3oyl4+G24er66v7K4iA10Rcf8Isw4TpHsjAi54dj57WB/ptolcUfqJUf8LNz3t4e/KqQhfiDk0szZqm+QcbN6Km",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"}},x={},b=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete contact"})}),"\n",(0,s.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{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)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(n.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.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:"Contact not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "error": "Contact 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)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.350b9d87.js b/assets/js/8a725248.350b9d87.js new file mode 100644 index 000000000..d77c1084d --- /dev/null +++ b/assets/js/8a725248.350b9d87.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var t=s(85893),r=s(11151),l=s(58219),n=(s(62316),s(51039)),i=s.n(n),c=(s(82723),s(9487)),o=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const h={id:"createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1r40YQ/ivb+dQD2ZZs35WKUi4N4Qh3XEKdUqhjwloaW5usdvd2V3aM0X8vs5Ic2ckdDZQrhRDk2Xl9npnZ3YPnawfpHM618jzzDhYR5OgyK4wXWkEKNwWyc4vcI8saJXZ2fcm4lHrr2E5XzGuGq5W2XqJzcseyRlvhtrNwzBfcs4wrRvbcMSfWCq1jK23Jh2WiNNp6rjzLdVaVqLwbQgTaoOWUyWUOKTSeW6cQgcUvFTr/m853kO5PEr+2eiNyZEuUessMt7xEj5bSzY7qgQjoC5UnJ9wYKbIQc3TvyNMeXFZgyemLIgqLOWF2UXIhIYLPvESI4LrQCgk/vzMIKejlPQbnxlIVXqAjD0E73Xdazluh1hDBStuS+74EH3lpJCndayoDoY7aoK+3XyK+bwXDTJfkqkn4la6S8WScTJLJOIG6jsALH8RHzNwtiZCazp/w8rbCIHBGK9dgMY7j57y1rdiSlDNXZRk6t6qk3P3wGq6+zUMjprZ6HQCmSJbF4/jeEIT/czKnySQZhz9y0QJ+5l9y82Q0jseTQRIP4p9uknfp9Of07bthHMd/QQSPZahGBVQg5z5U2fVI97sy+XeIU5+qtc2Zo+dCur5Btwfq0LLTePq8KWe6RF8ItWZbVJ5trVbriBmJ3CHzdsf4mgvFJPdo/8UmRWu1/TZMr8usP7NCSaHwrpvIu2k8vUsOILx9DsKl2nAp8rD/b/QDqu9baT+8b8I/Z1k0SuEcjorty5siHWaVFX4H6XwPjwNuxKA5T+eLehEBAavp3jHahYy5LyCF0ek15NBu0LrgprISUii8Ny4djZzna6HWA27MUBtUdO1JvnQ0tSNuxGiTAEXqMpkRWg0gR/kcYOFGfMQdRF25fa0IBLFUIM/RBmiIhN+f7siLDsruFjrsosMqemm7HJbL0fKnaCsdUmshvjKoZmKtAkGbBJ6/JIRjwoXj7pIPzRJeASfWbMkd5kwr5gsMhySfDBPmDGZi1fbZkN2qW0UzwCqHq0oyKdSDS2/VgM2vViuRCS7Zn7h0wuPix46X7Xb7jI83weaD8EW1ZBaNflJfB2EgrW91+PEGIvBoS3e1mqHdiAzbHvhKqFFQHrXTQ01EE9Ay0IrenxoR5FJkqBz2+v3sw/UnNhnGEPVa7x+kPPp0eX7xeXZBXql5G4qSYTyMSUQdX3LVC3R++mY6Inf/tAf+4xdjOygeH/3ISC7CFgjQ7NsBnp+8IxcRFDTg6Rz2e2q7P6ysaxJ/qdDSdlhEsOFW8CX1+XxRR92Q0cQ/4K59taDygxsKT+qyaub1ZCXWUWdxlmVo/Dd1+zvo+mp2AxEs27duqXOysXxL72C+hRRu4RbCk5k8hB0S5HuQXK0rvg4DH/zSbuAVYdFfLA9hsbQfVFl3pHa9LI83TlMK/afCXjT4hcj/iLtfD+rNyVcNWmw7bWJwUdf139bFTx0=",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/createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1r40YQ/ivb+dQD2ZZs35WKUi4N4Qh3XEKdUqhjwloaW5usdvd2V3aM0X8vs5Ic2ckdDZQrhRDk2Xl9npnZ3YPnawfpHM618jzzDhYR5OgyK4wXWkEKNwWyc4vcI8saJXZ2fcm4lHrr2E5XzGuGq5W2XqJzcseyRlvhtrNwzBfcs4wrRvbcMSfWCq1jK23Jh2WiNNp6rjzLdVaVqLwbQgTaoOWUyWUOKTSeW6cQgcUvFTr/m853kO5PEr+2eiNyZEuUessMt7xEj5bSzY7qgQjoC5UnJ9wYKbIQc3TvyNMeXFZgyemLIgqLOWF2UXIhIYLPvESI4LrQCgk/vzMIKejlPQbnxlIVXqAjD0E73Xdazluh1hDBStuS+74EH3lpJCndayoDoY7aoK+3XyK+bwXDTJfkqkn4la6S8WScTJLJOIG6jsALH8RHzNwtiZCazp/w8rbCIHBGK9dgMY7j57y1rdiSlDNXZRk6t6qk3P3wGq6+zUMjprZ6HQCmSJbF4/jeEIT/czKnySQZhz9y0QJ+5l9y82Q0jseTQRIP4p9uknfp9Of07bthHMd/QQSPZahGBVQg5z5U2fVI97sy+XeIU5+qtc2Zo+dCur5Btwfq0LLTePq8KWe6RF8ItWZbVJ5trVbriBmJ3CHzdsf4mgvFJPdo/8UmRWu1/TZMr8usP7NCSaHwrpvIu2k8vUsOILx9DsKl2nAp8rD/b/QDqu9baT+8b8I/Z1k0SuEcjorty5siHWaVFX4H6XwPjwNuxKA5T+eLehEBAavp3jHahYy5LyCF0ek15NBu0LrgprISUii8Ny4djZzna6HWA27MUBtUdO1JvnQ0tSNuxGiTAEXqMpkRWg0gR/kcYOFGfMQdRF25fa0IBLFUIM/RBmiIhN+f7siLDsruFjrsosMqemm7HJbL0fKnaCsdUmshvjKoZmKtAkGbBJ6/JIRjwoXj7pIPzRJeASfWbMkd5kwr5gsMhySfDBPmDGZi1fbZkN2qW0UzwCqHq0oyKdSDS2/VgM2vViuRCS7Zn7h0wuPix46X7Xb7jI83weaD8EW1ZBaNflJfB2EgrW91+PEGIvBoS3e1mqHdiAzbHvhKqFFQHrXTQ01EE9Ay0IrenxoR5FJkqBz2+v3sw/UnNhnGEPVa7x+kPPp0eX7xeXZBXql5G4qSYTyMSUQdX3LVC3R++mY6Inf/tAf+4xdjOygeH/3ISC7CFgjQ7NsBnp+8IxcRFDTg6Rz2e2q7P6ysaxJ/qdDSdlhEsOFW8CX1+XxRR92Q0cQ/4K59taDygxsKT+qyaub1ZCXWUWdxlmVo/Dd1+zvo+mp2AxEs27duqXOysXxL72C+hRRu4RbCk5k8hB0S5HuQXK0rvg4DH/zSbuAVYdFfLA9hsbQfVFl3pHa9LI83TlMK/afCXjT4hcj/iLtfD+rNyVcNWmw7bWJwUdf139bFTx0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},x={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create contact"})}),"\n",(0,t.jsx)(i(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.7a441f87.js b/assets/js/8a725248.7a441f87.js deleted file mode 100644 index fdb429cdc..000000000 --- a/assets/js/8a725248.7a441f87.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21r40YQ/ivb+XQHsi3ZuSsVpVwawhHuuIRLSqGOCWtpbG+y2t3bXfkFo/9+zEqy5ThJGyhXCsZIszOzM8+8aguezx2kYzjTyvPMO5hEkKPLrDBeaAUp3CyQnVnkHllWM7HTqwvGpdQrxza6ZF4znM209RKdkxuW1dwKV62EY37BPcu4YiTPHXNirtA6NtOWdFgmCqOt58qzXGdlgcq7PkSgDVpOllzkkEKtuVEKERhueYEeLfmwBcULhBTWPW5Ez+sHVBCBICcWyHO0EIHFb6WwmEPqbYkROL+RJONEYSRCBLg2UucI6YxLRwzZAgsO6Rb8xgROb4WaQ0WsPAilZKUij/rr9XoN1aS+B53/Xecbkj2E9MrqpciRTVHqFds5QUBmB0hDBPSEypMSbowUWUBjcO9I07Zj3t6zMZwXXEiI4AsBEsHVQiukyDYu6Ok91vhZwtcLdKQhcB85GsFM24L7LmXv+b0mN5DgqC99vfwU8UND6Ge6IFW1wa9UlQxHw2SUjIYJVFUEXvhAPsiZuykFpKLzw0wIBGe0cjUWwzg+jltTJE2QcubKLEPnZqWUm59eE6uX41CTKeFfB4BZJNPFenhvCML/eTBPklEyDD9S0QB+6p9SsxcaxsNRL4l78c83yfv05Jf03ft+HMd/QQTrInjTdIic++BlmyPte2nyH3BP9ZitSc4cPRfSdQXaPlCFlD2JT46T8loX6BdCzdkKlWcrq9U8YkYid8i83TA+50IxyT3afzFJ0VptX4bpdZZ1a1YoKRTetRV5dxKf3CU7EN4dg3ChllyKPEymG2r8P9bT7vW+vv44yqJmqufSgbNdeu2kw6y0wm/CWOvOs3Q8ofFCwGqaiEa7ehD6BaQweDwgHdplOx1LK2kSem9cOhg4z+dCzXvcmH47viSfOqraATdisEzCIGstuSa0akAO7NnBwo34hBuI/n4Kk4MUhK/7GXneQtlOoV0v2rWip7rLrrkcNH+6baaDaQ3ElwbVtZirEKBlAsc7jnBMuHDcrh8hWcJ+8kiaTbnDnGnF/ALDIdFH/YQ5g5mYNXnWZ7fqVlENsNLhrJRMCvXg0lvVY+PL2Uxkgkv2J06d8Dh508ZltVodxeNtkPko/KKcMotG79nngRiC1pXavbyFCDzawl3OrtEuRYZNDjxz1SAwD5rqoSSiCmgi0JA+PBYiyKXIUDns5Pvpx6vPbNSPIeqk3j8wefD54uz8y/U5aaXkrUOU9ON+TCTK+IKrzkVnj3emg+Bu933gP95lm0LxuPYDI7kIXSBAs20KePxow51EsKACT8ew3VLa/WFlVRH5W4mWusMkgiW3gk8pz8eTKmqLjCo+F44O8t0y+ywwb74229Bb9pyhD7g5quollyVxQhVtG4azWmfvhnTsOY4a8F7iNMvQ+Bd5ux3v6vL6BiKYNpt1EZZ1sHxF2z1fQQq3cAvh04E0hI4V6FuQXM1LPg/tJeilTsRLQr7bxh5CG2seCMf2SG06Vh4iUbtC/+TYkwK/Uqp9ws1vO/b65FmB3UdLzU1hmFRV9R1haqi9",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21r40YQ/ivb+XQHsi3ZuSsVpVwawhHuuIRLSqGOCWtpbG+y2t3bXfkFo/9+zEqy5ThJGyhXCsZIszOzM8+8aguezx2kYzjTyvPMO5hEkKPLrDBeaAUp3CyQnVnkHllWM7HTqwvGpdQrxza6ZF4znM209RKdkxuW1dwKV62EY37BPcu4YiTPHXNirtA6NtOWdFgmCqOt58qzXGdlgcq7PkSgDVpOllzkkEKtuVEKERhueYEeLfmwBcULhBTWPW5Ez+sHVBCBICcWyHO0EIHFb6WwmEPqbYkROL+RJONEYSRCBLg2UucI6YxLRwzZAgsO6Rb8xgROb4WaQ0WsPAilZKUij/rr9XoN1aS+B53/Xecbkj2E9MrqpciRTVHqFds5QUBmB0hDBPSEypMSbowUWUBjcO9I07Zj3t6zMZwXXEiI4AsBEsHVQiukyDYu6Ok91vhZwtcLdKQhcB85GsFM24L7LmXv+b0mN5DgqC99vfwU8UND6Ge6IFW1wa9UlQxHw2SUjIYJVFUEXvhAPsiZuykFpKLzw0wIBGe0cjUWwzg+jltTJE2QcubKLEPnZqWUm59eE6uX41CTKeFfB4BZJNPFenhvCML/eTBPklEyDD9S0QB+6p9SsxcaxsNRL4l78c83yfv05Jf03ft+HMd/QQTrInjTdIic++BlmyPte2nyH3BP9ZitSc4cPRfSdQXaPlCFlD2JT46T8loX6BdCzdkKlWcrq9U8YkYid8i83TA+50IxyT3afzFJ0VptX4bpdZZ1a1YoKRTetRV5dxKf3CU7EN4dg3ChllyKPEymG2r8P9bT7vW+vv44yqJmqufSgbNdeu2kw6y0wm/CWOvOs3Q8ofFCwGqaiEa7ehD6BaQweDwgHdplOx1LK2kSem9cOhg4z+dCzXvcmH47viSfOqraATdisEzCIGstuSa0akAO7NnBwo34hBuI/n4Kk4MUhK/7GXneQtlOoV0v2rWip7rLrrkcNH+6baaDaQ3ElwbVtZirEKBlAsc7jnBMuHDcrh8hWcJ+8kiaTbnDnGnF/ALDIdFH/YQ5g5mYNXnWZ7fqVlENsNLhrJRMCvXg0lvVY+PL2Uxkgkv2J06d8Dh508ZltVodxeNtkPko/KKcMotG79nngRiC1pXavbyFCDzawl3OrtEuRYZNDjxz1SAwD5rqoSSiCmgi0JA+PBYiyKXIUDns5Pvpx6vPbNSPIeqk3j8wefD54uz8y/U5aaXkrUOU9ON+TCTK+IKrzkVnj3emg+Bu933gP95lm0LxuPYDI7kIXSBAs20KePxow51EsKACT8ew3VLa/WFlVRH5W4mWusMkgiW3gk8pz8eTKmqLjCo+F44O8t0y+ywwb74229Bb9pyhD7g5quollyVxQhVtG4azWmfvhnTsOY4a8F7iNMvQ+Bd5ux3v6vL6BiKYNpt1EZZ1sHxF2z1fQQq3cAvh04E0hI4V6FuQXM1LPg/tJeilTsRLQr7bxh5CG2seCMf2SG06Vh4iUbtC/+TYkwK/Uqp9ws1vO/b65FmB3UdLzU1hmFRV9R1haqi9",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},y=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create contact"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.96daf7b3.js b/assets/js/a2bc1463.96daf7b3.js deleted file mode 100644 index f73e515db..000000000 --- a/assets/js/a2bc1463.96daf7b3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>v,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb/XQB2ZaT3JWKUi4cIYQLl3BJKTQxx1oaWxOvdvd2V4qN0X8vs5JsKU56vVKOQkji2Xl55u3xbLkXS8eTe/5BKy9S7/gs4hm41KLxqBVP+F0OrH1lV+g8O7u5ZFAY/QTWsY0umdfMgrcIFTDBJOnoBUtbjxEzVleYoVoywVJdGAs5KIcVsArhiXSFlExUAqWYS9hZMlTk33aCudarMY+4NmAFobvMeMLbRwrLI26EFQV4sJTVlitRAE/4eiQMjrxegeIRR0orB5GB5RG38LVECxlPvC0h4s5vJNk4LIwEHnFYG6kz4MlCSEcKaQ6F4MmW+40Jmt6iWvKaVEUwSgijcrhU4/V6veZ1tIMisUDfgfhagt0MMHQxWhALbYs+hBbicwSqLOZgBwimcS+oW6H5ATHjekZ+ndHKgSPd4zimP8OJcmWagnOLUrJdK3kUGgnKk74wRmIaHiaPjoy2hwD0/BHS0HNLbjw2IS24UvqenrBWUMLooXDftm/ENFrPGxyF0gjfl+w7bvLpPF8fPxoqyadQ9+9z8KiBzQHI/LwQKP+F/RzgfSsYp7ogVze5Vt8N5XR6Mj0OP+QitSA8ZGf+JTd7o+P4+GQ0jUfxz3fTd8npL8nbd+M4jv/kEV8XIZt2GjPhQ5Yevex/Lk32A+LUz9VaAsnAC5Sub9C+8LruCVFJVPClG/MvNOJ10DiN3x4O+6WqhMQssOYdEdBP/92og7Xa/n2x+uF9E/6wAtgoNfw4SLUvb5J0kJYW/SbQa59Xk/sZrX8BPtfEy0to+NjnPOGTIUs7sFVH0aWVRMfeG5dMJs6LJarlSBgz7jhUirmjcZ4Ig5NqyilMB+OWStVUYwBmv/0GPwKt/ze/Cig7VAsdjNsKXBtQt7hUoX7VlB9+OaJj6MJzptOyAOVDL9lCW/bMms2Fg4xpxXwO4ZHkJ+MpcwZSXLRjMGYP6kHd6gJY6YBYUqJaueRBjdj99WKBKQrJ/oC5Qw+zN13lnp6eDip2FGwu0OflnFkweq++DMJQ1r7V7sMRj7gHW7jrxS3YClNou/RKqElQnrTDTVtDA9rwWCd6/9yIhk1iCspBbxzPLm6u2Mk45lFvOP4B5MnV5YfzT7fn5JXGq2nRdByPYxIZ7XwhVC/QBfjutmDtZA7au90v6v/wDGoH3MPaT4wUGFY3FGzbrt394DiaRTzXzpN4u6VR/N3KuiZxcxLQMmboKPb+KFjBpne0VEKWFDMcNK/otrfGXnVGHyySbiCJqFu4FwO+2oA3n9uD5Yi9lnwDYLjhA8iNwlmagumnc8DBAyK7OL/jERclVbRPK6tAK+0/lEv3pDY930M0DQD6TXBeNPiVBusjbH7bqTcvrxrsLtlGm0oxq+v6Ly6lBSM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb/XQB2ZaT3JWKUi4cIYQLl3BJKTQxx1oaWxOvdvd2V4qN0X8vs5JsKU56vVKOQkji2Xl55u3xbLkXS8eTe/5BKy9S7/gs4hm41KLxqBVP+F0OrH1lV+g8O7u5ZFAY/QTWsY0umdfMgrcIFTDBJOnoBUtbjxEzVleYoVoywVJdGAs5KIcVsArhiXSFlExUAqWYS9hZMlTk33aCudarMY+4NmAFobvMeMLbRwrLI26EFQV4sJTVlitRAE/4eiQMjrxegeIRR0orB5GB5RG38LVECxlPvC0h4s5vJNk4LIwEHnFYG6kz4MlCSEcKaQ6F4MmW+40Jmt6iWvKaVEUwSgijcrhU4/V6veZ1tIMisUDfgfhagt0MMHQxWhALbYs+hBbicwSqLOZgBwimcS+oW6H5ATHjekZ+ndHKgSPd4zimP8OJcmWagnOLUrJdK3kUGgnKk74wRmIaHiaPjoy2hwD0/BHS0HNLbjw2IS24UvqenrBWUMLooXDftm/ENFrPGxyF0gjfl+w7bvLpPF8fPxoqyadQ9+9z8KiBzQHI/LwQKP+F/RzgfSsYp7ogVze5Vt8N5XR6Mj0OP+QitSA8ZGf+JTd7o+P4+GQ0jUfxz3fTd8npL8nbd+M4jv/kEV8XIZt2GjPhQ5Yevex/Lk32A+LUz9VaAsnAC5Sub9C+8LruCVFJVPClG/MvNOJ10DiN3x4O+6WqhMQssOYdEdBP/92og7Xa/n2x+uF9E/6wAtgoNfw4SLUvb5J0kJYW/SbQa59Xk/sZrX8BPtfEy0to+NjnPOGTIUs7sFVH0aWVRMfeG5dMJs6LJarlSBgz7jhUirmjcZ4Ig5NqyilMB+OWStVUYwBmv/0GPwKt/ze/Cig7VAsdjNsKXBtQt7hUoX7VlB9+OaJj6MJzptOyAOVDL9lCW/bMms2Fg4xpxXwO4ZHkJ+MpcwZSXLRjMGYP6kHd6gJY6YBYUqJaueRBjdj99WKBKQrJ/oC5Qw+zN13lnp6eDip2FGwu0OflnFkweq++DMJQ1r7V7sMRj7gHW7jrxS3YClNou/RKqElQnrTDTVtDA9rwWCd6/9yIhk1iCspBbxzPLm6u2Mk45lFvOP4B5MnV5YfzT7fn5JXGq2nRdByPYxIZ7XwhVC/QBfjutmDtZA7au90v6v/wDGoH3MPaT4wUGFY3FGzbrt394DiaRTzXzpN4u6VR/N3KuiZxcxLQMmboKPb+KFjBpne0VEKWFDMcNK/otrfGXnVGHyySbiCJqFu4FwO+2oA3n9uD5Yi9lnwDYLjhA8iNwlmagumnc8DBAyK7OL/jERclVbRPK6tAK+0/lEv3pDY930M0DQD6TXBeNPiVBusjbH7bqTcvrxrsLtlGm0oxq+v6Ly6lBSM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},v={},g=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.b1ad234a.js b/assets/js/a2bc1463.b1ad234a.js new file mode 100644 index 000000000..a42c147ca --- /dev/null +++ b/assets/js/a2bc1463.b1ad234a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>b,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>u,toc:()=>v});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb+dQD2ZaT3JWKUi4cIYQLl0BSCk3MsZbG1sSr3b3dlWNj9N/LrGRbji9tr5SjYGxr5nlmdl61Gwhy7iF7gA9GB5kHD5MECvS5IxvIaMjgvkTRacU1+SDOb68EVtY8o/NibWoRjHAYHOEShRSKMWYm8s5iIqwzSypIz4UUuamswxK1pyWKJeEzY6VSQi4lKTlVuGMK0mzfbQVTYxZDSMBYdJJPd1VABp2S3UICVjpZYUDHUW1AywohA0UVsZY4oC81ujUk4PBLTQ4LyGZSeUzAh7Vi9My4ChLAlVWmQMiCq1mbl1hJyDYQ1pZhuq6m6KBhpKwsU8dpk+yc+gXZ7+AzbSZs11ujPXrGnqQp/xyW0dd5jt7PaiV2+YMkZg91YLy0VlEeFaMnz6TN8QHM9AnzmGjHZgK1Lh36WoUeTjonOWAKWPm/57dirucO6YMjPYckpkaGvmQXO9hyPC1XJ0+WU/Ip5v3bDDwZFFNEpl9UktS/4E8R33eCYW4qNnVbGv3NRzkbn45P4odN5A5lwOI8fM3MnnSSnpwOxukg/el+/C47+zl7+26YpukfkMCqitF03VjIEKMMFFT/ubbFd/DTvIR1U1tgkKR8n9BpoGl6QtKKNH7etvlnbvEmIs7St8fNfqWXUlERV9W9WaD+4b9rdXTOuL9OVt99aN0fZ4BaUNTDQah9eRukx7x2FNZxp60G0tKg1WcPEx7/CkNpeBnOsV2CoYQMRoer0aNbbvdi7RRkUIZgfTYa+SDnpOcDae3QWN7Nc63k1HM7j6Sl0XIM7GZ7jDtOVZuNg8Psp9/SR+Tx72Lto7qNWKIseJM1/Dwzkdxl4MaivqO5jvlbjuH4jURekI/qwuR1hTrEWoqZceIFW0ylx0IYLUKJUcny0+FYeIs5zbo2GIpH/ajvTIWi9shbUpFe+OxRD8TDzWxGOUklfsepp4CTH7eZe35+PsrYm8i5pFDWU+HQmj18HoUxrX3W7uENJBDQVf5mdoduSTl2VXrF1SiCR11z89Rwg7Z7bCt6/5LEzaYoR+2x147nl7fX4nSYQtJrjn9w5NH11YeLT3cXbJXbqy3ReJgOUxZZ40Mldc/RJYbtC110nXlQ3s1+UP+Hd4+uwQOuwsgqSXF0Y8I23dg9HNxIJgmUxgcWbzbcir851TQsbq8EPIwFefa9vxQscN27tCylqtkn8N3iFWx319hDJ/zgiLFxSSTbgWOHLec8z9H2HRxtxYPVcnlxDwnImmPsD/oiDnr3h61vVXrds324AdoD8DfH9FXCL1zqj7j+dQdvNa8Suvi2aK7MpGmaPwF9YrDe",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r40YQ/ivb+dQD2ZaT3JWKUi4cIYQLl0BSCk3MsZbG1sSr3b3dlWNj9N/LrGRbji9tr5SjYGxr5nlmdl61Gwhy7iF7gA9GB5kHD5MECvS5IxvIaMjgvkTRacU1+SDOb68EVtY8o/NibWoRjHAYHOEShRSKMWYm8s5iIqwzSypIz4UUuamswxK1pyWKJeEzY6VSQi4lKTlVuGMK0mzfbQVTYxZDSMBYdJJPd1VABp2S3UICVjpZYUDHUW1AywohA0UVsZY4oC81ujUk4PBLTQ4LyGZSeUzAh7Vi9My4ChLAlVWmQMiCq1mbl1hJyDYQ1pZhuq6m6KBhpKwsU8dpk+yc+gXZ7+AzbSZs11ujPXrGnqQp/xyW0dd5jt7PaiV2+YMkZg91YLy0VlEeFaMnz6TN8QHM9AnzmGjHZgK1Lh36WoUeTjonOWAKWPm/57dirucO6YMjPYckpkaGvmQXO9hyPC1XJ0+WU/Ip5v3bDDwZFFNEpl9UktS/4E8R33eCYW4qNnVbGv3NRzkbn45P4odN5A5lwOI8fM3MnnSSnpwOxukg/el+/C47+zl7+26YpukfkMCqitF03VjIEKMMFFT/ubbFd/DTvIR1U1tgkKR8n9BpoGl6QtKKNH7etvlnbvEmIs7St8fNfqWXUlERV9W9WaD+4b9rdXTOuL9OVt99aN0fZ4BaUNTDQah9eRukx7x2FNZxp60G0tKg1WcPEx7/CkNpeBnOsV2CoYQMRoer0aNbbvdi7RRkUIZgfTYa+SDnpOcDae3QWN7Nc63k1HM7j6Sl0XIM7GZ7jDtOVZuNg8Psp9/SR+Tx72Lto7qNWKIseJM1/Dwzkdxl4MaivqO5jvlbjuH4jURekI/qwuR1hTrEWoqZceIFW0ylx0IYLUKJUcny0+FYeIs5zbo2GIpH/ajvTIWi9shbUpFe+OxRD8TDzWxGOUklfsepp4CTH7eZe35+PsrYm8i5pFDWU+HQmj18HoUxrX3W7uENJBDQVf5mdoduSTl2VXrF1SiCR11z89Rwg7Z7bCt6/5LEzaYoR+2x147nl7fX4nSYQtJrjn9w5NH11YeLT3cXbJXbqy3ReJgOUxZZ40Mldc/RJYbtC110nXlQ3s1+UP+Hd4+uwQOuwsgqSXF0Y8I23dg9HNxIJgmUxgcWbzbcir851TQsbq8EPIwFefa9vxQscN27tCylqtkn8N3iFWx319hDJ/zgiLFxSSTbgWOHLec8z9H2HRxtxYPVcnlxDwnImmPsD/oiDnr3h61vVXrds324AdoD8DfH9FXCL1zqj7j+dQdvNa8Suvi2aK7MpGmaPwF9YrDe",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},b={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.18fa1b31.js b/assets/js/a88a3db3.18fa1b31.js new file mode 100644 index 000000000..04e4a307b --- /dev/null +++ b/assets/js/a88a3db3.18fa1b31.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>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),p=l(5397),o=l(4667),c=l(9472),h=l(85162);const u={id:"delete-template",title:"Delete template by 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 by 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+vPYpGg2TYeJFRjuquOo5atfmYZ0st2xyd5rj3bE3/1e7tq1vwg3FRnIR+jTwtWsbcH5YrRBB2l+ziwhK7cir7Ha+Kn+3smm8+EuNdgvpfBHBmlvBl74N5jvIhfP/88O6/CZH7z61m/eC/bON/VVAXRcr38JrLmt/ggiecXvy6dAsmqhrZR/xXuM2y9BQz/Zsuvppchhhd+P78WwMTfMXjBVDFQ==",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 by 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 by 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 by 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+vPYpGg2TYeJFRjuquOo5atfmYZ0st2xyd5rj3bE3/1e7tq1vwg3FRnIR+jTwtWsbcH5YrRBB2l+ziwhK7cir7Ha+Kn+3smm8+EuNdgvpfBHBmlvBl74N5jvIhfP/88O6/CZH7z61m/eC/bON/VVAXRcr38JrLmt/ggiecXvy6dAsmqhrZR/xXuM2y9BQz/Zsuvppchhhd+P78WwMTfMXjBVDFQ==",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 by 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 by 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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.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)(o.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)(p.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)(o.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)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.3e8883fd.js b/assets/js/a88a3db3.3e8883fd.js deleted file mode 100644 index a352f753b..000000000 --- a/assets/js/a88a3db3.3e8883fd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),m=(s(82723),s(9487)),r=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const x={id:"delete-template",title:"Delete template by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3baXof507q1uAUr1sOaYcDaoFBsOtZVlnSSnCYI/N8HynbiJtfuBYdhn1rTpMnnIfkwW/B86SC9hxlWRnKPDuYR5OgyK4wXWkEKsxLZFUr0yHovdvlxyozVK5GjYxtds2fhS+ZLZHwhpPAb5jWzWOkVMs6cwUwUImO+jy+sroJ7b3FjNi0Y33sIx5RmUqslWqYQc8whAm3QcqprmkMKeaiqLwoiMNzyCj1awrQFxSuEFNYjbsTI6ydUEIEgTCXyHC1EYPFzLSzmkHpbYwTObyTFOFEZSZ/EtZE6R0gLLh05ZCVWHNIt+I0Jnt4KtYSGXHkISqlM5cRSjdfr9RqaaFdKD+9R5H0phvsSDjmfXjFdvCCI+ZL7QIQjbhfIWvT51wQRQaFtxf0AVjOn7zujlUNHEadJQn8OZqSvsiuKuTrL0LmilnLzDUSQaeVReYrkxkiRhS7GnxyFb48L0otPmHlqqaWee9Emb83U/OPS9/T/sC5PuTM/mTNqS1fSpX876DQ5PRtNklHy7WxykZ5/l76/GCdJ8gdEsK4kxXY9zGnWmgi88HL/3By5hbQvHDtLQ87nyfkbNCrtWaFrlX9F7tBabd/m4Ev5mwECoaRQ+NjPw+N5cv54sQP0/hjQVK24FHnQixkt4H+LZ5jet+mPGyVap1YfXoAd2luQFfpS76UnSI4vIYW439N4O9jxBiJwaFe9INVWkvh4b1wax87zpVDLETdm3CuG5As3znQVcyPi1QRo/RxmtRV+c0fEtNiHkrZngBvxM24g+mvhIyxCFToEd3hvDao7sVSBrdXkSJNmpXAky/Q611ldofKhc6zQlh1EswV3mDOtgojRS7KfjSe7YxBCx+xBPag7XSGrHRa1ZFKoJ5c+qBG7vy0KkQku2e+4cMLj/F3P3PPz8xFjJyHmg/BlvWAWjd67L4Mx0DqM2j2cQAQebeVuizu0K5Fh16VXUsXBOe5GmWdhlLHigrrbmb4/DKLRkiJD5XAwfJcfPt6ws3EC0WA4/kbJ8c30x+tf7q7pqzRebYsm42SckMlo5yuuBom6C747J4sNm14d9ni7383/1dnv5tvj2sdGchH2NPC17RbwfndaIYJ0eGbnEZTaeXLZbmkqf7Oyacj8uUa7gfR+HsGKW8EXtAb3W8iFo//z3bl8laN3v3aX94T9s4v9RUD9Fita4RWXNT1BBE+4Ofjp0MybqF/lf13xa2W06V5qx64a+i3TOlxmGRo/eHek5aRdO8G8ur65nl1D0/wJm2uXSw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/delete-template",title:"Delete template by 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 by 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 by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3baXof507q1uAUr1sOaYcDaoFBsOtZVlnSSnCYI/N8HynbiJtfuBYdhn1rTpMnnIfkwW/B86SC9hxlWRnKPDuYR5OgyK4wXWkEKsxLZFUr0yHovdvlxyozVK5GjYxtds2fhS+ZLZHwhpPAb5jWzWOkVMs6cwUwUImO+jy+sroJ7b3FjNi0Y33sIx5RmUqslWqYQc8whAm3QcqprmkMKeaiqLwoiMNzyCj1awrQFxSuEFNYjbsTI6ydUEIEgTCXyHC1EYPFzLSzmkHpbYwTObyTFOFEZSZ/EtZE6R0gLLh05ZCVWHNIt+I0Jnt4KtYSGXHkISqlM5cRSjdfr9RqaaFdKD+9R5H0phvsSDjmfXjFdvCCI+ZL7QIQjbhfIWvT51wQRQaFtxf0AVjOn7zujlUNHEadJQn8OZqSvsiuKuTrL0LmilnLzDUSQaeVReYrkxkiRhS7GnxyFb48L0otPmHlqqaWee9Emb83U/OPS9/T/sC5PuTM/mTNqS1fSpX876DQ5PRtNklHy7WxykZ5/l76/GCdJ8gdEsK4kxXY9zGnWmgi88HL/3By5hbQvHDtLQ87nyfkbNCrtWaFrlX9F7tBabd/m4Ev5mwECoaRQ+NjPw+N5cv54sQP0/hjQVK24FHnQixkt4H+LZ5jet+mPGyVap1YfXoAd2luQFfpS76UnSI4vIYW439N4O9jxBiJwaFe9INVWkvh4b1wax87zpVDLETdm3CuG5As3znQVcyPi1QRo/RxmtRV+c0fEtNiHkrZngBvxM24g+mvhIyxCFToEd3hvDao7sVSBrdXkSJNmpXAky/Q611ldofKhc6zQlh1EswV3mDOtgojRS7KfjSe7YxBCx+xBPag7XSGrHRa1ZFKoJ5c+qBG7vy0KkQku2e+4cMLj/F3P3PPz8xFjJyHmg/BlvWAWjd67L4Mx0DqM2j2cQAQebeVuizu0K5Fh16VXUsXBOe5GmWdhlLHigrrbmb4/DKLRkiJD5XAwfJcfPt6ws3EC0WA4/kbJ8c30x+tf7q7pqzRebYsm42SckMlo5yuuBom6C747J4sNm14d9ni7383/1dnv5tvj2sdGchH2NPC17RbwfndaIYJ0eGbnEZTaeXLZbmkqf7Oyacj8uUa7gfR+HsGKW8EXtAb3W8iFo//z3bl8laN3v3aX94T9s4v9RUD9Fita4RWXNT1BBE+4Ofjp0MybqF/lf13xa2W06V5qx64a+i3TOlxmGRo/eHek5aRdO8G8ur65nl1D0/wJm2uXSw==",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 by ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,l.jsx)(d(),{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)(r.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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function 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/bbdfc22d.b692819f.js b/assets/js/bbdfc22d.b692819f.js new file mode 100644 index 000000000..b7389ca6d --- /dev/null +++ b/assets/js/bbdfc22d.b692819f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>x,contentTitle:()=>h,default:()=>j,frontMatter:()=>u,metadata:()=>g,toc:()=>b});var a=t(85893),l=t(11151),i=t(58219),r=(t(62316),t(51039)),n=t.n(r),c=(t(82723),t(9487)),o=(t(41429),t(5397)),d=t(4667),p=t(9472),m=t(85162);const u={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v20YQ/SvbOSUCJcpJeuGprhsERgPbgBz0IBvGkhyJE5O7692hZMXgfy9mKSq0rRQ55NiTyPnYmXnz9lFPwHodIFvCNTau1owBbhMoMRSeHJM1kMF1hWpwqzOPWuzq9Opc6bq226DagD4otqoQJ6qiDWwb+qbzGhUPBydqW1FRqYB+g0oHldctOk+Gg1pZr9Zo0Gsms1alLdoGxbElrpTzWOKKDJYqsG8Lbj2GmfrirFGhLQoMYdXWh0p9G2RNorjC2KhHbr0JSqvW0EOLajIZos/LyURxpVkV2qgcZZpShtn3g6Nuci0+a+K5wWFBK5LgobA2pZpMWl/LkVZhSXxwziAB6+KE1pyXkEGP1uCHBDw+tBj4T1vuIHuCwhpGw/LYtDWT057TlfXNtNSsxRyKCpv4xDuHkIHNv2LBkIDzUosJg3hXVOMoKrAns4YE5DDNkEFORvsddAlc6OZIaJfAX2NOHPFfWD6euKC1QR9GPu293kECxNiEIzldlwATS88vQLrLBZsYIGCRxxIy9i1GQ3DWhH7id/O5/Lwg8jOCCJsO5Kl3v0EyRlw7V1MRl5V+Df3MPwt3b5YdHyJN2+ToBY7W18dWgY+6cXHiitmFLE33ltbXs8I2MAaFTE0G74aJ797N53cfBJYugQ/z319Pfm42uqYy3oVre4/mF06L3lv/3yONy3NfXlp9bCIUJlIOqA+Kfng27NjeD9kgV1bukLMhdqS5ggzSV1cqio2Qb/nUI3+AN7Bek1lPtXMz69AEWpta50HATrWjdHMC3a2cULSeeLcQOPqJH6fa0bRvaMRqR3+j0Ho/zzgqAZI1VKhLYUEn7ysbk/dTXjo0clMiRpsTeC3CFBSF6B4EqRdi0c4X2c+FSpxifz87GUSrX/VM3Zgbs7BNFD2R0JrMfchuzFQtL1crKkjX6h/MAzHevhmQ2263rxB7G3M+EVdtrjw6+z18HY0R1nHW4eUtJMDom3C5WqDfUDFcgh+USmNwuiewLiKBsdEk292b/niZJISqqUATcES5009Xn9X72RySETl+ouX08/nZx4vFRzlV6NWv6GQ2n83FJKRstBkVOus/jCNils/l9HAX///a/rKv7f5eMj5y6mpNZiS/vWAsX36DbxOoRFGyJTw9Sf0vvu46MT+06HeQLW8T2GhPAra8dclwqUVh7nEny+53Ob2W+hJet9LHsW94lwxJp0WBjkfhryRZxOige1eXi2tIIN//VWhsKTlycDw3+f4oTXbdv4qoets=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,g={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 **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVk1v20YQ/SvbOSUCJcpJeuGprhsERgPbgBz0IBvGkhyJE5O7692hZMXgfy9mKSq0rRQ55NiTyPnYmXnz9lFPwHodIFvCNTau1owBbhMoMRSeHJM1kMF1hWpwqzOPWuzq9Opc6bq226DagD4otqoQJ6qiDWwb+qbzGhUPBydqW1FRqYB+g0oHldctOk+Gg1pZr9Zo0Gsms1alLdoGxbElrpTzWOKKDJYqsG8Lbj2GmfrirFGhLQoMYdXWh0p9G2RNorjC2KhHbr0JSqvW0EOLajIZos/LyURxpVkV2qgcZZpShtn3g6Nuci0+a+K5wWFBK5LgobA2pZpMWl/LkVZhSXxwziAB6+KE1pyXkEGP1uCHBDw+tBj4T1vuIHuCwhpGw/LYtDWT057TlfXNtNSsxRyKCpv4xDuHkIHNv2LBkIDzUosJg3hXVOMoKrAns4YE5DDNkEFORvsddAlc6OZIaJfAX2NOHPFfWD6euKC1QR9GPu293kECxNiEIzldlwATS88vQLrLBZsYIGCRxxIy9i1GQ3DWhH7id/O5/Lwg8jOCCJsO5Kl3v0EyRlw7V1MRl5V+Df3MPwt3b5YdHyJN2+ToBY7W18dWgY+6cXHiitmFLE33ltbXs8I2MAaFTE0G74aJ797N53cfBJYugQ/z319Pfm42uqYy3oVre4/mF06L3lv/3yONy3NfXlp9bCIUJlIOqA+Kfng27NjeD9kgV1bukLMhdqS5ggzSV1cqio2Qb/nUI3+AN7Bek1lPtXMz69AEWpta50HATrWjdHMC3a2cULSeeLcQOPqJH6fa0bRvaMRqR3+j0Ho/zzgqAZI1VKhLYUEn7ysbk/dTXjo0clMiRpsTeC3CFBSF6B4EqRdi0c4X2c+FSpxifz87GUSrX/VM3Zgbs7BNFD2R0JrMfchuzFQtL1crKkjX6h/MAzHevhmQ2263rxB7G3M+EVdtrjw6+z18HY0R1nHW4eUtJMDom3C5WqDfUDFcgh+USmNwuiewLiKBsdEk292b/niZJISqqUATcES5009Xn9X72RySETl+ouX08/nZx4vFRzlV6NWv6GQ2n83FJKRstBkVOus/jCNils/l9HAX///a/rKv7f5eMj5y6mpNZiS/vWAsX36DbxOoRFGyJTw9Sf0vvu46MT+06HeQLW8T2GhPAra8dclwqUVh7nEny+53Ob2W+hJet9LHsW94lwxJp0WBjkfhryRZxOige1eXi2tIIN//VWhsKTlycDw3+f4oTXbdv4qoets=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},x={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:t}=s;return t||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create template"})}),"\n",(0,a.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template and ",(0,a.jsx)(s.strong,{children:"url"})," to edit template."]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function j(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.ec04bb2d.js b/assets/js/bbdfc22d.ec04bb2d.js deleted file mode 100644 index bf94bb4c3..000000000 --- a/assets/js/bbdfc22d.ec04bb2d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var t=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktvGzcQ/ivsnGJh9XCSXvZU1w0Co4FtVA56sA2D2h1pJ+aSNDmrRwT992K4kryy7DaHHHvSat7z8Zsh18B6FiG/hRusvdGMEe4zKDEWgTyTs5DDTYVqp1bnAbXI1dn1hdLGuEVUTcQQFTtViBJV0UR2NX3XE4OKd4EztaioqFTEMEelo5qYBn0gy1FNXVAztBg0k52p0hVNjaJYEFfKByxxShZLFTk0BTcB40B99c6q2BQFxjhtzD5TWwY5mymuMBUakJtgo9KqsfTUoOr1dtYXZa+nuNKsCm3VBKWbUprZ1oOdaiZadM6muNFjQVMS411ibUvV6zXBSEinsCTeKweQgfOpQ2cvSsihRWunhwy8DrpGxiAnsgara4Qcln3tqc/uES1kQHIiFeoSA2QQ8KmhgCXkHBrMIPLKiE+k2hsJiUtvXImQT7WJYlBUWGvI18Arnyw5kJ3BRkx1csqlTBtpZgfL5XIJm/s2D0b+3ZUr8S2cZbQsn3VjmLwOPJy6UPdLzSn6UR43+YYFS5NBUGDCKNopScaX1WQgwTRDDhOyOqykvssExyuF/9Fl6yv6S8evO45pZhPYe50OQa8EZcY6vuKz2WTAxAmlw+N7mAg2yeDwUJIgemdj2/H70Uh+XozYAXWF53tam9UvkHUR194bKhKNht9i2/OPwt2KhX17S9vUEwwCRxPMa0fxzIuK2cd8ONxKmmAGhauhCwpZQxYfdh0/vB+NHj4KLJsMPo5+Pe78ws61oTJN6Y1w/Cd2iyG48O8tddNzm15KXdYJiu0EUmvUjuBBs11522SNXDmZbu9iqkhzBTkMj4Y9rcHtpCfk9/BG1jOys772frAbRaMnUcAeak/D+WkayohFE4hXY4Gj7bi7Kzqs9vQnCq3/c6NIB2SnLjlvu7zyaGVSEkbzUzi+Higqikm9W5XtFSFb/YX34QoVpcg/DE5367Q96oG6s3d27Oq0jmW5G7KPMb+zfXV7NZ1SQdqov3ESifH+3Q65xWJxhNhJ8vlMXDUTFdC7Z/NZEiZYu177PyeQAWOo49V0jGFOxW4I3kg1TMbDLYF1kQiMtSY53a3ot5dOQihDBdqIHcqdfb7+oj4MRpB1yPEDJQ+/XJx/uhx/kqhCr/aITgejwUhEQspa206i8/bK7hCzPFyn+1n8/x3w094B27lkXPLQG022s37bhXH78nVwn0ElGyW/hfVa8n8NZrMR8VODYQX57X0Gcx1IwJZ/m2w31LJhSoqiKPcPgTdP+d1f2+vrRL1V6SOujrbIXJtGLGGTrbcG523M/o3EeLZ47cXw7HRWFOi5Y350Acjq22/Z66vxDWQw2T5M6vTWSa+HFDd7/hRINpt/AGl+1Hs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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 **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktvGzcQ/ivsnGJh9XCSXvZU1w0Co4FtVA56sA2D2h1pJ+aSNDmrRwT992K4kryy7DaHHHvSat7z8Zsh18B6FiG/hRusvdGMEe4zKDEWgTyTs5DDTYVqp1bnAbXI1dn1hdLGuEVUTcQQFTtViBJV0UR2NX3XE4OKd4EztaioqFTEMEelo5qYBn0gy1FNXVAztBg0k52p0hVNjaJYEFfKByxxShZLFTk0BTcB40B99c6q2BQFxjhtzD5TWwY5mymuMBUakJtgo9KqsfTUoOr1dtYXZa+nuNKsCm3VBKWbUprZ1oOdaiZadM6muNFjQVMS411ibUvV6zXBSEinsCTeKweQgfOpQ2cvSsihRWunhwy8DrpGxiAnsgara4Qcln3tqc/uES1kQHIiFeoSA2QQ8KmhgCXkHBrMIPLKiE+k2hsJiUtvXImQT7WJYlBUWGvI18Arnyw5kJ3BRkx1csqlTBtpZgfL5XIJm/s2D0b+3ZUr8S2cZbQsn3VjmLwOPJy6UPdLzSn6UR43+YYFS5NBUGDCKNopScaX1WQgwTRDDhOyOqykvssExyuF/9Fl6yv6S8evO45pZhPYe50OQa8EZcY6vuKz2WTAxAmlw+N7mAg2yeDwUJIgemdj2/H70Uh+XozYAXWF53tam9UvkHUR194bKhKNht9i2/OPwt2KhX17S9vUEwwCRxPMa0fxzIuK2cd8ONxKmmAGhauhCwpZQxYfdh0/vB+NHj4KLJsMPo5+Pe78ws61oTJN6Y1w/Cd2iyG48O8tddNzm15KXdYJiu0EUmvUjuBBs11522SNXDmZbu9iqkhzBTkMj4Y9rcHtpCfk9/BG1jOys772frAbRaMnUcAeak/D+WkayohFE4hXY4Gj7bi7Kzqs9vQnCq3/c6NIB2SnLjlvu7zyaGVSEkbzUzi+Higqikm9W5XtFSFb/YX34QoVpcg/DE5367Q96oG6s3d27Oq0jmW5G7KPMb+zfXV7NZ1SQdqov3ESifH+3Q65xWJxhNhJ8vlMXDUTFdC7Z/NZEiZYu177PyeQAWOo49V0jGFOxW4I3kg1TMbDLYF1kQiMtSY53a3ot5dOQihDBdqIHcqdfb7+oj4MRpB1yPEDJQ+/XJx/uhx/kqhCr/aITgejwUhEQspa206i8/bK7hCzPFyn+1n8/x3w094B27lkXPLQG022s37bhXH78nVwn0ElGyW/hfVa8n8NZrMR8VODYQX57X0Gcx1IwJZ/m2w31LJhSoqiKPcPgTdP+d1f2+vrRL1V6SOujrbIXJtGLGGTrbcG523M/o3EeLZ47cXw7HRWFOi5Y350Acjq22/Z66vxDWQw2T5M6vTWSa+HFDd7/hRINpt/AGl+1Hs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(s.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{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)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(s.p,{children:"required"})})]}),(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:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\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)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(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)(a,{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)(s.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:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.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)(a,{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)(s.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 v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.505e4272.js b/assets/js/bfe4b778.505e4272.js new file mode 100644 index 000000000..48cb3cd14 --- /dev/null +++ b/assets/js/bfe4b778.505e4272.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:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>f,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),t=(a(62316),a(51039)),d=a.n(t),r=(a(82723),a(9487)),m=a(41429),o=a(5397),c=a(4667),p=a(9472),u=a(85162);const h={id:"update-document",title:"Update document by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV1Fv2zYQ/ivcPbWAbCtO2mF6WtpkbbCiNZoUA5YYBiWdLLYUyZKUHcPQfx+OkmwlTrNm6DY/Wafj3X3fHe9OW/B86SC5hjOd1RUq72AeQY4us8J4oRUkcFUi+2Ry7pH1Wux0dsG4lHrtWO3QOuY1q3Quig3jKmd1q+5LZDl6LqRjumCcOYOZKETG8s7QGCLQBi0nXxc5JNAe7R1BBIZbXqFHS3FuQfEKIYHewELkEIGgOA33JdwP/uKMPIdA+th9yT1TiHmIOsUuWrJj8WstLOaQeFtjBM5vJHlzojISIQK8NVLnCEnBpSOFrMSKQ7IFvzFB01uhlhBBoW3F/V7SNPPWPjr/SucbOnM31JnVK5EjS1HqNdvBpiB7PrEyknt07Bn3TCJ3nmmFA90ewHOIINPKE4XJFrgxUmSB5MlnR962h6Hr9DNmgXFLKfECHb19Hwj/e4BEDg80JeDCnx3l0ETwXvsnm5kRRGQWVwLXobCcWCrmS+Hu2D4b8vg0F7uqGOaiieA3LXO0VJFPs/fqs0v5NC31DJomAi/8HTeLQd0uUiqDpiE9i85o5VrGp3F8WB27q9dVK3N1lqFzRS3l5qcfl+5W/DDwPUzu8ulbNzt5a4isLqRT//ihaTw9Hh3Fo/jnq6OXyckvyYuX4ziO/4QIbitJZ/vLzT3CkL3wPBAIJYXCRc/aYhrHi2lH5clD7HWVZLortuJS5KwQKHNGPt0PJBCt1fYfVvoj8T0GnyD34E8eKR2lPSt0rfL/G+5DET0O8GRxsoP44hDihWopo7l0pb+g+i8Q7vEM3fvWPYV6t6pFqxTewx2wQ3kLskJfahqHpm5noC8hgUnfPSbbQR9pIAKHdtVPyNpKSKD03rhkMnGeL4VajrgxY21QUQeVPHXjTFcTbsRkdQQ0mhxmtRV+c0mstMBvR9yIURvXHj434nfcQNTDGmp1k7hEnqMNFBDZH/dT77ynrJ8rB6OinxTf1/zv9f6H2/mwm99p0BRuoQO2LhcfDKpLckOZXB0drBNX5F248Lr3FaqKFdqye6dZyh3mTKuwf9BLkh+Pj3Z7UDg6ZjfqRl3qCmmXKmrJpFBfXHKjRuz6Q1GITHDJ/sDUCY/zZ31i1+v1QUKfhzNvhC/rlFk0eq++DMKQ9eGp3QNtDB5t5T4Ul2hXIsOuiL7hahKUJ90141m4ZlhxQcXXiX69f4golyJD5XBwMU7fzN6x43EM0aB2vyPkybuL1+fvL8/JKlV/m6KjcTyOSWS08xVXA0fdFrsrknTDLs7u53i77xv/+urbXSmPt35iJBehLwQOtt2dv4ZBrSfDrXceQamdJ5Xtlirtk5VNQ+KvNdoNJNfzCFbcCp5SaV9vIReO/ue77fWbuJ997PdI9rQF+kFAfeNQ1DVWXNb0BBF8wc29Tb6ZN1HfPSjiVuN1G9foiuzsLRz09CbqT5xmGRr/qO580GRnn64ggrTbyquw4IPla/oi4GtI4AZuIHypkIHQG4N8C5KrZc2XpN+apd9fsoOb2Q==",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 by 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 by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV1Fv2zYQ/ivcPbWAbCtO2mF6WtpkbbCiNZoUA5YYBiWdLLYUyZKUHcPQfx+OkmwlTrNm6DY/Wafj3X3fHe9OW/B86SC5hjOd1RUq72AeQY4us8J4oRUkcFUi+2Ry7pH1Wux0dsG4lHrtWO3QOuY1q3Quig3jKmd1q+5LZDl6LqRjumCcOYOZKETG8s7QGCLQBi0nXxc5JNAe7R1BBIZbXqFHS3FuQfEKIYHewELkEIGgOA33JdwP/uKMPIdA+th9yT1TiHmIOsUuWrJj8WstLOaQeFtjBM5vJHlzojISIQK8NVLnCEnBpSOFrMSKQ7IFvzFB01uhlhBBoW3F/V7SNPPWPjr/SucbOnM31JnVK5EjS1HqNdvBpiB7PrEyknt07Bn3TCJ3nmmFA90ewHOIINPKE4XJFrgxUmSB5MlnR962h6Hr9DNmgXFLKfECHb19Hwj/e4BEDg80JeDCnx3l0ETwXvsnm5kRRGQWVwLXobCcWCrmS+Hu2D4b8vg0F7uqGOaiieA3LXO0VJFPs/fqs0v5NC31DJomAi/8HTeLQd0uUiqDpiE9i85o5VrGp3F8WB27q9dVK3N1lqFzRS3l5qcfl+5W/DDwPUzu8ulbNzt5a4isLqRT//ihaTw9Hh3Fo/jnq6OXyckvyYuX4ziO/4QIbitJZ/vLzT3CkL3wPBAIJYXCRc/aYhrHi2lH5clD7HWVZLortuJS5KwQKHNGPt0PJBCt1fYfVvoj8T0GnyD34E8eKR2lPSt0rfL/G+5DET0O8GRxsoP44hDihWopo7l0pb+g+i8Q7vEM3fvWPYV6t6pFqxTewx2wQ3kLskJfahqHpm5noC8hgUnfPSbbQR9pIAKHdtVPyNpKSKD03rhkMnGeL4VajrgxY21QUQeVPHXjTFcTbsRkdQQ0mhxmtRV+c0mstMBvR9yIURvXHj434nfcQNTDGmp1k7hEnqMNFBDZH/dT77ynrJ8rB6OinxTf1/zv9f6H2/mwm99p0BRuoQO2LhcfDKpLckOZXB0drBNX5F248Lr3FaqKFdqye6dZyh3mTKuwf9BLkh+Pj3Z7UDg6ZjfqRl3qCmmXKmrJpFBfXHKjRuz6Q1GITHDJ/sDUCY/zZ31i1+v1QUKfhzNvhC/rlFk0eq++DMKQ9eGp3QNtDB5t5T4Ul2hXIsOuiL7hahKUJ90141m4ZlhxQcXXiX69f4golyJD5XBwMU7fzN6x43EM0aB2vyPkybuL1+fvL8/JKlV/m6KjcTyOSWS08xVXA0fdFrsrknTDLs7u53i77xv/+urbXSmPt35iJBehLwQOtt2dv4ZBrSfDrXceQamdJ5Xtlirtk5VNQ+KvNdoNJNfzCFbcCp5SaV9vIReO/ue77fWbuJ997PdI9rQF+kFAfeNQ1DVWXNb0BBF8wc29Tb6ZN1HfPSjiVuN1G9foiuzsLRz09CbqT5xmGRr/qO580GRnn64ggrTbyquw4IPla/oi4GtI4AZuIHypkIHQG4N8C5KrZc2XpN+apd9fsoOb2Q==",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 by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},j={},b=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Update document by ID"})}),"\n",(0,l.jsx)(d(),{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)(m.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)(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)(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 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)(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)(o.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)(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)(o.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)(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)(o.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)(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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.edb497d1.js b/assets/js/bfe4b778.edb497d1.js deleted file mode 100644 index b36307882..000000000 --- a/assets/js/bfe4b778.edb497d1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),n=s(11151),i=s(58219),t=(s(62316),s(51039)),d=s.n(t),r=(s(82723),s(9487)),m=s(41429),c=s(5397),o=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update document by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2VbctMP0aWnTtcGK1GhSDFhiGJR0stlSJEtSfoGh/z4cJdlynKZN0W3+ZFH39jx3vDttwfO5g+QGznVWlai8g2kEObrMCuOFVpDA9QLZR5Nzj6yTYmeTC8al1CvHKofWMa9ZqXNRbBhXOasacb9AlqPnQjqmC8aZM5iJQmQsbw0NIQJt0HLydZFDAo1q5wgiMNzyEj1ainMLipcICawH3IiB159RQQSC4lwgz9FCBBa/VMJiDom3FUbg/EaSjhOlkQgR4NpInSMkBZeOBLIFlhySLfiNCZLeCjWHmkR5UEooTOXEXA3X6/Ua6mgXSodlJvIuFMP9Au7yeHFOJAROOhr9gnumEPNAYIotcfnPBBFBoW3JfQ9WPW3so/Mvdb4hncNQJ1YvRY4sRalXbJcBCrJLLZZGco+OPeGeSeTOM62wJ9sBeAoRZFp5ymayBW6MFFnI9+iTI2/b49B1+gmzkHxL1eEFOnp7GQj/NsB+2lz4s6Occnqp/aPNTAgiMotLgatQ41QLzC+EO7B93ufxcS52VdHPRR3BH1rmaOlyPM7ey08u5eN0oSdQ1xF44Q/czHp1O0upDOqa5Cw6o5VrGB/H8XF17LpAW63MVVmGzhWVlJtffl66m+P7ge9hcpeP37rJ6VtDZLUhnfmHlcbx+NngJB7Ev16fvEhOf0uevxjGcfw3RLAuJel2l5t7hD574bl3IJQUCmcda7NxHM/GLZWn97HXVpJpr9iSS5GzQqDMGfl0P5FAtFbbH6z0B+J7CD5B7sCfPlA6SntW6Erl/zfc+yJ6GODp7HQH8fkxxAvVUEYj8prm03+BcI+n79437inUw6oWjVAzPg/A9s8bkCX6habJbKpmHPsFJDDqusdo2+sjNUTg0C67YV1ZSYPZe+OS0ch5PhdqPuDGDLtpKnnqhpkuR9yI0fIEaDQ5zCor/OaKWGmA98f9Hj434k/cQPTtpYCAENkf9lPvdUdZN1eORkU3Kb6v+d/p/fe38343P2jQFG6hA7Y2F+8NqityQ5lcnhytE9fkXbjwuvMVqooV2rI72izlDnOmVdg/6CWdPxue7FayoDpkt+pWXekSaa0rKsmkUJ9dcqsG7OZ9UYhMcMn+wtQJj9MnXWJXq9VRQp8GnTfCL6qUWTR6Lz4PhyHrfa3dA20MHm3p3hdXaJciw7aIvuJqFIRH7TXjWbhmWHJBxdce/X5XiSiXIkPlsHcxzt5M3rFnwxiiXu1+R8ijdxevXl9evSarVP1Nik6G8TCmI6OdL7nqOWoX6l2RpBt2cX43x9t93/jXt/D2Snlc+5GRXIS+EDjYtnf+Bnq1nvS33mkEC+08iWy3VGkfraxrOv5Sod1AcjONYMmt4CmV9s0WcuHof77bXr+K+8mHbo9kj1ug7wXUNQ5FXWPJZUVPEMFn3NzZ5OtpHXXd44cj/loYjbvDdrWLhj4tGoFXjc3BNdnYSxxNkL3GWZah8Q/KTnstffLxGiJI22+AMnxOgOUr+v7gK0jgFm4hfKKRgdCJw/kWJFfzis9JvjFLv38Ac7TwDw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update document by 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 by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2VbctMP0aWnTtcGK1GhSDFhiGJR0stlSJEtSfoGh/z4cJdlynKZN0W3+ZFH39jx3vDttwfO5g+QGznVWlai8g2kEObrMCuOFVpDA9QLZR5Nzj6yTYmeTC8al1CvHKofWMa9ZqXNRbBhXOasacb9AlqPnQjqmC8aZM5iJQmQsbw0NIQJt0HLydZFDAo1q5wgiMNzyEj1ainMLipcICawH3IiB159RQQSC4lwgz9FCBBa/VMJiDom3FUbg/EaSjhOlkQgR4NpInSMkBZeOBLIFlhySLfiNCZLeCjWHmkR5UEooTOXEXA3X6/Ua6mgXSodlJvIuFMP9Au7yeHFOJAROOhr9gnumEPNAYIotcfnPBBFBoW3JfQ9WPW3so/Mvdb4hncNQJ1YvRY4sRalXbJcBCrJLLZZGco+OPeGeSeTOM62wJ9sBeAoRZFp5ymayBW6MFFnI9+iTI2/b49B1+gmzkHxL1eEFOnp7GQj/NsB+2lz4s6Occnqp/aPNTAgiMotLgatQ41QLzC+EO7B93ufxcS52VdHPRR3BH1rmaOlyPM7ey08u5eN0oSdQ1xF44Q/czHp1O0upDOqa5Cw6o5VrGB/H8XF17LpAW63MVVmGzhWVlJtffl66m+P7ge9hcpeP37rJ6VtDZLUhnfmHlcbx+NngJB7Ev16fvEhOf0uevxjGcfw3RLAuJel2l5t7hD574bl3IJQUCmcda7NxHM/GLZWn97HXVpJpr9iSS5GzQqDMGfl0P5FAtFbbH6z0B+J7CD5B7sCfPlA6SntW6Erl/zfc+yJ6GODp7HQH8fkxxAvVUEYj8prm03+BcI+n79437inUw6oWjVAzPg/A9s8bkCX6habJbKpmHPsFJDDqusdo2+sjNUTg0C67YV1ZSYPZe+OS0ch5PhdqPuDGDLtpKnnqhpkuR9yI0fIEaDQ5zCor/OaKWGmA98f9Hj434k/cQPTtpYCAENkf9lPvdUdZN1eORkU3Kb6v+d/p/fe38343P2jQFG6hA7Y2F+8NqityQ5lcnhytE9fkXbjwuvMVqooV2rI72izlDnOmVdg/6CWdPxue7FayoDpkt+pWXekSaa0rKsmkUJ9dcqsG7OZ9UYhMcMn+wtQJj9MnXWJXq9VRQp8GnTfCL6qUWTR6Lz4PhyHrfa3dA20MHm3p3hdXaJciw7aIvuJqFIRH7TXjWbhmWHJBxdce/X5XiSiXIkPlsHcxzt5M3rFnwxiiXu1+R8ijdxevXl9evSarVP1Nik6G8TCmI6OdL7nqOWoX6l2RpBt2cX43x9t93/jXt/D2Snlc+5GRXIS+EDjYtnf+Bnq1nvS33mkEC+08iWy3VGkfraxrOv5Sod1AcjONYMmt4CmV9s0WcuHof77bXr+K+8mHbo9kj1ug7wXUNQ5FXWPJZUVPEMFn3NzZ5OtpHXXd44cj/loYjbvDdrWLhj4tGoFXjc3BNdnYSxxNkL3GWZah8Q/KTnstffLxGiJI22+AMnxOgOUr+v7gK0jgFm4hfKKRgdCJw/kWJFfzis9JvjFLv38Ac7TwDw==",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 by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,n.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 by 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)(m.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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample 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)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(c.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:"Document 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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.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)(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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,n.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/f0ff4a36.d8bbcdae.js b/assets/js/f0ff4a36.d8bbcdae.js deleted file mode 100644 index 2bab23c73..000000000 --- a/assets/js/f0ff4a36.d8bbcdae.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"getdocument",title:"Get document by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhXu/GoAxZaTtMOEYViwpJnXIikWFwOWGAElHVtMJJIlKceGoX97kj3anmQ4lCXLl6zz0PWPLZHn8p370RIcn1qI7uBCJWWB0lkYB5CiTYzQTigJEYwyZFfoWEPCzj8MGUoe52jZQpXMKWbQGYEzZCk6LnLLeKxKxzizGhMxEQlLV9w9CEBpNJykD1OIYIquuYQANDe8QIeGYC1B8gIhgvkx1+LYqSeUEIAgWBnyFA0EYPBTKQymEDlTYgDWLXLisaLQOUIAONe5ShGiCc8tESQZFhyiJbiF9pTOCDmFiki5Z4oIo7RiKnvz+XwOVdBCabA+iLSBornLYNttKn7ExA1TpiYsUdLxxH1JsAFMlCm4656s0eufB3GWnGQ6hqoak1qrlbRoSdBJGNLfJlxbJglaOylz1oYHAiDkFJhoCVzrXCT+ov9oiWm5i662muJoSIwTtcrGGYfa8fZKPJ2cxtnHXyg6I+Ho9DAR1j9Q/pGIa+UOlqBz5BYZZUObxiTrrcopAw+UdqNR3oqp/OuPP9mFETP0osThhmXOaRv1+6uT0uS9RBUk7eZZHo7rUSGL0aMheL4AWwncGL6gdHdY2M+H+9qXyq7+DW1QVQG4OqTrqmp002VikDtMz90/yzoJT06PB+Fx+O1o8CY6+y56/aYXhuHvEMC8yIm3KV3uvH2t0tV7qdOvoKfaIevk0rYfoKqI4Sw82y3VthFL5dhElTL95stVKhqj9ubO2g/79HdjKWQuJD40PefhLDx7OG0Ner1r0FDOeC5SP1hG1OO/rj1d9a5WvxssURPVI2jD2O55baTFpDTCLfwE646u6G5M3bhAl6nV6PMjz2UQQb+JfX/ZmTEVkDwzawZiafJO7VvHp0JOj7nWvWZi5Ty21An6XIv+bACksUF0S16rHbOBa13oWrxDqvTPDl4yVMiJ8swrZzS9zbtyNtiZiaNMWCasv25s9GFlE2XYFjeLucWUKclchv6Szk97g3ap8Kw9di/v5a0qkJUWaX7lQj7Z6F4es7ubyUQkgufsN4ytcDh+1Xju+fl5x2NHnudKuKyMmUGt1uRTf+jd2uVqX44gAIemsDeTWzQzkTQd+gVVfU/cX+U57QaUqwUXFN3V0Y/bTJR3uUhQWuxk5vnVh/fstBdC0EmOfwG5/3740+X17SVJpfSqQzTohb2QjrSyruCyo4iWwCZqLF6w4cV2gJfrqv0f1sZVijqcu77OufB16E1ermroDjqbZNTd1MYBZMo6IlkuKbE+mryq6PhTiYYqdRzAjBtB+HyhpcLSc9puYi9a+urX1VJ3xPYvfXuBNwUnqdpmPC/pDQJ4wsXWllmNq6Cpuv+M7CUYtbrNMm/R0NpbE5wnCWrXudvpyRuN7epyBAHwkoLS7S1PvresHsiWvV7YRFMDoF+Cs5fhe8qtd7j4oSWvb15kaD8eampyxbiqqr8BSkpv3g==",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 by 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 by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhXu/GoAxZaTtMOEYViwpJnXIikWFwOWGAElHVtMJJIlKceGoX97kj3anmQ4lCXLl6zz0PWPLZHn8p370RIcn1qI7uBCJWWB0lkYB5CiTYzQTigJEYwyZFfoWEPCzj8MGUoe52jZQpXMKWbQGYEzZCk6LnLLeKxKxzizGhMxEQlLV9w9CEBpNJykD1OIYIquuYQANDe8QIeGYC1B8gIhgvkx1+LYqSeUEIAgWBnyFA0EYPBTKQymEDlTYgDWLXLisaLQOUIAONe5ShGiCc8tESQZFhyiJbiF9pTOCDmFiki5Z4oIo7RiKnvz+XwOVdBCabA+iLSBornLYNttKn7ExA1TpiYsUdLxxH1JsAFMlCm4656s0eufB3GWnGQ6hqoak1qrlbRoSdBJGNLfJlxbJglaOylz1oYHAiDkFJhoCVzrXCT+ov9oiWm5i662muJoSIwTtcrGGYfa8fZKPJ2cxtnHXyg6I+Ho9DAR1j9Q/pGIa+UOlqBz5BYZZUObxiTrrcopAw+UdqNR3oqp/OuPP9mFETP0osThhmXOaRv1+6uT0uS9RBUk7eZZHo7rUSGL0aMheL4AWwncGL6gdHdY2M+H+9qXyq7+DW1QVQG4OqTrqmp002VikDtMz90/yzoJT06PB+Fx+O1o8CY6+y56/aYXhuHvEMC8yIm3KV3uvH2t0tV7qdOvoKfaIevk0rYfoKqI4Sw82y3VthFL5dhElTL95stVKhqj9ubO2g/79HdjKWQuJD40PefhLDx7OG0Ner1r0FDOeC5SP1hG1OO/rj1d9a5WvxssURPVI2jD2O55baTFpDTCLfwE646u6G5M3bhAl6nV6PMjz2UQQb+JfX/ZmTEVkDwzawZiafJO7VvHp0JOj7nWvWZi5Ty21An6XIv+bACksUF0S16rHbOBa13oWrxDqvTPDl4yVMiJ8swrZzS9zbtyNtiZiaNMWCasv25s9GFlE2XYFjeLucWUKclchv6Szk97g3ap8Kw9di/v5a0qkJUWaX7lQj7Z6F4es7ubyUQkgufsN4ytcDh+1Xju+fl5x2NHnudKuKyMmUGt1uRTf+jd2uVqX44gAIemsDeTWzQzkTQd+gVVfU/cX+U57QaUqwUXFN3V0Y/bTJR3uUhQWuxk5vnVh/fstBdC0EmOfwG5/3740+X17SVJpfSqQzTohb2QjrSyruCyo4iWwCZqLF6w4cV2gJfrqv0f1sZVijqcu77OufB16E1ermroDjqbZNTd1MYBZMo6IlkuKbE+mryq6PhTiYYqdRzAjBtB+HyhpcLSc9puYi9a+urX1VJ3xPYvfXuBNwUnqdpmPC/pDQJ4wsXWllmNq6Cpuv+M7CUYtbrNMm/R0NpbE5wnCWrXudvpyRuN7epyBAHwkoLS7S1PvresHsiWvV7YRFMDoF+Cs5fhe8qtd7j4oSWvb15kaD8eampyxbiqqr8BSkpv3g==",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",permalink:"/docs/API-docs/createdocument"},next:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get document by ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(d.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.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"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)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(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)(a.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.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,i.jsxs)(u.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.ef830ef8.js b/assets/js/f0ff4a36.ef830ef8.js new file mode 100644 index 000000000..ec570f632 --- /dev/null +++ b/assets/js/f0ff4a36.ef830ef8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),d=(a(82723),a(9487)),c=a(41429),o=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMlJ2qLCMCxY0sxrkRSNiwFLjICSzhYTiWRJyolh6NueZI+2JxmOkhzZTrYZ2PolsY73/+53dytwfG4hvoZTlVYlSmdhGkCGNjVCO6EkxDDJkZ2jYx0LO/k0Zih5UqBlS1Uxp5hBZwQukGXouCgs44mqHOPMakzFTKQsa6WHEIDSaDhpH2cQwxxd9wgBaG54iQ4NubUCyUuEGDqGW5FBAILc0tzlsO2rSu4wdeOMqRlLlXQ8JZ0Gv1bCYAaxMxUGYN2yIK1WlLpACAAfdaEyhHjGC0sMaY4lh3gFbqk9pzNCziGAmTIld30KPnKvJQb98yjJ08NcJ1DXUzJrtZIWLSk6jCL6t+murdIUrZ1VBVvnBAIgzykb8Qq41oVI/UN4Z0lotetdEzUlz5AaJxqTXTL2jeP9ubg/PEryL79AHcBEOKLup8L6H1R0UnGh3N4adIHcIrNiLte9Q7reqyJDs6+2S43ySszln7//wU6NWKBXJfYPLHdO2zgMW0plimGqStJ2+SD39+tOIUvQe0Pu+a5fa+DG8CW1u8PS/nO5LzxUdu1vWIO6DsA1JX1CVWebHlOD3GF24v5e12F0eDQYRYPo7WT0Jj5+F79+M4yi6DcI4LEsSLaDLnc+vrXR9rvS2TewU++w9XppOw9Q1yRwHB3vQnU9/aRybKYqmX333yEVjVHP9s5THp6z36+lkIWQeNvNnNvj6Pj2aB3Q692AxnLBC5H5aT5R9yi/bTx9864xv1ss0TD5d9gItk9vgrSYVka4pV8bjwOuxaB5j6+nNI1LdLlq943fMy6HGMKu9uGqt2NqIH1m0W2hyhQ97FvH50LOB1zrodIoaUYVPLE0CUKuRbgYAVnsPLqirDWJ2fDrCehafEBCeht2n6vddjlyGnsUqJAz5YXbZHSzzadyMdrZiZNcWCasf+5i9GVlM2XYljRLuMWMKclcjv6R6EfD0XqTe9Ehu5E38kqVyCqLtL8KIe9tfCMH7PpyNhOp4AX7FRMrHE5fdZl7eHjYydiBlzkXLq8SZlCrJ/a5J/q09qXWHwcQgENT2svZFZqFSLsJ/YKp0DOHbZ/TbUC9WnJB1W1JP24LUd8VIkVpsdeZJ+efPrKjYQRBrzn+hcvhx/FPZxdXZ6SV2qsp0WgYDSMiaWVdyWXPEF1eXdVYsmTj0+0Cr55Q+z/cam2LOnx0oS648Dj0Ia9aDF1D73yL+5faNIBcWUcsqxU11hdT1DWRv1ZoCKnTABbcCPLPAy0Tln5n60vsxUhffW6PugP2/NH3rOMd4CShbcGLir4ggHtcbl2Z9bQOOtSRZw3HSZqidj3ZnSm5MWrOzyYQAK8oTX2033u0tz9I+7N+bY6BxgH6WwcvCHxP1f6Ayx/W7M3LiwJtfB035Wha1/Vfwu4bqA==",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 by 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 by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMlJ2qLCMCxY0sxrkRSNiwFLjICSzhYTiWRJyolh6NueZI+2JxmOkhzZTrYZ2PolsY73/+53dytwfG4hvoZTlVYlSmdhGkCGNjVCO6EkxDDJkZ2jYx0LO/k0Zih5UqBlS1Uxp5hBZwQukGXouCgs44mqHOPMakzFTKQsa6WHEIDSaDhpH2cQwxxd9wgBaG54iQ4NubUCyUuEGDqGW5FBAILc0tzlsO2rSu4wdeOMqRlLlXQ8JZ0Gv1bCYAaxMxUGYN2yIK1WlLpACAAfdaEyhHjGC0sMaY4lh3gFbqk9pzNCziGAmTIld30KPnKvJQb98yjJ08NcJ1DXUzJrtZIWLSk6jCL6t+murdIUrZ1VBVvnBAIgzykb8Qq41oVI/UN4Z0lotetdEzUlz5AaJxqTXTL2jeP9ubg/PEryL79AHcBEOKLup8L6H1R0UnGh3N4adIHcIrNiLte9Q7reqyJDs6+2S43ySszln7//wU6NWKBXJfYPLHdO2zgMW0plimGqStJ2+SD39+tOIUvQe0Pu+a5fa+DG8CW1u8PS/nO5LzxUdu1vWIO6DsA1JX1CVWebHlOD3GF24v5e12F0eDQYRYPo7WT0Jj5+F79+M4yi6DcI4LEsSLaDLnc+vrXR9rvS2TewU++w9XppOw9Q1yRwHB3vQnU9/aRybKYqmX333yEVjVHP9s5THp6z36+lkIWQeNvNnNvj6Pj2aB3Q692AxnLBC5H5aT5R9yi/bTx9864xv1ss0TD5d9gItk9vgrSYVka4pV8bjwOuxaB5j6+nNI1LdLlq943fMy6HGMKu9uGqt2NqIH1m0W2hyhQ97FvH50LOB1zrodIoaUYVPLE0CUKuRbgYAVnsPLqirDWJ2fDrCehafEBCeht2n6vddjlyGnsUqJAz5YXbZHSzzadyMdrZiZNcWCasf+5i9GVlM2XYljRLuMWMKclcjv6R6EfD0XqTe9Ehu5E38kqVyCqLtL8KIe9tfCMH7PpyNhOp4AX7FRMrHE5fdZl7eHjYydiBlzkXLq8SZlCrJ/a5J/q09qXWHwcQgENT2svZFZqFSLsJ/YKp0DOHbZ/TbUC9WnJB1W1JP24LUd8VIkVpsdeZJ+efPrKjYQRBrzn+hcvhx/FPZxdXZ6SV2qsp0WgYDSMiaWVdyWXPEF1eXdVYsmTj0+0Cr55Q+z/cam2LOnx0oS648Dj0Ia9aDF1D73yL+5faNIBcWUcsqxU11hdT1DWRv1ZoCKnTABbcCPLPAy0Tln5n60vsxUhffW6PugP2/NH3rOMd4CShbcGLir4ggHtcbl2Z9bQOOtSRZw3HSZqidj3ZnSm5MWrOzyYQAK8oTX2033u0tz9I+7N+bY6BxgH6WwcvCHxP1f6Ayx/W7M3LiwJtfB035Wha1/Vfwu4bqA==",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",permalink:"/docs/API-docs/createdocument"},next:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"}},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:"Get document by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.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)(m.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)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.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,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.adc233e1.js b/assets/js/fa40969b.adc233e1.js new file mode 100644 index 000000000..9b10b4761 --- /dev/null +++ b/assets/js/fa40969b.adc233e1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var a=n(85893),l=n(11151),i=n(58219),t=(n(62316),n(51039)),r=n.n(t),c=(n(82723),n(9487)),d=n(41429),m=n(5397),o=n(4667),p=n(9472),h=n(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmSlBPB0N2eZI+2JxkOJcpy7HRJsfWqN4lFnt/vfDw8XFLH5pYml/S1SssCpLN0EtEMbGq4dlxJmtBnz56RsE0uKg02uZJn4AyHBRBGBLeOqBnJggkyZRYyoiRxlYYreSXHQ7Kz89qwmess2WRn50oSQshgtUZczhxhBkhaGgPSiYpwSTKvaR1zpR2ivV20d87nkrnSADmDzyXYL5k08LnkBojLgVSqNMQGZW9vD+2dyMEHo+YGrP2qKHWr7C3uo8VXqtACHGSPsZezBZApgCS2TFOwdlYKUZG0s3HLXU6YECGZbJVE4/MAfR7dab/3WI/QyjOZ+ZSkIkLJORjCfBR8KhqMXvoaQiq4fGpCWdCaVr4CpQUzvJI0okqDYcizk4wmdA4ukAhJRSOqmWEFODBI0iWVrACa0EylyCwaUY4E1czl9D5rL3Lw9FtnplPEtMylEQ1A0sSZEiJqXSXQvuWIOY0o3GmhMqDJjAmLAmkOBaPJknr/CbXOcDlHSVkWeI48VTt/NKJdjUxDUh90oEpfsCt0b60tTm8lQLk6rnUddcAIXnAXYPlcgqnWsgxZtGnOlCn6SbYg3M9RlsUUDK1RknlgknHcc2pvuP4GPuN6gnatVtKCRdndOMZ/63VfHR7SkcujKx1Ih/JMa8FTvzH6ZFFpuRmAmn6C1DPQoBnHG5cGbClcT44ZwzBh7qCw/67fLCPZNymE0DC3RqqQO31zzG9296b5x98QkwvucPVpJqz/gWcBTbxX7skWtABmwXed7kihrTdKZGCeau1Ug8QW/veff5HXhi/Am+JPTyx3TttkNGpXSiOGqSrQ2umtfHpcn5TvWqiP4fnW87Xlfu9PyJZu0fdG6zqirikpDbheB9+4mRpgDrJD92Vbu/Hu3mAcD+IfL8Yvk/2fkoOXwziO/6ARvSsE6ob+yZzPr3Pafpc6+wZ+6g2xHpfu40DrPjpcYvO7Dl3gejeOr/dQpI7ofry/2Q3OQCvjiFSOsAXjgk0F/PDftQMwRm0l2Aqs7RF8Kan9eP/6oEvqYDOpE7lggmfk8MMJuVA3IL9tRn33rnG/WVPeCPl9upZsf71J0kJaGu4qf8XfDZjmg2Y/uZxg0y/A5aqdD/xM4HKa0FF/VBgt25mgxisXzCJMDKURvRZhHZtzOR8wrYdKg8RWJtjUYsMYMc1HizFFjyGic0StAWYtrlU/0PwtYENo0+5LtVdiDgy7IybK5Ux55RaM0AI9lIvxlhmGW8Kt3w7Z+rKSmTLknnZv6s7Bb+L63nBMrIaUz1pGDAkOc+eq8GMYXpOCyxsc6Qfk8nQ24ylngvwOU8sdTJ4H5G5vbzcQe+F1jrnLyykxoNVKfO4XPax9re7jBY2oA1PY09k5mAVPQyN/wNXIC49anrPU8xwKxrG67dKv95WQd4KnIC30mHl4/OEd2RvGNOqR4xEhj96dvDp6f36EVpFeTYnGw3gY45JW1hVM9hwdg+uq1jySphVZja5rpV6uzu/399b399b/9t5q25aDOzfSgnHfm/0xWLZ99ZLee4IlgbKTiObKOhRZLpFyH42oa1xupn5stxm3eMGt5v4bqHrvkgUTJfqn+Hx4QLZ9TqxEJ/hhOMpu9/HgSXp+1lbuBXnMc3ArOKHRy6ofVAg2YFNP6ih0eoyx2T1MU9D9vDdu5rXr7fjogkaUlViG/g1z42+Y9gda3xrT+tXTBIB/EeqtCj/j/fAWql868WbnQYU2vyCN+Ezquv4HoSg/vQ==",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 by doctype",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 by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmSlBPB0N2eZI+2JxkOJcpy7HRJsfWqN4lFnt/vfDw8XFLH5pYml/S1SssCpLN0EtEMbGq4dlxJmtBnz56RsE0uKg02uZJn4AyHBRBGBLeOqBnJggkyZRYyoiRxlYYreSXHQ7Kz89qwmess2WRn50oSQshgtUZczhxhBkhaGgPSiYpwSTKvaR1zpR2ivV20d87nkrnSADmDzyXYL5k08LnkBojLgVSqNMQGZW9vD+2dyMEHo+YGrP2qKHWr7C3uo8VXqtACHGSPsZezBZApgCS2TFOwdlYKUZG0s3HLXU6YECGZbJVE4/MAfR7dab/3WI/QyjOZ+ZSkIkLJORjCfBR8KhqMXvoaQiq4fGpCWdCaVr4CpQUzvJI0okqDYcizk4wmdA4ukAhJRSOqmWEFODBI0iWVrACa0EylyCwaUY4E1czl9D5rL3Lw9FtnplPEtMylEQ1A0sSZEiJqXSXQvuWIOY0o3GmhMqDJjAmLAmkOBaPJknr/CbXOcDlHSVkWeI48VTt/NKJdjUxDUh90oEpfsCt0b60tTm8lQLk6rnUddcAIXnAXYPlcgqnWsgxZtGnOlCn6SbYg3M9RlsUUDK1RknlgknHcc2pvuP4GPuN6gnatVtKCRdndOMZ/63VfHR7SkcujKx1Ih/JMa8FTvzH6ZFFpuRmAmn6C1DPQoBnHG5cGbClcT44ZwzBh7qCw/67fLCPZNymE0DC3RqqQO31zzG9296b5x98QkwvucPVpJqz/gWcBTbxX7skWtABmwXed7kihrTdKZGCeau1Ug8QW/veff5HXhi/Am+JPTyx3TttkNGpXSiOGqSrQ2umtfHpcn5TvWqiP4fnW87Xlfu9PyJZu0fdG6zqirikpDbheB9+4mRpgDrJD92Vbu/Hu3mAcD+IfL8Yvk/2fkoOXwziO/6ARvSsE6ob+yZzPr3Pafpc6+wZ+6g2xHpfu40DrPjpcYvO7Dl3gejeOr/dQpI7ofry/2Q3OQCvjiFSOsAXjgk0F/PDftQMwRm0l2Aqs7RF8Kan9eP/6oEvqYDOpE7lggmfk8MMJuVA3IL9tRn33rnG/WVPeCPl9upZsf71J0kJaGu4qf8XfDZjmg2Y/uZxg0y/A5aqdD/xM4HKa0FF/VBgt25mgxisXzCJMDKURvRZhHZtzOR8wrYdKg8RWJtjUYsMYMc1HizFFjyGic0StAWYtrlU/0PwtYENo0+5LtVdiDgy7IybK5Ux55RaM0AI9lIvxlhmGW8Kt3w7Z+rKSmTLknnZv6s7Bb+L63nBMrIaUz1pGDAkOc+eq8GMYXpOCyxsc6Qfk8nQ24ylngvwOU8sdTJ4H5G5vbzcQe+F1jrnLyykxoNVKfO4XPax9re7jBY2oA1PY09k5mAVPQyN/wNXIC49anrPU8xwKxrG67dKv95WQd4KnIC30mHl4/OEd2RvGNOqR4xEhj96dvDp6f36EVpFeTYnGw3gY45JW1hVM9hwdg+uq1jySphVZja5rpV6uzu/399b399b/9t5q25aDOzfSgnHfm/0xWLZ99ZLee4IlgbKTiObKOhRZLpFyH42oa1xupn5stxm3eMGt5v4bqHrvkgUTJfqn+Hx4QLZ9TqxEJ/hhOMpu9/HgSXp+1lbuBXnMc3ArOKHRy6ofVAg2YFNP6ih0eoyx2T1MU9D9vDdu5rXr7fjogkaUlViG/g1z42+Y9gda3xrT+tXTBIB/EeqtCj/j/fAWql868WbnQYU2vyCN+Ezquv4HoSg/vQ==",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 by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,a.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,a.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,a.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(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,a.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Query Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsxs)("ul",{children:[(0,a.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,a.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"result"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"document[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"Signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,a.jsx)(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,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.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,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Report not available!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.d78cd316.js b/assets/js/fa40969b.d78cd316.js deleted file mode 100644 index 777e8f66e..000000000 --- a/assets/js/fa40969b.d78cd316.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var n=a(85893),l=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmQlGPD0N2eZI+2JxkOJcpy7LRJ0fWqN4lFnv/z8fwsqWNTS5NL+lqlZQHSWTqKaAY2NVw7riRN6LNnz0i4JhcLDTa5kmfgDIcZEEYEt46oCcmCCDJmFjKiJHELDVfySg77ZGfntWET10qyyc7OlSSEkN7qjLicOcIMkLQ0BqQTC8IlyTyndcyVto/ydlHeOZ9K5koD5AxuS7CfE2ngtuQGiMuBLFRpiA3MXt4eyjuRvQ9GTQ1Y+1VW6obZS9xHia9UoQU4yB4jL2czIGMASWyZpmDtpBRiQdJWxh13OWFCBGeylRO1zgPUeTTX/u6xGqGhZzLzLklFhJJTMIR5K/hY1DF66XMIqeDyqQ5lgWu88BkoLZj+laQRVRoMQ5ydZDShU3ABRAgqGlHNDCvAgUGQLqlkBdCEZipFZNGIcgSoZi6n91F7kYOH3zoynSKmQS6NaAgkTZwpIaLWLQTKtxxjTiMKcy1UBjSZMGGRIM2hYDRZUq8/odYZLqdIKcsC35GHaquPRrTNkalB6o0OUOkStonunDXJ6ZyEUK6ea1VFbWDmPaZ5z6kbkCE4ObAMzLd0tkJS5pkSTKBEF/vz+XxOO6YIXnAXjLgtwSzWbAg6GiMmyhRdExoT71sgy2IMZs2CYdxRam+4/g4642qEcq1W0oJF2t04xn/rEFy9Y9Li3CdaOpAO6ZnWgqf+YvDJItNy0wA1/gSpfwwGxTheqzRgS+E6dMwYhg5zB4X9Mn99jO9uE80YGubW8N1m/M0xv9ndG+cf/8CYXHCHp08TYf0PfJYo4r1yT5agBTALvgC2rxtlvVEC0f5EaacaJHaTf//+h7w2fAZeFH+6Y7lz2iaDQXNSGtFPVYHSTu/k0+36pHwBRX40z1fBr033e/9CthSurjZaVRF1dUppiOt10I2XqQHmIDt0n5e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSGQN5Ry5rx/rdLmu9TZd9BTbZB1sHQ/DrTqRodLrMPXoQpc78bx9R6SVBHdj/c3q8EZaGUckcoRNmNcsLGAn75dOQBj1FaArYK13YLPObUf718ftE4dbDp1ImdM8IwcfjghF9h2vq9HXfWuVr+ZU14T1V1xzdnuee2khbQ03C38tNHtpsnlCIt+AS5XzajixxOX04QOulPLYNmMJxV2fzCzMLyURnRKhHVsyuW0x7TuhyYq2NhiwRgwzQezIUWNwaJzjFodmDW7VvVA87eABeGLswA6yuVEeeYmGKEE+lDOhlvGKW4Jt/46eOvTSibKkHvcnQUgB3+J53v9IbEaUj5pENEnOFeeq8JPhNgmBZc3uF30yOXpZMJTzgT5E8aWOxg9D5G7u7vbiNgLz3PMXV6OiQGtVuRTf+jD2uVqP17QiDowhT2dnIOZ8TQU8gdUDTzxoME5Sz3OoWAcs9sc/X6fCXEneArSQgeZh8cf3pG9fkyjDjgeYfLg3cmro/fnRygV4VWnaNiP+zEeaWVdwWRH0TG4Nmv1vjZekNUUvZbq5er9/lj9fqx+/9vq15QtB3M30IJxX5v9M1g2dfWS3tsGkwDZUURzZR2SLJcIuY9GVBUe11M/ltuMW2xwq7n/BhadvWTGRIn6/c7yAG2zTqxIR/hhONJu1/HgS3p+1mTuBXnMZro1OKHQy0XXqGBsiE01qqJQ6b/axodMqFWtt5a1SNYEh2kKuhvljTlgrZkeH13QiLISk97tZze+nzU/0JetEVi3pjYA/6I5Wxl+xW70Fha/teT1zYMM7Q5dU2MoRlVV/QfJ+pPz",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 by doctype",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 by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmQlGPD0N2eZI+2JxkOJcpy7LRJ0fWqN4lFnv/z8fwsqWNTS5NL+lqlZQHSWTqKaAY2NVw7riRN6LNnz0i4JhcLDTa5kmfgDIcZEEYEt46oCcmCCDJmFjKiJHELDVfySg77ZGfntWET10qyyc7OlSSEkN7qjLicOcIMkLQ0BqQTC8IlyTyndcyVto/ydlHeOZ9K5koD5AxuS7CfE2ngtuQGiMuBLFRpiA3MXt4eyjuRvQ9GTQ1Y+1VW6obZS9xHia9UoQU4yB4jL2czIGMASWyZpmDtpBRiQdJWxh13OWFCBGeylRO1zgPUeTTX/u6xGqGhZzLzLklFhJJTMIR5K/hY1DF66XMIqeDyqQ5lgWu88BkoLZj+laQRVRoMQ5ydZDShU3ABRAgqGlHNDCvAgUGQLqlkBdCEZipFZNGIcgSoZi6n91F7kYOH3zoynSKmQS6NaAgkTZwpIaLWLQTKtxxjTiMKcy1UBjSZMGGRIM2hYDRZUq8/odYZLqdIKcsC35GHaquPRrTNkalB6o0OUOkStonunDXJ6ZyEUK6ea1VFbWDmPaZ5z6kbkCE4ObAMzLd0tkJS5pkSTKBEF/vz+XxOO6YIXnAXjLgtwSzWbAg6GiMmyhRdExoT71sgy2IMZs2CYdxRam+4/g4642qEcq1W0oJF2t04xn/rEFy9Y9Li3CdaOpAO6ZnWgqf+YvDJItNy0wA1/gSpfwwGxTheqzRgS+E6dMwYhg5zB4X9Mn99jO9uE80YGubW8N1m/M0xv9ndG+cf/8CYXHCHp08TYf0PfJYo4r1yT5agBTALvgC2rxtlvVEC0f5EaacaJHaTf//+h7w2fAZeFH+6Y7lz2iaDQXNSGtFPVYHSTu/k0+36pHwBRX40z1fBr033e/9CthSurjZaVRF1dUppiOt10I2XqQHmIDt0n5e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSGQN5Ry5rx/rdLmu9TZd9BTbZB1sHQ/DrTqRodLrMPXoQpc78bx9R6SVBHdj/c3q8EZaGUckcoRNmNcsLGAn75dOQBj1FaArYK13YLPObUf718ftE4dbDp1ImdM8IwcfjghF9h2vq9HXfWuVr+ZU14T1V1xzdnuee2khbQ03C38tNHtpsnlCIt+AS5XzajixxOX04QOulPLYNmMJxV2fzCzMLyURnRKhHVsyuW0x7TuhyYq2NhiwRgwzQezIUWNwaJzjFodmDW7VvVA87eABeGLswA6yuVEeeYmGKEE+lDOhlvGKW4Jt/46eOvTSibKkHvcnQUgB3+J53v9IbEaUj5pENEnOFeeq8JPhNgmBZc3uF30yOXpZMJTzgT5E8aWOxg9D5G7u7vbiNgLz3PMXV6OiQGtVuRTf+jD2uVqP17QiDowhT2dnIOZ8TQU8gdUDTzxoME5Sz3OoWAcs9sc/X6fCXEneArSQgeZh8cf3pG9fkyjDjgeYfLg3cmro/fnRygV4VWnaNiP+zEeaWVdwWRH0TG4Nmv1vjZekNUUvZbq5er9/lj9fqx+/9vq15QtB3M30IJxX5v9M1g2dfWS3tsGkwDZUURzZR2SLJcIuY9GVBUe11M/ltuMW2xwq7n/BhadvWTGRIn6/c7yAG2zTqxIR/hhONJu1/HgS3p+1mTuBXnMZro1OKHQy0XXqGBsiE01qqJQ6b/axodMqFWtt5a1SNYEh2kKuhvljTlgrZkeH13QiLISk97tZze+nzU/0JetEVi3pjYA/6I5Wxl+xW70Fha/teT1zYMM7Q5dU2MoRlVV/QfJ+pPz",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 by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(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 by doctype"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["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)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\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:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.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)(d.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.29615506.js b/assets/js/runtime~main.2e73fb7f.js similarity index 88% rename from assets/js/runtime~main.29615506.js rename to assets/js/runtime~main.2e73fb7f.js index 4eb3531e5..c24d8e603 100644 --- a/assets/js/runtime~main.29615506.js +++ b/assets/js/runtime~main.2e73fb7f.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,b,c,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=f,r.c=t,e=[],r.O=(a,d,b,c)=>{if(!d){var f=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,b,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.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 c=Object.create(null);r.r(c);var f={};a=a||[null,d({}),d([]),d(d)];for(var t=2&b&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(c,f),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"b2bc89d2",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"d78cd316",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"d8bbcdae",1359:"49fdcec2",1477:"b31b2642",1520:"795c8a7a",1531:"ec04bb2d",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"edb497d1",2245:"96daf7b3",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"6b4bf0ac",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"72ce6921",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"3e8883fd",7971:"7a441f87",8106:"9a14b681",8140:"901b2f91",8163:"5942955c",8468:"2021ef58",8475:"d27b3009",8489:"36b0ee4c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"1277174c",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},c="OpenSign-Docs:",r.l=(e,a,d,f)=>{if(b[e])b[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var b=r.o(e,a)?e[a]:void 0;if(0!==b)if(b)d.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>b=e[a]=[d,c]));d.push(b[2]=c);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,b[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var b,c,f=d[0],t=d[1],o=d[2],n=0;if(f.some((a=>0!==e[a]))){for(b in t)r.o(t,b)&&(r.m[b]=t[b]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,d,b,c,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=f,r.c=t,e=[],r.O=(a,d,b,c)=>{if(!d){var f=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,b,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.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 c=Object.create(null);r.r(c);var f={};a=a||[null,d({}),d([]),d(d)];for(var t=2&b&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(c,f),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"b2bc89d2",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"adc233e1",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"ef830ef8",1359:"49fdcec2",1477:"b31b2642",1520:"e45522a5",1531:"b692819f",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"505e4272",2245:"b1ad234a",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"760fabc2",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"a139a053",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"18fa1b31",7971:"350b9d87",8106:"951fd941",8140:"901b2f91",8163:"017914b9",8468:"13bbb31c",8475:"d27b3009",8489:"496e8402",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"073fe3de",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},c="OpenSign-Docs:",r.l=(e,a,d,f)=>{if(b[e])b[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var b=r.o(e,a)?e[a]:void 0;if(0!==b)if(b)d.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>b=e[a]=[d,c]));d.push(b[2]=c);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,b[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var b,c,f=d[0],t=d[1],o=d[2],n=0;if(f.some((a=>0!==e[a]))){for(b in t)r.o(t,b)&&(r.m[b]=t[b]);if(o)var i=o(r)}for(a&&a(d);n Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 0d688256e..f2bb319c5 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 3481727ea..3d0c62887 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 2f2186db3..2d8b96f5a 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 becad2a06..3bd6717f1 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 1a8649792..944bfb41e 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 7cc9f7635..3b90f0bcb 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 aeceb3f7b..7c6517329 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 56ffa7cde..5fd74126c 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 3c866ebce..18271a474 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 cc489f84c..3aaec4adb 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 bababc8f6..ce1b32802 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Query Parameters

    limit number
    Example: 10
    skip number
    Example: 0
-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

successful operation

Schema

    result

    contactdetails[]

  • Array [

    • objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index cffbbedc7..cce1e3f50 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create contact | OpenSign™ - + @@ -13,7 +13,6 @@ 
POST 
/createcontact

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

Request​

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

required

Provide below parameter to create contact

    Name stringrequired
    Email stringrequired
    Phone stringrequired

Responses​

Contact created successfully!

Schema

    objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date
Loading...
diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index b860256d1..a79ce831e 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + @@ -13,7 +13,6 @@ 
POST 
/createdocument

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​

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

required

    file binary
    Name string
    Description string
    Note string
    Signers string[]

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 3e2c8a166..ee448ccfb 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create template | OpenSign™ - + @@ -13,7 +13,6 @@ 
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 templateId that can be used to generate documents based on the specified template and url to edit template.

Request​

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

required

    file binary
    Name string
    Description string
    Note string
    Signers string[]

Responses​

Template created successfully!

Schema

    objectId number
    url string
Loading...
diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index b4175c639..900af55e9 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete template by ID | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Path Parameters

    template_id stringrequired

    ID of the template that needs to be deleted

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Template deleted successfully!

Schema

    objectId string
    deletedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 39abf7440..1a6d8123d 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete contact | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Path Parameters

    contact_id stringrequired

    Provide objectId of contact to delete

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Contact deleted successfully!

Schema

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

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

Request​

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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 203e892f2..ec82bfd40 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get template by ID | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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 3d81f565a..8d01a2238 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™ - + @@ -13,7 +13,6 @@ 
GET 
/getuser

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

Request​

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 7aa443215..66cec0905 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 1090cca03..ac49202c0 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get document by ID | OpenSign™ - + @@ -14,7 +14,6 @@

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

Request​

Path Parameters

    document_id stringrequired

    objectId of contact

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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 1e95f90c5..00e304ae3 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get document list by doctype | OpenSign™ - + @@ -54,7 +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
    Example: 10
    skip number
    Example: 0
-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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 fbec2952e..3ba3f5652 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + @@ -14,7 +14,6 @@

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
    Example: 10
    skip number
    Example: 0
-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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 83208fe2f..aea822636 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 56332f4da..d1a161fd2 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/update-document/index.html b/docs/API-docs/update-document/index.html index 6c512f4bc..ef7bc096d 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update document by ID | OpenSign™ - + @@ -14,7 +14,6 @@

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

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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...
diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index d42a7a10f..21b968c1d 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update template by ID | OpenSign™ - + @@ -14,7 +14,6 @@

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

-

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

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...
diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index 2daee2bb8..ce1fa8520 100644 --- a/docs/category/tutorial---basics/index.html +++ b/docs/category/tutorial---basics/index.html @@ -5,7 +5,7 @@ Tutorial - Basics | OpenSign™ - + diff --git a/docs/category/tutorial---extras/index.html b/docs/category/tutorial---extras/index.html index 608896c1c..07dbeab0c 100644 --- a/docs/category/tutorial---extras/index.html +++ b/docs/category/tutorial---extras/index.html @@ -5,7 +5,7 @@ Tutorial - Extras | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 1de2d173a..d9feba0f3 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 0b5e33824..8e159549e 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ COMMUNITY | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 833236b31..aa0e1fda1 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATION | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 455b1d4da..dd2a08f57 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ REPORTING_GUIDELINES | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index e05238907..0303548b1 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 dc61dca33..099188c9d 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 061ffe91b..202ba1463 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/intro/index.html b/docs/help/intro/index.html index 95cc2deff..a62de6b16 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 3b4fef7bb..1b4bd85e3 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index be6365d5f..8fb947bde 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/congratulations/index.html b/docs/self-host/tutorial-basics/congratulations/index.html index bd7c050aa..4540a6e17 100644 --- a/docs/self-host/tutorial-basics/congratulations/index.html +++ b/docs/self-host/tutorial-basics/congratulations/index.html @@ -5,7 +5,7 @@ Congratulations! | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-blog-post/index.html b/docs/self-host/tutorial-basics/create-a-blog-post/index.html index bfb59e0ff..5e393cde2 100644 --- a/docs/self-host/tutorial-basics/create-a-blog-post/index.html +++ b/docs/self-host/tutorial-basics/create-a-blog-post/index.html @@ -5,7 +5,7 @@ Create a Blog Post | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-document/index.html b/docs/self-host/tutorial-basics/create-a-document/index.html index ae50eca32..cd02b3389 100644 --- a/docs/self-host/tutorial-basics/create-a-document/index.html +++ b/docs/self-host/tutorial-basics/create-a-document/index.html @@ -5,7 +5,7 @@ Create a Document | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-page/index.html b/docs/self-host/tutorial-basics/create-a-page/index.html index 1d397b68c..a5f4a5c33 100644 --- a/docs/self-host/tutorial-basics/create-a-page/index.html +++ b/docs/self-host/tutorial-basics/create-a-page/index.html @@ -5,7 +5,7 @@ Create a Page | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/deploy-your-site/index.html b/docs/self-host/tutorial-basics/deploy-your-site/index.html index 50d248737..bc2a75f8d 100644 --- a/docs/self-host/tutorial-basics/deploy-your-site/index.html +++ b/docs/self-host/tutorial-basics/deploy-your-site/index.html @@ -5,7 +5,7 @@ Deploy your site | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/markdown-features/index.html b/docs/self-host/tutorial-basics/markdown-features/index.html index 3a8e14dce..8aa18be37 100644 --- a/docs/self-host/tutorial-basics/markdown-features/index.html +++ b/docs/self-host/tutorial-basics/markdown-features/index.html @@ -5,7 +5,7 @@ Markdown Features | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/manage-docs-versions/index.html b/docs/self-host/tutorial-extras/manage-docs-versions/index.html index 0515f5d9c..8deac7c35 100644 --- a/docs/self-host/tutorial-extras/manage-docs-versions/index.html +++ b/docs/self-host/tutorial-extras/manage-docs-versions/index.html @@ -5,7 +5,7 @@ Manage Docs Versions | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/translate-your-site/index.html b/docs/self-host/tutorial-extras/translate-your-site/index.html index fea16f11f..b81d85625 100644 --- a/docs/self-host/tutorial-extras/translate-your-site/index.html +++ b/docs/self-host/tutorial-extras/translate-your-site/index.html @@ -5,7 +5,7 @@ Translate your site | OpenSign™ - + diff --git a/index.html b/index.html index f29126336..572a8b9ce 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 e87bf842e..f555cb05f 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +