From f7bfa52ae05e4ec4417cb4edaf28b3624a1689ef Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Jan 2024 07:49:31 +0000 Subject: [PATCH] deploy: fd34ba778cb4a7274be57012ebd8438cbff33255 --- 404.html | 2 +- assets/js/05632a52.56636457.js | 1 + assets/js/05632a52.dbc22dee.js | 1 - assets/js/2c586be5.5a3fe832.js | 1 + assets/js/2c586be5.ddf96f1e.js | 1 - assets/js/{377084eb.f92effd7.js => 377084eb.fc47c37f.js} | 2 +- assets/js/{52d5c0f9.1bf4c76e.js => 52d5c0f9.0d9e94c0.js} | 2 +- assets/js/{5a2de241.e12965bb.js => 5a2de241.8057ae9d.js} | 2 +- assets/js/{770b40a9.c77fc495.js => 770b40a9.a106d1ce.js} | 2 +- assets/js/7b076186.04f4277f.js | 1 + assets/js/7b076186.621d99d2.js | 1 - assets/js/a2bc1463.d45861d2.js | 1 - assets/js/a2bc1463.f4361f8a.js | 1 + assets/js/a88a3db3.b9986137.js | 1 + assets/js/a88a3db3.cbedd512.js | 1 - assets/js/bbdfc22d.dc75f692.js | 1 + assets/js/bbdfc22d.e44fb86a.js | 1 - assets/js/f0ff4a36.415bb7e5.js | 1 - assets/js/f0ff4a36.54a35a79.js | 1 + assets/js/fa40969b.4b77d0d7.js | 1 + assets/js/fa40969b.ae0bc259.js | 1 - .../js/{runtime~main.b70a4847.js => runtime~main.df94cecd.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 | 4 ++-- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 4 ++-- docs/API-docs/createtemplate/index.html | 4 ++-- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/getcontact/index.html | 4 ++-- docs/API-docs/getdocument/index.html | 4 ++-- docs/API-docs/getdocumentlist/index.html | 4 ++-- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- 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 +- .../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 +- 71 files changed, 69 insertions(+), 69 deletions(-) create mode 100644 assets/js/05632a52.56636457.js delete mode 100644 assets/js/05632a52.dbc22dee.js create mode 100644 assets/js/2c586be5.5a3fe832.js delete mode 100644 assets/js/2c586be5.ddf96f1e.js rename assets/js/{377084eb.f92effd7.js => 377084eb.fc47c37f.js} (56%) rename assets/js/{52d5c0f9.1bf4c76e.js => 52d5c0f9.0d9e94c0.js} (67%) rename assets/js/{5a2de241.e12965bb.js => 5a2de241.8057ae9d.js} (70%) rename assets/js/{770b40a9.c77fc495.js => 770b40a9.a106d1ce.js} (50%) create mode 100644 assets/js/7b076186.04f4277f.js delete mode 100644 assets/js/7b076186.621d99d2.js delete mode 100644 assets/js/a2bc1463.d45861d2.js create mode 100644 assets/js/a2bc1463.f4361f8a.js create mode 100644 assets/js/a88a3db3.b9986137.js delete mode 100644 assets/js/a88a3db3.cbedd512.js create mode 100644 assets/js/bbdfc22d.dc75f692.js delete mode 100644 assets/js/bbdfc22d.e44fb86a.js delete mode 100644 assets/js/f0ff4a36.415bb7e5.js create mode 100644 assets/js/f0ff4a36.54a35a79.js create mode 100644 assets/js/fa40969b.4b77d0d7.js delete mode 100644 assets/js/fa40969b.ae0bc259.js rename assets/js/{runtime~main.b70a4847.js => runtime~main.df94cecd.js} (55%) diff --git a/404.html b/404.html index 22f97eb87..c4084193a 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.56636457.js b/assets/js/05632a52.56636457.js new file mode 100644 index 000000000..ecd947b6a --- /dev/null +++ b/assets/js/05632a52.56636457.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),c=a.n(i),r=(a(82723),a(9487)),o=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kBxZId94s4SkMJudDShHOO+5CYsJJG1ibS7nZ35dgI/fdjVrItx07blKNgbHnnZZ95ezQNOL6wEN/BJyUdT52FeQAZ2tQI7YSSEMMCHeMs7eQQgNJoOMmusk66E2lueIUODblsQPIKIYbVKdfi1KknlBCAIJ8F8gwNBGDwWy0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisOcQNurb2mM0IuoCVV7o1igiitWMjRarVaQRtsofRQH0S2QaK5K+BlyCp5xNRdZUzlg8D/N6wB5MpU3A1PduD1X+OkSCeFTqBt53St1UpatORoEkX0sw/X1mmK1uZ1ybbFgcAHi9KRPte6FKkXhI+WjJpDdF3UVEZDbpzorkx9SFstWVeJL90W8SSKWg+zLt2P3W1y++a0FOOkWE0eNZX6qy/n2xw8KmQJIplfVFyUv2CfIH7sD0apqsjVTaHkm6FMx2fjif9A2wawqjyY/R7N0HFRWrrDCVcekwxEQpZC4sOmVx4mUfQwgbYlnWk0PeyZft6ZVI7lqpbZH7+xY6bRtA2gQmv54mjydqk6gvN7cU+j6SDu94dxX8klL0XGzm+u2C1R0u+N+/3Pxj3E6Tqch60iOqWOWveyMjzvsmExrY1wa8/MQ0qO7+ZEMxW6QvWM7qncFRBD2Pdc2OyoswXyZpYbmq9NSZTunLZxGHKtRxv+LXliaVBCrkW4HAPds8Exo6R2edtDs00K1+IzriH48WuEwhMyV964T8G1RjkTC+kTuBwfUPxtISwT1oszldYVSuerznJl2AtrlnCLGVOSuQK9kM7PRmNmNaYi7xtmxO7lvZypClltkei4FPLJxvfylN1d57lIBS/Zv5hY4XD+bpOx5+fng4ydeJtL4Yo6YQa12qkv/KFP69Bq++cEAnBoKnudz9AsRYp9dV65KvTKYT8G9KqLG8COITdHH18aUbeVIkVpcdCP55c3X9jZKIJg0BQ/ATn8cvXp4uvsgrxSW3UlGo+iUURHWllXcTm46BLd4MW8V9lmN80Hq0vfWQ5XLtQlF35oPNKmb/g72GnHg21hHkChrCOFpqFu+MeUbUvH32o0NFTzAJbcCJ5Q+901kAlLz9l2G3gV5bu/+8XihB1fPI7C3kyJpBFZ8rKmfxDAE673F5123gabSfllYK+h6G7bH80tGFq8OoXzNEXtBrIDmt2joMuLWwiA11SRIR88eT7oHyiWo0nYR9MBoG+Cc9TgT5rmz7j+sFXvJK8abNfXTptSMW/b9j9RcNhE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get contact",description:"get a 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:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kBxZId94s4SkMJudDShHOO+5CYsJJG1ibS7nZ35dgI/fdjVrItx07blKNgbHnnZZ95ezQNOL6wEN/BJyUdT52FeQAZ2tQI7YSSEMMCHeMs7eQQgNJoOMmusk66E2lueIUODblsQPIKIYbVKdfi1KknlBCAIJ8F8gwNBGDwWy0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisOcQNurb2mM0IuoCVV7o1igiitWMjRarVaQRtsofRQH0S2QaK5K+BlyCp5xNRdZUzlg8D/N6wB5MpU3A1PduD1X+OkSCeFTqBt53St1UpatORoEkX0sw/X1mmK1uZ1ybbFgcAHi9KRPte6FKkXhI+WjJpDdF3UVEZDbpzorkx9SFstWVeJL90W8SSKWg+zLt2P3W1y++a0FOOkWE0eNZX6qy/n2xw8KmQJIplfVFyUv2CfIH7sD0apqsjVTaHkm6FMx2fjif9A2wawqjyY/R7N0HFRWrrDCVcekwxEQpZC4sOmVx4mUfQwgbYlnWk0PeyZft6ZVI7lqpbZH7+xY6bRtA2gQmv54mjydqk6gvN7cU+j6SDu94dxX8klL0XGzm+u2C1R0u+N+/3Pxj3E6Tqch60iOqWOWveyMjzvsmExrY1wa8/MQ0qO7+ZEMxW6QvWM7qncFRBD2Pdc2OyoswXyZpYbmq9NSZTunLZxGHKtRxv+LXliaVBCrkW4HAPds8Exo6R2edtDs00K1+IzriH48WuEwhMyV964T8G1RjkTC+kTuBwfUPxtISwT1oszldYVSuerznJl2AtrlnCLGVOSuQK9kM7PRmNmNaYi7xtmxO7lvZypClltkei4FPLJxvfylN1d57lIBS/Zv5hY4XD+bpOx5+fng4ydeJtL4Yo6YQa12qkv/KFP69Bq++cEAnBoKnudz9AsRYp9dV65KvTKYT8G9KqLG8COITdHH18aUbeVIkVpcdCP55c3X9jZKIJg0BQ/ATn8cvXp4uvsgrxSW3UlGo+iUURHWllXcTm46BLd4MW8V9lmN80Hq0vfWQ5XLtQlF35oPNKmb/g72GnHg21hHkChrCOFpqFu+MeUbUvH32o0NFTzAJbcCJ5Q+901kAlLz9l2G3gV5bu/+8XihB1fPI7C3kyJpBFZ8rKmfxDAE673F5123gabSfllYK+h6G7bH80tGFq8OoXzNEXtBrIDmt2joMuLWwiA11SRIR88eT7oHyiWo0nYR9MBoG+Cc9TgT5rmz7j+sFXvJK8abNfXTptSMW/b9j9RcNhE",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:"Deletes contact",permalink:"/docs/API-docs/deletecontact"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get contact"})}),"\n",(0,l.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(s.p,{children:"get a contact"}),"\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:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"contactdetails"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact 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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Contact 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)(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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.dbc22dee.js b/assets/js/05632a52.dbc22dee.js deleted file mode 100644 index 657f20441..000000000 --- a/assets/js/05632a52.dbc22dee.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),t=s(58219),i=(s(62316),s(51039)),c=s.n(i),r=(s(82723),s(9487)),d=s(41429),m=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zgM/isaP62Amzhp9sU4HFYMRa/YsBaXHu5DGxSyTcdqbUmT5DSB4f8+ULYTp0lv63AYUKSJ+KKH5ENSNTi+tBDdwSclHU+chUUAKdrECO2EkhDBEh3jLGnlEIDSaDjJrtJWuhNpbniJDg25rEHyEiGC9SnX4tSpJ5QQgCCfOfIUDQRg8FslDKYQOVNhANZtCrKxotQFQgC41oVKEaKMF5YUkhxLDlENbqO9pjNCLqEhVe6NIoIorVjK0Xq9XkMTbKF0UB9E2iPR3OXwMmQVP2LirlKmskHg/xvWADJlSu6GJzvw+q9JnCfTXMfQNAu61molLVpyNA1D+rcP11ZJgtZmVcG2xYHAB4vSkT7XuhCJF4wfLRnVh+jaqKmMhtw40V6Z+JC2WrIqY1+6LeJpGDYBlGgtX+KxaHexdSxjiUHuMGU75MXmHdXQoK0K92NQfYXenNx8Eufr6aOmy756UrzNwaNCFiOS+UXJRfEL9jHix+5glKiSXN3kSr4ZymxyNpn6P2iaANalB7PP9BQdF4WlO5xwxTHJQCRkISQ+9Ix7mIbhAzknnVk4O2ReX0+pHMtUJdN3v5F3s3D2Vt4NcP5X3LNw9jDdxv3hMO4rueKFSNn5zRW7pcH2e+P+8LNxD3G6FuchVUSr1A7ovawMz9tsWEwqI9zGz/fhYI/uFjSsSnS56vaCXwguhwjGHefG9W4AN0DezKpfFpUpaDE4p200HnOtR/0UL3hsqVHGXIvxagJ0T49jTklt87aHZpsUrsVn3EDw42VE4QmZKW/cpeBao5yLpfQJXE0OFsVtLiwT1otTlVQlSuerzjJl2AtrFnOLKVOSuRy9kM7PRhNmNSYi6wgzYvfyXs5ViayySEO9EPLJRvfylN1dZ5lIBC/Yvxhb4XDxvs/Y8/PzQcZOvM2lcHkVM4Na7dSX/tCndWi1/XECATg0pb3O5mhWIsGuOq9cNfbK464NaGFGNWA7Ifujjy+NiG2FSFBaHPDx/PLmCzsbhRAMSPETkMdfrj5dfJ1fkFeiVVuiySgchXSklXUll4OLLtEN1vteZetdNx88gDpmOVy7sS648E3jkdYd4e9gpx0N3hyLAHJlHSnUNbHhH1M0DR1/q9BQUy0CWHEjeEz0u6shFZa+p9s3xaso3//dPU9O2PHny1HYfZdIapEVLyr6BQE84Wb/udQsmqDvlF8G9hqK9rb91tyCoedbq3CeJKjdQHYwZvdG0OXFLQTAK6rIcB48+XnQfaFYjiZhH00LgD4JzlGDP6ibP+Pmz616K3nVYPsIbrUpFYumab4D91nw6Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get contact",description:"get a 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:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zgM/isaP62Amzhp9sU4HFYMRa/YsBaXHu5DGxSyTcdqbUmT5DSB4f8+ULYTp0lv63AYUKSJ+KKH5ENSNTi+tBDdwSclHU+chUUAKdrECO2EkhDBEh3jLGnlEIDSaDjJrtJWuhNpbniJDg25rEHyEiGC9SnX4tSpJ5QQgCCfOfIUDQRg8FslDKYQOVNhANZtCrKxotQFQgC41oVKEaKMF5YUkhxLDlENbqO9pjNCLqEhVe6NIoIorVjK0Xq9XkMTbKF0UB9E2iPR3OXwMmQVP2LirlKmskHg/xvWADJlSu6GJzvw+q9JnCfTXMfQNAu61molLVpyNA1D+rcP11ZJgtZmVcG2xYHAB4vSkT7XuhCJF4wfLRnVh+jaqKmMhtw40V6Z+JC2WrIqY1+6LeJpGDYBlGgtX+KxaHexdSxjiUHuMGU75MXmHdXQoK0K92NQfYXenNx8Eufr6aOmy756UrzNwaNCFiOS+UXJRfEL9jHix+5glKiSXN3kSr4ZymxyNpn6P2iaANalB7PP9BQdF4WlO5xwxTHJQCRkISQ+9Ix7mIbhAzknnVk4O2ReX0+pHMtUJdN3v5F3s3D2Vt4NcP5X3LNw9jDdxv3hMO4rueKFSNn5zRW7pcH2e+P+8LNxD3G6FuchVUSr1A7ovawMz9tsWEwqI9zGz/fhYI/uFjSsSnS56vaCXwguhwjGHefG9W4AN0DezKpfFpUpaDE4p200HnOtR/0UL3hsqVHGXIvxagJ0T49jTklt87aHZpsUrsVn3EDw42VE4QmZKW/cpeBao5yLpfQJXE0OFsVtLiwT1otTlVQlSuerzjJl2AtrFnOLKVOSuRy9kM7PRhNmNSYi6wgzYvfyXs5ViayySEO9EPLJRvfylN1dZ5lIBC/Yvxhb4XDxvs/Y8/PzQcZOvM2lcHkVM4Na7dSX/tCndWi1/XECATg0pb3O5mhWIsGuOq9cNfbK464NaGFGNWA7Ifujjy+NiG2FSFBaHPDx/PLmCzsbhRAMSPETkMdfrj5dfJ1fkFeiVVuiySgchXSklXUll4OLLtEN1vteZetdNx88gDpmOVy7sS648E3jkdYd4e9gpx0N3hyLAHJlHSnUNbHhH1M0DR1/q9BQUy0CWHEjeEz0u6shFZa+p9s3xaso3//dPU9O2PHny1HYfZdIapEVLyr6BQE84Wb/udQsmqDvlF8G9hqK9rb91tyCoedbq3CeJKjdQHYwZvdG0OXFLQTAK6rIcB48+XnQfaFYjiZhH00LgD4JzlGDP6ibP+Pmz616K3nVYPsIbrUpFYumab4D91nw6Q==",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:"Deletes contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function N(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:"Get contact"})}),"\n",(0,l.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"get a contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.5a3fe832.js b/assets/js/2c586be5.5a3fe832.js new file mode 100644 index 000000000..a7e1b150a --- /dev/null +++ b/assets/js/2c586be5.5a3fe832.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),c=a.n(i),r=(a(82723),a(9487)),d=a(41429),o=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",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:"Create document",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:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",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={},b=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create document"})}),"\n",(0,l.jsx)(c(),{method:"post",path:"/createdocument"}),"\n",(0,l.jsx)(s.p,{children:"Create 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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.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,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 created 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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document created successfully!"}}),(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:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Document created successfully!",\n "result": {\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n }\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.ddf96f1e.js b/assets/js/2c586be5.ddf96f1e.js deleted file mode 100644 index fab023b72..000000000 --- a/assets/js/2c586be5.ddf96f1e.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:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>v});var l=a(85893),n=a(11151),i=a(58219),c=(a(62316),a(51039)),t=a.n(c),r=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVKc9kUohgVZUQQtlmDOsAfHCGjqymJCUSxJOfYM/ffhUh+VrRTpXvbiOPdDPPfccygfwPONg3QJv1eiLlF7B6sIKoOWe1npmwxSEBa5x6wrgAgMt7xEj5Y6D6B5iZDC7pwbee6rZ9QQgdSQQoE8QwsRWPxWS4sZpN7WGIHze0U9TpZGIUSAO6OqDCHNuXJUIAosOaQH8HsTKr2VegMNlfLQlBJM7eRGz3a73Q6aFZ3jTKUdOuqcJwn9ydAJKw2NA+kwJ+umYq4WAp3La6X2v0AEotKexkwPwI1RUgQi4idH7YcpsGr9hCKwYok2L9vDRZhmqNJ1uQ5MDOjnSdJEUKJzfIPTQcdzXlfac+FZhgqnkJswdq3826DaMC11elxe2ZL71wEUT3L+z05s53d0Wm3Vf36A98alcdxFZqIqoWki8NKHvNRKanzs1/c4T5LHy8durDcLoWmo5n3yYbrvG73lSmbs6u6G3ZM2/88dv08+/OyOxzh9i5Nm2pWB685isi1qPXbEyjjesuFQ1Fb6fbDo2JvpckVWOabpOriBjUxeoi8qsr+pXGt6X0AK8eQ2cGi3/VUQpDFsmxsz6z2q+NrR2mNuZLy9CG7tIS6I75bSI6ADX9zIL7iH6O2rhiaXOq9Cc8fOrUG9kBsduN1ewOns94V0TLqQ7ucKgmB5ZdlJN1tzhxmrNPMFhiTFL2cXzBkUMu+0NGMP+kEvqhJZ7TCvFVNSP7v0QZ+z5W2eSyG5Yn/j2kmPq3c9Yy8vLxPGzkLPZ+mLes0smup7+SYEA63jruGfM4jAoy3dbb5Au5Wi9+IPjopDcdw5hIvgECy5pK12od9Om0iISgrUDkdSvfp895VdzhKIRqL4Ccjx15vrT38sPtFTSVbtii5mySyhEImx5Hp00FS5R9sdNORx52OjuNSjO6wV9fL0FbeKoCDVp0s4HGjhf1nVNBT+VqMlS60i2HIr+ZoUtlw1US9AckEmHSWy4W12gmi4fuDdn92L8YzRql5D+oz7ieK3XNVUCU106AquhEDjR7nJxUaOG0x9d7u4hwh4TfOPffYcfNZ9oWH6lN6PHn4Mp0VAn4Tn1YaP5JIvuP91KG8zP2wYfjq01cTFqmmafwHUdfmX",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:"Create document",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:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVKc9kUohgVZUQQtlmDOsAfHCGjqymJCUSxJOfYM/ffhUh+VrRTpXvbiOPdDPPfccygfwPONg3QJv1eiLlF7B6sIKoOWe1npmwxSEBa5x6wrgAgMt7xEj5Y6D6B5iZDC7pwbee6rZ9QQgdSQQoE8QwsRWPxWS4sZpN7WGIHze0U9TpZGIUSAO6OqDCHNuXJUIAosOaQH8HsTKr2VegMNlfLQlBJM7eRGz3a73Q6aFZ3jTKUdOuqcJwn9ydAJKw2NA+kwJ+umYq4WAp3La6X2v0AEotKexkwPwI1RUgQi4idH7YcpsGr9hCKwYok2L9vDRZhmqNJ1uQ5MDOjnSdJEUKJzfIPTQcdzXlfac+FZhgqnkJswdq3826DaMC11elxe2ZL71wEUT3L+z05s53d0Wm3Vf36A98alcdxFZqIqoWki8NKHvNRKanzs1/c4T5LHy8durDcLoWmo5n3yYbrvG73lSmbs6u6G3ZM2/88dv08+/OyOxzh9i5Nm2pWB685isi1qPXbEyjjesuFQ1Fb6fbDo2JvpckVWOabpOriBjUxeoi8qsr+pXGt6X0AK8eQ2cGi3/VUQpDFsmxsz6z2q+NrR2mNuZLy9CG7tIS6I75bSI6ADX9zIL7iH6O2rhiaXOq9Cc8fOrUG9kBsduN1ewOns94V0TLqQ7ucKgmB5ZdlJN1tzhxmrNPMFhiTFL2cXzBkUMu+0NGMP+kEvqhJZ7TCvFVNSP7v0QZ+z5W2eSyG5Yn/j2kmPq3c9Yy8vLxPGzkLPZ+mLes0smup7+SYEA63jruGfM4jAoy3dbb5Au5Wi9+IPjopDcdw5hIvgECy5pK12od9Om0iISgrUDkdSvfp895VdzhKIRqL4Ccjx15vrT38sPtFTSVbtii5mySyhEImx5Hp00FS5R9sdNORx52OjuNSjO6wV9fL0FbeKoCDVp0s4HGjhf1nVNBT+VqMlS60i2HIr+ZoUtlw1US9AckEmHSWy4W12gmi4fuDdn92L8YzRql5D+oz7ieK3XNVUCU106AquhEDjR7nJxUaOG0x9d7u4hwh4TfOPffYcfNZ9oWH6lN6PHn4Mp0VAn4Tn1YaP5JIvuP91KG8zP2wYfjq01cTFqmmafwHUdfmX",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={},v=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create document"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,l.jsx)(s.p,{children:"Create 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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.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,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:"Document created 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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!",\n "result": {\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.f92effd7.js b/assets/js/377084eb.fc47c37f.js similarity index 56% rename from assets/js/377084eb.f92effd7.js rename to assets/js/377084eb.fc47c37f.js index c8e00d480..976421503 100644 --- a/assets/js/377084eb.f92effd7.js +++ b/assets/js/377084eb.fc47c37f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1P4zgQ/1d887RI3jawRSfladGBUHUI0MLqHqBCbjJpDInttZ3Sqsr/fhrno6GFXTid9qnNeD5+8z0b8GLhIL6DWyxNITw6mHFI0SVWGi+1ghiAgzZoBX1OU4hhgb5jBw5GWFGiR0t6NqBEiRDD6rMw8rPXT6iAgyQ9OYoULXCw+KOSFlOIva2Qg/PrgmScLE1BKnFlCp0ixJkoHDEkOZYC4g34tQmc3kq1gJpYRRCKCaNycqFGq9VqBTXvofgW64NMOyhG+Bx2/ZyeMp2xjpv5XHimEFPHvGZzZBn6JMf0/3SAQ6ZtKXxDIY/qGal3RiuHjgSOooh+XkJ1VZKgc1lVsD41wCHRyqPyxC+MKWQSHsaPjoQ2+yj0/BETTzm0pMbLxmQSoPdcqirnIW99rI+iqA4wq8L/Wt1lSMPPXW8o22S68KdPBmX6UvsPq7kuUDhkFpcSn5lQKaMKYT6XjqU6qUqKVs3hdBjdj5no62WYoZrD928XH1WVe29cPB6vdWVlKRY4SnRJugh06K9en7BWrIfCd/Co8euiFLIIUhweda4GhBmHVVmQirYtOqUcnq0wpqvmmoP0WLrXwG+hkrH2qzX3uvKag5e+eEGqKQpFipaGyccitHp0c3F4LlbXQc1Lm4lF4XFYMp3p3ZfBk1SFVPjQtdzDURQ9/Al1TTyTaLLfet3kY0p7lulKpX/8xs6bRJOaQ4nOicWr3bCN1WtAf+b5JJo8HPeeH+97PlVLUciUnVxP2S0N9t/r+PF7HR/i9A3O/WKRDVOzoF5EZUhvolGiz3W7+MLC8znEMO7qabwZbJgaODi0y24dVrYYdLYwZtTtqULMHfXOWBg5Xh4CTX6HSWWlX99Q2JrIDBfpoP+N/BtpAPxy3ZIDUmU6CLdOXhlUNzQIKUTLw71NeEvzUbrw3I3JkFeWact2pNlcOEyZprGK4ZHoX0aHzBlMZNaWxIjdq3t1o0tklUPaXIVUTy6+V5/Z3VWWyUSKgv2Dcyc9zj51EXt+ft6L2EGQOZc+r+bMotFb9kUghrAOpfqPA+Dg0ZbuKrtBu5RJN3ffMDUOzOO20EUSCh1pqNJYaUhfd4WongqZoHI4qLiT8+sL9mUUAR8UxTsgjy+mf51d3pyRViqrJkWHo2gUEclo50uhBobO0W+vmPmaTU93E7zZti1dd21NeVz5sSmEDA0RMG7aYr/r1xxwiIcH1YxDrp0nls2GKuG7LeqayD8qtGuI72YclsJKMQ9ragOpdPQ/7Y+jN6F9+tbeWQfs/bfZq850XaOoZZaiqLDx/AnXOwdiPat51zr/Ge1bMBpzL3u1R0MXa8NwkiRo/OBtb7LSrOin0vnZLdT1v4mSCwg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,u={id:"API-docs/get-template",title:"Get template by ID",description:"",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:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1P4zgQ/1d887RI3jawRSfladGBUHUI0MLqHqBCbjJpDInttZ3Sqsr/fhrno6GFXTid9qnNeD5+8z0b8GLhIL6DWyxNITw6mHFI0SVWGi+1ghiAgzZoBX1OU4hhgb5jBw5GWFGiR0t6NqBEiRDD6rMw8rPXT6iAgyQ9OYoULXCw+KOSFlOIva2Qg/PrgmScLE1BKnFlCp0ixJkoHDEkOZYC4g34tQmc3kq1gJpYRRCKCaNycqFGq9VqBTXvofgW64NMOyhG+Bx2/ZyeMp2xjpv5XHimEFPHvGZzZBn6JMf0/3SAQ6ZtKXxDIY/qGal3RiuHjgSOooh+XkJ1VZKgc1lVsD41wCHRyqPyxC+MKWQSHsaPjoQ2+yj0/BETTzm0pMbLxmQSoPdcqirnIW99rI+iqA4wq8L/Wt1lSMPPXW8o22S68KdPBmX6UvsPq7kuUDhkFpcSn5lQKaMKYT6XjqU6qUqKVs3hdBjdj5no62WYoZrD928XH1WVe29cPB6vdWVlKRY4SnRJugh06K9en7BWrIfCd/Co8euiFLIIUhweda4GhBmHVVmQirYtOqUcnq0wpqvmmoP0WLrXwG+hkrH2qzX3uvKag5e+eEGqKQpFipaGyccitHp0c3F4LlbXQc1Lm4lF4XFYMp3p3ZfBk1SFVPjQtdzDURQ9/Al1TTyTaLLfet3kY0p7lulKpX/8xs6bRJOaQ4nOicWr3bCN1WtAf+b5JJo8HPeeH+97PlVLUciUnVxP2S0N9t/r+PF7HR/i9A3O/WKRDVOzoF5EZUhvolGiz3W7+MLC8znEMO7qabwZbJgaODi0y24dVrYYdLYwZtTtqULMHfXOWBg5Xh4CTX6HSWWlX99Q2JrIDBfpoP+N/BtpAPxy3ZIDUmU6CLdOXhlUNzQIKUTLw71NeEvzUbrw3I3JkFeWact2pNlcOEyZprGK4ZHoX0aHzBlMZNaWxIjdq3t1o0tklUPaXIVUTy6+V5/Z3VWWyUSKgv2Dcyc9zj51EXt+ft6L2EGQOZc+r+bMotFb9kUghrAOpfqPA+Dg0ZbuKrtBu5RJN3ffMDUOzOO20EUSCh1pqNJYaUhfd4WongqZoHI4qLiT8+sL9mUUAR8UxTsgjy+mf51d3pyRViqrJkWHo2gUEclo50uhBobO0W+vmPmaTU93E7zZti1dd21NeVz5sSmEDA0RMG7aYr/r1xxwiIcH1YxDrp0nls2GKuG7LeqayD8qtGuI72YclsJKMQ9ragOpdPQ/7Y+jN6F9+tbeWQfs/bfZq850XaOoZZaiqLDx/AnXOwdiPat51zr/Ge1bMBpzL3u1R0MXa8NwkiRo/OBtb7LSrOin0vnZLdT1v4mSCwg=",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={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"createtemplate"})})]})}),(0,l.jsxs)("div",{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:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "result": {\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n }\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),p=a(5397),o=a(4667),c=a(9472),h=a(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VltP20oQ/it75qlIS+LQ8OKnogNC0UGACtV5gAht7HG8YO9ud9chUeT/Xs06dkwCLVRVnxLPzuWb+6zBi7mD+A5usTSF8OhgyiFFl1hpvNQKYgAO2qAV9DlJIYY5+pYdOBhhRYkeLelZgxIlQgzLQ2HkoddPqICDJD05ihQtcLD4vZIWU4i9rZCD86uCZJwsTUEqcWkKnSLEmSgcMSQ5lgLiNfiVCZzeSjWHmlhFEIoJo3JyrgbL5XIJNe+g+A3WB5m2UIzwOez6OTllOmMtN/O58Ewhpo55zWbIMvRJjumfdIBDpm0pfEMhj+opqXdGK4eOBI6iiH5eQnVVkqBzWVWwLjXAIdHKo/LEL4wpZBIeho+OhNb7KPTsERNPObSkxsvGZBKgd1yqKmchb12sj6KoDjCrwv9a3WVIw89dbyjbZLrwp0sGZfpS+w+ruS5QOGQWFxKfmVApowphPpeOpTqpSopWzeG0H92PmejqpZ+hmsO3rxcfVZV7b1w8HK50ZWUp5jhIdEm6CHTor06fsFas+sJ38Kjxy7wUsghSHB51rnqEKYdlWZCKTVu0Sjk8W2FMW801B+mxdK+B30IlY5uvjbnXldccvPTFC1JNUShStDRMPhah5aObidG5WF4HNS9tJhaFx37JtKZ3X3pPUhVS4UPbcg9HUfQwiqCuiWkcjfd7rx19TGnPMl2p9J+/2HrjaFxzKNE5MX+1HbbBeg3oz1wfR+OH487z433PJ2ohCpmyk+sJu6XJ/ncdP36v432cvsG5Xy2yYWo21Iuo9OlNNEr0ud5svrDxfA4xDNuCGq57K6YGDg7tot2HlS16rS2MGbSLqhAzR80zFEYOFyOg0e8wqaz0qxsKWxOZ/ibtDQAj/0OaAL/ct+SAVJkOwhsnrwyqG5qEFKLFaG8V3tKAlC48t3My5JVl2rIdaTYTDlOmaa5ieCT658GIOYOJzDYlMWD36l7d6BJZ5ZBWVyHVk4vv1SG7u8oymUhRsP9x5qTH6ac2Ys/Pz3sROwgy59Ln1YxZNHrLPg/EENa+VPdxABw82tJdZTdoFzJpB+8bpoaBebgpdJGEQkeaqjRXGtKXXSGqp0ImqBz2Ku7k/PqCfR5EwHtF8Q7Iw4vJv2eXN2eklcqqSdFoEA0iIhntfClUz9A5+u0ZM1uxyelugtfbtqXzblNTHpd+aAohQ0MEjOtNsd91ew44xP2Lasoh184Ty3pNlfDNFnVN5O8V2hXEd1MOC2GlmIU9tYZUOvqfdtfRm9A+fd0cWgfs/cfZq860XaOoZRaiqLDx/AlXOxdiPa152zq/jfYtGI25l73aoaGTtWE4SRI0vve2N1lpVnRT6fzsFur6B2OiCzI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get template by ID",description:"",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:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VltP20oQ/it75qlIS+LQ8OKnogNC0UGACtV5gAht7HG8YO9ud9chUeT/Xs06dkwCLVRVnxLPzuWb+6zBi7mD+A5usTSF8OhgyiFFl1hpvNQKYgAO2qAV9DlJIYY5+pYdOBhhRYkeLelZgxIlQgzLQ2HkoddPqICDJD05ihQtcLD4vZIWU4i9rZCD86uCZJwsTUEqcWkKnSLEmSgcMSQ5lgLiNfiVCZzeSjWHmlhFEIoJo3JyrgbL5XIJNe+g+A3WB5m2UIzwOez6OTllOmMtN/O58Ewhpo55zWbIMvRJjumfdIBDpm0pfEMhj+opqXdGK4eOBI6iiH5eQnVVkqBzWVWwLjXAIdHKo/LEL4wpZBIeho+OhNb7KPTsERNPObSkxsvGZBKgd1yqKmchb12sj6KoDjCrwv9a3WVIw89dbyjbZLrwp0sGZfpS+w+ruS5QOGQWFxKfmVApowphPpeOpTqpSopWzeG0H92PmejqpZ+hmsO3rxcfVZV7b1w8HK50ZWUp5jhIdEm6CHTor06fsFas+sJ38Kjxy7wUsghSHB51rnqEKYdlWZCKTVu0Sjk8W2FMW801B+mxdK+B30IlY5uvjbnXldccvPTFC1JNUShStDRMPhah5aObidG5WF4HNS9tJhaFx37JtKZ3X3pPUhVS4UPbcg9HUfQwiqCuiWkcjfd7rx19TGnPMl2p9J+/2HrjaFxzKNE5MX+1HbbBeg3oz1wfR+OH487z433PJ2ohCpmyk+sJu6XJ/ncdP36v432cvsG5Xy2yYWo21Iuo9OlNNEr0ud5svrDxfA4xDNuCGq57K6YGDg7tot2HlS16rS2MGbSLqhAzR80zFEYOFyOg0e8wqaz0qxsKWxOZ/ibtDQAj/0OaAL/ct+SAVJkOwhsnrwyqG5qEFKLFaG8V3tKAlC48t3My5JVl2rIdaTYTDlOmaa5ieCT658GIOYOJzDYlMWD36l7d6BJZ5ZBWVyHVk4vv1SG7u8oymUhRsP9x5qTH6ac2Ys/Pz3sROwgy59Ln1YxZNHrLPg/EENa+VPdxABw82tJdZTdoFzJpB+8bpoaBebgpdJGEQkeaqjRXGtKXXSGqp0ImqBz2Ku7k/PqCfR5EwHtF8Q7Iw4vJv2eXN2eklcqqSdFoEA0iIhntfClUz9A5+u0ZM1uxyelugtfbtqXzblNTHpd+aAohQ0MEjOtNsd91ew44xP2Lasoh184Ty3pNlfDNFnVN5O8V2hXEd1MOC2GlmIU9tYZUOvqfdtfRm9A+fd0cWgfs/cfZq860XaOoZRaiqLDx/AlXOxdiPa152zq/jfYtGI25l73aoaGTtWE4SRI0vve2N1lpVnRT6fzsFur6B2OiCzI=",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"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get template by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"createtemplate"})})]})}),(0,l.jsxs)("div",{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:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "result": {\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"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)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.1bf4c76e.js b/assets/js/52d5c0f9.0d9e94c0.js similarity index 67% rename from assets/js/52d5c0f9.1bf4c76e.js rename to assets/js/52d5c0f9.0d9e94c0.js index 4533951c1..52e8e0301 100644 --- a/assets/js/52d5c0f9.1bf4c76e.js +++ b/assets/js/52d5c0f9.0d9e94c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>y,contentTitle:()=>x,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),d=a(58219),t=(a(62316),a(51039)),i=a.n(t),r=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1P4zgU/Sve+zRIoQlQXqLVatCCRtWgBW1Z7QNUyE1uGg+J7bGd0irKfx9d54O0hRlmtZqXNrHvtc859ys1OL6yEN/DpUqqEqWzsAggRZsYoZ1QEmJIsUCHjLO0s4EAlEbDaX+WDhajbc0NL9GhobNrkLxEiGFzzLU4duoJJQQg6OwceYoGAjD4tRIGU4idqTAA67YF+VhR6gIhANzoQqUIccYLSwZJjiWHuAa31d7SGSFX0JAp904xwZRWrORks9lsoAkGKD3WR5H2UDR3OexzvzVqLVJkavkFEzdLmcoGGZhTrGX+f+IPIFOm5G688kJI56fL/JTbFJpmQbdaraRFS+ecRhH97RLo49ohTZmtkgStzaqi2P4GASRKOgpaXAPXuhCJD2v4xZJ7fQizVYJibCgJnGgvTzy3wUpW5dLHdYB+GkVNACVay1f4Gu0Xkj/A3DQBOOG8qZCFkPjY6/B4GkWP59A0ZDONpt/RQyrHMlXJ9FeKMI2mPy3CCOj3mE+j6ePZwPz8kPlMrnkhUnZxO2N3VIO/lvj5e4mPcboWJ3HalAX5dfUrWqO2l+yoMl5v1bCYVEa4rW9F4x4U3y+oiEp0uXppY759uRxiCPtKD+tRv2iAjjTrvrlVpqBG5py2cRhyrSd91yn40k4SVYZci3B9AnRZD2ZOyrbi7UAalOFafMYtBD9unsRRyEx5506HG41yLlbSq7g+Oehrd7mwTFi/3XPzoWeZMmzPmy25xZQpyVyOfpPWzyYnzGpMRNZlzYQ9yAc5VyWyymJWFawQ8snGD/KY3d9kmUgEL9i/uLTC4eJDr9jz8/OBYkfe55NwebVkBrV6MV/5RS/r2Gt4OYIAHJrS3mRzNGuRYBedN64KvXHY1QJPfC1gyQVFtVv6uO9EKVeIBKXFUVJefLq9ZmeTCIJRUrwDcng9+/Pqr/kVnUpp1YboZBJNIlrSyrqSy9FFl+1EHgbRcstml/sxrl+K+9UR3uWZw40LdcGFryOPu+4K4B5G5vF4ZC4CyJV1ZFLXlB3/mKJpaPlrhYYqbRHAmhvBl5SO9zWkwtJzOsy/N7F++LsbpUfs3dP3VS59IUmqojUvKnqDAJ5wu/cF0CyaoK+m/wz2LRjtdbvlO6ChT5LW4CJJULvR3kE/3ulVl1fXV3dXEACvKFTjtvHk20b3QHReFWIXUIuBfgnRqw6/U9F/xu0fg3m786bD8G3XWpMai6ZpvgGx3JPf",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:"delete a document",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:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1P4zgU/Sve+zRIoQlQXqLVatCCRtWgBW1Z7QNUyE1uGg+J7bGd0irKfx9d54O0hRlmtZqXNrHvtc859ys1OL6yEN/DpUqqEqWzsAggRZsYoZ1QEmJIsUCHjLO0s4EAlEbDaX+WDhajbc0NL9GhobNrkLxEiGFzzLU4duoJJQQg6OwceYoGAjD4tRIGU4idqTAA67YF+VhR6gIhANzoQqUIccYLSwZJjiWHuAa31d7SGSFX0JAp904xwZRWrORks9lsoAkGKD3WR5H2UDR3OexzvzVqLVJkavkFEzdLmcoGGZhTrGX+f+IPIFOm5G688kJI56fL/JTbFJpmQbdaraRFS+ecRhH97RLo49ohTZmtkgStzaqi2P4GASRKOgpaXAPXuhCJD2v4xZJ7fQizVYJibCgJnGgvTzy3wUpW5dLHdYB+GkVNACVay1f4Gu0Xkj/A3DQBOOG8qZCFkPjY6/B4GkWP59A0ZDONpt/RQyrHMlXJ9FeKMI2mPy3CCOj3mE+j6ePZwPz8kPlMrnkhUnZxO2N3VIO/lvj5e4mPcboWJ3HalAX5dfUrWqO2l+yoMl5v1bCYVEa4rW9F4x4U3y+oiEp0uXppY759uRxiCPtKD+tRv2iAjjTrvrlVpqBG5py2cRhyrSd91yn40k4SVYZci3B9AnRZD2ZOyrbi7UAalOFafMYtBD9unsRRyEx5506HG41yLlbSq7g+Oehrd7mwTFi/3XPzoWeZMmzPmy25xZQpyVyOfpPWzyYnzGpMRNZlzYQ9yAc5VyWyymJWFawQ8snGD/KY3d9kmUgEL9i/uLTC4eJDr9jz8/OBYkfe55NwebVkBrV6MV/5RS/r2Gt4OYIAHJrS3mRzNGuRYBedN64KvXHY1QJPfC1gyQVFtVv6uO9EKVeIBKXFUVJefLq9ZmeTCIJRUrwDcng9+/Pqr/kVnUpp1YboZBJNIlrSyrqSy9FFl+1EHgbRcstml/sxrl+K+9UR3uWZw40LdcGFryOPu+4K4B5G5vF4ZC4CyJV1ZFLXlB3/mKJpaPlrhYYqbRHAmhvBl5SO9zWkwtJzOsy/N7F++LsbpUfs3dP3VS59IUmqojUvKnqDAJ5wu/cF0CyaoK+m/wz2LRjtdbvlO6ChT5LW4CJJULvR3kE/3ulVl1fXV3dXEACvKFTjtvHk20b3QHReFWIXUIuBfgnRqw6/U9F/xu0fg3m786bD8G3XWpMai6ZpvgGx3JPf",sidebar_class_name:"delete 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:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},y={},b=[{value:"Request",id:"request",level:2}];function f(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:"delete a 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:"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)(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)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(d.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document deleted successfully!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Document deleted successfully!"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>v,contentTitle:()=>j,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",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:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete 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:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},v={},y=[{value:"Request",id:"request",level:2}];function g(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)(d(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a 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:"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)(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)("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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document deleted successfully!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Document deleted successfully!"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.e12965bb.js b/assets/js/5a2de241.8057ae9d.js similarity index 70% rename from assets/js/5a2de241.e12965bb.js rename to assets/js/5a2de241.8057ae9d.js index 0aeb7bb37..cd7460c1a 100644 --- a/assets/js/5a2de241.e12965bb.js +++ b/assets/js/5a2de241.8057ae9d.js @@ -1 +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:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),m=s.n(t),r=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const x={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu4zYQ/RV2nrKAYjtZb1HoqekmzRpdJMYmQR8Sw6Ckkc2EIrkk5QsM/XsxulmOc9m0QddPMjVDzjlnhjPagOczB+EtXGNmJPfoYBKANmi5F1qNEgghNwn32BhAAIZbnqFHS54bUDxDCGF1yI049PoBFQQgFIQwR56ghQAsfs+FxQRCb3MMwPm1JB8nMiNpS1wZqROEMOXSkUE8x4xDuAG/NqWlt0LNoCBTXjqFFKZyYqZ6q9VqBUXQhuLrWKciaUIx3M8hgARdbIUhbBDC6JTplPk5ssaD+Tn3TCEmjnnNImQV+uQ9QQSQaptx34FVTKr90fk/dLImn91QjdULkSCLUOolaxWgIKsIWwiOHXDPJHLnmVbYsW0AfIAAYq08Kk8HcWOkiEu9+/eOTtvsh66je4w9iW8pO7xAR28vSsJfB9iVzZUPbbyk6YX2b95mTBCRWVwIXDKuEka5wPxcOJboOM8IXhHAaZfHtx3RZkVXiyKAP7VM0FJxvG2/1b2L+NE5X42hKALwwu8cM+3k7TSiNCgKsrPojFauYvx4MNjPjqY4m2xlLo9jdC7NpVz/8n5yx2V6t1Yqz6KyvlvQ7UoL+ngwKALI0Dk+e7PGHVwNrAYVVMTk0r8edrX8tF7bw7hLjr+48fCL2VFHKCkUThsRpseDwfS3aX30q4a1hMOnVKszuCntBZciYalAmTC6yNzPFW74X4R7HdpLzBFbDW/DF7Jdac9SnavkZzM1fIcU74B5mZvh9NeWnU/77IxUxfbJeMSuqRv/D+R0qPj0MhVb4N04fRUnYVplkvzqTi4qo2qq2GGlu16xsUvDzW5XZNGajU6BYvNzTWONyUt8NBeE0G/s+pvOJVxAAA7topl0citpqvHeuLDf58b0mhFE8sj1Yp31uRH9xRFQP3cY51b49RWRW/HXnZG25HAj/sI1BK9PUgSTNPu2HRXOGkKbZrzXX5v2+mMd81HDfLoHdlvgTlejcFNdYquVujSorugY0nlxtDeDXdPpwpWvmyDK5GSptuyRN4u4w4RpVQ5t9JLWP/aOmDMYi7TO6x67U3fqSmfIcodpLpkU6sGFd+qQ3V6mqYgFl+xvjJzwODloBF0ul3uCfih9zoWf5xGzaPTWfFYulqp3vdo/NGZ5tJm7TK/QLkSMdfI8c1S/NO7X1crjslox44KSrl76/bETUS5FjMphp2xOzsdf2cfeAIJOzv5AyP2vo89nF1dntCtlfSXRUW/QG9CS0c5nXHUOeq7KkieHLo8r3zeSi7KWy8g2dQXeQidfw+4APwlgrp0nk82G9L+xsiho+XuOdg3h7SSABbeCR5RwtxtIhKPnpB3EH0XTXoZw8K0ZidnbvgWeBNSUs6JaXnCZ0z8I4AHXjz5KikkRNDX9ryN+LozquN1LpI2GvpIqg8/VnofXtMfWYq89bD1O4hiNf9F20rlgxzfXEEBUf85kZesAy5f0KcWXEMId3BE9uoRZ3o/l+gYkV7O8bCBQbUu/fwB7wA/6",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:"Update template by ID",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:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu4zYQ/RV2nrKAYjtZb1HoqekmzRpdJMYmQR8Sw6Ckkc2EIrkk5QsM/XsxulmOc9m0QddPMjVDzjlnhjPagOczB+EtXGNmJPfoYBKANmi5F1qNEgghNwn32BhAAIZbnqFHS54bUDxDCGF1yI049PoBFQQgFIQwR56ghQAsfs+FxQRCb3MMwPm1JB8nMiNpS1wZqROEMOXSkUE8x4xDuAG/NqWlt0LNoCBTXjqFFKZyYqZ6q9VqBUXQhuLrWKciaUIx3M8hgARdbIUhbBDC6JTplPk5ssaD+Tn3TCEmjnnNImQV+uQ9QQSQaptx34FVTKr90fk/dLImn91QjdULkSCLUOolaxWgIKsIWwiOHXDPJHLnmVbYsW0AfIAAYq08Kk8HcWOkiEu9+/eOTtvsh66je4w9iW8pO7xAR28vSsJfB9iVzZUPbbyk6YX2b95mTBCRWVwIXDKuEka5wPxcOJboOM8IXhHAaZfHtx3RZkVXiyKAP7VM0FJxvG2/1b2L+NE5X42hKALwwu8cM+3k7TSiNCgKsrPojFauYvx4MNjPjqY4m2xlLo9jdC7NpVz/8n5yx2V6t1Yqz6KyvlvQ7UoL+ngwKALI0Dk+e7PGHVwNrAYVVMTk0r8edrX8tF7bw7hLjr+48fCL2VFHKCkUThsRpseDwfS3aX30q4a1hMOnVKszuCntBZciYalAmTC6yNzPFW74X4R7HdpLzBFbDW/DF7Jdac9SnavkZzM1fIcU74B5mZvh9NeWnU/77IxUxfbJeMSuqRv/D+R0qPj0MhVb4N04fRUnYVplkvzqTi4qo2qq2GGlu16xsUvDzW5XZNGajU6BYvNzTWONyUt8NBeE0G/s+pvOJVxAAA7topl0citpqvHeuLDf58b0mhFE8sj1Yp31uRH9xRFQP3cY51b49RWRW/HXnZG25HAj/sI1BK9PUgSTNPu2HRXOGkKbZrzXX5v2+mMd81HDfLoHdlvgTlejcFNdYquVujSorugY0nlxtDeDXdPpwpWvmyDK5GSptuyRN4u4w4RpVQ5t9JLWP/aOmDMYi7TO6x67U3fqSmfIcodpLpkU6sGFd+qQ3V6mqYgFl+xvjJzwODloBF0ul3uCfih9zoWf5xGzaPTWfFYulqp3vdo/NGZ5tJm7TK/QLkSMdfI8c1S/NO7X1crjslox44KSrl76/bETUS5FjMphp2xOzsdf2cfeAIJOzv5AyP2vo89nF1dntCtlfSXRUW/QG9CS0c5nXHUOeq7KkieHLo8r3zeSi7KWy8g2dQXeQidfw+4APwlgrp0nk82G9L+xsiho+XuOdg3h7SSABbeCR5RwtxtIhKPnpB3EH0XTXoZw8K0ZidnbvgWeBNSUs6JaXnCZ0z8I4AHXjz5KikkRNDX9ryN+LozquN1LpI2GvpIqg8/VnofXtMfWYq89bD1O4hiNf9F20rlgxzfXEEBUf85kZesAy5f0KcWXEMId3BE9uoRZ3o/l+gYkV7O8bCBQbUu/fwB7wA/6",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={},b=[{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,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)(m(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be 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)(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,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:200}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template upated sucessfully"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template upated sucessfully",\n "result": {\n "objectId": "asd2HsP4Hp"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:400}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 400,\n "message": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:404}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",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:"Update template by ID",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:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",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"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be 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)(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,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:200}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template upated sucessfully"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template upated sucessfully",\n "result": {\n "objectId": "asd2HsP4Hp"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:400}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 400,\n "message": "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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:404}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.c77fc495.js b/assets/js/770b40a9.a106d1ce.js similarity index 50% rename from assets/js/770b40a9.c77fc495.js rename to assets/js/770b40a9.a106d1ce.js index ad40e1979..2fc9d9328 100644 --- a/assets/js/770b40a9.c77fc495.js +++ b/assets/js/770b40a9.a106d1ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),d=s(5397),p=s(4667),o=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnZ3YtOzaZpGnSxCdYuerCNgJJGNhOK5JKUY8PQfy+G+rBip3FaFPXF9nAeOfPmzZA7cGxpIZnBFEstmEMLixCURsMcV/I2hwSW6Fy7Krh1EIJmhpXo0BB0B5KVCAlszpnm5049oYQQuIQEVshyNBCCwR8VN5hD4kyFIVi3FYSxvNQCIQTcaKFyhKRgwpJDtsKSQbIDt9Xe0xkul1CTK/OghOKUli/laLPZbKBeNOegdV9UviVspqRD6egn01rwzGcVPVolyXZ0iEofMfMZGuLAcbS0KnjJ3cBNVmXq0yqUKZkbWvrgxnEdgn3i+h/i4roOYVMKgrXEEuspZVSH4LgTL201AQxaraRtwr2IY/rK0WaGa8qY+KuyDK0tKhH05YXwv2Io87U7TrRP6yKOmzArMWSSGcO2pBaHpT19TGMmVR7qYsBpb9kLZTP+LZWlvbj3AvqVC3xth73/yjltkyjqdF9ZNKNMlYT+5ovyFtr6H0EH9iDlToA670CqBvLLsHzvQ1JklJ8S1HVvggrv00MmfCl9O//bypxm5VEh1AMFd2E/dGfT4pVB5vDL9p0ZZ+SuujSOGmdYgcNjoR4Gw6XgEh+6Nnq4iOOHcdw216f483E/3co1EzwPLu9vgynNvJ/+x276FH+uQyjRWrY8QfswTtfEeUwUb5ya2f2ClqG9YeMlDTfoeqEH7fVQolspujm0aq8Lt4IEooNbxKJZd1dIZcSg7ZjWo262C5Zaar2IaR6tx37KW8wqw912Qnw2lA0vn4GINf8dScUnryjKjMr0fX+BXHcc9hfAOO5GOg0zLgvlz2rJutMoScue6vUYDqmarrgNuPXLucqqEqXz+ggKZYIDdJAyi3mgZOBW6BfJ/nE0DqzGjBettEbBXM7lRJUYVBZpuAsun2wyl+fB7K4oeMaZCP7E1HKHiw8dwc/Pz0cEn3nMDXerKg0MarV3X3qjr8IQ1f85gxAcmtLeFRM0a551M/Rvjoq8c9Q2DMt8w2DJOImgNf18CCJdCp6htDhQ7uXN/dfg4yiGcKChd4Qcfb29uv42uaZdSYVNicajeBSTiZRbMjk46DWh56+OaIcbF2nBuG8lH9Wu7YEZvOiBRQgrapFkBrsdFfwPI+qazD8qNFtIZosQ1sxwlpLCZos67PRKTZNzSwt5/2g6iKefRvDhe/v+OguoVK/F+YTbowZZM1GRJ9ThrnW4avY8n9Iee4+jabdHXGYZavem72IwM+7vJlMIIW1fcKUfhWDYM70i2TMkMIc5AD1SaQff/N6+A8HksvIDEZp96fMXx6q8PA==",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/gettemplatelist",title:"Get template list",description:"Get template list",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:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnZ3YtOzaZpGnSxCdYuerCNgJJGNhOK5JKUY8PQfy+G+rBip3FaFPXF9nAeOfPmzZA7cGxpIZnBFEstmEMLixCURsMcV/I2hwSW6Fy7Krh1EIJmhpXo0BB0B5KVCAlszpnm5049oYQQuIQEVshyNBCCwR8VN5hD4kyFIVi3FYSxvNQCIQTcaKFyhKRgwpJDtsKSQbIDt9Xe0xkul1CTK/OghOKUli/laLPZbKBeNOegdV9UviVspqRD6egn01rwzGcVPVolyXZ0iEofMfMZGuLAcbS0KnjJ3cBNVmXq0yqUKZkbWvrgxnEdgn3i+h/i4roOYVMKgrXEEuspZVSH4LgTL201AQxaraRtwr2IY/rK0WaGa8qY+KuyDK0tKhH05YXwv2Io87U7TrRP6yKOmzArMWSSGcO2pBaHpT19TGMmVR7qYsBpb9kLZTP+LZWlvbj3AvqVC3xth73/yjltkyjqdF9ZNKNMlYT+5ovyFtr6H0EH9iDlToA670CqBvLLsHzvQ1JklJ8S1HVvggrv00MmfCl9O//bypxm5VEh1AMFd2E/dGfT4pVB5vDL9p0ZZ+SuujSOGmdYgcNjoR4Gw6XgEh+6Nnq4iOOHcdw216f483E/3co1EzwPLu9vgynNvJ/+x276FH+uQyjRWrY8QfswTtfEeUwUb5ya2f2ClqG9YeMlDTfoeqEH7fVQolspujm0aq8Lt4IEooNbxKJZd1dIZcSg7ZjWo262C5Zaar2IaR6tx37KW8wqw912Qnw2lA0vn4GINf8dScUnryjKjMr0fX+BXHcc9hfAOO5GOg0zLgvlz2rJutMoScue6vUYDqmarrgNuPXLucqqEqXz+ggKZYIDdJAyi3mgZOBW6BfJ/nE0DqzGjBettEbBXM7lRJUYVBZpuAsun2wyl+fB7K4oeMaZCP7E1HKHiw8dwc/Pz0cEn3nMDXerKg0MarV3X3qjr8IQ1f85gxAcmtLeFRM0a551M/Rvjoq8c9Q2DMt8w2DJOImgNf18CCJdCp6htDhQ7uXN/dfg4yiGcKChd4Qcfb29uv42uaZdSYVNicajeBSTiZRbMjk46DWh56+OaIcbF2nBuG8lH9Wu7YEZvOiBRQgrapFkBrsdFfwPI+qazD8qNFtIZosQ1sxwlpLCZos67PRKTZNzSwt5/2g6iKefRvDhe/v+OguoVK/F+YTbowZZM1GRJ9ThrnW4avY8n9Iee4+jabdHXGYZavem72IwM+7vJlMIIW1fcKUfhWDYM70i2TMkMIc5AD1SaQff/N6+A8HksvIDEZp96fMXx6q8PA==",sidebar_class_name:"post 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"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,l.jsx)(a.p,{children:"Get template list"}),"\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:"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)(m.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"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "File": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n }\n ]\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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>b});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnJ7kWnZtM0DbrYBGsXPdhGQEkjmwlFcknKHzD034uhJFuxs3G2KOqL7eE8cubNmyG34NjcQjKBMZZaMIcWZiEojYY5ruRdDgnM0bl2VXDrIATNDCvRoSHoFiQrERJYnzPNz516RgkhcAkJLJDlaCAEg98rbjCHxJkKQ7BuIwhjeakFQgi41kLlCEnBhCWHbIElg2QLbqO9pzNczqEmV+ZBCcUpLZ/LwXq9XkM9a85B6z6rfEPYTEmH0tFPprXgmc8qerJKku3oEJU+YeYzNMSB42hpVfCSu56brMrUp1UoUzLXt+yCG8Z1CPaZ65/ExXUdwroUBGuJJdZTyqgOwXEnXtpqAhi0WknbhHsRx/SVo80M15Qx8VdlGVpbVCLYlRfC/4qhzNfuONFdWhdx3IRZiT6TzBi2IbU4LO3pYxozqfJQFz1Od5a9UNbDP1JZ2osHL6DfucDXdtj7L5zTNomiTveVRTPIVEnor74ob6Gt/xF0YA9S7gSo8w6kaiC/9cv3PiRFRvkpQV33JqjwPjvIiM+lb+d/W5nTrDwphLqn4C7sx+5sWrw2yBx+3rwz44zcVZfGUeP0K3B4LNT9YLgUXOJj10aPF3H8OLxsm+tj/Om4n+7kkgmeB1cPd8GYZt4v/2M3fYw/1SGUaC2bn6C9H6dr4jwmijdOzex+QUvf3rDxkoZbdDuhB+31UKJbKLo5tGqvC7eABKKDW8SiWXZXSGVEr+2Y1oNutguWWmq9iGkeLYd+ylvMKsPdZkR8NpT1L5+eiDX/E0nFJ68oyozK9G1/gdx0HO4ugGHcjXQaZlwWyp/VknWvUZKWPdXLIRxSNV5wG3Drl3OVVSVK5/URFMoEB+ggZRbzQMnALdAvkv1yMAysxowXrbQGwVRO5UiVGFQWabgLLp9tMpXnweS+KHjGmQj+xtRyh7MPHcGr1eqI4DOPueVuUaWBQa327nNv9FXoo3Z/ziAEh6a098UIzZJn3Qz9wVGRd47ahmGZbxgsGScRtKZfD0GkS8EzlBZ7yr26ffgSXA5iCHsaekfI0Ze765uvoxvalVTYlGg4iAcxmUi5JZO9g14Tev7qiHa4dpEWjPtW8lFt2x6YwIsemIWwoBZJJrDdUsH/MqKuyfy9QrOBZDILYckMZykpbDKrw06v1DQ5t7SQ7x5NB/HsphF8+Na+v84CKtVrcT7j5qhBlkxU5Al1uG0drps9z8e0x97jaNrtEVdZhtq96TvrzYyH+9EYQkjbF1zpRyEYtqJXJFtBAlOYAtAjlXbwze/tWxBMzis/EKHZlz7/ANj5vD8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/gettemplatelist",title:"Get template list",description:"Get template list",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:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnJ7kWnZtM0DbrYBGsXPdhGQEkjmwlFcknKHzD034uhJFuxs3G2KOqL7eE8cubNmyG34NjcQjKBMZZaMIcWZiEojYY5ruRdDgnM0bl2VXDrIATNDCvRoSHoFiQrERJYnzPNz516RgkhcAkJLJDlaCAEg98rbjCHxJkKQ7BuIwhjeakFQgi41kLlCEnBhCWHbIElg2QLbqO9pzNczqEmV+ZBCcUpLZ/LwXq9XkM9a85B6z6rfEPYTEmH0tFPprXgmc8qerJKku3oEJU+YeYzNMSB42hpVfCSu56brMrUp1UoUzLXt+yCG8Z1CPaZ65/ExXUdwroUBGuJJdZTyqgOwXEnXtpqAhi0WknbhHsRx/SVo80M15Qx8VdlGVpbVCLYlRfC/4qhzNfuONFdWhdx3IRZiT6TzBi2IbU4LO3pYxozqfJQFz1Od5a9UNbDP1JZ2osHL6DfucDXdtj7L5zTNomiTveVRTPIVEnor74ob6Gt/xF0YA9S7gSo8w6kaiC/9cv3PiRFRvkpQV33JqjwPjvIiM+lb+d/W5nTrDwphLqn4C7sx+5sWrw2yBx+3rwz44zcVZfGUeP0K3B4LNT9YLgUXOJj10aPF3H8OLxsm+tj/Om4n+7kkgmeB1cPd8GYZt4v/2M3fYw/1SGUaC2bn6C9H6dr4jwmijdOzex+QUvf3rDxkoZbdDuhB+31UKJbKLo5tGqvC7eABKKDW8SiWXZXSGVEr+2Y1oNutguWWmq9iGkeLYd+ylvMKsPdZkR8NpT1L5+eiDX/E0nFJ68oyozK9G1/gdx0HO4ugGHcjXQaZlwWyp/VknWvUZKWPdXLIRxSNV5wG3Drl3OVVSVK5/URFMoEB+ggZRbzQMnALdAvkv1yMAysxowXrbQGwVRO5UiVGFQWabgLLp9tMpXnweS+KHjGmQj+xtRyh7MPHcGr1eqI4DOPueVuUaWBQa327nNv9FXoo3Z/ziAEh6a098UIzZJn3Qz9wVGRd47ahmGZbxgsGScRtKZfD0GkS8EzlBZ7yr26ffgSXA5iCHsaekfI0Ze765uvoxvalVTYlGg4iAcxmUi5JZO9g14Tev7qiHa4dpEWjPtW8lFt2x6YwIsemIWwoBZJJrDdUsH/MqKuyfy9QrOBZDILYckMZykpbDKrw06v1DQ5t7SQ7x5NB/HsphF8+Na+v84CKtVrcT7j5qhBlkxU5Al1uG0drps9z8e0x97jaNrtEVdZhtq96TvrzYyH+9EYQkjbF1zpRyEYtqJXJFtBAlOYAtAjlXbwze/tWxBMzis/EKHZlz7/ANj5vD8=",sidebar_class_name:"post 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"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"Get template list"}),"\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)(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,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.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"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"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)(o.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "File": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.04f4277f.js b/assets/js/7b076186.04f4277f.js new file mode 100644 index 000000000..12ba2eafb --- /dev/null +++ b/assets/js/7b076186.04f4277f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var l=s(85893),t=s(11151),n=s(58219),c=(s(62316),s(51039)),i=s.n(c),d=(s(82723),s(9487)),r=s(41429),o=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu2zgQ/RXuPDWAYimO+yIsFg3aoAgabIJ1FvuQGAEtjSw2FMmSlGND0L8XQ8mynEubXSz6YkvkGfLMmZsa8HzlIL2Fj1p5nnkHiwhydJkVxgutIIUcJXpknGUdBCLQBi2n7Yt8AOx3Dbe8Qo+WDm5A8Qohhc0xN+LY6wdUEIGgk0vkOVqIwOK3WljMIfW2xgic30qycaIyEiEC3Bipc4S04NIRICux4pA24LcmIL0VagUtQXkwSomlcmKlJpvNZgNtNFDpqd6LfMfEcF/CU8evrV6LHJlefsXMX+RMFzsNmNesc/v/ZB9BoW3F/Xhl744pp8tyyl0ObbugW53RyqGjc6ZJQn+H/PuQ9kRz5uosQ+eKWsrtbxAFGVB5MuTGSJGFkMZfHVk3z1l2OlCALSWAF93dWXBtQKm6WoagDsynSdJGUKFzfIUveb338ceU2zYCL3xACiWFwvudCvfTJLk/hbYlzCyZva6G0p4Vulb5r5Rglsz+rQQjnj/ye5bM7qeD3++f+32h1lyKnJ1dX7Abqr5f6/f7t/o95uk7nuTTppJk11eu6EBdFzlQZbzeqeEwq63w29CExt0nvV1QAVXoS73vX6Fx+RJSiPsij5t9o2iBDrTrXVOrraQG5r1xaRxzYya7biP50k0yXcXciHh9AnTVjsqcdO2kOyA06MKN+IJbiH7eNMlDoQodjHsVrgyquVipoOH65FlDuymFY8KF7VxndYXKh8CzQlv2xJotucOcacV8iWGT1k8nJ8wZzETR58yE3ak7NdcVstphUUsmhXpw6Z06ZrdXRSEywSX7B5dOeFy82yn2+Pj4TLGjYPNZ+LJeMotG7+GrsBhkHVsNL0cQgUdbuatijnYtMuyj88pVcQDHfSXQ2EobwIoLuR8PH54aUcJJkaFyOErJs8/Xl+x0kkA0Soo3UI4vLz6e/zk/p1MprboQnUySSUJLRjtfcTW66FNIUzcawwfRbfZF/dLI7hPM48bHRnIRyicQbvq8v4U9Oh2NyEUEpXaeAE1DSfG3lW1Ly99qtFReiwjW3Aq+pCy8bSAXjp7zYeC9SvTdX/3sPGJvnbYvOrIrH0W1s+aypjeI4AG3h/O+XbTRroT+M9XXWHS3HdbsQIa+PzrAWZah8aO9Zy34oD19Or88vzmHCHhNYRr3iofQK/oHcudFHQ4JdRzolxi9aPA7VfoX3P4xwLudVw2GD7kOTWos2rb9DjHmiwQ=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Deletes contact",description:"delete a contact",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:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu2zgQ/RXuPDWAYimO+yIsFg3aoAgabIJ1FvuQGAEtjSw2FMmSlGND0L8XQ8mynEubXSz6YkvkGfLMmZsa8HzlIL2Fj1p5nnkHiwhydJkVxgutIIUcJXpknGUdBCLQBi2n7Yt8AOx3Dbe8Qo+WDm5A8Qohhc0xN+LY6wdUEIGgk0vkOVqIwOK3WljMIfW2xgic30qycaIyEiEC3Bipc4S04NIRICux4pA24LcmIL0VagUtQXkwSomlcmKlJpvNZgNtNFDpqd6LfMfEcF/CU8evrV6LHJlefsXMX+RMFzsNmNesc/v/ZB9BoW3F/Xhl744pp8tyyl0ObbugW53RyqGjc6ZJQn+H/PuQ9kRz5uosQ+eKWsrtbxAFGVB5MuTGSJGFkMZfHVk3z1l2OlCALSWAF93dWXBtQKm6WoagDsynSdJGUKFzfIUveb338ceU2zYCL3xACiWFwvudCvfTJLk/hbYlzCyZva6G0p4Vulb5r5Rglsz+rQQjnj/ye5bM7qeD3++f+32h1lyKnJ1dX7Abqr5f6/f7t/o95uk7nuTTppJk11eu6EBdFzlQZbzeqeEwq63w29CExt0nvV1QAVXoS73vX6Fx+RJSiPsij5t9o2iBDrTrXVOrraQG5r1xaRxzYya7biP50k0yXcXciHh9AnTVjsqcdO2kOyA06MKN+IJbiH7eNMlDoQodjHsVrgyquVipoOH65FlDuymFY8KF7VxndYXKh8CzQlv2xJotucOcacV8iWGT1k8nJ8wZzETR58yE3ak7NdcVstphUUsmhXpw6Z06ZrdXRSEywSX7B5dOeFy82yn2+Pj4TLGjYPNZ+LJeMotG7+GrsBhkHVsNL0cQgUdbuatijnYtMuyj88pVcQDHfSXQ2EobwIoLuR8PH54aUcJJkaFyOErJs8/Xl+x0kkA0Soo3UI4vLz6e/zk/p1MprboQnUySSUJLRjtfcTW66FNIUzcawwfRbfZF/dLI7hPM48bHRnIRyicQbvq8v4U9Oh2NyEUEpXaeAE1DSfG3lW1Ly99qtFReiwjW3Aq+pCy8bSAXjp7zYeC9SvTdX/3sPGJvnbYvOrIrH0W1s+aypjeI4AG3h/O+XbTRroT+M9XXWHS3HdbsQIa+PzrAWZah8aO9Zy34oD19Or88vzmHCHhNYRr3iofQK/oHcudFHQ4JdRzolxi9aPA7VfoX3P4xwLudVw2GD7kOTWos2rb9DjHmiwQ=",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"}},y={},b=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Deletes contact"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"delete a contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.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)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.621d99d2.js b/assets/js/7b076186.621d99d2.js deleted file mode 100644 index 45eb4c686..000000000 --- a/assets/js/7b076186.621d99d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var l=a(85893),t=a(11151),n=a(58219),c=(a(62316),a(51039)),i=a.n(c),r=(a(82723),a(9487)),d=a(41429),o=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVJc90UYhgVtUAQNlmDOsAfHCGjpymJDkSxJOTYE/ffiUrIs56PLhqEvtkSeS5577pca8HztIF3AR608z7yDZQQ5uswK44VWkEKOEj0yzrIOAhFog5bT9mU+AA67hlteoUdLBzegeIWQwvaUG3Hq9QMqiEDQySXyHC1EYPFbLSzmkHpbYwTO7yTZOFEZiRABbo3UOUJacOkIkJVYcUgb8DsTkN4KtYaWoDwYpcRSObFWk+12u4U2Gqj0VO9FvmdiuC/hqeM3Vm9EjkyvvmLmL3Omi70GzGvWuf1/so+g0LbifrxycMeU01U55S6Htl3Src5o5dDROdMkob9j/n1Ie6I5c3WWoXNFLeXuF4iCDKg8GXJjpMhCSOOvjqyb5yw7HSjAlhLAi+7uLLg2oFRdrUJQB+bTJGkjqNA5vsaXvD74+GPKbRuBFz4ghZJC4f1ehftpktxPoW0JM0tmr6uhtGeFrlX+MyWYJbN/K8GI54/8niWzkd8fnvt9qTZcipyd31yyW6q+n+v3h7f6PebpO57k07aSZNdXruhAXRc5UmW83qnhMKut8LvQhMbdJ10sqYAq9KU+9K/QuHwJKcR9kcfNoVG0QAfazb6p1VZSA/PeuDSOuTGTfbeRfOUmma5ibkS8OQO6ak9lTrp20h0RGnThRnzBHUT/3DTJQ6EKHYx7Fa4NqrlYq6Dh5uxZQ7sthWPChe1cZ3WFyofAs0Jb9sSarbjDnGnFfIlhk9bfT86YM5iJos+ZCbtTd2quK2S1w6KWTAr14NI7dcoW10UhMsEl+xtXTnhcvtsr9vj4+Eyxk2DzWfiyXjGLRh/g67AYZB1bDS8nEIFHW7nrYo52IzLso/PKVXEAx30l0NhKG8CKC3kYD78/NaKEkyJD5XCUkuefb67Y+0kC0Sgp3kA5vrr8ePHH/IJOpbTqQnQ2SSYJLRntfMXV6KJPIU3daAwfRbc5FPVLI7tPMI9bHxvJRSifQLjp834BB3Q6GpHLCErtPAGahpLiLyvblpa/1WipvJYRbLgVfEVZuGggF46e82HgvUr03Z/97Dxhb522LzqyLx9FtbPhsqY3iOABd8fzvl220b6E/jPV11h0tx3X7ECGvj86wHmWofGjvWct+Kg9fbq4uri9gAh4TWEa94qH0Cv6B3LnRR2OCXUc6JcYvWjwK1X6F9z9NsC7nVcNhg+5Dk1qLNu2/Q4qVosD",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Deletes contact",description:"delete a contact",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:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVJc90UYhgVtUAQNlmDOsAfHCGjpymJDkSxJOTYE/ffiUrIs56PLhqEvtkSeS5577pca8HztIF3AR608z7yDZQQ5uswK44VWkEKOEj0yzrIOAhFog5bT9mU+AA67hlteoUdLBzegeIWQwvaUG3Hq9QMqiEDQySXyHC1EYPFbLSzmkHpbYwTO7yTZOFEZiRABbo3UOUJacOkIkJVYcUgb8DsTkN4KtYaWoDwYpcRSObFWk+12u4U2Gqj0VO9FvmdiuC/hqeM3Vm9EjkyvvmLmL3Omi70GzGvWuf1/so+g0LbifrxycMeU01U55S6Htl3Src5o5dDROdMkob9j/n1Ie6I5c3WWoXNFLeXuF4iCDKg8GXJjpMhCSOOvjqyb5yw7HSjAlhLAi+7uLLg2oFRdrUJQB+bTJGkjqNA5vsaXvD74+GPKbRuBFz4ghZJC4f1ehftpktxPoW0JM0tmr6uhtGeFrlX+MyWYJbN/K8GI54/8niWzkd8fnvt9qTZcipyd31yyW6q+n+v3h7f6PebpO57k07aSZNdXruhAXRc5UmW83qnhMKut8LvQhMbdJ10sqYAq9KU+9K/QuHwJKcR9kcfNoVG0QAfazb6p1VZSA/PeuDSOuTGTfbeRfOUmma5ibkS8OQO6ak9lTrp20h0RGnThRnzBHUT/3DTJQ6EKHYx7Fa4NqrlYq6Dh5uxZQ7sthWPChe1cZ3WFyofAs0Jb9sSarbjDnGnFfIlhk9bfT86YM5iJos+ZCbtTd2quK2S1w6KWTAr14NI7dcoW10UhMsEl+xtXTnhcvtsr9vj4+Eyxk2DzWfiyXjGLRh/g67AYZB1bDS8nEIFHW7nrYo52IzLso/PKVXEAx30l0NhKG8CKC3kYD78/NaKEkyJD5XCUkuefb67Y+0kC0Sgp3kA5vrr8ePHH/IJOpbTqQnQ2SSYJLRntfMXV6KJPIU3daAwfRbc5FPVLI7tPMI9bHxvJRSifQLjp834BB3Q6GpHLCErtPAGahpLiLyvblpa/1WipvJYRbLgVfEVZuGggF46e82HgvUr03Z/97Dxhb522LzqyLx9FtbPhsqY3iOABd8fzvl220b6E/jPV11h0tx3X7ECGvj86wHmWofGjvWct+Kg9fbq4uri9gAh4TWEa94qH0Cv6B3LnRR2OCXUc6JcYvWjwK1X6F9z9NsC7nVcNhg+5Dk1qLNu2/Q4qVosD",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={},b=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Deletes contact"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a contact"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact deleted 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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact 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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Contact 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)(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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.d45861d2.js b/assets/js/a2bc1463.d45861d2.js deleted file mode 100644 index 1d6e44226..000000000 --- a/assets/js/a2bc1463.d45861d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const j={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVlFv4jgQ/iu+edpKKQlt9yU6nbZXVVW1q2219HQPwIOTDMTFsb22Q0Eo/301ToAAy+11JQRhPGPPfN/MF2/A87mDdAx3WnmeewfTCAp0uRXGC60gBYhAG7Sc/j4WkELeukrhPERguOUVerS0zQYUrxBSWF1yIy69XqCCCATtUyIv0EIEFr/XwmIBqbc1RuD8WlKME5WRCBHgykhdIKQzLh055CVWHNIN+LUJnt4KNYeGXHkISilH5cRcDVar1QqaaXsOOv+3LtYUS2mj8vTIjZEiDxXFr46q3JweorNXzEOFlur3Ah2tSlEJ33NTdZWFsmbaVtz3LbvkhkkTgVsI8864pGkiWFWSwjpgCfWMKmoi8MLLQ1tDARad0cq16V4lCf0cUurqPEfnZrVkO2ohejdC3Fq+Jno9Vu7XyLVmaqFjInsg7Cx7Zk05zMrV1auhmr8GGN63watGliFS+H3FhfyN+AzxU2cY5LqirZ5Lrd6dys3wengVPnDKbTdYBXoupOszfLzSEn2TfDzl9lEtuRQFu31+ZC80f3/8BrNnGMzDVJ628K6+m+RjE0GFzvH5T7HZI9HP07d5niIiWqdWR3p4HNpbNBzmtRV+HWSorz/peEpyUKEvNemX0Z1w+RJSiA/lzKFdbrWstpJ0y3vj0jjmxgy2IiN55qgPYm5EvBwGudmePyIwW7wOstiPjRGfkebml1pJZRFH3/ZKdr8FcKdEw2SrLaQyQs10OKtD6smgGom5Cjgvh3Cs7i+lcEy4sFzovK5Q+dAcbKYtO4pmGXdYMK2YLzEskv16MGTOYC5mXV8N2ERN1EhXyGqHpDJSqIVLJ+qSjZ9mM5ELLtm/mDnhcfphC/Db29sJwBch5kH4ss6YRaP37vNgDCz0o3Z/LiACj7ZyT7MR2qXIsSPzzFFxcI67aeF5mBZs9WJr+nQcRE0pRY7KYa9tbx+ev7DrQQJRr4f+R8rxl8e7+6+je9qVurClaDhIBgmZqHErrnoHPaBnXWqsa+ADentvPXqPdw3oceVjI7kIMxUy3HTjMD54u08jKGlY0jFsNsT9P1Y2DZm/12hp0qYRLLkVPKNmG0+baNu6ND+FcLRQ7F7kZ3P78K27E1ywc2kucH0yK0sua/KEJtp0DnftnpcvtMfe40T19hG3eY7G/6dvXz2en0YvEEHW3SqqIIlg+RvdbPgbpDCBSXtpoh2CDgT7BiRX8zoII7T70nzzmnDvi8MiiEP3QDhul9S6l+UhEm0p9E2F/TTgT5rVz7j+a+ferpwN2F3YWm+iYdo0zQ/AjXfi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/contactlist",title:"Get contact list",description:"",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:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVlFv4jgQ/iu+edpKKQlt9yU6nbZXVVW1q2219HQPwIOTDMTFsb22Q0Eo/301ToAAy+11JQRhPGPPfN/MF2/A87mDdAx3WnmeewfTCAp0uRXGC60gBYhAG7Sc/j4WkELeukrhPERguOUVerS0zQYUrxBSWF1yIy69XqCCCATtUyIv0EIEFr/XwmIBqbc1RuD8WlKME5WRCBHgykhdIKQzLh055CVWHNIN+LUJnt4KNYeGXHkISilH5cRcDVar1QqaaXsOOv+3LtYUS2mj8vTIjZEiDxXFr46q3JweorNXzEOFlur3Ah2tSlEJ33NTdZWFsmbaVtz3LbvkhkkTgVsI8864pGkiWFWSwjpgCfWMKmoi8MLLQ1tDARad0cq16V4lCf0cUurqPEfnZrVkO2ohejdC3Fq+Jno9Vu7XyLVmaqFjInsg7Cx7Zk05zMrV1auhmr8GGN63watGliFS+H3FhfyN+AzxU2cY5LqirZ5Lrd6dys3wengVPnDKbTdYBXoupOszfLzSEn2TfDzl9lEtuRQFu31+ZC80f3/8BrNnGMzDVJ628K6+m+RjE0GFzvH5T7HZI9HP07d5niIiWqdWR3p4HNpbNBzmtRV+HWSorz/peEpyUKEvNemX0Z1w+RJSiA/lzKFdbrWstpJ0y3vj0jjmxgy2IiN55qgPYm5EvBwGudmePyIwW7wOstiPjRGfkebml1pJZRFH3/ZKdr8FcKdEw2SrLaQyQs10OKtD6smgGom5Cjgvh3Cs7i+lcEy4sFzovK5Q+dAcbKYtO4pmGXdYMK2YLzEskv16MGTOYC5mXV8N2ERN1EhXyGqHpDJSqIVLJ+qSjZ9mM5ELLtm/mDnhcfphC/Db29sJwBch5kH4ss6YRaP37vNgDCz0o3Z/LiACj7ZyT7MR2qXIsSPzzFFxcI67aeF5mBZs9WJr+nQcRE0pRY7KYa9tbx+ev7DrQQJRr4f+R8rxl8e7+6+je9qVurClaDhIBgmZqHErrnoHPaBnXWqsa+ADentvPXqPdw3oceVjI7kIMxUy3HTjMD54u08jKGlY0jFsNsT9P1Y2DZm/12hp0qYRLLkVPKNmG0+baNu6ND+FcLRQ7F7kZ3P78K27E1ywc2kucH0yK0sua/KEJtp0DnftnpcvtMfe40T19hG3eY7G/6dvXz2en0YvEEHW3SqqIIlg+RvdbPgbpDCBSXtpoh2CDgT7BiRX8zoII7T70nzzmnDvi8MiiEP3QDhul9S6l+UhEm0p9E2F/TTgT5rVz7j+a+ferpwN2F3YWm+iYdo0zQ/AjXfi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/contactlist"}),"\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)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("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)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'[\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.f4361f8a.js b/assets/js/a2bc1463.f4361f8a.js new file mode 100644 index 000000000..5f944091a --- /dev/null +++ b/assets/js/a2bc1463.f4361f8a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),m=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",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/contactlist",title:"Get contact list",description:"",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:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},b=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/contactlist"}),"\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)(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)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.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"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.b9986137.js b/assets/js/a88a3db3.b9986137.js new file mode 100644 index 000000000..53732536e --- /dev/null +++ b/assets/js/a88a3db3.b9986137.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),c=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete template by ID",description:"Delete template by ID",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:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",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:"Delete template by ID"}),"\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 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)(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)("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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Template deleted successfully!"\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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(c.Z,{responseExample:'{\n "code": 404,\n "message": "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)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.cbedd512.js b/assets/js/a88a3db3.cbedd512.js deleted file mode 100644 index 1bc27a644..000000000 --- a/assets/js/a88a3db3.cbedd512.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:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),m=s.n(n),d=(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:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYilZ51CdGjTGwmjQLOoUPTiGQUsjixuK5JIjx4ah/16QsmQ53uxHUezJFjVDvvdm5lF7IL52kM7hESsjOaGDRQTaoOUktJrmkEKOEgm7AIjAcMsrJLQ+cw+KVwgpbC+5EZekn1FBBEJBCiXyHC1EYPFzLSzmkJKtMQJHO+lznKiM9Fvi1kidI6QFl84HZCVWHNI90M6ESLJCraHxoTwkpR6mcmKtRtvtdgtN1EOhA9alyDsohlMJEeToMiuM5wYpTO+YLhiVyLoMRiUnphBzx0izFbKWff5/koig0LbiNKDVLPz+zmjl0PmM6yTxP6d4uxp0oJirswydK2opd79ABJlWhIp8JjdGiixUMf7kfPr+HJBefcKMfEmtrzmJ9vAssOijVF2tQhl76a+TpImgQuf4Gr9E8Fikb2BumghIUAgVSgqFy06H5XWSLH+FpvEx42T8FT2UJlboWuU/U4RxMv5hEQZAv8Z8nIyXNz3zm3PmU7XhUuTs9uOUPfqR+7nEb76X+BAntTg9p20lfd5hXEUb1FrHiSrD9VaNUxnuQk8dp3e1Y9M78Nio1EfvCp5FJaQQd6HxfmASDUTg0G46R6ut9O5FZFwax9yYUWc1kq/cKNNVzI2IN1fg59ZhVltBu5nXt5Vw6IVHfbgRf+AOom87pmcqVKFD8kGNB4NqJtYqaLm5OjOzx1I4Jlx4neusrlBRaABWaMteZbMVd5gzrYL7+Zd+/f3oijmDmSgOvTNiT+pJzXSFrHZY1JJJoZ5d+qQu2fyhKEQmuGT/4MoJwsW7TrGXl5czxS5CzgdBZb1iFo0+hq/DYpB1mNU/XEAEhLZyD8UM7UZkeKjOG0fFITg+TATPwkRgxYWv6mHpt9dJvvGkyFA5HLTm7YeP9+z9KIFo0BTfATm+n/4++XM28bv6tmpLdDVKRolfMtpRxdXgoLc6+aTGfScRbik2koswLwHZ/tDi8/72gwjS4U24iKDUjnzIfu/r/7eVTeOXP9dod5DOFxFsuBV85RtuvodcOP8/72+0V2h6w4F3fx0uxwv2Y5fqFwl186L8sGy4rP0TRPCMu1e3e7Noom5o/jPit2C0x51OaY/Gf260AbdZhoYG787M17tEb0l3k/vJ4wSa5l+DqUIR",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete template by ID",description:"Delete template by ID",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:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYilZ51CdGjTGwmjQLOoUPTiGQUsjixuK5JIjx4ah/16QsmQ53uxHUezJFjVDvvdm5lF7IL52kM7hESsjOaGDRQTaoOUktJrmkEKOEgm7AIjAcMsrJLQ+cw+KVwgpbC+5EZekn1FBBEJBCiXyHC1EYPFzLSzmkJKtMQJHO+lznKiM9Fvi1kidI6QFl84HZCVWHNI90M6ESLJCraHxoTwkpR6mcmKtRtvtdgtN1EOhA9alyDsohlMJEeToMiuM5wYpTO+YLhiVyLoMRiUnphBzx0izFbKWff5/koig0LbiNKDVLPz+zmjl0PmM6yTxP6d4uxp0oJirswydK2opd79ABJlWhIp8JjdGiixUMf7kfPr+HJBefcKMfEmtrzmJ9vAssOijVF2tQhl76a+TpImgQuf4Gr9E8Fikb2BumghIUAgVSgqFy06H5XWSLH+FpvEx42T8FT2UJlboWuU/U4RxMv5hEQZAv8Z8nIyXNz3zm3PmU7XhUuTs9uOUPfqR+7nEb76X+BAntTg9p20lfd5hXEUb1FrHiSrD9VaNUxnuQk8dp3e1Y9M78Nio1EfvCp5FJaQQd6HxfmASDUTg0G46R6ut9O5FZFwax9yYUWc1kq/cKNNVzI2IN1fg59ZhVltBu5nXt5Vw6IVHfbgRf+AOom87pmcqVKFD8kGNB4NqJtYqaLm5OjOzx1I4Jlx4neusrlBRaABWaMteZbMVd5gzrYL7+Zd+/f3oijmDmSgOvTNiT+pJzXSFrHZY1JJJoZ5d+qQu2fyhKEQmuGT/4MoJwsW7TrGXl5czxS5CzgdBZb1iFo0+hq/DYpB1mNU/XEAEhLZyD8UM7UZkeKjOG0fFITg+TATPwkRgxYWv6mHpt9dJvvGkyFA5HLTm7YeP9+z9KIFo0BTfATm+n/4++XM28bv6tmpLdDVKRolfMtpRxdXgoLc6+aTGfScRbik2koswLwHZ/tDi8/72gwjS4U24iKDUjnzIfu/r/7eVTeOXP9dod5DOFxFsuBV85RtuvodcOP8/72+0V2h6w4F3fx0uxwv2Y5fqFwl186L8sGy4rP0TRPCMu1e3e7Noom5o/jPit2C0x51OaY/Gf260AbdZhoYG787M17tEb0l3k/vJ4wSa5l+DqUIR",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={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,l.jsx)(m(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Delete template by ID"}),"\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)(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)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Template deleted successfully!"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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.dc75f692.js b/assets/js/bbdfc22d.dc75f692.js new file mode 100644 index 000000000..369af332f --- /dev/null +++ b/assets/js/bbdfc22d.dc75f692.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>b});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),p=a(5397),o=a(4667),d=a(9472),u=a(85162);const h={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOg3IJIGZOWyfhmURQjsaEGG0B4hGTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkDm6xsEoE9DDikKFPnbRBGg0J3ObI2mN25lCQnJ1eXzKhlJl7Vnp0ngXDUjpElpY+mEL+FGOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PfbdGs18mabo/aRU65tqGNJozkKOEajDUDrtmWCllk8lssPDVvsyOzxkIReBpUKzMdJrMnpMgwc7aMaCzoyOfr3FVE4kKTeuesDB2PgIoy8zSKAOSHsOHKxwosCAjoK+Ai0KhAQWR8LKo2AeUQMHSUHPUWTogIPDp1I6zCAJrkQOPiwV2XhZWEUucWGVyRCSiVCeFNIcCwHJCsLSRs3gpJ5CRaoiGiUEU3s51b3FYrGAalTfgz78YbIl2aZGB9SBPgprlUzjo/oPnkpitX+JGT9gGuiFjkIQJHo6/RYfuAuFw8S4QoSuZIPNxw/rqBLwbya82821QuGROZxJnDOhM0YPZiGXfp1S8v1nt9jfd8W64roNU3H4fvP1va7yEKxP+v2lKZ0sxBR7qSnIF4GO5bL2J5wTy67xHTwY/DIthFTRisODyXVHMOKwKBS5aAqudcph7oS1bXVVHGTAwj8HfgOVLmu+Ndc977ziEGRQW6KKoqAydNQe74vQ4sGPxfGFWFxHN9t37jRa5+rdk4qMHXprtK9r9GQwoH87pLdFJsQ8a6JRy9+A/1sNksbWXWvpshjHtl+/+2QwqDgU6L2YPtsDmwi9grl+d6nC66hq8VaOGmQVh9KpX+Noa7mRlK6uwpey1sK+aZKyn719jY6K1Epq/NGm9MfJYPDj9ybPnwaf91N7qWdCySwOhlvi3P8ynZ8Gn9+azi7OUOPcD6GslerZsRWVrryORoEhNzSWrPERugg5JNDfm1JxRDcjKmZ7nVJhba+dHUqMPSW2L6zsz47jFPGYlk6G5ZDiVYekO9w6JGblX0gs9uoIJOSUhpvNgDpvY9QOmL2Z0Y6Mt02BnSHwPK83tP4CU3eI+i10vCHBLV6jl09MDFOTxyuLekiIqQpmx7C/nEnPpI/H7XvqBY12qh3r7QWGDkn+sXfcLjN11ffYvb7XQ1PEZYhWKyX1o0/u9RG7u5pMZCqFYn/j2MuAow9tQObz+V5tHESbCxnycswcWrNRn0ZhLKCu1frLAXAI6Ap/NRmim8m0pZYXrupH5X7TyyKNvYwUdOKRWvRl14hCrmSKRCqbpjq9uP7KPvYGwDvl/wbI/a+XZ+ffhufklRqoTtFxb9AbkIjarhC6c9FZvTB3yjbb3kbWtPT/Fv6eLbwhmYCL0LdKSN2ZWzXr3e0uBiMOOdFicgerFV3x3amqIvFTiW4Jyd2Iw0w4SfGkbxVvGYpoMpOeDrL1Gv5iIj/cNBv9AXsJ6SMu9yhxJlRJmlDxVaNwVvs8uiUfG429+bWxOE1TtOGXuqPOnLi+Gt4Ch3Hzm6CIww2cmNPvEjGHBO7hHuKvHvIQ6T7KV6CEnpZxxEHtl/7+AVe8CCQ=",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.",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.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOg3IJIGZOWyfhmURQjsaEGG0B4hGTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkDm6xsEoE9DDikKFPnbRBGg0J3ObI2mN25lCQnJ1eXzKhlJl7Vnp0ngXDUjpElpY+mEL+FGOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PfbdGs18mabo/aRU65tqGNJozkKOEajDUDrtmWCllk8lssPDVvsyOzxkIReBpUKzMdJrMnpMgwc7aMaCzoyOfr3FVE4kKTeuesDB2PgIoy8zSKAOSHsOHKxwosCAjoK+Ai0KhAQWR8LKo2AeUQMHSUHPUWTogIPDp1I6zCAJrkQOPiwV2XhZWEUucWGVyRCSiVCeFNIcCwHJCsLSRs3gpJ5CRaoiGiUEU3s51b3FYrGAalTfgz78YbIl2aZGB9SBPgprlUzjo/oPnkpitX+JGT9gGuiFjkIQJHo6/RYfuAuFw8S4QoSuZIPNxw/rqBLwbya82821QuGROZxJnDOhM0YPZiGXfp1S8v1nt9jfd8W64roNU3H4fvP1va7yEKxP+v2lKZ0sxBR7qSnIF4GO5bL2J5wTy67xHTwY/DIthFTRisODyXVHMOKwKBS5aAqudcph7oS1bXVVHGTAwj8HfgOVLmu+Ndc977ziEGRQW6KKoqAydNQe74vQ4sGPxfGFWFxHN9t37jRa5+rdk4qMHXprtK9r9GQwoH87pLdFJsQ8a6JRy9+A/1sNksbWXWvpshjHtl+/+2QwqDgU6L2YPtsDmwi9grl+d6nC66hq8VaOGmQVh9KpX+Noa7mRlK6uwpey1sK+aZKyn719jY6K1Epq/NGm9MfJYPDj9ybPnwaf91N7qWdCySwOhlvi3P8ynZ8Gn9+azi7OUOPcD6GslerZsRWVrryORoEhNzSWrPERugg5JNDfm1JxRDcjKmZ7nVJhba+dHUqMPSW2L6zsz47jFPGYlk6G5ZDiVYekO9w6JGblX0gs9uoIJOSUhpvNgDpvY9QOmL2Z0Y6Mt02BnSHwPK83tP4CU3eI+i10vCHBLV6jl09MDFOTxyuLekiIqQpmx7C/nEnPpI/H7XvqBY12qh3r7QWGDkn+sXfcLjN11ffYvb7XQ1PEZYhWKyX1o0/u9RG7u5pMZCqFYn/j2MuAow9tQObz+V5tHESbCxnycswcWrNRn0ZhLKCu1frLAXAI6Ap/NRmim8m0pZYXrupH5X7TyyKNvYwUdOKRWvRl14hCrmSKRCqbpjq9uP7KPvYGwDvl/wbI/a+XZ+ffhufklRqoTtFxb9AbkIjarhC6c9FZvTB3yjbb3kbWtPT/Fv6eLbwhmYCL0LdKSN2ZWzXr3e0uBiMOOdFicgerFV3x3amqIvFTiW4Jyd2Iw0w4SfGkbxVvGYpoMpOeDrL1Gv5iIj/cNBv9AXsJ6SMu9yhxJlRJmlDxVaNwVvs8uiUfG429+bWxOE1TtOGXuqPOnLi+Gt4Ch3Hzm6CIww2cmNPvEjGHBO7hHuKvHvIQ6T7KV6CEnpZxxEHtl/7+AVe8CCQ=",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,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:"Create template"})}),"\n",(0,t.jsx)(r(),{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."]}),"\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)(m.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(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:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.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,t.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(o.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:"createTemplateResponse"})})]})}),(0,t.jsxs)("div",{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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template created successfully!",\n "result": {\n "objectId": 0,\n "url": "https://exampleurl.com"\n }\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.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)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.e44fb86a.js b/assets/js/bbdfc22d.e44fb86a.js deleted file mode 100644 index b8fc94810..000000000 --- a/assets/js/bbdfc22d.e44fb86a.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:()=>f});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),o=a(41429),m=a(5397),d=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.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tTIzcQ/iva3stCDbZhkxzmtIRQFBVqoTBUDsZFyTNtj0AjCUnjx7rmv6da8/DYhiykcgwX7Fa/H1+31+D5zEE8gjvMjeQeHYwjSNElVhgvtIIY7jJkzTM7s8iJzk5vLhmXUi8cKxxax7xmCT0iSwrndS5+8IlE5hvFEVtkIsmYQztHxh2byAKNFco7NtWWzVCh5V6oGUt1UuRIDwvhM2YspjgVClPmvC0SX1h0PXZvtGKuSBJ0blrI1lLlhtAqYj7D4KhFX1jlGGeFEi8FssPDhvsyPTxkPuOeJVyxCVI0KQVT+4Mdbyac3rQKep3BREwFMdeqehCBNiEIrS5TiKFKSPMOERhueY4eLSV9DYrnCDEsj7gRR14/o4IIBCU9Q56ihQgsvhTCYgqxtwVG4PxKkowTuZGkEpdG6hQhnnLpiCHJMOcQr8GvTOD0VqgZlMTKg1BMbionZqq3XC6XUI4rO+j87zpdkWyilUfl6SM3RookBNV/ctQS630jevKEiacILaXAC3T0+j0EuOtKBFNtc+67lI1vLnxos0qOf9f+w2puJHKHzOJc4IJxlTIKmPlMuLakpPuPbrN/zETbcd2BKSO4v736qKrMe+Pifn+lCytyPsNeonPSRU6Hdmn1cWv5qis8gieN32Y5FzJIRfCkM9UhjCNY5pJU1A3XKI1gYbkxTXeVEQiPuXvN+Y2rZKz+Vpt7XXkZgRdebpFKyoJM0dJ4fCxDyyc34ccXfHkT1Gzb3Bm0jundl5KELTqjlat69GQwoH87oLcFJoQ8LdDI1SeI/qsBScLotlyqyCdh7Nu4TwaDMoIcneOzV2dgk6Gf+FzFXUj/771q61NTKM+B5RWwedPl/ep9/pzilJNne4VrYrqtKxakGxahpFD42FTz8WQwePytLvEvg1/3q3qp5lyKNOyEO4LbT0Ffjj7ThNdGu5AM7jOIob8H32F31dhdWNmZW25MrwFVySeOJqPPjejPjwO8OkwKK/xqSH1RJbmL+p3pNuJPpPH+6W4gz6ndbjfIfd70QoO8e2DaYOn74HEHHV8HvBrv3oCwDoK9B6c26LA18BT5VIc01bW/NqiG5DHVcn4M+1eLcEy48NzEU10udGzsSG9vdnok+tfecbPlq+nusQf1oIY6D1cC3RxSqGcXP6gjNrqeTkUiuGR/4cQJj+MvTUIWi8VebxwEmQvhs2LCLBq9YZ8FYmigrlT75QAi8Ghzdz0dop2LpNkfb5jqB+Z+jVk8CfOPlHSasor0bVeIUi5FgjRym0E9vbi5Yl97A4g67f8Ol/tXl2fn34fnpJUGqCrRcW/QGxCJxi7nqmPorLokO22bbq/pFn7/P08/cp7WIONx6ftGchHOlVDKdY16o92NOY4gI1iMR7Bek4l7K8uSyC8F2hXEo3EEc24F5ZO+lVGDUASTqXD0kLb36ZuF/HJbn7oH7C1Pn3G1B4lzLgvihDJa1wxnlc6jO9Kx4djb0xuJ0yRB4/+Rd9zZEzfXwzuIYFIfy3lYl2D5gg52voAYHuABws8B0hDgPtDXILmaFWEvQqWX/v4GeJa2sg==",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.",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.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tTIzcQ/iva3stCDbZhkxzmtIRQFBVqoTBUDsZFyTNtj0AjCUnjx7rmv6da8/DYhiykcgwX7Fa/H1+31+D5zEE8gjvMjeQeHYwjSNElVhgvtIIY7jJkzTM7s8iJzk5vLhmXUi8cKxxax7xmCT0iSwrndS5+8IlE5hvFEVtkIsmYQztHxh2byAKNFco7NtWWzVCh5V6oGUt1UuRIDwvhM2YspjgVClPmvC0SX1h0PXZvtGKuSBJ0blrI1lLlhtAqYj7D4KhFX1jlGGeFEi8FssPDhvsyPTxkPuOeJVyxCVI0KQVT+4Mdbyac3rQKep3BREwFMdeqehCBNiEIrS5TiKFKSPMOERhueY4eLSV9DYrnCDEsj7gRR14/o4IIBCU9Q56ihQgsvhTCYgqxtwVG4PxKkowTuZGkEpdG6hQhnnLpiCHJMOcQr8GvTOD0VqgZlMTKg1BMbionZqq3XC6XUI4rO+j87zpdkWyilUfl6SM3RookBNV/ctQS630jevKEiacILaXAC3T0+j0EuOtKBFNtc+67lI1vLnxos0qOf9f+w2puJHKHzOJc4IJxlTIKmPlMuLakpPuPbrN/zETbcd2BKSO4v736qKrMe+Pifn+lCytyPsNeonPSRU6Hdmn1cWv5qis8gieN32Y5FzJIRfCkM9UhjCNY5pJU1A3XKI1gYbkxTXeVEQiPuXvN+Y2rZKz+Vpt7XXkZgRdebpFKyoJM0dJ4fCxDyyc34ccXfHkT1Gzb3Bm0jundl5KELTqjlat69GQwoH87oLcFJoQ8LdDI1SeI/qsBScLotlyqyCdh7Nu4TwaDMoIcneOzV2dgk6Gf+FzFXUj/771q61NTKM+B5RWwedPl/ep9/pzilJNne4VrYrqtKxakGxahpFD42FTz8WQwePytLvEvg1/3q3qp5lyKNOyEO4LbT0Ffjj7ThNdGu5AM7jOIob8H32F31dhdWNmZW25MrwFVySeOJqPPjejPjwO8OkwKK/xqSH1RJbmL+p3pNuJPpPH+6W4gz6ndbjfIfd70QoO8e2DaYOn74HEHHV8HvBrv3oCwDoK9B6c26LA18BT5VIc01bW/NqiG5DHVcn4M+1eLcEy48NzEU10udGzsSG9vdnok+tfecbPlq+nusQf1oIY6D1cC3RxSqGcXP6gjNrqeTkUiuGR/4cQJj+MvTUIWi8VebxwEmQvhs2LCLBq9YZ8FYmigrlT75QAi8Ghzdz0dop2LpNkfb5jqB+Z+jVk8CfOPlHSasor0bVeIUi5FgjRym0E9vbi5Yl97A4g67f8Ol/tXl2fn34fnpJUGqCrRcW/QGxCJxi7nqmPorLokO22bbq/pFn7/P08/cp7WIONx6ftGchHOlVDKdY16o92NOY4gI1iMR7Bek4l7K8uSyC8F2hXEo3EEc24F5ZO+lVGDUASTqXD0kLb36ZuF/HJbn7oH7C1Pn3G1B4lzLgvihDJa1wxnlc6jO9Kx4djb0xuJ0yRB4/+Rd9zZEzfXwzuIYFIfy3lYl2D5gg52voAYHuABws8B0hDgPtDXILmaFWEvQqWX/v4GeJa2sg==",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={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",strong:"strong",...(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:"Create template"})}),"\n",(0,t.jsx)(r(),{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."]}),"\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)(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)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(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:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\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:"Template 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)(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)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(d.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:"##default"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Template created successfully!",\n "result": {\n "code": 0,\n "type": "string",\n "message": "string"\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",{})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.415bb7e5.js b/assets/js/f0ff4a36.415bb7e5.js deleted file mode 100644 index 4b467330e..000000000 --- a/assets/js/f0ff4a36.415bb7e5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu2zgQ/RV2nhpAsZXEfREWiw2aNOttkRRNin1IDIOSxhYTimRJyrEh6G2/ZD9tv2QxkmXLl9wWi74k9nBmeOZyZugSPJ86iG7hTCdFjso7GAWQokusMF5oBRFcoGecpUsFCEAbtJwOhylEMEXfOTPc8hw9WvJaguI5QgTzQ27EodcPqCAAQV4z5ClaCMDij0JYTCHytsAAnF9IsnEiNxIhAJwbqVOEaMKlI4Ukw5xDVIJfmFrTW6GmUJEqr40iwqicmKrefD6fQxWsoLRYxyJtoRjuM9iOWsf3mPhhyvSEJVp5nvj/E2wAE21z7ruSNXrz+1GcJceZiaGqRnStM1o5dOToOAzp3yZcVyQJOjcpJFuVBwIg5FSYqARujBRJfdC/d2RU7qJroqY6WnLjRXNlUoe00lJFHte1WyE+DsMqgByd41PcF+06to9NMllikXtM2Rq5XLyjIlp0hfQvg2or9NbkfroQD8cncfb9D7rtRni5F/FzLlz9gThBLi61f7MHI5E7ZNSia2pVAXzSkmjxRm9XBtW1mKp//vqbnVkxw9qVeHtgmffGRf3+UlJY2Ut0Tt6uHtXbcd1rZDHWaAhePRVWHri1fEEc9Ji7l8t9WfP3uc661whVFYBvSgoecyO5x3F7d0Wn81ySm61xAB27tawjFEoKheOWiePjMBwPyGMVwCAc7DKynahMac8mulDpu59IyEE4eC0h9wF9LvJBOBifrCL/sBv5UM24FCk7/TpkNzTzf27gH14beBenb3DuNoholJrdtZGVrrzJhsOksMIv6tXX3XnR7YjGeI4+08udWe9Kn0EE/bbf+mVnOVVA/uys3aSFlR1+cmN67YqTPHbE0j43oj87ArqpRXJNaW0yt4FnTUIjPiOx8MVNTQEKNdG18TIJ7dypUzg72lmiN5lwTLj6uI2trjubaMu2rFnMHaZMK+YzrA9JftI7Ys5gIibLlumxO3WnrnWOrHBIC08K9eCiO3XIbq8mE5EILtmfGDvhcfS+zdjj4+NOxg5qmwvhsyJmFo1eq09rYZ3WrtXqywEE4NHm7mpyjXYmknZ6PnFVv1buL4lAj4moBMy5oKouRb9tG1G/SZGgctjpyNOLr1/YSS+EoNMUr4Dc/zL8eH55fU5eqa2aEh31wl5IIqOdz7nqXEQPv7ZqLF6w4dl2gcs1rXeficsO8zj3fSO5qOlTIy6XrX8LHfWo+zIbBZBp50mlLKkvvltZVST+UaAlgo0CmHEreEyNeFtCKhx9TlcvryeBvv+2fMQdsP2PvL3AW74oIsuMy4K+QQAPuNh6VVajKmhJ85+RPQWjuW6TpSs09MxtFE6TBI3vnO3M3I15dHF+AwHwgorSHQ0P9WhYfqBY9mZhE00DgP4SnL0GvxCxP+Pi15V6c/KkwerHQqNNqRhVVfUvqnRZlw==",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:"Get a 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:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu2zgQ/RV2nhpAsZXEfREWiw2aNOttkRRNin1IDIOSxhYTimRJyrEh6G2/ZD9tv2QxkmXLl9wWi74k9nBmeOZyZugSPJ86iG7hTCdFjso7GAWQokusMF5oBRFcoGecpUsFCEAbtJwOhylEMEXfOTPc8hw9WvJaguI5QgTzQ27EodcPqCAAQV4z5ClaCMDij0JYTCHytsAAnF9IsnEiNxIhAJwbqVOEaMKlI4Ukw5xDVIJfmFrTW6GmUJEqr40iwqicmKrefD6fQxWsoLRYxyJtoRjuM9iOWsf3mPhhyvSEJVp5nvj/E2wAE21z7ruSNXrz+1GcJceZiaGqRnStM1o5dOToOAzp3yZcVyQJOjcpJFuVBwIg5FSYqARujBRJfdC/d2RU7qJroqY6WnLjRXNlUoe00lJFHte1WyE+DsMqgByd41PcF+06to9NMllikXtM2Rq5XLyjIlp0hfQvg2or9NbkfroQD8cncfb9D7rtRni5F/FzLlz9gThBLi61f7MHI5E7ZNSia2pVAXzSkmjxRm9XBtW1mKp//vqbnVkxw9qVeHtgmffGRf3+UlJY2Ut0Tt6uHtXbcd1rZDHWaAhePRVWHri1fEEc9Ji7l8t9WfP3uc661whVFYBvSgoecyO5x3F7d0Wn81ySm61xAB27tawjFEoKheOWiePjMBwPyGMVwCAc7DKynahMac8mulDpu59IyEE4eC0h9wF9LvJBOBifrCL/sBv5UM24FCk7/TpkNzTzf27gH14beBenb3DuNoholJrdtZGVrrzJhsOksMIv6tXX3XnR7YjGeI4+08udWe9Kn0EE/bbf+mVnOVVA/uys3aSFlR1+cmN67YqTPHbE0j43oj87ArqpRXJNaW0yt4FnTUIjPiOx8MVNTQEKNdG18TIJ7dypUzg72lmiN5lwTLj6uI2trjubaMu2rFnMHaZMK+YzrA9JftI7Ys5gIibLlumxO3WnrnWOrHBIC08K9eCiO3XIbq8mE5EILtmfGDvhcfS+zdjj4+NOxg5qmwvhsyJmFo1eq09rYZ3WrtXqywEE4NHm7mpyjXYmknZ6PnFVv1buL4lAj4moBMy5oKouRb9tG1G/SZGgctjpyNOLr1/YSS+EoNMUr4Dc/zL8eH55fU5eqa2aEh31wl5IIqOdz7nqXEQPv7ZqLF6w4dl2gcs1rXeficsO8zj3fSO5qOlTIy6XrX8LHfWo+zIbBZBp50mlLKkvvltZVST+UaAlgo0CmHEreEyNeFtCKhx9TlcvryeBvv+2fMQdsP2PvL3AW74oIsuMy4K+QQAPuNh6VVajKmhJ85+RPQWjuW6TpSs09MxtFE6TBI3vnO3M3I15dHF+AwHwgorSHQ0P9WhYfqBY9mZhE00DgP4SnL0GvxCxP+Pi15V6c/KkwerHQqNNqRhVVfUvqnRZlw==",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:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\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:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\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)(m.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\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 }\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\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)(m.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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",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)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.54a35a79.js b/assets/js/f0ff4a36.54a35a79.js new file mode 100644 index 000000000..6456966c7 --- /dev/null +++ b/assets/js/f0ff4a36.54a35a79.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYhiUNLaYSCSXpBwbgm59kj5an6QYyrJlO2nWRbGXRB7ODL/5+ThTg+MzC/EdnKu0KlE6C+MAMrSpEdoJJSGGS3SMs2ylAAEojYbT4SiDGGboemeaG16iQ0Nea5C8RIhh8ZZr8dapR5QQgCCvOfIMDQRg8GslDGYQO1NhANYtC7KxotQFQgC40IXKEOIpLywppDmWHOIa3FJ7TWeEnEFDqtwbxYRRWjGTg8VisYAmWEPpsE5E1kHR3OWwG7VKHjB1o4ypKUuVdDx1/yfYAKbKlNz1JRv0+tfjJE9Pcp1A04zpWquVtGjJ0UkU0b9tuLZKU7R2WhVsXR4IgJBTYeIauNaFSP1B+GDJqN5H10ZNdTTkxon2ytSHtNaSVZn42q0Rn0RR42FWhXvdXZfbQ9Py4VI8npwm+ZffqNi3whV4qAvrP6ibycWVcgd70AVyi4yaa0OKJoAPqqCGPtDbtUZ5I2by7z//YudGzNG7EocHljunbRyGK0llikGqSvJ2/SQPx/WgkCXo0RA8z+e1B24MXxJ7HJb29XJfeebt3791GzRNAK4tKTgsdcEdTrq7GzpdlAW52SEy9Ow2sp5QyEJInHQcmpxE0eQ9eWwCGEbDfS51byGTyrGpqmT2w3ek0jAaNgGUaC2fvZK254D+W+TDaDg5XUf+bj/ykZzzQmTs7POI3dJr/X0Df/etgfdxuhbnfoOIVqmdOltZ6cvbbFhMKyPc0g+t/rSK78b0AJfocrWadn7KuRxiCLt+C+veWGmA/Jl5NwMrU/T4ybUedMOp4IklloZci3B+DHRTh+SG0tpmbgvPhoRafERi4aszlgIUcqq88SoJ3bvjUzg/3ht/t7mwTFh/3MXm686myrAda5ZwixlTkrkc/SHJTwfHzGpMxXTVMgN2L+/ljSqRVRZpVBVCPtr4Xr5ld9fTqUgFL9gfmFjhcPymy9jT09Nexo68zaVweZUwg1pt1Gde6NPat1r/OIIAHJrSXk9v0MxF2r2eL1wVeuVwRQRaA+IasOSCqroS/bxrRP1WiBSlxV5Hnl1+/sROBxEEvab4Bsjhp9EvF1c3F+SV2qot0fEgGkQk0sq6ksveRbSydVVjyZKNzncLXG9ovb/grTrM4cKFuuDC08cjrletfwc99bi/U40DyJV1pFLX1BdfTNE0JP5aoSGCjQOYcyN4Qo14V0MmLH1n653pRaBvfl+tX0fs+fXsWeAdXySRZc6Lin5BAI+43NkHm3ETdKT5z8hegtFet83SNRpaUFuFszRF7Xpne2/u1nt0eXELAfCKitJ/Gh7907D6oFiezcI2mhYA/SU4zxr8SMT+iMuf1urtyYsG6zW/1aZUjJum+QcuFUDz",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:"Get a 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:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYhiUNLaYSCSXpBwbgm59kj5an6QYyrJlO2nWRbGXRB7ODL/5+ThTg+MzC/EdnKu0KlE6C+MAMrSpEdoJJSGGS3SMs2ylAAEojYbT4SiDGGboemeaG16iQ0Nea5C8RIhh8ZZr8dapR5QQgCCvOfIMDQRg8GslDGYQO1NhANYtC7KxotQFQgC40IXKEOIpLywppDmWHOIa3FJ7TWeEnEFDqtwbxYRRWjGTg8VisYAmWEPpsE5E1kHR3OWwG7VKHjB1o4ypKUuVdDx1/yfYAKbKlNz1JRv0+tfjJE9Pcp1A04zpWquVtGjJ0UkU0b9tuLZKU7R2WhVsXR4IgJBTYeIauNaFSP1B+GDJqN5H10ZNdTTkxon2ytSHtNaSVZn42q0Rn0RR42FWhXvdXZfbQ9Py4VI8npwm+ZffqNi3whV4qAvrP6ibycWVcgd70AVyi4yaa0OKJoAPqqCGPtDbtUZ5I2by7z//YudGzNG7EocHljunbRyGK0llikGqSvJ2/SQPx/WgkCXo0RA8z+e1B24MXxJ7HJb29XJfeebt3791GzRNAK4tKTgsdcEdTrq7GzpdlAW52SEy9Ow2sp5QyEJInHQcmpxE0eQ9eWwCGEbDfS51byGTyrGpqmT2w3ek0jAaNgGUaC2fvZK254D+W+TDaDg5XUf+bj/ykZzzQmTs7POI3dJr/X0Df/etgfdxuhbnfoOIVqmdOltZ6cvbbFhMKyPc0g+t/rSK78b0AJfocrWadn7KuRxiCLt+C+veWGmA/Jl5NwMrU/T4ybUedMOp4IklloZci3B+DHRTh+SG0tpmbgvPhoRafERi4aszlgIUcqq88SoJ3bvjUzg/3ht/t7mwTFh/3MXm686myrAda5ZwixlTkrkc/SHJTwfHzGpMxXTVMgN2L+/ljSqRVRZpVBVCPtr4Xr5ld9fTqUgFL9gfmFjhcPymy9jT09Nexo68zaVweZUwg1pt1Gde6NPat1r/OIIAHJrSXk9v0MxF2r2eL1wVeuVwRQRaA+IasOSCqroS/bxrRP1WiBSlxV5Hnl1+/sROBxEEvab4Bsjhp9EvF1c3F+SV2qot0fEgGkQk0sq6ksveRbSydVVjyZKNzncLXG9ovb/grTrM4cKFuuDC08cjrletfwc99bi/U40DyJV1pFLX1BdfTNE0JP5aoSGCjQOYcyN4Qo14V0MmLH1n653pRaBvfl+tX0fs+fXsWeAdXySRZc6Lin5BAI+43NkHm3ETdKT5z8hegtFet83SNRpaUFuFszRF7Xpne2/u1nt0eXELAfCKitJ/Gh7907D6oFiezcI2mhYA/SU4zxr8SMT+iMuf1urtyYsG6zW/1aZUjJum+QcuFUDz",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:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{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:"Get a 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.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)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"document"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": {\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 }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(d.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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.4b77d0d7.js b/assets/js/fa40969b.4b77d0d7.js new file mode 100644 index 000000000..4ca8d7f4c --- /dev/null +++ b/assets/js/fa40969b.4b77d0d7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>f,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtbR2lKJYFEXTxDHcBLFhO+jBFgxqd6RlzCUZkitLEPbWJ+mj9UmK4f5oZdmJHaQ55WKvhpzh/HzztwLPZw6SC3it07JA5R2MI8jQpVYYL7SCBJ48ecLaY3a+NOiSS3WK3gqcI+NMCueZnrKsFcEm3GHGtGJ+afBSXaq9AdvZeW351HeSXLKzc6kYY2x3TWM+555xiywtrUXl5ZIJxbLA6Tz3pRuQvH2SdyZmivvSIjvFTyW6z4m0+KkUFpnPkS11aZlrmYO85yTvSO2eWD2z6NxXaWka5iBxRBJf6cJI9Jg9RF7O58gmiIq5Mk3RuWkp5ZKlnYwb4XPGpWyNydZG1G++oDcPFiacPfRFbO5zlQWTlGZSqxlaxoMWYiJrH/0cYoipFOqxBmUt12QZIlA6tINLBRFog5YTzo4ySGCGvgURgQoiMNzyAj1aAukKFC8QEsh0SsiCCAQB1HCfw23UnucY4LeJTK+ZbZALEbSOhMTbEiNwfilJvhPkc4gAF0bqDCGZcunoQppjwSFZQXg/AeetUDO6qcqC8ihAtXsPIuhiZGuQBqVbqPQvdoHu0Zrg9CitK9fpWlVR55jFLjdi1+trVK1zcuQZ2m9pbEVXeWBKKICKTBwsFosFVOP6HXT+D50tiTfVyqPy9MmNkSIN4R5+dBSl1fYjevIR0xB6S+DwAh2dSlEI37umymISzJpqW3Dfp3TK7cVVBO5amEfyxVUVwaKQxNY4luA4IYuqCLzwcpNWEYNFZ7Rytbr7cUz/NiG5zmvW4T4E/pt4KA2x2za0M2s/jms1S9n3JLeWLwktHgv35WdqMqXrdhJ0Pl2nRQeUN4fiev/5JP/wJ/nwvPbh40S48EHZTCLea/9oCUYidxjqZlcUSNYbLSlJHint2KCiJvTv3/+w11bMMYgSjzcs9964ZDhsKKWVg1QXJO34Rj1er4861F3iJ/VC8fzacL8P+L+j3vVfg6qXFh4LI7nHq/btajud+r5v+da0vjShqNxdtcl1tR/HV780GTeKR9tJdopGW8+U9ozPuZB8IvGn75hlo3hURVCgc3z2Bc/drernrB/Fo6tRZ/2LbeuP1JxLkbGXJ0fsnNrA9zX9xUNN7+vpaz23USLqS3U72/BKn157w2FaWuGXYUzot8HkYkxdqUCfa5oxjG4GC59DAsP+vDFcNYNFRX0b7bwdO0ore1nKjRm0bU/yiaNcHXIjhvO90ABbVc7Ir7XrNhRap6IRb5Fy8YvdmyykcJ2ue+tB68uuN+7FbbejOi/UVIe3Gqe1xSq4fL53x7wkHBMuHLdOCThhU23ZLe7ehJ9jOCT688EecwZTMW0gNmA0OJ7pIox81PekUNe0Puyyi+PpVKSCS/YXTpzwOH7aOvjm5mbLwc8Cz6HweTlhFo1eX58FYohCn6v78Qwi8GgLdzw9QzsXaVty73lqGC4Pm8ThaUgcLLggEDSk328zET6lSFE57CH45eHJO/Z8EEPUw9ADVB6+O3p18P7sgKQSCusQ7Q3iQUwkwnDBVe+hQ/Rd1OqFbLJk6zF5I9S9mezHbvdjt/vfdrumynlc+KGRXIQaHtJg1ZTfC7i17iUtZMcR5FSokwtYrQhyH6ysKiJ/KtFSlR9HMOdWUM8MNToTjr6zbn25F/NPTxsfP2MPWRLvNKOt4IrK95zLkn5BBNe47O2n1biK2hL+1Trep0L91GbP6DShnbC+8KqWuXteV4L2xtYgsOZ4maZo/Gfv9hvqyfHZOUQwafa9IkwJYPkN7Zz8BhK4hEsIuz5JCP0w0FcguZqVYVaAWi71OV4SNPpN8jo0yeaD/Hin9zc9UZtCf8mwOxl+pZ71Fpe/ddfrk3sZulW6vk1hGFdV9R930J/8",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/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:"eJztV81uGzcQfhV2ckmMtbR2lKJYFEXTxDHcBLFhO+jBFgxqd6RlzCUZkitLEPbWJ+mj9UmK4f5oZdmJHaQ55WKvhpzh/HzztwLPZw6SC3it07JA5R2MI8jQpVYYL7SCBJ48ecLaY3a+NOiSS3WK3gqcI+NMCueZnrKsFcEm3GHGtGJ+afBSXaq9AdvZeW351HeSXLKzc6kYY2x3TWM+555xiywtrUXl5ZIJxbLA6Tz3pRuQvH2SdyZmivvSIjvFTyW6z4m0+KkUFpnPkS11aZlrmYO85yTvSO2eWD2z6NxXaWka5iBxRBJf6cJI9Jg9RF7O58gmiIq5Mk3RuWkp5ZKlnYwb4XPGpWyNydZG1G++oDcPFiacPfRFbO5zlQWTlGZSqxlaxoMWYiJrH/0cYoipFOqxBmUt12QZIlA6tINLBRFog5YTzo4ySGCGvgURgQoiMNzyAj1aAukKFC8QEsh0SsiCCAQB1HCfw23UnucY4LeJTK+ZbZALEbSOhMTbEiNwfilJvhPkc4gAF0bqDCGZcunoQppjwSFZQXg/AeetUDO6qcqC8ihAtXsPIuhiZGuQBqVbqPQvdoHu0Zrg9CitK9fpWlVR55jFLjdi1+trVK1zcuQZ2m9pbEVXeWBKKICKTBwsFosFVOP6HXT+D50tiTfVyqPy9MmNkSIN4R5+dBSl1fYjevIR0xB6S+DwAh2dSlEI37umymISzJpqW3Dfp3TK7cVVBO5amEfyxVUVwaKQxNY4luA4IYuqCLzwcpNWEYNFZ7Rytbr7cUz/NiG5zmvW4T4E/pt4KA2x2za0M2s/jms1S9n3JLeWLwktHgv35WdqMqXrdhJ0Pl2nRQeUN4fiev/5JP/wJ/nwvPbh40S48EHZTCLea/9oCUYidxjqZlcUSNYbLSlJHint2KCiJvTv3/+w11bMMYgSjzcs9964ZDhsKKWVg1QXJO34Rj1er4861F3iJ/VC8fzacL8P+L+j3vVfg6qXFh4LI7nHq/btajud+r5v+da0vjShqNxdtcl1tR/HV780GTeKR9tJdopGW8+U9ozPuZB8IvGn75hlo3hURVCgc3z2Bc/drernrB/Fo6tRZ/2LbeuP1JxLkbGXJ0fsnNrA9zX9xUNN7+vpaz23USLqS3U72/BKn157w2FaWuGXYUzot8HkYkxdqUCfa5oxjG4GC59DAsP+vDFcNYNFRX0b7bwdO0ore1nKjRm0bU/yiaNcHXIjhvO90ABbVc7Ir7XrNhRap6IRb5Fy8YvdmyykcJ2ue+tB68uuN+7FbbejOi/UVIe3Gqe1xSq4fL53x7wkHBMuHLdOCThhU23ZLe7ehJ9jOCT688EecwZTMW0gNmA0OJ7pIox81PekUNe0Puyyi+PpVKSCS/YXTpzwOH7aOvjm5mbLwc8Cz6HweTlhFo1eX58FYohCn6v78Qwi8GgLdzw9QzsXaVty73lqGC4Pm8ThaUgcLLggEDSk328zET6lSFE57CH45eHJO/Z8EEPUw9ADVB6+O3p18P7sgKQSCusQ7Q3iQUwkwnDBVe+hQ/Rd1OqFbLJk6zF5I9S9mezHbvdjt/vfdrumynlc+KGRXIQaHtJg1ZTfC7i17iUtZMcR5FSokwtYrQhyH6ysKiJ/KtFSlR9HMOdWUM8MNToTjr6zbn25F/NPTxsfP2MPWRLvNKOt4IrK95zLkn5BBNe47O2n1biK2hL+1Trep0L91GbP6DShnbC+8KqWuXteV4L2xtYgsOZ4maZo/Gfv9hvqyfHZOUQwafa9IkwJYPkN7Zz8BhK4hEsIuz5JCP0w0FcguZqVYVaAWi71OV4SNPpN8jo0yeaD/Hin9zc9UZtCf8mwOxl+pZ71Fpe/ddfrk3sZulW6vk1hGFdV9R930J/8",sidebar_class_name:"post 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 b(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,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:"post",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.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,n.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(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)("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 "code": 200,\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 }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.ae0bc259.js b/assets/js/fa40969b.ae0bc259.js deleted file mode 100644 index 9f47465e2..000000000 --- a/assets/js/fa40969b.ae0bc259.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:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtSTHSg+LomiaOIabIDZsBz3YgkHtjrSMuSRDcvUDYW95kj5an6QY7o9Wlp1YRttTLvZqODOcn29mOCvwfOogvoK3OilyVN7BKIIUXWKF8UIriOHZs2esOWaXS4Muvlbn6K3AGTLOpHCe6QlLGxVszB2mTCvmlwav1bU66LG9vbeWT3yrycV7e9eKMcb21zTmM+4Zt8iSwlpUXi6ZUCwNks5zX7ge6XtJ+i7EVHFfWGTn+KVA9y2VFr8UwiLzGbKlLixzjXDQd0j6TtT+mdVTi849yUpTCweNQ9L4RudGosf0MfoyPkM2RlTMFUmCzk0KKZcsaXXMhc8Yl7JxJl07Ud35iu48Wphw9tgbsebnKg0uKc2kVlO0jAcrxFhWMfo55BATKdSuDqWN1HgZMlA4tL1rBRFog5YTzk5SiGGKvgERgQoiMNzyHD1aAukKFM8RYkh1QsiCCAQB1HCfwV3UXmYY4LeJTK+ZrZELETSBhNjbAiNwfilJvxMUc4gAF0bqFCGecOmIIckw5xCvINwfg/NWqClxqiKnOgpQbe+DCNoc2QqkwegGKl3GNtEdWp2cDqUJ5bpcyzJqA7PY50bse32LqglOhjxF+286WxIrD0IxJVCRi73FYrGAclTdg87/rtMlySZaeVSePrkxUiQh3f3PjrK02r5Ejz9jElJvCRxeoKNTKXLhO2yqyMfBrYm2OfddSmvcwaCMwN0Ks6PcoCwjWOSSxOrAEhzH5FEZgRdebtJKErDojFauMvflYED/NiG5rmvW4j4kfrcIcWv5ktLrMXffj1xFpvraRm0bhDWO28y+Oxa3Lw/H2ac/yOnLyundVLjwQeVHKj5qv7MGI5E7DI2urWLS9U5LQvWO2k4NKpoaf3/9i721YoZBldjdscx74+J+v6YUVvYSnZO207na3a7POjRKkifzQrd7aro/BsDe06C6t0HZwbHH3Eju8aa5u9zGfzf2jdyaVhXAcDDcxvw5Gm09U9ozPuNC8rHEn54A+ge8TULD2q7u1tvhYFhGkKNzfPqduNxvajdSQlHvvWkq/WY4GN4MofH+1bb3J2rGpUjZ67MTdkld+f91/dVjXe/a6Ss7tzEgKqZqumxEpUuvouEwKazwyzC1u1MpvhrRkMjRZ5pGvtH1nPcZxNDvjv/+qp7zJY1RtLPmFVBY2alBbkyvmUKSjx1VYp8b0Z8dhHnUmHJBca1Ct2HQutCMeI9Uad8dpuQhpet8PeqOmli2o+pg0AwfGkNCTXS4qw5a04pCyGcH9zxfhGPCheMmKAEnbKItuyPdeXBnGA6Jftg7YM5gIiY1xHqM3nEXOg8vMBpDUqhbes3vs6vTyUQkgkv2J46d8Dh63gR4Pp9vBfhFkDkWPivGzKLRa/ZpIIYsdKXaHy8gAo82d6eTC7QzkTQN9YGr+oG5XxcOT0LhYM4FgaAm/XZXiPApRYLKYQfBr4/PPrDD3gCiDoYeYXL/w8mbo48XR6SVUFil6KA36A2IRBjOuepcdIy+zVq1H42XbP1q3Uh154n0Y9X6sWr9Z6tW3eU8LnzfSC5CDw9lsKrb7xXc2b7iBrKjCDJq1PEVrFYEuU9WliWRvxRoqcuPIphxK2hmhh6dCkffabtNPIj55+d1jF+wx+xs97rRdHBF7XvGZUG/IIJbXHbWxXJURk0Lf7KND5lQXbU5M1pLaEWrGN5UOvcvq07QcGw9BNYSr5MEjf8mb3egnp1eXEIE43r9ysMrASyf0wrI5xDDNVxDWL1JQ5iHgb4CydW0CG8FqPTSnOMFQaM7JG/DkKw/KI73Rn8zEpUr9Jccu1fgF5pZ73H5a8tenTwo0G62FTelYVSW5T9fr3mm",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/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:"eJztV81uGzcQfhV2ckmMtSTHSg+LomiaOIabIDZsBz3YgkHtjrSMuSRDcvUDYW95kj5an6QY7o9Wlp1YRttTLvZqODOcn29mOCvwfOogvoK3OilyVN7BKIIUXWKF8UIriOHZs2esOWaXS4Muvlbn6K3AGTLOpHCe6QlLGxVszB2mTCvmlwav1bU66LG9vbeWT3yrycV7e9eKMcb21zTmM+4Zt8iSwlpUXi6ZUCwNks5zX7ge6XtJ+i7EVHFfWGTn+KVA9y2VFr8UwiLzGbKlLixzjXDQd0j6TtT+mdVTi849yUpTCweNQ9L4RudGosf0MfoyPkM2RlTMFUmCzk0KKZcsaXXMhc8Yl7JxJl07Ud35iu48Wphw9tgbsebnKg0uKc2kVlO0jAcrxFhWMfo55BATKdSuDqWN1HgZMlA4tL1rBRFog5YTzk5SiGGKvgERgQoiMNzyHD1aAukKFM8RYkh1QsiCCAQB1HCfwV3UXmYY4LeJTK+ZrZELETSBhNjbAiNwfilJvxMUc4gAF0bqFCGecOmIIckw5xCvINwfg/NWqClxqiKnOgpQbe+DCNoc2QqkwegGKl3GNtEdWp2cDqUJ5bpcyzJqA7PY50bse32LqglOhjxF+286WxIrD0IxJVCRi73FYrGAclTdg87/rtMlySZaeVSePrkxUiQh3f3PjrK02r5Ejz9jElJvCRxeoKNTKXLhO2yqyMfBrYm2OfddSmvcwaCMwN0Ks6PcoCwjWOSSxOrAEhzH5FEZgRdebtJKErDojFauMvflYED/NiG5rmvW4j4kfrcIcWv5ktLrMXffj1xFpvraRm0bhDWO28y+Oxa3Lw/H2ac/yOnLyundVLjwQeVHKj5qv7MGI5E7DI2urWLS9U5LQvWO2k4NKpoaf3/9i721YoZBldjdscx74+J+v6YUVvYSnZO207na3a7POjRKkifzQrd7aro/BsDe06C6t0HZwbHH3Eju8aa5u9zGfzf2jdyaVhXAcDDcxvw5Gm09U9ozPuNC8rHEn54A+ge8TULD2q7u1tvhYFhGkKNzfPqduNxvajdSQlHvvWkq/WY4GN4MofH+1bb3J2rGpUjZ67MTdkld+f91/dVjXe/a6Ss7tzEgKqZqumxEpUuvouEwKazwyzC1u1MpvhrRkMjRZ5pGvtH1nPcZxNDvjv/+qp7zJY1RtLPmFVBY2alBbkyvmUKSjx1VYp8b0Z8dhHnUmHJBca1Ct2HQutCMeI9Uad8dpuQhpet8PeqOmli2o+pg0AwfGkNCTXS4qw5a04pCyGcH9zxfhGPCheMmKAEnbKItuyPdeXBnGA6Jftg7YM5gIiY1xHqM3nEXOg8vMBpDUqhbes3vs6vTyUQkgkv2J46d8Dh63gR4Pp9vBfhFkDkWPivGzKLRa/ZpIIYsdKXaHy8gAo82d6eTC7QzkTQN9YGr+oG5XxcOT0LhYM4FgaAm/XZXiPApRYLKYQfBr4/PPrDD3gCiDoYeYXL/w8mbo48XR6SVUFil6KA36A2IRBjOuepcdIy+zVq1H42XbP1q3Uh154n0Y9X6sWr9Z6tW3eU8LnzfSC5CDw9lsKrb7xXc2b7iBrKjCDJq1PEVrFYEuU9WliWRvxRoqcuPIphxK2hmhh6dCkffabtNPIj55+d1jF+wx+xs97rRdHBF7XvGZUG/IIJbXHbWxXJURk0Lf7KND5lQXbU5M1pLaEWrGN5UOvcvq07QcGw9BNYSr5MEjf8mb3egnp1eXEIE43r9ysMrASyf0wrI5xDDNVxDWL1JQ5iHgb4CydW0CG8FqPTSnOMFQaM7JG/DkKw/KI73Rn8zEpUr9Jccu1fgF5pZ73H5a8tenTwo0G62FTelYVSW5T9fr3mm",sidebar_class_name:"post 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={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(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,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)(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,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.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"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"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)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'[\n {\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 }\n]',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.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/runtime~main.b70a4847.js b/assets/js/runtime~main.df94cecd.js similarity index 55% rename from assets/js/runtime~main.b70a4847.js rename to assets/js/runtime~main.df94cecd.js index 529a23e34..0b28d2295 100644 --- a/assets/js/runtime~main.b70a4847.js +++ b/assets/js/runtime~main.df94cecd.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,b,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=f,r.c=t,e=[],r.O=(a,c,d,b)=>{if(!c){var f=1/0;for(i=0;i=b)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,b0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[c,d,b]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var b=Object.create(null);r.r(b);var f={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(b,f),b},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](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",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:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"ae0bc259",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"415bb7e5",1359:"49fdcec2",1477:"b31b2642",1520:"c77fc495",1531:"e44fb86a",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"d45861d2",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"b4037d80",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:"dbc22dee",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:"cbedd512",7971:"ba909b7d",8106:"f92effd7",8140:"901b2f91",8163:"e12965bb",8468:"1bf4c76e",8475:"d27b3009",8489:"621d99d2",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"ddf96f1e",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),d={},b="OpenSign-Docs:",r.l=(e,a,c,f)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var b=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(c))),a)return a(c)},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",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,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>d=e[a]=[c,b]));c.push(d[2]=b);var f=r.p+r.u(a),t=new Error;r.l(f,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var b=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+f+")",t.name="ChunkLoadError",t.type=b,t.request=f,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,b,f=c[0],t=c[1],o=c[2],n=0;if(f.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n{"use strict";var e,a,d,c,f,b={},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 b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,c,f)=>{if(!d){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[d,c,f]},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,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},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",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:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"4b77d0d7",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"54a35a79",1359:"49fdcec2",1477:"b31b2642",1520:"a106d1ce",1531:"dc75f692",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"f4361f8a",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"b4037d80",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:"56636457",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:"b9986137",7971:"ba909b7d",8106:"fc47c37f",8140:"901b2f91",8163:"8057ae9d",8468:"0d9e94c0",8475:"d27b3009",8489:"04f4277f",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5a3fe832",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),c={},f="OpenSign-Docs:",r.l=(e,a,d,b)=>{if(c[e])c[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 f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.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",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 c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)d.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((d,f)=>c=e[a]=[d,f]));d.push(c[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var c,f,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);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 c7630febf..ae02a6978 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 e6815f813..29bfae6de 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 d84fa2059..4bb2fd05a 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 faa6ba480..d5edb14a8 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 128e96fc8..ae92feef7 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 d2129b542..a413cd9ac 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 677cd166b..b569f70ed 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 a6576fffd..250eb4cb0 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 48a985b8f..8c45c9b3f 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 16e10eb9d..91453d617 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 874fb0e9f..70b3cbcb0 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + @@ -14,6 +14,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

  • Array [

    • objectId string
    Name string
    Email string
    Phone string

  • ]

Loading...
+

Responses​

successful operation

Schema

    code number

    result

    contactdetails[]

  • Array [

    • objectId string
    Name string
    Email string
    Phone string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 1b888a103..6b09a82a4 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 824720c61..6a7493c30 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + @@ -14,6 +14,6 @@

Create document

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx
-

Responses​

Document created successfully!

Schema

    code number
    message string

    result

    object

    objectId string
    url string
Loading...
+

Responses​

Document created successfully!

Schema

    code number
    message string

    result

    object

    objectId string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index bc76926e4..aff8e5f7c 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create template | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    Name string
    Note string
    Description string
    URL string
    signers signers[]
    folderId string
-

Responses​

Template created successfully!

Schema

    code number
    message string

    result

    ##default

    code number
    type string
    message string
Loading...
+

Responses​

Template created successfully!

Schema

    code number
    message string

    result

    createTemplateResponse

    objectId number
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 90b761947..ced8c5e5b 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™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 38d709a50..4d6fec5a0 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Deletes contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 9e4a20e92..0d65afa4a 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete document by ID | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 18ac5d9c6..8247fa79d 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™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 5f6b074a6..07b9cacd7 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index b6a854979..87c295aed 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx
-

Responses​

successful operation

Schema

    code number
    message string

    result

    contactdetails

    objectId string
    Name string
    Email string
    Phone string
Loading...
+

Responses​

successful operation

Schema

    code number

    result

    contactdetails

    objectId string
    Name string
    Email string
    Phone string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 2693fcefa..38fdc28fe 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get document by ID | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    document_id stringrequired

    objectId of contact

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx
-

Responses​

successful operation

Schema

    code number
    message string

    result

    document

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
+

Responses​

successful operation

Schema

    code number

    result

    document

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index bf85fba25..a58f3394a 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™ - + @@ -55,6 +55,6 @@

Path Parameters

    doctype stringrequired

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

    The type of documents to retrieve

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

  • Array [

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

  • ]

Loading...
+

Responses​

successful operation

Schema

    code number

    result

    document[]

  • Array [

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 92ce5da1d..85c3ea363 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index fab3c5988..02680e7f3 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 b01b1ff90..c9548dc70 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-template/index.html b/docs/API-docs/update-template/index.html index dd46017cc..5a4b4d52d 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™ - + diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index 313814189..fadca6385 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 f9a64eec0..132421802 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 cc218888d..21d176417 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 26d0dd1ec..1b06075e7 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 613b771b7..2ac4f8269 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 fd8d780c2..b83e92c18 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 dc5e59b93..cc07a310c 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 b88c181ea..38aa783ad 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 02471f659..365de1ab5 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 b2a2b74fe..f100e7c53 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 7ccdd9060..72cbbcc09 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 ff165ffc2..b2df4a7ed 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 d4351c509..7037d38f9 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 fc4427034..e626617a5 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 0ad1b7538..71d875e0d 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 20f0a3dcd..2b8a05113 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 ad0768169..0d978ba75 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 a699ba90c..5b4d0fc46 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 d3911374d..f41930f2c 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 ccec467d5..077e67e62 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 f181062df..8b63d9b7d 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 9a84f4100..3bc4aaed6 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +