diff --git a/404.html b/404.html index fa286d567..843c4673a 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.b6d65080.js b/assets/js/05632a52.b6d65080.js deleted file mode 100644 index d1a0821a1..000000000 --- a/assets/js/05632a52.b6d65080.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:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),c=s.n(i),r=(s(82723),s(9487)),o=s(41429),d=s(5397),p=s(4667),m=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:"eJy9Vm1r20gQ/it786kBxZIdt0fFcTSUkAstTbjkKFxiwkoaWZtIu9vdlWNj9N+PWUm2HDt3l1IKxrZ23p55e7RrcHxuIb6Fj0o6njoLswAytKkR2gklIYY5OsZZ2sohAKXRcJJdZK10K9Lc8AodGnK5BskrhBiWx1yLY6ceUUIAgnwWyDM0EIDBb7UwmEHsTI0BWLcqycaKSpcIAeBSlypDiHNeWlJIC6w4xGtwK+01nRFyDg2pcm8UE0RpxVyOlsvlEppgA6WDei+yHonmroDnKavkAVN3kTGVDxL/YVgDyJWpuBuebMHrP8ZJkU4KnUDTzCis1UpatORoEkX0swvX1mmK1uZ1yTbNgcAni9KRPte6FKkXhA+WjNb76NqsqY2G3DjRhuyL8eo8inFSLCcPmnrzxdf/dQ4eFLIEkczPKi7K77BPED90B6NUVeTqqlDy1VCm45PxxH/IRWqQO8xO3SE3W6NJNDk5HkfH0a8343fx9H389t0oiqK/IYBl5bPppjLjzmfphCuHz7XOfkKc5rlaN/EZOi5KOzTod6FpyGoaTfdnseMRJpVjuapl9suPm0Q0Rpl/r8WB8M0gASFLIfG+X6n7aTS9n2zSebufzoVc8FJk7PTqgt0Qg/3cdIbhXRt+v1+iVWoJdifZ4XmbpMW0NsKtPD8PiTm+nRHZVOgK1fG6J3RXQAxh1/hwvSXQBsibWfRkX5uSiN05beMw5FqPehYueWJp+0KuRbgYA8XpcVxTrdpy7KDZFIVr8QlXEPz3y4TSEzJX3rgrwaVGeS3m0hdwMd4j+ptCWCasF2cqrSuUzjeT5cqwZ9Ys4RYzpiRzBXohnZ+MxsxqTEXezcGI3ck7ea0qZLVFIuVSyEcb38ljdnuZ5yIVvGRfMbHC4exNX7Gnp6e9ih15m3PhijphBrXaqs/9oS/r0GrzcAQBODSVvcyv0SxEil13XggVeuWwm25acprQlnb7ow/PjWjaSpGitDiYx9Pzq8/sZBRBMBiK/wE5/Hzx8ezL9Rl5pbFqWzQeRaOIjrSyruJyEOgc3eD1vNPZ9XZJ9y4w3WQ5XLpQl1z4pfFI193A38JWOx7cGWYBFMo6UlivaRr+MmXT0PG3Gg0t1SyABTeCJzR+t2vIhKX/2eZO8CLKN39214sjdvj6cRB2vyWSVmTBy5qeIIBHXO1ed5pZE/Sb8t3AXkLRRttdzQ0Yun61CqdpitoNZHvsuUNB52c3EACvqSNDPnj0fND9oVwOFmEXTQuAvgnOQYPfaJs/4er3jXoredFgc4lttakUs6Zp/gET9NJS",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/it786kBxZIdt0fFcTSUkAstTbjkKFxiwkoaWZtIu9vdlWNj9N+PWUm2HDt3l1IKxrZ23p55e7RrcHxuIb6Fj0o6njoLswAytKkR2gklIYY5OsZZ2sohAKXRcJJdZK10K9Lc8AodGnK5BskrhBiWx1yLY6ceUUIAgnwWyDM0EIDBb7UwmEHsTI0BWLcqycaKSpcIAeBSlypDiHNeWlJIC6w4xGtwK+01nRFyDg2pcm8UE0RpxVyOlsvlEppgA6WDei+yHonmroDnKavkAVN3kTGVDxL/YVgDyJWpuBuebMHrP8ZJkU4KnUDTzCis1UpatORoEkX0swvX1mmK1uZ1yTbNgcAni9KRPte6FKkXhA+WjNb76NqsqY2G3DjRhuyL8eo8inFSLCcPmnrzxdf/dQ4eFLIEkczPKi7K77BPED90B6NUVeTqqlDy1VCm45PxxH/IRWqQO8xO3SE3W6NJNDk5HkfH0a8343fx9H389t0oiqK/IYBl5bPppjLjzmfphCuHz7XOfkKc5rlaN/EZOi5KOzTod6FpyGoaTfdnseMRJpVjuapl9suPm0Q0Rpl/r8WB8M0gASFLIfG+X6n7aTS9n2zSebufzoVc8FJk7PTqgt0Qg/3cdIbhXRt+v1+iVWoJdifZ4XmbpMW0NsKtPD8PiTm+nRHZVOgK1fG6J3RXQAxh1/hwvSXQBsibWfRkX5uSiN05beMw5FqPehYueWJp+0KuRbgYA8XpcVxTrdpy7KDZFIVr8QlXEPz3y4TSEzJX3rgrwaVGeS3m0hdwMd4j+ptCWCasF2cqrSuUzjeT5cqwZ9Ys4RYzpiRzBXohnZ+MxsxqTEXezcGI3ck7ea0qZLVFIuVSyEcb38ljdnuZ5yIVvGRfMbHC4exNX7Gnp6e9ih15m3PhijphBrXaqs/9oS/r0GrzcAQBODSVvcyv0SxEil13XggVeuWwm25acprQlnb7ow/PjWjaSpGitDiYx9Pzq8/sZBRBMBiK/wE5/Hzx8ezL9Rl5pbFqWzQeRaOIjrSyruJyEOgc3eD1vNPZ9XZJ9y4w3WQ5XLpQl1z4pfFI193A38JWOx7cGWYBFMo6UlivaRr+MmXT0PG3Gg0t1SyABTeCJzR+t2vIhKX/2eZO8CLKN39214sjdvj6cRB2vyWSVmTBy5qeIIBHXO1ed5pZE/Sb8t3AXkLRRttdzQ0Yun61CqdpitoNZHvsuUNB52c3EACvqSNDPnj0fND9oVwOFmEXTQuAvgnOQYPfaJs/4er3jXoredFgc4lttakUs6Zp/gET9NJS",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 y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact"})}),"\n",(0,t.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"get a contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.ff3f50af.js b/assets/js/05632a52.ff3f50af.js new file mode 100644 index 000000000..08ff1708f --- /dev/null +++ b/assets/js/05632a52.ff3f50af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>b,contentTitle:()=>j,default:()=>f,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(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:"eJy9Vv9r20YU/1du76cWZEt23I6JMRpKyEJLE5aMwRITTtKTdYl0d707OTZG//t4J8mWY2dbSikY27r37fO+fXQbcHxhIb6Fj0o6njoL8wAytKkR2gklIYYFOsZZ2sohAKXRcJJdZK10J9Lc8AodGnK5AckrhBhWI67FyKlHlBCAIJ8F8gwNBGDway0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisO8QbcWntNZ4RcQEOq3BvFBFFasZDj1Wq1gibYQumg3ousR6K5K+B5yip5wNRdZEzlg8S/G9YAcmUq7oYnO/D690lSpNNCJ9A0cwprtZIWLTmaRhH97MO1dZqitXldsm1zIPDJonSkz7UuReoF4YMlo80hujZraqMhN060IftivDqPYpIUq+mDpt588fV/nYMHhSxBJPOziovyG+wTxA/dwThVFbm6KpR8NZTZ5GQy9R9ykRrkDrNTd8zNzmgaTU9Gk2gU/XwzeR/PfonfvR9HUfQ3BLCqfDbdVGbc+SydcOXwudbZD4jTPFfrJj5Dx0Vphwb9LjQNWc2i2eEsdjzCpHIsV7XMfvp+k4jGKPPvtTgSvhkkIGQpJN73K3U/i2b302067w7TuZBLXoqMnV5dsBtisB+bzjC8a8Mf9ku0Si3B7iU7PG+TtJjWRri15+chMce3cyKbCl2hOl73hO4KiCHsGh9udgTaAHkzy57sa1MSsTunbRyG1vGFkIsR13rcs3HJE0tbGHItwuUEKF6P55pq1pZlD9W2OFyLT7iG4L9fKpSmkLnyxl0pLjXKa7GQvpDLyQHh3xTCMmG9OFNpXaF0vqksV4Y9s2YJt5gxJZkr0Avp/GQ8YVZjKvJuHsbsTt7Ja1Uhqy0SOZdCPtr4To7Y7WWei1Twkv2FiRUO52/6yj09PR1U7K23OReuqBNmUKud+sIf+rIOrbYPbyEAh6ayl/k1mqVIsevSC6FCrxx2U07LTpPa0m9/9OG5EU1dKVKUFgdzeXp+9ZmdjCMIBsPxPyCHny8+nn25PiOvNF5tiybjaBzRkVbWVVwOAp2jG7ym9zq72S3rwUWmmyyHKxfqkgu/PB7pphv8W9hpx4O7wzyAQllHCpsNTcOfpmwaOv5ao6Hlmgew5EbwhMbvdgOZsPQ/294NXkT55o/umvGWHb+GHIXdb4mkFVnysqYnCOAR1/vXnmbeBP2mfDOwl1C00fZXcwuGrmGtwmmaonYD2QGL7lHR+dkNBMBr6siQDx49H3R/KJejRdhH0wKgb4Jz1OBX2uZPuP5tq95KXjTYXmZbbSrFvGmafwCp2NVs",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/getcontact",title:"Get contact",description:"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:"eJy9Vv9r20YU/1du76cWZEt23I6JMRpKyEJLE5aMwRITTtKTdYl0d707OTZG//t4J8mWY2dbSikY27r37fO+fXQbcHxhIb6Fj0o6njoL8wAytKkR2gklIYYFOsZZ2sohAKXRcJJdZK10J9Lc8AodGnK5AckrhBhWI67FyKlHlBCAIJ8F8gwNBGDway0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisO8QbcWntNZ4RcQEOq3BvFBFFasZDj1Wq1gibYQumg3ousR6K5K+B5yip5wNRdZEzlg8S/G9YAcmUq7oYnO/D690lSpNNCJ9A0cwprtZIWLTmaRhH97MO1dZqitXldsm1zIPDJonSkz7UuReoF4YMlo80hujZraqMhN060IftivDqPYpIUq+mDpt588fV/nYMHhSxBJPOziovyG+wTxA/dwThVFbm6KpR8NZTZ5GQy9R9ykRrkDrNTd8zNzmgaTU9Gk2gU/XwzeR/PfonfvR9HUfQ3BLCqfDbdVGbc+SydcOXwudbZD4jTPFfrJj5Dx0Vphwb9LjQNWc2i2eEsdjzCpHIsV7XMfvp+k4jGKPPvtTgSvhkkIGQpJN73K3U/i2b302067w7TuZBLXoqMnV5dsBtisB+bzjC8a8Mf9ku0Si3B7iU7PG+TtJjWRri15+chMce3cyKbCl2hOl73hO4KiCHsGh9udgTaAHkzy57sa1MSsTunbRyG1vGFkIsR13rcs3HJE0tbGHItwuUEKF6P55pq1pZlD9W2OFyLT7iG4L9fKpSmkLnyxl0pLjXKa7GQvpDLyQHh3xTCMmG9OFNpXaF0vqksV4Y9s2YJt5gxJZkr0Avp/GQ8YVZjKvJuHsbsTt7Ja1Uhqy0SOZdCPtr4To7Y7WWei1Twkv2FiRUO52/6yj09PR1U7K23OReuqBNmUKud+sIf+rIOrbYPbyEAh6ayl/k1mqVIsevSC6FCrxx2U07LTpPa0m9/9OG5EU1dKVKUFgdzeXp+9ZmdjCMIBsPxPyCHny8+nn25PiOvNF5tiybjaBzRkVbWVVwOAp2jG7ym9zq72S3rwUWmmyyHKxfqkgu/PB7pphv8W9hpx4O7wzyAQllHCpsNTcOfpmwaOv5ao6Hlmgew5EbwhMbvdgOZsPQ/294NXkT55o/umvGWHb+GHIXdb4mkFVnysqYnCOAR1/vXnmbeBP2mfDOwl1C00fZXcwuGrmGtwmmaonYD2QGL7lHR+dkNBMBr6siQDx49H3R/KJejRdhH0wKgb4Jz1OBX2uZPuP5tq95KXjTYXmZbbSrFvGmafwCp2NVs",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"}},b={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"get a contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(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,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.6dd96ce6.js b/assets/js/1f73ca32.6dd96ce6.js new file mode 100644 index 000000000..35508dfb8 --- /dev/null +++ b/assets/js/1f73ca32.6dd96ce6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTsc6Phdy3uJat+vJSfnU0hrocC06q65fr3WNQ+pj2aq9SncN41p8xA0E//7fQNSFnCkPrtpzp1EOxVz65q66cEh+tBCWCeuPExXnGUrnL5rNlGEHaDblFhOmJHML9Idk77e7zGqMxazSSJs9ykc5VBmy3CL9PaRCLm30KFtsfDebiVjwlP2NUyscTt7UnXt+fj7q2JnHDIRb5FNmUKsX97k3+rY2UbuHMwjAocns3WyIZiVirG7pB6k63rlTKZ/HXvlY7v/a9P4QREpMRYzSYkOrV4P7T6zfDiFoiOM/lNz5dPPh+vPwmqKSvMor6rbDdkgmrazLuGwkekW6e9e7E5HDtevolAs/O76obSXrMdSyngSwUNaRabulq34waVGQ+VuOhqZpEsCKG8GnpK3xpAhq6dEcJMLSQbJ78TgoZbdQ4M1f1TvMGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRqqJZ243z4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8DuJa/0plZMiqL4DrFTd0k=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-user",title:"Get your details",description:"Get your details",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTsc6Phdy3uJat+vJSfnU0hrocC06q65fr3WNQ+pj2aq9SncN41p8xA0E//7fQNSFnCkPrtpzp1EOxVz65q66cEh+tBCWCeuPExXnGUrnL5rNlGEHaDblFhOmJHML9Idk77e7zGqMxazSSJs9ykc5VBmy3CL9PaRCLm30KFtsfDebiVjwlP2NUyscTt7UnXt+fj7q2JnHDIRb5FNmUKsX97k3+rY2UbuHMwjAocns3WyIZiVirG7pB6k63rlTKZ/HXvlY7v/a9P4QREpMRYzSYkOrV4P7T6zfDiFoiOM/lNz5dPPh+vPwmqKSvMor6rbDdkgmrazLuGwkekW6e9e7E5HDtevolAs/O76obSXrMdSyngSwUNaRabulq34waVGQ+VuOhqZpEsCKG8GnpK3xpAhq6dEcJMLSQbJ78TgoZbdQ4M1f1TvMGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRqqJZ243z4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8DuJa/0plZMiqL4DrFTd0k=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get your details"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(a.p,{children:"Get your details"}),"\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)(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)(a.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.bd1f8bd5.js b/assets/js/1f73ca32.bd1f8bd5.js deleted file mode 100644 index c89bf5f95..000000000 --- a/assets/js/1f73ca32.bd1f8bd5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=a(85893),l=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),o=(a(82723),a(9487)),d=a(41429),c=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTodr3a4nJuVTS+Pf4Vp0Vl2/VuvahtS/skV7Fe4axbX4iBsI/v0/gSgLOVMeXLXlTqMcirn0TV114ZD0aCEsE9YfJyrOM5TOXzCbKcMO0GzKLSZMSeYW6A/J3m93mdUYi1mljTZ7lI9yqDJkuUX6W0iFXNroUbbY+G42E7HgKfsbp1Y4nLypO/b8/HzUsTOPGQi3yKfMoFYv7nNv9G1tonYPZxCAQ5PZu9kQzUrEWN3OD1J1vHOnUjyPveKx3Pu16f0hiBSYihilxYZGrwb3n1i/HULQEMV/KLnz6ebD9efhNUUlWZVX1G2H7ZBMWlmXcdlI9Ipk9653JyKHa9fRKRd+ZnxR20rOY6jlPAlgoawj03ZLV/1g0qIg87ccDU3RJIAVN4JPSVvjSRHU0iP9J8LSQbJ74TgoZbdI4M1f1bvLGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRiqJZ243x4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8Du5a70plZMiqL4DlKydC8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-user",title:"Get your details",description:"Get your details",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTodr3a4nJuVTS+Pf4Vp0Vl2/VuvahtS/skV7Fe4axbX4iBsI/v0/gSgLOVMeXLXlTqMcirn0TV114ZD0aCEsE9YfJyrOM5TOXzCbKcMO0GzKLSZMSeYW6A/J3m93mdUYi1mljTZ7lI9yqDJkuUX6W0iFXNroUbbY+G42E7HgKfsbp1Y4nLypO/b8/HzUsTOPGQi3yKfMoFYv7nNv9G1tonYPZxCAQ5PZu9kQzUrEWN3OD1J1vHOnUjyPveKx3Pu16f0hiBSYihilxYZGrwb3n1i/HULQEMV/KLnz6ebD9efhNUUlWZVX1G2H7ZBMWlmXcdlI9Ipk9653JyKHa9fRKRd+ZnxR20rOY6jlPAlgoawj03ZLV/1g0qIg87ccDU3RJIAVN4JPSVvjSRHU0iP9J8LSQbJ74TgoZbdI4M1f1bvLGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRiqJZ243x4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8Du5a70plZMiqL4DlKydC8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},b=[{value:"Request",id:"request",level:2}];function f(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 your details"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"Get your details"}),"\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)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"User not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.879f33f5.js b/assets/js/2c586be5.879f33f5.js new file mode 100644 index 000000000..ffe325c8e --- /dev/null +++ b/assets/js/2c586be5.879f33f5.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 t=a(85893),n=a(11151),l=a(58219),i=(a(62316),a(51039)),r=a.n(i),d=(a(82723),a(9487)),o=a(41429),c=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:"eJytVdtu4zYQ/RV2njaAYtnZ9kUoigbbxSLYRRPUKfrgGAFNjSwmFMklKUdeQ/9eDHWJbGfRFuiLL3MR55w5hzpA4FsP2Qp+M6KuUAcP6wSMRceDNPomhwyEQx4w7wsgAcsdrzCgo84DaF4hZNBccisvg3lGDQlIDRmUyHN0kIDDr7V0mEMWXI0J+LBX1ONlZRVCAthYZXKErODKU4EoseKQHSDsbawMTuottFTKY1NGY2ovt3rWNE0D7ZrO8dZoj546r+Zz+srRCyctwYFsxMl6VMzXQqD3Ra3U/gdIQBgdCGZ2AG6tkiISkT55aj+cD2Y2TygiK45oC7I7vAsTf6cQEiiMq3iYRl4xlU/y6lsjdld3hLV26j8/IATrszTtIzNhKmjbBIIMMS+1khofB6Yer+bzxwW0LdX8OP/pnLEbveNK5uz67obd03b/R5bQOePeQviKZ3p86I6nUZsqMtNrT3ZFnfiOwE7jHUiPonYy7KN2p6LNVmvS0DH6D1EmbKL+CkNpyBfW+M4NoYQM0jObeHS7wSNxkeNufOBbqbeX3NrZIGLFN56WlXIr090iynkYdUl0dowdDTzyxq38jHtI/tmLxIDUhYnNPUu3FvVSbnXkeLeAUw7uS+mZ9DE94Iv7ZoVx7KSbbbjHnBnNQokxSfH3swXzFoUseqnM2IN+0EtTIas9FrViSupnnz3oS7a6LQopJFfsL9x4GXD9bmDu5eXljLGL2PNJhrLeMIfWvJZvYzDSOu0a/1xAAgFd5W+LJbqdFIODvnNUGovT3gBcRANgxSVttw/9etpEglRSoPY4kez1p7sv7P1sDslEHP9i5PTLzYePvy8/0lNJXt2KFrP5bE4hEmXF9eSgcwUfbXfUUMAmpFZxqSc3Tyfu1ek7YJ1ASerPVnA40ML/dKptKfy1RkfWWiew407yDSlstW6TQYDkhlx6SuTjdX8y0Xi7wLs/+jfHBaNVvTXpM+7PFL/jqqZKaJNDX3AtBNowyZ3dW+S40dx3t8t7SIDXhH/qs+fos/4HgRlSej95+PE43QT0SfO82fAzueQz7n8Zy7vMdxvGd2tXTVys27b9GwYdrYc=",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:"eJytVdtu4zYQ/RV2njaAYtnZ9kUoigbbxSLYRRPUKfrgGAFNjSwmFMklKUdeQ/9eDHWJbGfRFuiLL3MR55w5hzpA4FsP2Qp+M6KuUAcP6wSMRceDNPomhwyEQx4w7wsgAcsdrzCgo84DaF4hZNBccisvg3lGDQlIDRmUyHN0kIDDr7V0mEMWXI0J+LBX1ONlZRVCAthYZXKErODKU4EoseKQHSDsbawMTuottFTKY1NGY2ovt3rWNE0D7ZrO8dZoj546r+Zz+srRCyctwYFsxMl6VMzXQqD3Ra3U/gdIQBgdCGZ2AG6tkiISkT55aj+cD2Y2TygiK45oC7I7vAsTf6cQEiiMq3iYRl4xlU/y6lsjdld3hLV26j8/IATrszTtIzNhKmjbBIIMMS+1khofB6Yer+bzxwW0LdX8OP/pnLEbveNK5uz67obd03b/R5bQOePeQviKZ3p86I6nUZsqMtNrT3ZFnfiOwE7jHUiPonYy7KN2p6LNVmvS0DH6D1EmbKL+CkNpyBfW+M4NoYQM0jObeHS7wSNxkeNufOBbqbeX3NrZIGLFN56WlXIr090iynkYdUl0dowdDTzyxq38jHtI/tmLxIDUhYnNPUu3FvVSbnXkeLeAUw7uS+mZ9DE94Iv7ZoVx7KSbbbjHnBnNQokxSfH3swXzFoUseqnM2IN+0EtTIas9FrViSupnnz3oS7a6LQopJFfsL9x4GXD9bmDu5eXljLGL2PNJhrLeMIfWvJZvYzDSOu0a/1xAAgFd5W+LJbqdFIODvnNUGovT3gBcRANgxSVttw/9etpEglRSoPY4kez1p7sv7P1sDslEHP9i5PTLzYePvy8/0lNJXt2KFrP5bE4hEmXF9eSgcwUfbXfUUMAmpFZxqSc3Tyfu1ek7YJ1ASerPVnA40ML/dKptKfy1RkfWWiew407yDSlstW6TQYDkhlx6SuTjdX8y0Xi7wLs/+jfHBaNVvTXpM+7PFL/jqqZKaJNDX3AtBNowyZ3dW+S40dx3t8t7SIDXhH/qs+fos/4HgRlSej95+PE43QT0SfO82fAzueQz7n8Zy7vMdxvGd2tXTVys27b9GwYdrYc=",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 N(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create document"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,t.jsx)(s.p,{children:"Create document"}),"\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)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Document created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.bb79ab65.js b/assets/js/2c586be5.bb79ab65.js deleted file mode 100644 index 5584f3ee5..000000000 --- a/assets/js/2c586be5.bb79ab65.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:()=>b,contentTitle:()=>h,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>v});var t=a(85893),n=a(11151),i=a(58219),l=(a(62316),a(51039)),r=a.n(l),d=(a(82723),a(9487)),c=a(41429),o=a(5397),m=a(4667),p=a(9472),u=a(85162);const x={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJytVdtu4zYQ/RV2njaAYtnZ9kUoigbbxSLYRRPUKfrgGAFNjSwmFMklKUdeQ/9eDHWJbGfRFuiLL3MR55w5hzpA4FsP2Qp+M6KuUAcP6wSMRceDNPomhwyEQx4w7wsgAcsdrzCgo84DaF4hZNBccisvg3lGDQlIDRmUyHN0kIDDr7V0mEMWXI0J+LBX1ONlZRVCAthYZXKErODKU4EoseKQHSDsbawMTuottFTKY1NGY2ovt3rWNE0D7ZrO8dZoj546r+Zz+srRCyctwYFsxMl6VMzXQqD3Ra3U/gdIQBgdCGZ2AG6tkiISkT55aj+cD2Y2TygiK45oC7I7vAsTf6cQEiiMq3iYRl4xlU/y6lsjdld3hLV26j8/IATrszTtIzNhKmjbBIIMMS+1khofB6Yer+bzxwW0LdX8OP/pnLEbveNK5uz67obd03b/R5bQOePeQviKZ3p86I6nUZsqMtNrT3ZFnfiOwE7jHUiPonYy7KN2p6LNVmvS0DH6D1EmbKL+CkNpyBfW+M4NoYQM0jObeHS7wSNxkeNuuLWzQbyKbzwtKeVWprtFlPEw4pJo7Jg6GnTki1v5GfeQ/LMHCbnUhYnNPTu3FvVSbnXkdreAU+z3pfRM+pgecMU9s8I4dtLNNtxjzoxmocSYpPj72YJ5i0IWvURm7EE/6KWpkNUei1oxJfWzzx70JVvdFoUUkiv2F268DLh+NzD28vJyxthF7PkkQ1lvmENrXsu3MRhpnXaNfy4ggYCu8rfFEt1OisE53zkqjcVpL3wuovCx4pK22od+PW0iISopUHucSPX6090X9n42h2Qiin8xcvrl5sPH35cf6akkq25Fi9l8NqcQibHienLQuXKPtjtqKGATUqu41JMbpxP16vTuXydQkuqzFRwOtPA/nWpbCn+t0ZGl1gnsuJN8QwpbrdtkECC5IJeeEvl4zZ9MNN4q8O6P/o1xwWhVb036jPszxe+4qqkS2uTQF1wLgTZMcmf3FTluNPXd7fIeEuA14Z/67Dn6rP9BYIaU3k8efjxONwF90jxvNvxMLvmM+1/G8i7z3YbxndpVExfrtm3/Bvdpqm0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={id:"API-docs/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:"eJytVdtu4zYQ/RV2njaAYtnZ9kUoigbbxSLYRRPUKfrgGAFNjSwmFMklKUdeQ/9eDHWJbGfRFuiLL3MR55w5hzpA4FsP2Qp+M6KuUAcP6wSMRceDNPomhwyEQx4w7wsgAcsdrzCgo84DaF4hZNBccisvg3lGDQlIDRmUyHN0kIDDr7V0mEMWXI0J+LBX1ONlZRVCAthYZXKErODKU4EoseKQHSDsbawMTuottFTKY1NGY2ovt3rWNE0D7ZrO8dZoj546r+Zz+srRCyctwYFsxMl6VMzXQqD3Ra3U/gdIQBgdCGZ2AG6tkiISkT55aj+cD2Y2TygiK45oC7I7vAsTf6cQEiiMq3iYRl4xlU/y6lsjdld3hLV26j8/IATrszTtIzNhKmjbBIIMMS+1khofB6Yer+bzxwW0LdX8OP/pnLEbveNK5uz67obd03b/R5bQOePeQviKZ3p86I6nUZsqMtNrT3ZFnfiOwE7jHUiPonYy7KN2p6LNVmvS0DH6D1EmbKL+CkNpyBfW+M4NoYQM0jObeHS7wSNxkeNuuLWzQbyKbzwtKeVWprtFlPEw4pJo7Jg6GnTki1v5GfeQ/LMHCbnUhYnNPTu3FvVSbnXkdreAU+z3pfRM+pgecMU9s8I4dtLNNtxjzoxmocSYpPj72YJ5i0IWvURm7EE/6KWpkNUei1oxJfWzzx70JVvdFoUUkiv2F268DLh+NzD28vJyxthF7PkkQ1lvmENrXsu3MRhpnXaNfy4ggYCu8rfFEt1OisE53zkqjcVpL3wuovCx4pK22od+PW0iISopUHucSPX6090X9n42h2Qiin8xcvrl5sPH35cf6akkq25Fi9l8NqcQibHienLQuXKPtjtqKGATUqu41JMbpxP16vTuXydQkuqzFRwOtPA/nWpbCn+t0ZGl1gnsuJN8QwpbrdtkECC5IJeeEvl4zZ9MNN4q8O6P/o1xwWhVb036jPszxe+4qqkS2uTQF1wLgTZMcmf3FTluNPXd7fIeEuA14Z/67Dn6rP9BYIaU3k8efjxONwF90jxvNvxMLvmM+1/G8i7z3YbxndpVExfrtm3/Bvdpqm0=",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"}},b={},v=[{value:"Request",id:"request",level:2}];function N(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create document"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,t.jsx)(s.p,{children:"Create document"}),"\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)("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:"Document created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.96f0357e.js b/assets/js/377084eb.96f0357e.js new file mode 100644 index 000000000..8340026c3 --- /dev/null +++ b/assets/js/377084eb.96f0357e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),o=s(5397),c=s(4667),p=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:"eJy9Vm1v4zYM/isaP10BJ3HaXof504pd1wU7tMWSYcDaoFBsOlZrSzpJThME/u8D5Ze4ybU5DIf7lJjiwxfxIaktOL60EN3DDAudc4cW5gEkaGMjtBNKQgQQgNJoOH1OEohgia5VhwA0N7xAh4bsbEHyAiGC9YBrMXDqGSUEIMhOhjxBAwEY/FIKgwlEzpQYgHWbnDBWFDonk7jWuUoQopTnlhTiDAsO0RbcRntNZ4RcQkWq3IMiilFasZTD9Xq9hiroQnFNrI8iaUPR3GWwn+fkE1Mpa7WZy7hjEjGxzCm2QJaiizNMvmcCAaTKFNzVEsqompN5q5W0aAlwGob08zpUW8YxWpuWOetKAwHESjqUjvS51rmI/cHoyRJoexiFWjxh7KiGhsw4UbusxVTq9+OtJbsKrMd/LGRhT+98ZWbCkfTQxA5g/Z/uygl1o9wRUFcgqWrI7yonXr0LSr0O84wgiDgWWuacttFo1HorLZphrApC377IY/66IGOD3Kmd56lYSt8qHZobwzdETIeFPV6cG0/q93w/KWQLRKiqAFxdhF0PtP7p0MeGyaV7395peHo2GIeD8OfZ+CI6/yX6eDEMw/BfCGBd5IRtGi1patg6bb9LnfwAP9W+Wp9W+/cAVUWA8/D8sLlmPYKxVJUy+en79RYao45w52v++7UUMhcSH9sp8Xgenj9edAl9PExoIlc8Fwm7vJuwGU3kH5tP372r3R8WS9RK9cJ4lWxfXidZoMtUs4j8AnIZRNC16mjbm/gVBGDRrNr1VJq8193W8aWQywHXetjuj5wvLHX6iGsxWo2BJrLFuDTCbaZ0K3Xi/QXXa2Yt/kTq5qNrkBIRMlUe3CR7q1FSg/qrWo0PNtQsE5YJ648TFZcFSufLxlJl2B6aLbjFhCnJXIb+kORnwzGzGmORNhUfsgf5IKeqQFZapI2SC/lsowc5YPe3aSpiwXP2Dy6scDj/0N7cy8vLwY2deMy1cFm5YAa12qkvvdBfax/VfZxAAA5NYW/TKZqViNsZ/IarkVceNTzmsecxFlxQdRvRr/sg4lUuYpQWe8y7vL77zM6GIQQ9cnxDyKPPk9+ubqZXZJXoVZdoPAyHIYm0sq7gsufoGt3udbHYsMmn/QJvd11Jr66GUw7XbqRzLnxj+Bi3DenvdwMtgKj/0JkHkCnrSGW7JSb8bfKqIvGXEs0Govt5ACtuBF8Q9e63kAhL/5Pu0fJmaB/+at4/J+zb30xfTabtGkkts+J5iXXmz7jZe7hV8ypoW+d/R/tWGLW7173aRUMvyVrhMo5Ru97ZweCkWdFNp+urGVTVfyjh3yg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/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:"eJy9Vm1v4zYM/isaP10BJ3HaXof504pd1wU7tMWSYcDaoFBsOlZrSzpJThME/u8D5Ze4ybU5DIf7lJjiwxfxIaktOL60EN3DDAudc4cW5gEkaGMjtBNKQgQQgNJoOH1OEohgia5VhwA0N7xAh4bsbEHyAiGC9YBrMXDqGSUEIMhOhjxBAwEY/FIKgwlEzpQYgHWbnDBWFDonk7jWuUoQopTnlhTiDAsO0RbcRntNZ4RcQkWq3IMiilFasZTD9Xq9hiroQnFNrI8iaUPR3GWwn+fkE1Mpa7WZy7hjEjGxzCm2QJaiizNMvmcCAaTKFNzVEsqompN5q5W0aAlwGob08zpUW8YxWpuWOetKAwHESjqUjvS51rmI/cHoyRJoexiFWjxh7KiGhsw4UbusxVTq9+OtJbsKrMd/LGRhT+98ZWbCkfTQxA5g/Z/uygl1o9wRUFcgqWrI7yonXr0LSr0O84wgiDgWWuacttFo1HorLZphrApC377IY/66IGOD3Kmd56lYSt8qHZobwzdETIeFPV6cG0/q93w/KWQLRKiqAFxdhF0PtP7p0MeGyaV7395peHo2GIeD8OfZ+CI6/yX6eDEMw/BfCGBd5IRtGi1patg6bb9LnfwAP9W+Wp9W+/cAVUWA8/D8sLlmPYKxVJUy+en79RYao45w52v++7UUMhcSH9sp8Xgenj9edAl9PExoIlc8Fwm7vJuwGU3kH5tP372r3R8WS9RK9cJ4lWxfXidZoMtUs4j8AnIZRNC16mjbm/gVBGDRrNr1VJq8193W8aWQywHXetjuj5wvLHX6iGsxWo2BJrLFuDTCbaZ0K3Xi/QXXa2Yt/kTq5qNrkBIRMlUe3CR7q1FSg/qrWo0PNtQsE5YJ648TFZcFSufLxlJl2B6aLbjFhCnJXIb+kORnwzGzGmORNhUfsgf5IKeqQFZapI2SC/lsowc5YPe3aSpiwXP2Dy6scDj/0N7cy8vLwY2deMy1cFm5YAa12qkvvdBfax/VfZxAAA5NYW/TKZqViNsZ/IarkVceNTzmsecxFlxQdRvRr/sg4lUuYpQWe8y7vL77zM6GIQQ9cnxDyKPPk9+ubqZXZJXoVZdoPAyHIYm0sq7gsufoGt3udbHYsMmn/QJvd11Jr66GUw7XbqRzLnxj+Bi3DenvdwMtgKj/0JkHkCnrSGW7JSb8bfKqIvGXEs0Govt5ACtuBF8Q9e63kAhL/5Pu0fJmaB/+at4/J+zb30xfTabtGkkts+J5iXXmz7jZe7hV8ypoW+d/R/tWGLW7173aRUMvyVrhMo5Ru97ZweCkWdFNp+urGVTVfyjh3yg=",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 a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template 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)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(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:"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)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(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)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.ae92b574.js b/assets/js/377084eb.ae92b574.js deleted file mode 100644 index a687afd63..000000000 --- a/assets/js/377084eb.ae92b574.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),r=(s(62316),s(51039)),n=s.n(r),m=(s(82723),s(9487)),c=s(41429),d=s(5397),p=s(4667),o=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:"eJy9Vm1v4zYM/isaP10BJ3HaXIf504pd1wU7tMWaYcDaoFBsOlZrSzpJThME/u8D5Ze4ybU5DIf7lJjiwxfxIaktOL60EN3DDAudc4cW5gEkaGMjtBNKQgQQgNJoOH1OE4hgia5VhwA0N7xAh4bsbEHyAiGC9YBrMXDqGSUEIMhOhjxBAwEY/FIKgwlEzpQYgHWbnDBWFDonk7jWuUoQopTnlhTiDAsO0RbcRntNZ4RcQkWq3IMiilFasZTD9Xq9hiroQnFNrI8iaUPR3GWwn+f0E1Mpa7WZy7hjEjGxzCm2QJaiizNMvmcCAaTKFNzVEsqompN5q5W0aAlwGob08zpUW8YxWpuWOetKAwHESjqUjvS51rmI/cHoyRJoexiFWjxh7KiGhsw4UbusxVTq9+OtJbsKrMd/LGRhT299ZWbCkfTQxA5g/Z/uygl1rdwRUFcgqWrI7yonXr0LSr0O84wgiDgWWuacttFo1HorLZphrApC37zIY/66IGOD3Kmd5zuxlL5VOjQ3hm+ImA4Le7w4157U7/l+UsgWiFBVAbi6CLseaP3ToY8Nkwv3vr3T8PRsMA4H4c+z8Xk0+SX6eD4Mw/BfCGBd5IRtGi1patg6bb9LnfwAP9W+Wp9W+/cAVUWASTg5bK5Zj2AsVaVMfvp+vYXGqCPc+Zr/fi2FzIXEx3ZKPE7CyeN5l9DHw4SmcsVzkbCL2ymb0UT+sfn03bva/WGxRK1UL4xXyfbldZIFukw1i8gvIJdBBF2rjra9iV9BABbNql1Ppcl73c21HrZ7I+cLSx0+4lqMVmOgSWwxLo1wmzu6jTrh/mLrNbEWfyJ18dH1RwkImSoPbpK80SipMf0VrcYHm2mWCcuE9ceJissCpfPlYqkybA/NFtxiwpRkLkN/SPKz4ZhZjbFIm0oP2YN8kHeqQFZapE2SC/lsowc5YPc3aSpiwXP2Dy6scDj/0N7Yy8vLwY2deMyVcFm5YAa12qkvvdBfax/VfZxAAA5NYW/SOzQrEbez9w1XI688avjLY89fLLigqjaiX/dBxKdcxCgt9hh3cXX7mZ0NQwh6pPiGkEefp79dXt9dklWiVV2i8TAchiTSyrqCy56jK3S7V8Viw6af9gu83XUjvbYaTjlcu5HOufAN4WPcNmS/3w2yAKL+A2ceQKasI5Xtlpjwt8mrisRfSjQbiO7nAay4EXxB1LvfQiIs/U+6x8qboX34q3n3nLBvfyt9NZm2ayS1zIrnJdaZP+Nm78FWzaugbZ3/He1bYdTuXvdqFw29IGuFizhG7XpnBwOTZkU3la4uZ1BV/wGfBtwO",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/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:"eJy9Vm1v4zYM/isaP10BJ3HaXIf504pd1wU7tMWaYcDaoFBsOlZrSzpJThME/u8D5Ze4ybU5DIf7lJjiwxfxIaktOL60EN3DDAudc4cW5gEkaGMjtBNKQgQQgNJoOH1OE4hgia5VhwA0N7xAh4bsbEHyAiGC9YBrMXDqGSUEIMhOhjxBAwEY/FIKgwlEzpQYgHWbnDBWFDonk7jWuUoQopTnlhTiDAsO0RbcRntNZ4RcQkWq3IMiilFasZTD9Xq9hiroQnFNrI8iaUPR3GWwn+f0E1Mpa7WZy7hjEjGxzCm2QJaiizNMvmcCAaTKFNzVEsqompN5q5W0aAlwGob08zpUW8YxWpuWOetKAwHESjqUjvS51rmI/cHoyRJoexiFWjxh7KiGhsw4UbusxVTq9+OtJbsKrMd/LGRhT299ZWbCkfTQxA5g/Z/uygl1rdwRUFcgqWrI7yonXr0LSr0O84wgiDgWWuacttFo1HorLZphrApC37zIY/66IGOD3Kmd5zuxlL5VOjQ3hm+ImA4Le7w4157U7/l+UsgWiFBVAbi6CLseaP3ToY8Nkwv3vr3T8PRsMA4H4c+z8Xk0+SX6eD4Mw/BfCGBd5IRtGi1patg6bb9LnfwAP9W+Wp9W+/cAVUWASTg5bK5Zj2AsVaVMfvp+vYXGqCPc+Zr/fi2FzIXEx3ZKPE7CyeN5l9DHw4SmcsVzkbCL2ymb0UT+sfn03bva/WGxRK1UL4xXyfbldZIFukw1i8gvIJdBBF2rjra9iV9BABbNql1Ppcl73c21HrZ7I+cLSx0+4lqMVmOgSWwxLo1wmzu6jTrh/mLrNbEWfyJ18dH1RwkImSoPbpK80SipMf0VrcYHm2mWCcuE9ceJissCpfPlYqkybA/NFtxiwpRkLkN/SPKz4ZhZjbFIm0oP2YN8kHeqQFZapE2SC/lsowc5YPc3aSpiwXP2Dy6scDj/0N7Yy8vLwY2deMyVcFm5YAa12qkvvdBfax/VfZxAAA5NYW/SOzQrEbez9w1XI688avjLY89fLLigqjaiX/dBxKdcxCgt9hh3cXX7mZ0NQwh6pPiGkEefp79dXt9dklWiVV2i8TAchiTSyrqCy56jK3S7V8Viw6af9gu83XUjvbYaTjlcu5HOufAN4WPcNmS/3w2yAKL+A2ceQKasI5Xtlpjwt8mrisRfSjQbiO7nAay4EXxB1LvfQiIs/U+6x8qboX34q3n3nLBvfyt9NZm2ayS1zIrnJdaZP+Nm78FWzaugbZ3/He1bYdTuXvdqFw29IGuFizhG7XpnBwOTZkU3la4uZ1BV/wGfBtwO",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,l.jsx)(n(),{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)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.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)("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:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(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 bee"}}),(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:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.296814e0.js b/assets/js/52d5c0f9.296814e0.js new file mode 100644 index 000000000..bcb89b3fc --- /dev/null +++ b/assets/js/52d5c0f9.296814e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>y});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),d=a.n(i),c=(a(82723),a(9487)),r=a(41429),m=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:"eJy9Vm1r40YQ/ivb+XQB2ZKT3JWKUpo24WouNKFOKdQxYS2NrL1Iu3u7K8dG6L+X0Zvll6RHOfrFlmaf2XnmXSU4vrIQzuFaRUWO0llYeBCjjYzQTigJIcSYoUPGWdxiwAOl0XA6n8Y9YnCsueE5OjR0dwmS5wghbEZci5FTzyjBA0F3p8hjNOCBwS+FMBhD6EyBHli3zUjHilxnCB7gRmcqRggTnlkCRCnmHMIS3FbXSGeEXEFFUF4rhURTWrGS481ms4HK66l0XJ9E3FHR3KVw6Pu9UWsRI1PLzxi5acxU0oeBOcUaz78lfw8SZXLuhpKdQzo9X6bn3MZQVQuyarWSFi3dcx4E9LfvQJfXlmnMbBFFaG1SZNn2O/AgUtJR0sISuNaZiOq0+p8tqZfHNJtIUI4NFYETjfEuQKcc2tH/ZUPk9W/6gvLUUrpybyudB+cXo0kwCr5/mHwIL38I338YB0HwN3iwyTPS7ZLKHdK9Trhs914dwZqcDYGtpCLwZXD5RhilcixRhYy/YezQGGXejsEp+9XAAyEzIfGpq4eny+Dy6aJ36P2xQ1O55pmI2dX9lD1QR/6//gzNu8b8caJEA2oGxp6zQ3njpMWoMMJt63kzHDThfEGdkqNL1W5W1TPKpRCC37WzXw6GQgV0pVl3E6wwGU0r57QNfd86vhJyNeJaj7sRk/GlHUcq97kW/noCZLQjNaPANbHZo9ZHiGvxCbfg/fukJF+FTFSt3MbjTqOciZWso7meHA2xh1RYJmx93PlYZ5YlyrADbbbkFmOmJHMp1ockvxhPmNUYiaQtijF7lI9ypnJkhcWkyFgm5LMNH+WIze+SRESCZ+wvXFrhcPGui9zLy8tRxM5qnY/CpcWSGdRqB1/VwjqsQ63+5Qw8cGhye5fM0KxFhG2WXjHl12C/LXUe1aWOOReU3Vb086ESlV4mIpQWB8V59fH+ll2MA/AGxfEVlP3b6a83v89u6FYqryZFk3EwDkiklXU5lwND18367bfOcsum14c5Lne9e3Jft3XmcON8nXFR91PNu2wbYQ4DeDjcjwsPUmUdQcqSquNPk1UVib8UaKjjFh6suRF8SeU4LyEWlp7jftm9yvXdH+3ePGNfvWpP+tI1kqQuWvOsoDfw4Bm3B+u+WlRe103/mexrNBpz++3bs6HvjwZwFUWo3eDsaNzuzazrm9ubhxvwgBeUquHYeK7HRvtA7pwMxD6hhgP9EqOTCj9S03/C7U89vDl5VaH/kGvQFI1FVVX/ACRfiX0=",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:"eJy9Vm1r40YQ/ivb+XQB2ZKT3JWKUpo24WouNKFOKdQxYS2NrL1Iu3u7K8dG6L+X0Zvll6RHOfrFlmaf2XnmXSU4vrIQzuFaRUWO0llYeBCjjYzQTigJIcSYoUPGWdxiwAOl0XA6n8Y9YnCsueE5OjR0dwmS5wghbEZci5FTzyjBA0F3p8hjNOCBwS+FMBhD6EyBHli3zUjHilxnCB7gRmcqRggTnlkCRCnmHMIS3FbXSGeEXEFFUF4rhURTWrGS481ms4HK66l0XJ9E3FHR3KVw6Pu9UWsRI1PLzxi5acxU0oeBOcUaz78lfw8SZXLuhpKdQzo9X6bn3MZQVQuyarWSFi3dcx4E9LfvQJfXlmnMbBFFaG1SZNn2O/AgUtJR0sISuNaZiOq0+p8tqZfHNJtIUI4NFYETjfEuQKcc2tH/ZUPk9W/6gvLUUrpybyudB+cXo0kwCr5/mHwIL38I338YB0HwN3iwyTPS7ZLKHdK9Trhs914dwZqcDYGtpCLwZXD5RhilcixRhYy/YezQGGXejsEp+9XAAyEzIfGpq4eny+Dy6aJ36P2xQ1O55pmI2dX9lD1QR/6//gzNu8b8caJEA2oGxp6zQ3njpMWoMMJt63kzHDThfEGdkqNL1W5W1TPKpRCC37WzXw6GQgV0pVl3E6wwGU0r57QNfd86vhJyNeJaj7sRk/GlHUcq97kW/noCZLQjNaPANbHZo9ZHiGvxCbfg/fukJF+FTFSt3MbjTqOciZWso7meHA2xh1RYJmx93PlYZ5YlyrADbbbkFmOmJHMp1ockvxhPmNUYiaQtijF7lI9ypnJkhcWkyFgm5LMNH+WIze+SRESCZ+wvXFrhcPGui9zLy8tRxM5qnY/CpcWSGdRqB1/VwjqsQ63+5Qw8cGhye5fM0KxFhG2WXjHl12C/LXUe1aWOOReU3Vb086ESlV4mIpQWB8V59fH+ll2MA/AGxfEVlP3b6a83v89u6FYqryZFk3EwDkiklXU5lwND18367bfOcsum14c5Lne9e3Jft3XmcON8nXFR91PNu2wbYQ4DeDjcjwsPUmUdQcqSquNPk1UVib8UaKjjFh6suRF8SeU4LyEWlp7jftm9yvXdH+3ePGNfvWpP+tI1kqQuWvOsoDfw4Bm3B+u+WlRe103/mexrNBpz++3bs6HvjwZwFUWo3eDsaNzuzazrm9ubhxvwgBeUquHYeK7HRvtA7pwMxD6hhgP9EqOTCj9S03/C7U89vDl5VaH/kGvQFI1FVVX/ACRfiX0=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,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)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.580fe438.js b/assets/js/52d5c0f9.580fe438.js deleted file mode 100644 index 64a9749e6..000000000 --- a/assets/js/52d5c0f9.580fe438.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=a(85893),t=a(11151),n=a(58219),d=(a(62316),a(51039)),i=a.n(d),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:"eJy9Vm1v2zYQ/ivcfWoAxZKTtMOEYVi2BJ3RYAnmDAOWGAEtnSI2FMmSlGND0H8fTm+WYycrhmJfbOn4HO+5d1Xg+aOD+A4udFIWqLyDRQApusQK44VWEEOKEj0yztIOAwFog5bT+SwdEKNjwy0v0KOluytQvECIYX3MjTj2+gkVBCDo7hx5ihYCsPilFBZTiL0tMQDnN5J0nCiMRAgA10bqFCHOuHQESHIsOMQV+I1pkN4K9Qg1QXmjFBNN5cSjmqzX6zXUwUCl5/og0p6K4T6Hl77fWL0SKTK9/IyJn6VMZ0MYmNes9fxb8g8g07bgfizZOmTyk2V+wl0Kdb0gq85o5dDRPSdRRH+7DvR57ZimzJVJgs5lpZSb7yCARCtPSYsr4MZIkTRpDT87Uq/2abaRoBxbKgIvWuN9gA45tKX/y5rIm9/MKeWpo3Tu31Y6iU5Oj6fRcfT97fRDfPZD/P7DJIqivyGAdSFJt08q90j3euHl9r3eg7U5GwM7SU3gs+jsjTAq7VmmS5V+w9ihtdq+HYND9uuRB0JJofChr4eHs+js4XRw6P2+QzO14lKk7Pxmxm6pI/9ff8bmfWt+P1GiBbUDY8fZsbx10mFSWuE3zbwZD5r4bkGdUqDP9XZWNTPK5xBD2LdzWI2GQg10pV31E6y0kqaV98bFYciNmfSjRfKlmyS6CLkR4WoKZKwnM6eAtTHZoTREhhvxCTcQ/PuEJB+FynSj3MXh2qCai0fVRHE13Rtet7lwTLjmuPetySjLtGUvtNmSO0yZVszn2ByS/HQyZc5gIrKuGCbsXt2ruS6QlQ6zUjIp1JOL79Uxu7vOMpEILtlfuHTC4+JdH7Hn5+e9iB01Oh+Fz8sls2j0Fv7YCJuwjrWGlyMIwKMt3HU2R7sSCXbZecVU2IDDrsR50pQ4FlxQVjvRzy+VqOSkSFA5HBXl+cebK3Y6iSAYFcVXUA6vZr9e/j6/pFuprNoUTSfRJCKR0c4XXI0MXbRrd9g2yw2bXbzMcbXt2YN7uqszj2sfGslF00cN76prgDsYwePxXlwEkGvnCVJVVB1/WlnXJP5SoqVOWwSw4lbwJZXjXQWpcPScDkvuVa7v/uj25RH76hV70Je+kRR10YrLkt4ggCfcvFjz9aIO+m76z2Rfo9Ga223fgQ19d7SA8yRB40dne2N2Z1ZdXF5d3l5CALykVI3HxlMzNroHcudgIHYJtRzolxgdVPiRmv4Tbn4a4O3JqwrDB1yLpmgs6rr+B+YchmM=",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:"eJy9Vm1v2zYQ/ivcfWoAxZKTtMOEYVi2BJ3RYAnmDAOWGAEtnSI2FMmSlGND0H8fTm+WYycrhmJfbOn4HO+5d1Xg+aOD+A4udFIWqLyDRQApusQK44VWEEOKEj0yztIOAwFog5bT+SwdEKNjwy0v0KOluytQvECIYX3MjTj2+gkVBCDo7hx5ihYCsPilFBZTiL0tMQDnN5J0nCiMRAgA10bqFCHOuHQESHIsOMQV+I1pkN4K9Qg1QXmjFBNN5cSjmqzX6zXUwUCl5/og0p6K4T6Hl77fWL0SKTK9/IyJn6VMZ0MYmNes9fxb8g8g07bgfizZOmTyk2V+wl0Kdb0gq85o5dDRPSdRRH+7DvR57ZimzJVJgs5lpZSb7yCARCtPSYsr4MZIkTRpDT87Uq/2abaRoBxbKgIvWuN9gA45tKX/y5rIm9/MKeWpo3Tu31Y6iU5Oj6fRcfT97fRDfPZD/P7DJIqivyGAdSFJt08q90j3euHl9r3eg7U5GwM7SU3gs+jsjTAq7VmmS5V+w9ihtdq+HYND9uuRB0JJofChr4eHs+js4XRw6P2+QzO14lKk7Pxmxm6pI/9ff8bmfWt+P1GiBbUDY8fZsbx10mFSWuE3zbwZD5r4bkGdUqDP9XZWNTPK5xBD2LdzWI2GQg10pV31E6y0kqaV98bFYciNmfSjRfKlmyS6CLkR4WoKZKwnM6eAtTHZoTREhhvxCTcQ/PuEJB+FynSj3MXh2qCai0fVRHE13Rtet7lwTLjmuPetySjLtGUvtNmSO0yZVszn2ByS/HQyZc5gIrKuGCbsXt2ruS6QlQ6zUjIp1JOL79Uxu7vOMpEILtlfuHTC4+JdH7Hn5+e9iB01Oh+Fz8sls2j0Fv7YCJuwjrWGlyMIwKMt3HU2R7sSCXbZecVU2IDDrsR50pQ4FlxQVjvRzy+VqOSkSFA5HBXl+cebK3Y6iSAYFcVXUA6vZr9e/j6/pFuprNoUTSfRJCKR0c4XXI0MXbRrd9g2yw2bXbzMcbXt2YN7uqszj2sfGslF00cN76prgDsYwePxXlwEkGvnCVJVVB1/WlnXJP5SoqVOWwSw4lbwJZXjXQWpcPScDkvuVa7v/uj25RH76hV70Je+kRR10YrLkt4ggCfcvFjz9aIO+m76z2Rfo9Ga223fgQ19d7SA8yRB40dne2N2Z1ZdXF5d3l5CALykVI3HxlMzNroHcudgIHYJtRzolxgdVPiRmv4Tbn4a4O3JqwrDB1yLpmgs6rr+B+YchmM=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete document by ID"})}),"\n",(0,l.jsx)(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)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.2c528911.js b/assets/js/5a2de241.2c528911.js deleted file mode 100644 index d661e40b8..000000000 --- a/assets/js/5a2de241.2c528911.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),d=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21P20gQ/it784lKTuIAbXX+dFzhaHQVRAV00kEUbewxWVjvbnfXeVHk/16NXxKHBFoqdJdP8Xpm53nm3Svw/N5BdAvXmBnJPToYBaANWu6FVoMEIshNwj02AhCA4ZZn6NGS5goUzxAiWHS4ER2vH1FBAEJBBFPkCVoIwOK3XFhMIPI2xwCcX0rScSIzkq7EhZE6QYhSLh0JxFPMOEQr8EtTSnor1D0UJMpLpYhgKifuVXexWCygCNZQfI11LJIGiuF+CgEk6GIrDHGDCAanTKfMT5E1GsxPuWcKMXHMazZBVrFP3pJEAKm2GfctWsWouh+d/1MnS9LZhmqsnokE2QSlnrN1BAhkhXBNwbED7plE7jzTCluyDYF3EECslUflyRA3Roq4jHfvwZG11S50PXnA2FPwLWWHF+jo7UXp8B8TbIfNlX/WeCmmF9q/+pohUURmcSZwzrhKGOUC81PhWKLjPCN6RQCnbT++zsQ6K9qxKAL4S8sELRXH6+5bPLgJ75/zxRCKIgAv/JaZcStvxxNKg6IgOYvOaOUqjx+G4W52NMXZZCtzeRyjc2ku5fK3twt3dbyf+IYmd8nhZzc8/mzIWTWkE/+y0mF4eNTph53w43X/Q3T8e/T+QzcMw38hgEUmSbcu7qTOmcZ71XPrQCgpFI4br40Pw3B8WLvyeJ/36kxqSmzGpUhYKlAmjGy6N3QgWqvtL2b6C/heok+UG/LHL6SO0p6lOlfJ/013H6KXCR6PP64pvt+lOFCVy06GA3ZN8+m/YLjh0zbvK/MEdTurRSVUjc8tsu3ziuQ2u5vt9s8mSzY4hQAy9FNN89vkJWwagBH0GrneqtVtCgjAoZ01Iz23ksa398ZFvR43ptvMWsknrhvrrMeN6M36QIPLYZxb4ZdX5LPKLe1lYOMcbsTfuITgxysD0aRQfN3MxLPGoc3U2RkkzRz5udHwZDLsb/btXr/VvgluqktudaQuDaorMkNxnvV3lo1rsi5c+boBUeYcS7VlT7TZhDtMmFbldkIv6fyo22fOYCzSOl277E7dqSudIcsdprlkUqhHF92pDru9TFMRCy7ZPzhxwuPooAnofD7fCei7Uudc+Gk+YRaN3ojfl4dl1Nta6wfaJzzazF2mV2hnIsY6eZ4x1SuFe3UR8rgsQsy4oKSrj/54qkQulyJG5bBVNifnwy/sqBtC0MrZn4Dc+zL4dHZxdUa3UtZXIep3w25IR0Y7n3HVMvRclSV7twuPC98zkouylktkq7oCb6GVr1F7Ux0FMNXOk8hqRfG/sbIo6PhbjnYJ0e0ogBm3gk8o4W5XkAhH/5P1xvkEzbrHwcHXZvdjr1t69xJqyllRLc+4zOkJAnjE5ZPtuxgVQVPTv4z4ORiVue0mskZDnwOVwKfqzs413bGR2On6G42TOEbjX5QdtRrs8OYaApjUe3tWfgKA5XP6ZuBziOAO7sg9uqRZ9sfyfAWSq/uc35N8dS39vgP4ra2O",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:"eJzFV21P20gQ/it784lKTuIAbXX+dFzhaHQVRAV00kEUbewxWVjvbnfXeVHk/16NXxKHBFoqdJdP8Xpm53nm3Svw/N5BdAvXmBnJPToYBaANWu6FVoMEIshNwj02AhCA4ZZn6NGS5goUzxAiWHS4ER2vH1FBAEJBBFPkCVoIwOK3XFhMIPI2xwCcX0rScSIzkq7EhZE6QYhSLh0JxFPMOEQr8EtTSnor1D0UJMpLpYhgKifuVXexWCygCNZQfI11LJIGiuF+CgEk6GIrDHGDCAanTKfMT5E1GsxPuWcKMXHMazZBVrFP3pJEAKm2GfctWsWouh+d/1MnS9LZhmqsnokE2QSlnrN1BAhkhXBNwbED7plE7jzTCluyDYF3EECslUflyRA3Roq4jHfvwZG11S50PXnA2FPwLWWHF+jo7UXp8B8TbIfNlX/WeCmmF9q/+pohUURmcSZwzrhKGOUC81PhWKLjPCN6RQCnbT++zsQ6K9qxKAL4S8sELRXH6+5bPLgJ75/zxRCKIgAv/JaZcStvxxNKg6IgOYvOaOUqjx+G4W52NMXZZCtzeRyjc2ku5fK3twt3dbyf+IYmd8nhZzc8/mzIWTWkE/+y0mF4eNTph53w43X/Q3T8e/T+QzcMw38hgEUmSbcu7qTOmcZ71XPrQCgpFI4br40Pw3B8WLvyeJ/36kxqSmzGpUhYKlAmjGy6N3QgWqvtL2b6C/heok+UG/LHL6SO0p6lOlfJ/013H6KXCR6PP64pvt+lOFCVy06GA3ZN8+m/YLjh0zbvK/MEdTurRSVUjc8tsu3ziuQ2u5vt9s8mSzY4hQAy9FNN89vkJWwagBH0GrneqtVtCgjAoZ01Iz23ksa398ZFvR43ptvMWsknrhvrrMeN6M36QIPLYZxb4ZdX5LPKLe1lYOMcbsTfuITgxysD0aRQfN3MxLPGoc3U2RkkzRz5udHwZDLsb/btXr/VvgluqktudaQuDaorMkNxnvV3lo1rsi5c+boBUeYcS7VlT7TZhDtMmFbldkIv6fyo22fOYCzSOl277E7dqSudIcsdprlkUqhHF92pDru9TFMRCy7ZPzhxwuPooAnofD7fCei7Uudc+Gk+YRaN3ojfl4dl1Nta6wfaJzzazF2mV2hnIsY6eZ4x1SuFe3UR8rgsQsy4oKSrj/54qkQulyJG5bBVNifnwy/sqBtC0MrZn4Dc+zL4dHZxdUa3UtZXIep3w25IR0Y7n3HVMvRclSV7twuPC98zkouylktkq7oCb6GVr1F7Ux0FMNXOk8hqRfG/sbIo6PhbjnYJ0e0ogBm3gk8o4W5XkAhH/5P1xvkEzbrHwcHXZvdjr1t69xJqyllRLc+4zOkJAnjE5ZPtuxgVQVPTv4z4ORiVue0mskZDnwOVwKfqzs413bGR2On6G42TOEbjX5QdtRrs8OYaApjUe3tWfgKA5XP6ZuBziOAO7sg9uqRZ9sfyfAWSq/uc35N8dS39vgP4ra2O",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,l.jsx)(i(),{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)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.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)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.652d37f8.js b/assets/js/5a2de241.652d37f8.js new file mode 100644 index 000000000..89bc0b055 --- /dev/null +++ b/assets/js/5a2de241.652d37f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),m=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21P20gQ/it784lKTuIE2ur86bjC0egqQAV00kEUbexxsrDe3e6u86LI/70avyQOAVoqdJdP8Xpm53nm3WvwfOoguoVrzIzkHh2MAtAGLfdCq2ECEeQm4R4bAQjAcMsz9GhJcw2KZwgRLDvciI7XD6ggAKEgghnyBC0EYPFbLiwmEHmbYwDOryTpOJEZSVfi0kidIEQpl44E4hlmHKI1+JUpJb0VagoFifJSKSKYyomp6i6XyyUUwQaKr7GORdJAMdzPIIAEXWyFIW4QwfCE6ZT5GbJGg/kZ90whJo55zSbIKvbJW5IIINU2475FqxhV96Pzf+pkRTq7UI3Vc5Egm6DUC7aJAIGsEG4oOHbAPZPInWdaYUu2IfAOAoi18qg8GeLGSBGX8e7dO7K23oeuJ/cYewq+pezwAh29PS8d/mOC7bC58s8GL8X0XPtXX3NJFJFZnAtcMK4SRrnA/Ew4lug4z4heEcBJ24+vM7HJinYsigD+0jJBS8XxuvuW927C+2d8eQlFEYAXfsfMuJW34wmlQVGQnEVntHKVxwdhuJ8dTXE22cpcHsfoXJpLufrt7cJdHT9NfEuTu2Tw2V0efTbkrBrSsX9ZaRAODjv9sBN+vO5/iI5+j95/6IZh+C8EsMwk6dbFndQ503ivem4dCCWFwnHjtfEgDMeD2pVHT3mvzqSmxOZcioSlAmXCyKZ7Qweitdr+Yqa/gO8l+kS5IX/0Quoo7Vmqc5X833SfQvQywaPxxw3F9/sUh6py2fHlkF3TfPovGG75tM37yjxB3c1qUQlV43OHbPu8IrnL7ma3/bPJig1PIIAM/UzT/DZ5CZsGYAS9Rq63bnWbAgJwaOfNSM+tpPHtvXFRr+c8nwo17XBjus3MlXziurHOetyI3rwPNMAcxrkVfnVFvqvc014Ktk7iRvyNKwh+vDoQXQrJ1+1sPG0c20yfvYHSzJOfGxGPJsTTTb/d83faOMFNdcmtjtiFQXVFZije8/7e0nFN1oUrXzcgytxjqbbskTabcIcJ06rcUuglnR92+8wZjEVap22X3ak7daUzZLnDNJdMCvXgojvVYbcXaSpiwSX7BydOeBwdNIFdLBZ7AX1X6pwJP8snzKLRW/FpeVhGva21eaC9wqPN3EV6hXYuYqyT6BlTvVK4Vxcjj8tixIwLSr766I/HSuRyKWJUDlvlc3x2+YUddkMIWrn7E5B7X4afTs+vTulWyv4qRP1u2A3pyGjnM65ahp6rtuTJLcPj0veM5KKs6RLZuq7EW2jla9TeWEcBzLTzJLJeU/xvrCwKOv6Wo11BdDsKYM6t4BNKuNs1JMLR/2SzeT5Cs+l1cPC12QHZ65bfJwk15ayoludc5vQEATzg6tEWXoyKoKnpX0b8HIzK3G4T2aChz4JK4FN1Z+ea7thK7HX/rcZxHKPxL8qOWo328uYaApjU+3tWfgqA5Qv6duALiOAO7sg9uqRZ9sfyfA2Sq2nOpyRfXUu/72e5sKg=",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:"eJzFV21P20gQ/it784lKTuIE2ur86bjC0egqQAV00kEUbexxsrDe3e6u86LI/70avyQOAVoqdJdP8Xpm53nm3WvwfOoguoVrzIzkHh2MAtAGLfdCq2ECEeQm4R4bAQjAcMsz9GhJcw2KZwgRLDvciI7XD6ggAKEgghnyBC0EYPFbLiwmEHmbYwDOryTpOJEZSVfi0kidIEQpl44E4hlmHKI1+JUpJb0VagoFifJSKSKYyomp6i6XyyUUwQaKr7GORdJAMdzPIIAEXWyFIW4QwfCE6ZT5GbJGg/kZ90whJo55zSbIKvbJW5IIINU2475FqxhV96Pzf+pkRTq7UI3Vc5Egm6DUC7aJAIGsEG4oOHbAPZPInWdaYUu2IfAOAoi18qg8GeLGSBGX8e7dO7K23oeuJ/cYewq+pezwAh29PS8d/mOC7bC58s8GL8X0XPtXX3NJFJFZnAtcMK4SRrnA/Ew4lug4z4heEcBJ24+vM7HJinYsigD+0jJBS8XxuvuW927C+2d8eQlFEYAXfsfMuJW34wmlQVGQnEVntHKVxwdhuJ8dTXE22cpcHsfoXJpLufrt7cJdHT9NfEuTu2Tw2V0efTbkrBrSsX9ZaRAODjv9sBN+vO5/iI5+j95/6IZh+C8EsMwk6dbFndQ503ivem4dCCWFwnHjtfEgDMeD2pVHT3mvzqSmxOZcioSlAmXCyKZ7Qweitdr+Yqa/gO8l+kS5IX/0Quoo7Vmqc5X833SfQvQywaPxxw3F9/sUh6py2fHlkF3TfPovGG75tM37yjxB3c1qUQlV43OHbPu8IrnL7ma3/bPJig1PIIAM/UzT/DZ5CZsGYAS9Rq63bnWbAgJwaOfNSM+tpPHtvXFRr+c8nwo17XBjus3MlXziurHOetyI3rwPNMAcxrkVfnVFvqvc014Ktk7iRvyNKwh+vDoQXQrJ1+1sPG0c20yfvYHSzJOfGxGPJsTTTb/d83faOMFNdcmtjtiFQXVFZije8/7e0nFN1oUrXzcgytxjqbbskTabcIcJ06rcUuglnR92+8wZjEVap22X3ak7daUzZLnDNJdMCvXgojvVYbcXaSpiwSX7BydOeBwdNIFdLBZ7AX1X6pwJP8snzKLRW/FpeVhGva21eaC9wqPN3EV6hXYuYqyT6BlTvVK4Vxcjj8tixIwLSr766I/HSuRyKWJUDlvlc3x2+YUddkMIWrn7E5B7X4afTs+vTulWyv4qRP1u2A3pyGjnM65ahp6rtuTJLcPj0veM5KKs6RLZuq7EW2jla9TeWEcBzLTzJLJeU/xvrCwKOv6Wo11BdDsKYM6t4BNKuNs1JMLR/2SzeT5Cs+l1cPC12QHZ65bfJwk15ayoludc5vQEATzg6tEWXoyKoKnpX0b8HIzK3G4T2aChz4JK4FN1Z+ea7thK7HX/rcZxHKPxL8qOWo328uYaApjU+3tWfgqA5Qv6duALiOAO7sg9uqRZ9sfyfA2Sq2nOpyRfXUu/72e5sKg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"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)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.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)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.164785f5.js b/assets/js/770b40a9.164785f5.js deleted file mode 100644 index ee4686ad8..000000000 --- a/assets/js/770b40a9.164785f5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),p=s(41429),d=s(5397),o=s(4667),c=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:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkjbky/vREknzqapZgbES8HQGemw6y0wq9HVKW6EN0rqzMuRvyBNC8nLzZKTKiZDuAm+TuDikYglG45gMPUxwvhmHBhOddZWaDyoY1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaBfTZo3pUI10gKx3SmS+FenHpo+qxh7vZTGSCS/YVp054nHxoK/b6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Sn3nVBxcI4bXfMs6BoLLqirjemXQxDpTIoMlcOOEi+v77+w834CUUcU/4Jy/OXm16vb0RXtSrKqWzToJ/2ETEY7X3DVCfSWcPf6u1WRx5WPjeQijEZgtWlE/QB7op5EsNDOk32zoYb/ZWVVkbl+RpDUc+H4VHYeEi+47jx0llyWFDQ8gr7j27xPdq4T+rCCfCF9mFRRK+s3Ax5kuT2K4MOfzSPnjJEA3sq+JrA/R3uUa4fLLEPTTefokCPO23Pi+moMVfUPiOamsg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/gettemplatelist",title:"Get template list",description:"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:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkjbky/vREknzqapZgbES8HQGemw6y0wq9HVKW6EN0rqzMuRvyBNC8nLzZKTKiZDuAm+TuDikYglG45gMPUxwvhmHBhOddZWaDyoY1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaBfTZo3pUI10gKx3SmS+FenHpo+qxh7vZTGSCS/YVp054nHxoK/b6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Sn3nVBxcI4bXfMs6BoLLqirjemXQxDpTIoMlcOOEi+v77+w834CUUcU/4Jy/OXm16vb0RXtSrKqWzToJ/2ETEY7X3DVCfSWcPf6u1WRx5WPjeQijEZgtWlE/QB7op5EsNDOk32zoYb/ZWVVkbl+RpDUc+H4VHYeEi+47jx0llyWFDQ8gr7j27xPdq4T+rCCfCF9mFRRK+s3Ax5kuT2K4MOfzSPnjJEA3sq+JrA/R3uUa4fLLEPTTefokCPO23Pi+moMVfUPiOamsg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function 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 list"})}),"\n",(0,l.jsx)(r(),{method:"get",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:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("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.jsx)("ul",{style:{marginLeft:"1rem"},children:(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:"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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("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 "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,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.5dce35a3.js b/assets/js/770b40a9.5dce35a3.js new file mode 100644 index 000000000..b622e9cc0 --- /dev/null +++ b/assets/js/770b40a9.5dce35a3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),p=a(41429),d=a(5397),c=a(4667),o=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:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkj5/lcqHmPG9NvbwbJp45mKuZGxMsB0NnpMCut8OsRVasuSPfq6oyNEX8gzc3JC44SFGqmA7gpwp1BRaMQSrgcwGEJxgvhmHBhOddZWaDyoZ1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaJfTZo3pUI10gKx3S2S+FenHpo+qxh7vZTGSCS/YVp054nHxoK/f6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Wn3nVBxcI4bffMs6BsLLqi7jemXQxDpTYoMlcOOIi+v77+w834CUUcc/4Jy/OXm16vb0RXtSvKqWzToJ/2ETEY7X3DVCfSWgPf6u1WRx5WPjeQijEhgtWnE/QB74p5EsNDOk32zoYb/ZWVVkbl+TpDkc+H4VHYeFC+47jx4llyWFDQ8hr7j27xTdq4T+rCCfCF9mFRRK+s3Ax5kuT2S4MOfzWPnjJEA3sq+JrA/R3uUa4fLLEPTTefosCPO2/Pi+moMVfUPQUupzA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/gettemplatelist",title:"Get template list",description:"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:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkj5/lcqHmPG9NvbwbJp45mKuZGxMsB0NnpMCut8OsRVasuSPfq6oyNEX8gzc3JC44SFGqmA7gpwp1BRaMQSrgcwGEJxgvhmHBhOddZWaDyoZ1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaJfTZo3pUI10gKx3S2S+FenHpo+qxh7vZTGSCS/YVp054nHxoK/f6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Wn3nVBxcI4bffMs6BsLLqi7jemXQxDpTYoMlcOOIi+v77+w834CUUcc/4Jy/OXm16vb0RXtSvKqWzToJ/2ETEY7X3DVCfSWgPf6u1WRx5WPjeQijEhgtWnE/QB74p5EsNDOk32zoYb/ZWVVkbl+TpDkc+H4VHYeFC+47jx4llyWFDQ8hr7j27xTdq4T+rCCfCF9mFRRK+s3Ax5kuT2S4MOfzWPnjJEA3sq+JrA/R3uUa4fLLEPTTefosCPO2/Pi+moMVfUPQUupzA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function 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 list"})}),"\n",(0,l.jsx)(r(),{method:"get",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:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\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)(p.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"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)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(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)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe bee"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.c9060b90.js b/assets/js/7b076186.c9060b90.js deleted file mode 100644 index c1aec9955..000000000 --- a/assets/js/7b076186.c9060b90.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>A,frontMatter:()=>h,metadata:()=>u,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),m=s(9472),x=s(85162);const h={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZIdt0OFYVjWGl3QoAnqDAPmGAEtnSw2FMmSlGPD0H8fTpJtOba7Yij2xZaOd7znnnvTBjxfOIin8E4rzxPvYBZAii6xwnihFcSQokSPjLOkUYEAtEHL6fg63SnsTw23vECPli7egOIFQgyrHjei5/UTKghA0M058hQtBGDxayksphB7W2IAzq8l2ThRGIkQAK6M1ClCnHHpSCHJseAQb8CvTa3prVALqEiV10YxoVROLFR/tVqtoAp2UFqojyLdIjHc5/Ay8DurlyJFpudfMPHXKdPZlgPmNWvC/pHoA8i0LbjvSvbhmHw4z4fcpVBVM/LqjFYOHd0zjCL6O8TfprQFmjJXJgk6l5VSrn+CoKYBlSdDbowUSZ3S8Isj680xyoYHSrClAvCi8b2l51Q8e/S/rwi7+cNcUpJaSFf+20bDaHjZG0S96Of7wZt49DZ+/aYfRdHfEMCqkGTbZjTlHuleL7zcv1dHak3KuoqtpCLlUTQ6z6LSnmW6VOkPpA6t1fbbFJxwX3XwCyWFwsdtMTyOotHjcBfO6+NwrtWSS5Gyq7trdk/N+P+G03XvG/fHaRKNUjMrDoLtypsgHSalFX5dj5rujImnM2qTAn2u91OqHk8+hxjCtpXDzX4cVEAX2uV2dJVW0pjy3rg4DLkx/e1MkXzu+okuQm5EuBwAudpCmRBdDSMHgHa8cCM+4hqCfx+NFKFQma6NWxZuDaqJWKiaw+XgaGzd58Ix4erjVCdlgcrX+WSZtuyFNZtzhynTivkc60OSX/YHzBlMRNaWQp89qAc10QWy0mFWSiaFenLxg+qx6W2WiURwyf7CuRMeZ6+2jD0/Px8xdlHbfBA+L+fMotF79UUtrGntWu1eLiAAj7Zwt9kE7VIk2GbnjKuwVg7bAqflREVacCH3S+C3l0ZUcFIkqBx2SvLqw90Nu+xHEHSK4jsghzfX78afJmO6lcqqSdGgH/UjEhntfMFVx9H7ukxdZ9keZHez79VTi7ktMI8rHxrJRd0+NeBNW/dT2GvHnUU4CyDXzpPCZkNF8aeVVUXiryVaaq9ZAEtuBZ9TFU43kApHz+lurZ0F+upzuyEv2Pfu1JOBbNtHUe8suSzpDQJ4wvXhVq9mVbBtof8M9RyKxtthz+7A0FdGo3CVJGh85+xosh6Mp/fjm/H9GALgJaWpOyue6lnRPlA4J3k4BNRgoF9CdNLgF+r0j7j+dafenJw12H2uNdrExqyqqn8A+5p9/Q==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/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:"eJy9Vm1v2zYQ/ivcfWoA2ZIdt0OFYVjWGl3QoAnqDAPmGAEtnSw2FMmSlGPD0H8fTpJtOba7Yij2xZaOd7znnnvTBjxfOIin8E4rzxPvYBZAii6xwnihFcSQokSPjLOkUYEAtEHL6fg63SnsTw23vECPli7egOIFQgyrHjei5/UTKghA0M058hQtBGDxayksphB7W2IAzq8l2ThRGIkQAK6M1ClCnHHpSCHJseAQb8CvTa3prVALqEiV10YxoVROLFR/tVqtoAp2UFqojyLdIjHc5/Ay8DurlyJFpudfMPHXKdPZlgPmNWvC/pHoA8i0LbjvSvbhmHw4z4fcpVBVM/LqjFYOHd0zjCL6O8TfprQFmjJXJgk6l5VSrn+CoKYBlSdDbowUSZ3S8Isj680xyoYHSrClAvCi8b2l51Q8e/S/rwi7+cNcUpJaSFf+20bDaHjZG0S96Of7wZt49DZ+/aYfRdHfEMCqkGTbZjTlHuleL7zcv1dHak3KuoqtpCLlUTQ6z6LSnmW6VOkPpA6t1fbbFJxwX3XwCyWFwsdtMTyOotHjcBfO6+NwrtWSS5Gyq7trdk/N+P+G03XvG/fHaRKNUjMrDoLtypsgHSalFX5dj5rujImnM2qTAn2u91OqHk8+hxjCtpXDzX4cVEAX2uV2dJVW0pjy3rg4DLkx/e1MkXzu+okuQm5EuBwAudpCmRBdDSMHgHa8cCM+4hqCfx+NFKFQma6NWxZuDaqJWKiaw+XgaGzd58Ix4erjVCdlgcrX+WSZtuyFNZtzhynTivkc60OSX/YHzBlMRNaWQp89qAc10QWy0mFWSiaFenLxg+qx6W2WiURwyf7CuRMeZ6+2jD0/Px8xdlHbfBA+L+fMotF79UUtrGntWu1eLiAAj7Zwt9kE7VIk2GbnjKuwVg7bAqflREVacCH3S+C3l0ZUcFIkqBx2SvLqw90Nu+xHEHSK4jsghzfX78afJmO6lcqqSdGgH/UjEhntfMFVx9H7ukxdZ9keZHez79VTi7ktMI8rHxrJRd0+NeBNW/dT2GvHnUU4CyDXzpPCZkNF8aeVVUXiryVaaq9ZAEtuBZ9TFU43kApHz+lurZ0F+upzuyEv2Pfu1JOBbNtHUe8suSzpDQJ4wvXhVq9mVbBtof8M9RyKxtthz+7A0FdGo3CVJGh85+xosh6Mp/fjm/H9GALgJaWpOyue6lnRPlA4J3k4BNRgoF9CdNLgF+r0j7j+dafenJw12H2uNdrExqyqqn8A+5p9/Q==",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={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Deletes contact"})}),"\n",(0,t.jsx)(d(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"delete a contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(x.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(x.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(x.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(x.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(x.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(x.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(x.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,t.jsx)(x.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(x.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(x.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(x.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(x.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function A(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.e9e2536a.js b/assets/js/7b076186.e9e2536a.js new file mode 100644 index 000000000..690b8fd10 --- /dev/null +++ b/assets/js/7b076186.e9e2536a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>j,metadata:()=>u,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),p=s(4667),m=s(9472),h=s(85162);const j={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZIdt0OFYVjWGl3QoAnqDAPmGAEtnSw2FMmSlGPD0H8fTpJtOba7Yij2xZaOd7znnnvTBjxfOIin8E4rzxPvYBZAii6xwnihFcSQokSPjLOkUYEAtEHL6fg63SnsTw23vECPli7egOIFQgyrHjei5/UTKghA0M058hQtBGDxayksphB7W2IAzq8l2ThRGIkQAK6M1ClCnHHpSCHJseAQb8CvTa3prVALqEiV10YxoVROLFR/tVqtoAp2UFqojyLdIjHc5/Ay8DurlyJFpudfMPHXKdPZlgPmNWvC/pHoA8i0LbjvSvbhmHw4z4fcpVBVM/LqjFYOHd0zjCL6O8TfprQFmjJXJgk6l5VSrn+CoKYBlSdDbowUSZ3S8Isj680xyoYHSrClAvCi8b2l51Q8e/S/rwi7+cNcUpJaSFf+20bDaHjZG0S96Of7wZt49DZ+/aYfRdHfEMCqkGTbZjTlHuleL7zcv1dHak3KuoqtpCLlUTQ6z6LSnmW6VOkPpA6t1fbbFJxwX3XwCyWFwsdtMTyOotHjcBfO6+NwrtWSS5Gyq7trdk/N+P+G03XvG/fHaRKNUjMrDoLtypsgHSalFX5dj5rujImnM2qTAn2u91OqHk8+hxjCtpXDzX4cVEAX2uV2dJVW0pjy3rg4DJ3nC6EWPW5MfztbJJ+7fqKLkBsRLgdALreQJkRbw8wBsB0/3IiPuIbg30ckRSpUpmvjlo1bg2oiFqrmcjk4Gl/3uXBMuPo41UlZoPJ1XlmmLXthzebcYcq0Yj7H+pDkl/0BcwYTkbUl0WcP6kFNdIGsdJiVkkmhnlz8oHpseptlIhFcsr9w7oTH2astc8/Pz0eMXdQ2H4TPyzmzaPRefVELa1q7VruXCwjAoy3cbTZBuxQJtlk64yqslcO20GlJUbEWXMj9MvjtpREVnhQJKoed0rz6cHfDLvsRBJ3i+A7I4c31u/GnyZhupfJqUjToR/2IREY7X3DVcfS+LlfXWboH2d3se/bUgm4LzOPKh0ZyUbdRDXjT1v8U9tpxZyHOAsi186Sw2VBR/GllVZH4a4mW2mwWwJJbwedUhdMNpMLRc7pbb2eBvvrcbsoL9r279WQg2/ZR1DtLLkt6gwCecH243atZFWxb6D9DPYei8XbYszsw9LXRKFwlCRrfOTuasAdj6v34Znw/hgB4SWnqzoqnela0DxTOSR4OATUY6JcQnTT4hTr9I65/3ak3J2cNdp9tjTaxMauq6h/zuIEX",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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:"eJy9Vm1v2zYQ/ivcfWoA2ZIdt0OFYVjWGl3QoAnqDAPmGAEtnSw2FMmSlGPD0H8fTpJtOba7Yij2xZaOd7znnnvTBjxfOIin8E4rzxPvYBZAii6xwnihFcSQokSPjLOkUYEAtEHL6fg63SnsTw23vECPli7egOIFQgyrHjei5/UTKghA0M058hQtBGDxayksphB7W2IAzq8l2ThRGIkQAK6M1ClCnHHpSCHJseAQb8CvTa3prVALqEiV10YxoVROLFR/tVqtoAp2UFqojyLdIjHc5/Ay8DurlyJFpudfMPHXKdPZlgPmNWvC/pHoA8i0LbjvSvbhmHw4z4fcpVBVM/LqjFYOHd0zjCL6O8TfprQFmjJXJgk6l5VSrn+CoKYBlSdDbowUSZ3S8Isj680xyoYHSrClAvCi8b2l51Q8e/S/rwi7+cNcUpJaSFf+20bDaHjZG0S96Of7wZt49DZ+/aYfRdHfEMCqkGTbZjTlHuleL7zcv1dHak3KuoqtpCLlUTQ6z6LSnmW6VOkPpA6t1fbbFJxwX3XwCyWFwsdtMTyOotHjcBfO6+NwrtWSS5Gyq7trdk/N+P+G03XvG/fHaRKNUjMrDoLtypsgHSalFX5dj5rujImnM2qTAn2u91OqHk8+hxjCtpXDzX4cVEAX2uV2dJVW0pjy3rg4DJ3nC6EWPW5MfztbJJ+7fqKLkBsRLgdALreQJkRbw8wBsB0/3IiPuIbg30ckRSpUpmvjlo1bg2oiFqrmcjk4Gl/3uXBMuPo41UlZoPJ1XlmmLXthzebcYcq0Yj7H+pDkl/0BcwYTkbUl0WcP6kFNdIGsdJiVkkmhnlz8oHpseptlIhFcsr9w7oTH2astc8/Pz0eMXdQ2H4TPyzmzaPRefVELa1q7VruXCwjAoy3cbTZBuxQJtlk64yqslcO20GlJUbEWXMj9MvjtpREVnhQJKoed0rz6cHfDLvsRBJ3i+A7I4c31u/GnyZhupfJqUjToR/2IREY7X3DVcfS+LlfXWboH2d3se/bUgm4LzOPKh0ZyUbdRDXjT1v8U9tpxZyHOAsi186Sw2VBR/GllVZH4a4mW2mwWwJJbwedUhdMNpMLRc7pbb2eBvvrcbsoL9r279WQg2/ZR1DtLLkt6gwCecH243atZFWxb6D9DPYei8XbYszsw9LXRKFwlCRrfOTuasAdj6v34Znw/hgB4SWnqzoqnela0DxTOSR4OATUY6JcQnTT4hTr9I65/3ak3J2cNdp9tjTaxMauq6h/zuIEX",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 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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.86c34487.js b/assets/js/8a725248.86c34487.js deleted file mode 100644 index 39605df0f..000000000 --- a/assets/js/8a725248.86c34487.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),c=(s(82723),s(9487)),m=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM78zzzstqD40sL8RQ+KOl44izMAlAaDXdCyesUYkgMcodJdQ4BaG54jg4N2e1B8hwhhm2Pa9Fz6gklBCAkxLBCnqKBAAx+K4TBFGJnCgzAul1GNlbkOkMIALc6UylCvOCZJYVkhTmHeA9up72mM0IuoSRV7o1iilJasZT97Xa7hXJW3YPW/a7SHdmmaBMjNCUCMWij1iJFNsdMbVibBHOKVRmyQ4r0CaUjJ1zrTCQejcGjJU/7TniHzKZwlXORQQBfCJAAbldKIqFZp6Dmj1jhZwhfJ9CSB699lmgAC2Vy7rqSQ+aPitJAgqO69PX2c8T3taCfqJxcVQG/0lU0HA2jUTQaRlCWATjhvPioZh7mREhJ58eV4AVWK2krLIZheM5bXZg1SSmzRZKgtYsiy3Y/vYarl3moxFTwrwNAr6L5ajt81ATh/5zMcTSKhv6PXNSAX7rn3ByMhuFw1IvCXvjzXfQuHv8Sv33XD8PwLwhgm/ts6gmRcuezbGqk+V7o9AfcU56q1cWZouMis12DZg6UvmTH4fi8KCcqR7cScsk2KB3bGCWXAdMZcovMmR3jSy4ky7hD8x8WKRqjzMswvS6ybs8KmQmJD01HPozD8UPUgvD2HIRrueaZSNnl7TW7o8H/YzPtXu+q689ZFpVStZeOku3KqyQtJoURbufXWnefxdMZrZeTuXS6NAh3RQtTK1vtSbeCGAan+9OiWTfLszAZLUrntI0HA651v9lqGZ9bauYB12Kwjvx+awKcEIgVTkdhtmhxLT7hDoJ/Xs6UN3Hz9bA6rxqEm+XUjqh2Qj03dNqZc7QT6LaF8qHVyN9olBOxlJ63dQSnuN6thGXC+uNUJUWO0vkaYgtl2Ik1m3OLKVOSuRX6Q5KP+hGzGhOxqMuvz+7lvaTWYIXFRZGxTMgnG9/LHpveLBYiETxjf+LcCoezNw0fm83mjI8Lb/NRuFUxZwa1OqgvvdCT1rVqv1xAAA5Nbm8WEzRrkWDN/XeuGnjlQd1UVDzUGDUDtej9qRFBnokEpcVOG1x+vP3MRv0Qgk7J/YuQB5+vP1x9mVyRVyraiqKoH/ZDElGl51x2LjrriiNy2wJ1uHUDnXHhm9KHtK8bZnry4JwFsKKGiqew3xPdf5isLEn8rUBDzToLYM2N4HOqr+msDJripg5LhaWDtH1bngTUzit487V+nFwwCJ4P9Al3Z9205llBmlAG+1rhQ+Wzd0c+Dhpn8/BgcZkkqN2LurPOhLm9mdxBAPP6oZv7tzMYvqHHNt9ADPdwD0AvefLgJ4WX7yHjclnwpW9r75cmAC8I+e74ePLjo/5AODZHcteJ8hiJKhX6T4k9a/Artecn3P3Wqlcn3zVof0NU2kTDrCzLvwHkZ0wm",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/createcontact",title:"Create contact",description:"Create contact",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM78zzzstqD40sL8RQ+KOl44izMAlAaDXdCyesUYkgMcodJdQ4BaG54jg4N2e1B8hwhhm2Pa9Fz6gklBCAkxLBCnqKBAAx+K4TBFGJnCgzAul1GNlbkOkMIALc6UylCvOCZJYVkhTmHeA9up72mM0IuoSRV7o1iilJasZT97Xa7hXJW3YPW/a7SHdmmaBMjNCUCMWij1iJFNsdMbVibBHOKVRmyQ4r0CaUjJ1zrTCQejcGjJU/7TniHzKZwlXORQQBfCJAAbldKIqFZp6Dmj1jhZwhfJ9CSB699lmgAC2Vy7rqSQ+aPitJAgqO69PX2c8T3taCfqJxcVQG/0lU0HA2jUTQaRlCWATjhvPioZh7mREhJ58eV4AVWK2krLIZheM5bXZg1SSmzRZKgtYsiy3Y/vYarl3moxFTwrwNAr6L5ajt81ATh/5zMcTSKhv6PXNSAX7rn3ByMhuFw1IvCXvjzXfQuHv8Sv33XD8PwLwhgm/ts6gmRcuezbGqk+V7o9AfcU56q1cWZouMis12DZg6UvmTH4fi8KCcqR7cScsk2KB3bGCWXAdMZcovMmR3jSy4ky7hD8x8WKRqjzMswvS6ybs8KmQmJD01HPozD8UPUgvD2HIRrueaZSNnl7TW7o8H/YzPtXu+q689ZFpVStZeOku3KqyQtJoURbufXWnefxdMZrZeTuXS6NAh3RQtTK1vtSbeCGAan+9OiWTfLszAZLUrntI0HA651v9lqGZ9bauYB12Kwjvx+awKcEIgVTkdhtmhxLT7hDoJ/Xs6UN3Hz9bA6rxqEm+XUjqh2Qj03dNqZc7QT6LaF8qHVyN9olBOxlJ63dQSnuN6thGXC+uNUJUWO0vkaYgtl2Ik1m3OLKVOSuRX6Q5KP+hGzGhOxqMuvz+7lvaTWYIXFRZGxTMgnG9/LHpveLBYiETxjf+LcCoezNw0fm83mjI8Lb/NRuFUxZwa1OqgvvdCT1rVqv1xAAA5Nbm8WEzRrkWDN/XeuGnjlQd1UVDzUGDUDtej9qRFBnokEpcVOG1x+vP3MRv0Qgk7J/YuQB5+vP1x9mVyRVyraiqKoH/ZDElGl51x2LjrriiNy2wJ1uHUDnXHhm9KHtK8bZnry4JwFsKKGiqew3xPdf5isLEn8rUBDzToLYM2N4HOqr+msDJripg5LhaWDtH1bngTUzit487V+nFwwCJ4P9Al3Z9205llBmlAG+1rhQ+Wzd0c+Dhpn8/BgcZkkqN2LurPOhLm9mdxBAPP6oZv7tzMYvqHHNt9ADPdwD0AvefLgJ4WX7yHjclnwpW9r75cmAC8I+e74ePLjo/5AODZHcteJ8hiJKhX6T4k9a/Artecn3P3Wqlcn3zVof0NU2kTDrCzLvwHkZ0wm",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},v=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create contact"})}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"Create 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:"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)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(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/8a725248.ace1ce06.js b/assets/js/8a725248.ace1ce06.js new file mode 100644 index 000000000..3b75c70f0 --- /dev/null +++ b/assets/js/8a725248.ace1ce06.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM788wzM6s9OL60EE/hg5KOJ87CLACl0XAnlLxOIYbEIHeYVOcQgOaG5+jQkN0eJM8RYtj2uBY9p55QQgBCQgwr5CkaCMDgt0IYTCF2psAArNtlZGNFrjOEAHCrM5UixAueWVJIVphziPfgdtprOiPkEkpS5d4opiilFUvZ3263Wyhn1T1o3e8q3ZFtijYxQlMiEIM2ai1SZHPM1Ia1STCnWJUhO6RIn1A6csK1zkTi0Rg8WvK074R3yGwKVzkXGQTwhQAJ4HalJBKadQpq/ogVfobwdQItefDaZ4kGsFAm564rOWT+qCgNJDiqS19vP0d8Xwv6icrJVRXwK11Fw9EwGkWjYQRlGYATzouPOPMwp4KUdH7MBC+wWklbYTEMw/O61cSsi5QyWyQJWrsosmz302tq9XIdKjER/nUA6FU0X22Hj5og/J8XcxyNoqH/Ixc14JfuOTcHo2E4HPWisBf+fBe9i8e/xG/f9cMw/AsC2OY+m3pCpNz5LBuONN8Lnf6Ae8pTtZqcKTouMts1aOZA6Sk7DsfnpJyoHN1KyCXboHRsY5RcBkxnyC0yZ3aML7mQLOMOzX9IUjRGmZdhel1k3Z4VMhMSH5qOfBiH44eoBeHtOQjXcs0zkbLL22t2R4P/x2bavd5V159XWVRK1V46SrYrr5K0mBRGuJ1fa919Fk9ntF5O5tLp0iDcFS1MrWy1J90KYhic7k+LZt0sz8JktCid0zYeDKzjSyGXPa51v9luGZ9bauoB12KwjvyeawKdEJgVXkfhtqhxLT7hDoJ/XtKUP9Xo62GFXjVIN0uqHVXtpHpu+LSz52g30G0L5UOrK3CjUU7EUvr6rSM4xfduJSwT1h+nKilylM5ziS2UYSfWbM4tpkxJ5lboD0k+6kfMakzEoqZhn93Le0ktwgqLiyJjmZBPNr6XPTa9WSxEInjG/sS5FQ5nb5q6bDabs3pceJuPwq2KOTOo1UF96YW+aF2r9ssFBODQ5PZmMUGzFgnWHPjOVQOvPKibi0hEDVJXoBa9PzUiyDORoLTYaYfLj7ef2agfQtCh3r8IefD5+sPVl8kVeSXyViWK+mE/JBExPueyc9FZdxwVtyWow60b6IwL35w+pH3dONOTh+csgBU1VjyF/Z7K/YfJypLE3wo01LSzANbcCD4nfk1nZdCQmzotFZYO0vaNeRJQO7fgzdf6kXLBIHg+0CfcnXXTmmcFaUIZ7GuFD5XP3h35OGiczcWDxWWSoHYv6s46k+b2ZnIHAczrB2/u39Bg+IYe3XwDMdzDPQC96MmDnxRevoeMy2XBl76tvV+aALwg5Lvj48mPj/oD4dgcyV0nymMkqlToPyX2rMGv1J6fcPdbq16dfNeg/S1RaVMZZmVZ/g1rnE9A",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/createcontact",title:"Create contact",description:"Create contact",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21rG0cQ/ivb+RTDSbqTlJQepcQNJpiE2EQuhcrCrO5G0tp3u5vdPb0g7r+X2XvRSXLcGkqgYIw0OzM788wzM6s9OL60EE/hg5KOJ87CLACl0XAnlLxOIYbEIHeYVOcQgOaG5+jQkN0eJM8RYtj2uBY9p55QQgBCQgwr5CkaCMDgt0IYTCF2psAArNtlZGNFrjOEAHCrM5UixAueWVJIVphziPfgdtprOiPkEkpS5d4opiilFUvZ3263Wyhn1T1o3e8q3ZFtijYxQlMiEIM2ai1SZHPM1Ia1STCnWJUhO6RIn1A6csK1zkTi0Rg8WvK074R3yGwKVzkXGQTwhQAJ4HalJBKadQpq/ogVfobwdQItefDaZ4kGsFAm564rOWT+qCgNJDiqS19vP0d8Xwv6icrJVRXwK11Fw9EwGkWjYQRlGYATzouPOPMwp4KUdH7MBC+wWklbYTEMw/O61cSsi5QyWyQJWrsosmz302tq9XIdKjER/nUA6FU0X22Hj5og/J8XcxyNoqH/Ixc14JfuOTcHo2E4HPWisBf+fBe9i8e/xG/f9cMw/AsC2OY+m3pCpNz5LBuONN8Lnf6Ae8pTtZqcKTouMts1aOZA6Sk7DsfnpJyoHN1KyCXboHRsY5RcBkxnyC0yZ3aML7mQLOMOzX9IUjRGmZdhel1k3Z4VMhMSH5qOfBiH44eoBeHtOQjXcs0zkbLL22t2R4P/x2bavd5V159XWVRK1V46SrYrr5K0mBRGuJ1fa919Fk9ntF5O5tLp0iDcFS1MrWy1J90KYhic7k+LZt0sz8JktCid0zYeDKzjSyGXPa51v9luGZ9bauoB12KwjvyeawKdEJgVXkfhtqhxLT7hDoJ/XtKUP9Xo62GFXjVIN0uqHVXtpHpu+LSz52g30G0L5UOrK3CjUU7EUvr6rSM4xfduJSwT1h+nKilylM5ziS2UYSfWbM4tpkxJ5lboD0k+6kfMakzEoqZhn93Le0ktwgqLiyJjmZBPNr6XPTa9WSxEInjG/sS5FQ5nb5q6bDabs3pceJuPwq2KOTOo1UF96YW+aF2r9ssFBODQ5PZmMUGzFgnWHPjOVQOvPKibi0hEDVJXoBa9PzUiyDORoLTYaYfLj7ef2agfQtCh3r8IefD5+sPVl8kVeSXyViWK+mE/JBExPueyc9FZdxwVtyWow60b6IwL35w+pH3dONOTh+csgBU1VjyF/Z7K/YfJypLE3wo01LSzANbcCD4nfk1nZdCQmzotFZYO0vaNeRJQO7fgzdf6kXLBIHg+0CfcnXXTmmcFaUIZ7GuFD5XP3h35OGiczcWDxWWSoHYv6s46k+b2ZnIHAczrB2/u39Bg+IYe3XwDMdzDPQC96MmDnxRevoeMy2XBl76tvV+aALwg5Lvj48mPj/oD4dgcyV0nymMkqlToPyX2rMGv1J6fcPdbq16dfNeg/S1RaVMZZmVZ/g1rnE9A",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create contact"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"Create contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.0602d8f8.js b/assets/js/a2bc1463.0602d8f8.js deleted file mode 100644 index 4f92e91a4..000000000 --- a/assets/js/a2bc1463.0602d8f8.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:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>b});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),d=a(41429),m=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/ivafWoA2ZKdtMOEYWhQBEHQognmDAOWGAUlnS3GFMmSlGPD0H8fjpJsyYnXdRgKBEl0fO7uuVdyB44tLSQP8EFJxzJnYR5CjjYzXDuuJCQAISiNhtHnTQ4JZA1UcOsgBM0MK9GhITM7kKxESGAzYpqPnFqhhBA42SmQ5WggBINfK24wh8SZCkOwbitIx/JSC4QQcKOFyhGSBROWAFmBJYNkB26rPdIZLpdQE5R5pYQ4SsuXcrzZbDZQh3sqgpfcdSS+Vmi2Aw6dj5bEQpmyT6GleMxAVmWKZsBgEvec2hXXP8BnXM/JrtVKWrSEncYx/RmW0FZZhtYuKhHsSwmhLyRKR3imteCZP4ieLCntXhJQ6RNmvuaGzDjeuDRoK+F6OGYMo4C5w9J+W78RU2sdFzj0qWGuLzlUXBeTtNhMnzSl5LPP+/cZeFIYpIikflUyLv6Dfor4vhWMM1WSqbtCye+mcjE5n0z9D5nIDDKH+aV7zcxBaRpPz0eTeBT/fD95l1z8krx9N47j+C8IYVP6aNpuzJnzUTruRP+70vkP8FMfw9oFkqNjXNi+QnsCdd0Tcim4xC9dm3+hFq894iJ++7LZb+SaCZ4Hl3c3wT0toJ/+v1ZHY5T552T13bvG/csM8AbU7MdBqH15E6TFrDLcbf167e/V5GFO41+iKxTt5SU2+9gVkEA03NIWzbpb0ZURtI6d0zaJIqb1uNudgqWW2jhimkfrCZD5zv2MUtRkYUDiMPWaf0Qa+29eARQVlwvlldvIbzXKGV9Kn7f1BI5vofuC24Bbf5yrrCpROl/DYKFMcKQdpMxiHigZuAL9IcnPx5PAasz4oi3/OHiUj3KmSgwqi7QdBZcrmzzKUfBwu1jwjDMR/Imp5Q7nb7qMPT8/v8jYmde55q6o0sCgVgf40gt9Wvta+48zCMGhKe3tYoZmzTNsq3PCVeTBUdvUNC3UmM3+6kTvj5WoyQTPUFrsteHl9d2n4HwcQ9hrin9BOfp08+Hq8+yKrFJbNSWajONxTCKtrCuZ7Dm6Rhe01IK2Iwfl3R0GlN4bbUc53LhIC8b9jHiGu7a/HwavkHkIhbKOxLsd1f4PI+qaxM3dS12fc8tS0bt9V7jtvQ7WTFTk078cTmDbS/0AndOH4YT10xh2Hf6qw5MRv/m9fRmcBaeCbwgMR2pAuQFcZhnqfjgvlt1gY1xf3UMIrKKM9ud45ee4/Ydi6Y7ktmd7yKYhQL+JzqsKv9IUfsTtb3t4c3JSYf9kbNCUinld138DOBiYzA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/contactlist",title:"Get contact list",description:"",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/ivafWoA2ZKdtMOEYWhQBEHQognmDAOWGAUlnS3GFMmSlGPD0H8fjpJsyYnXdRgKBEl0fO7uuVdyB44tLSQP8EFJxzJnYR5CjjYzXDuuJCQAISiNhtHnTQ4JZA1UcOsgBM0MK9GhITM7kKxESGAzYpqPnFqhhBA42SmQ5WggBINfK24wh8SZCkOwbitIx/JSC4QQcKOFyhGSBROWAFmBJYNkB26rPdIZLpdQE5R5pYQ4SsuXcrzZbDZQh3sqgpfcdSS+Vmi2Aw6dj5bEQpmyT6GleMxAVmWKZsBgEvec2hXXP8BnXM/JrtVKWrSEncYx/RmW0FZZhtYuKhHsSwmhLyRKR3imteCZP4ieLCntXhJQ6RNmvuaGzDjeuDRoK+F6OGYMo4C5w9J+W78RU2sdFzj0qWGuLzlUXBeTtNhMnzSl5LPP+/cZeFIYpIikflUyLv6Dfor4vhWMM1WSqbtCye+mcjE5n0z9D5nIDDKH+aV7zcxBaRpPz0eTeBT/fD95l1z8krx9N47j+C8IYVP6aNpuzJnzUTruRP+70vkP8FMfw9oFkqNjXNi+QnsCdd0Tcim4xC9dm3+hFq894iJ++7LZb+SaCZ4Hl3c3wT0toJ/+v1ZHY5T552T13bvG/csM8AbU7MdBqH15E6TFrDLcbf167e/V5GFO41+iKxTt5SU2+9gVkEA03NIWzbpb0ZURtI6d0zaJIqb1uNudgqWW2jhimkfrCZD5zv2MUtRkYUDiMPWaf0Qa+29eARQVlwvlldvIbzXKGV9Kn7f1BI5vofuC24Bbf5yrrCpROl/DYKFMcKQdpMxiHigZuAL9IcnPx5PAasz4oi3/OHiUj3KmSgwqi7QdBZcrmzzKUfBwu1jwjDMR/Imp5Q7nb7qMPT8/v8jYmde55q6o0sCgVgf40gt9Wvta+48zCMGhKe3tYoZmzTNsq3PCVeTBUdvUNC3UmM3+6kTvj5WoyQTPUFrsteHl9d2n4HwcQ9hrin9BOfp08+Hq8+yKrFJbNSWajONxTCKtrCuZ7Dm6Rhe01IK2Iwfl3R0GlN4bbUc53LhIC8b9jHiGu7a/HwavkHkIhbKOxLsd1f4PI+qaxM3dS12fc8tS0bt9V7jtvQ7WTFTk078cTmDbS/0AndOH4YT10xh2Hf6qw5MRv/m9fRmcBaeCbwgMR2pAuQFcZhnqfjgvlt1gY1xf3UMIrKKM9ud45ee4/Ydi6Y7ktmd7yKYhQL+JzqsKv9IUfsTtb3t4c3JSYf9kbNCUinld138DOBiYzA==",sidebar_class_name:"get 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 g(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(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.jsx)("ul",{style:{marginLeft:"1rem"},children:(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:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"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)(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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.87a05c5b.js b/assets/js/a2bc1463.87a05c5b.js new file mode 100644 index 000000000..506f18e81 --- /dev/null +++ b/assets/js/a2bc1463.87a05c5b.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:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),d=(a(82723),a(9487)),c=a(41429),m=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:"eJy9Vm1r40YQ/ivqfLqAbMtO7kpFKReOEMIdl1CnFJqYYy2NrYlXu3u7K8fG6L+XWcmx5CS9XikHIYlm5+WZmWdmdwdeLB2kd/BBKy8y72AWQ44us2Q8aQUpQAzaoBX8eZVDClmjKsl5iMEIK0r0aNnNDpQoEVLYDIShgdcrVBADsZ8CRY4WYrD4tSKLOaTeVhiD81vJNo5KIxFiwI2ROkdIF0I6VsgKLAWkO/BbEzS9JbWEmlVFMEoZo3K0VMPNZrOBOn6CIqkkvwfxtUK77WHYx2hBLLQtuxBaiMcIVFXO0fYQjJNOULci8wNiJvWM/TqjlUPHupMk4T/9Froqy9C5RSWjp1ZCHBqJyrO+MEZSFg5GD46Nds8B6PkDZqHnlt14akJadJX0HT1hreCEyWPpvm3fiJlaxw2OQ2mE70oOHTfFeF5sJg+GS/I51P37HDxojOaIbH5RCpL/wX6O+L4VDDNdsqubQqvvhnI2Ph1Pwg+7yCwKj/m5f8nNwWiSTE4H42SQ/Hw7fpee/ZK+fTdMkuQviGFThmxaNubChyw9edn9rkz+A+LUx2rtAsnRC5Kua9CeQF13hKQkKfyyp/kXpngdNM6St8/JfqXWQlIend9cRbe8gH76/6iO1mr7z8XqhvdN+OcVoEap2Y+9VLvyJkmHWWXJb8N67e7V9G7G41+iLzTv5SU2+9gXkMKov6Ud2vV+RVdW8jr23rh0NHJeLEktB8KY4X6HSjF3TOeRMDRaj4HD7GFMuVRNNXpgDtNv6CPy+H/zKuDsSC10MG4rcG1QTWmpQv3WYzi+jW4LchG5cJzrrCpR+dDLaKFtdGQdzYXDPNIq8gWGQ5afDseRM5jRoqXBMLpX92qqS4wqh7wlJamVS+/VILq7XiwoIyGjP3HuyOPszb5yj4+Pzyp2EmwuyRfVPLJo9EF9GYShrF2rp48TiMGjLd31Yop2TRm2XXol1Cgoj1py89QwQZs9the9PzZisknKUDns0PH88uZTdDpMIO6Q419AHn26+nDxeXrBXpleTYvGw2SYsMho50uhOoEu0UcttKhlZq+9u8Og8rujZZTHjR8ZKSjMSkC4a3l+13uNzGIotPMs3u24939YWdcsbu5gZn9OTsxl5xZe4bbzSlgLWXHM8IJ4Rbe93A+qM/6wxLphKuM9w18M+GrGb35vXwgn0WvJNwD6I9WD3CicZxmabjrPll5vc1xe3EIMouKKdud4Fea4/Ydz2R+pbcd3H00DgH8znBcNfuUp/Ijb357Um5NXDZ6ejo02l2JW1/Xf7z6b5g==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get contact list",description:"",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:"eJy9Vm1r40YQ/ivqfLqAbMtO7kpFKReOEMIdl1CnFJqYYy2NrYlXu3u7K8fG6L+XWcmx5CS9XikHIYlm5+WZmWdmdwdeLB2kd/BBKy8y72AWQ44us2Q8aQUpQAzaoBX8eZVDClmjKsl5iMEIK0r0aNnNDpQoEVLYDIShgdcrVBADsZ8CRY4WYrD4tSKLOaTeVhiD81vJNo5KIxFiwI2ROkdIF0I6VsgKLAWkO/BbEzS9JbWEmlVFMEoZo3K0VMPNZrOBOn6CIqkkvwfxtUK77WHYx2hBLLQtuxBaiMcIVFXO0fYQjJNOULci8wNiJvWM/TqjlUPHupMk4T/9Froqy9C5RSWjp1ZCHBqJyrO+MEZSFg5GD46Nds8B6PkDZqHnlt14akJadJX0HT1hreCEyWPpvm3fiJlaxw2OQ2mE70oOHTfFeF5sJg+GS/I51P37HDxojOaIbH5RCpL/wX6O+L4VDDNdsqubQqvvhnI2Ph1Pwg+7yCwKj/m5f8nNwWiSTE4H42SQ/Hw7fpee/ZK+fTdMkuQviGFThmxaNubChyw9edn9rkz+A+LUx2rtAsnRC5Kua9CeQF13hKQkKfyyp/kXpngdNM6St8/JfqXWQlIend9cRbe8gH76/6iO1mr7z8XqhvdN+OcVoEap2Y+9VLvyJkmHWWXJb8N67e7V9G7G41+iLzTv5SU2+9gXkMKov6Ud2vV+RVdW8jr23rh0NHJeLEktB8KY4X6HSjF3TOeRMDRaj4HD7GFMuVRNNXpgDtNv6CPy+H/zKuDsSC10MG4rcG1QTWmpQv3WYzi+jW4LchG5cJzrrCpR+dDLaKFtdGQdzYXDPNIq8gWGQ5afDseRM5jRoqXBMLpX92qqS4wqh7wlJamVS+/VILq7XiwoIyGjP3HuyOPszb5yj4+Pzyp2EmwuyRfVPLJo9EF9GYShrF2rp48TiMGjLd31Yop2TRm2XXol1Cgoj1py89QwQZs9the9PzZisknKUDns0PH88uZTdDpMIO6Q419AHn26+nDxeXrBXpleTYvGw2SYsMho50uhOoEu0UcttKhlZq+9u8Og8rujZZTHjR8ZKSjMSkC4a3l+13uNzGIotPMs3u24939YWdcsbu5gZn9OTsxl5xZe4bbzSlgLWXHM8IJ4Rbe93A+qM/6wxLphKuM9w18M+GrGb35vXwgn0WvJNwD6I9WD3CicZxmabjrPll5vc1xe3EIMouKKdud4Fea4/Ydz2R+pbcd3H00DgH8znBcNfuUp/Ijb357Um5NXDZ6ejo02l2JW1/Xf7z6b5g==",sidebar_class_name:"get 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"}},g={},f=[{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:"get",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:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(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)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.2e469c24.js b/assets/js/a88a3db3.2e469c24.js deleted file mode 100644 index e273b60f7..000000000 --- a/assets/js/a88a3db3.2e469c24.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:()=>b,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),d=(s(82723),s(9487)),m=s(41429),p=s(5397),o=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:"eJy9Vm1v4zYM/isaP10BNXbaXof507q1uAUr1sMlw4C1QaHYdKyrLOkkOk0Q+L8P8kviNNfuBYd9SkyT4kM+5CNvgcTSQ3IPMyytEoQe5hyMRSdIGj3JIIEMFRL2DsDBCidKJHQhcgtalAgJrE+FladknlADB6khgQJFhg44OPxSSYcZJOQq5OBpo0KMl6VV4UhcW2UyhCQXygeHtMBSQLIF2tjGk5zUS6iDq2iCkgBTe7nUo/V6vYaa76BQh/VRZj0UK6gADhn61EkbaoMEJtfM5IwKZH0Eo0IQ04iZZ2TYAllbffYti+CQG1cKGpRVz8P53hrt0YeIszgOP4d4ew56UMxXaYre55VSm++AQ2o0oaYQKaxVMm1YjD77EL49BmQWnzGlQKkLnJNsk7fmQP4x9H37f1oXZ8LbX+x5oKWDdEVvB53FZ+en4/g0/n42vkwufkjeX47iOP4TOKxLFWI7DrMwazUHkqT2z/WRW5P2wLGz1MH5Ir54o43aEMtNpbNv2Dt0zri3e/C1/PWgAqmV1PjYz8PjRXzxeLkr6P1xQRO9Ekpm7OrjhM3CAv6/9QzTU5v+mCjZOrX6cFDs0N4WeVjddUPofkUXGza5Bg4lUmH2AtUIExWQQNS7RtuBEtTAwaNb9bJVORUkisj6JIqEtaNeT5RY+FFqykhYGa3GEJbTY1o5SZtpaFvbmaHg7fsjrPwVN8D/XhZDpVLnpgnuunFnUU/lUje9XI2PFGtWSM+kb15nJq1K1NTwynLj2ItothAeM2Z0I3HhZbCfj8bMW0xl3o3EiD3oBz01JbLKY14ppqR+8smDPmX3d3kuUykU+wMXXhLO3/Ude35+PurYSRPzQVJRLZhDa/buy8bYtHUYtXs4AQ6ErvR3+RTdSqbYsfNKqqhxjrpBF2kz6FgKGVjtTD++DAqDp2SK2uNgNK8+fLxl56MY+GAo/gHk6Hby881v05twahirlqLxKB7FwWSNp1LoQaLXJvmA490kEa4pskrIZl8aZNtuxO93VxxwSIbX3ZxDYTwFl+028P+7U3UdzF8qdBtI7uccVsJJsQgDd7+FTPrwP9tdWy/Q7HQE3n3qbsAT9u9uzq8W1O+LDsuyEqoKT8DhCTcvrvB6XvN+af4z4tdgtOkOt3SHJnxTtA5XaYqWBu+ONDWoxE6Srm9ub2Y3UNd/Afb0NJU=",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:"eJy9Vm1v4zYM/isaP10BNXbaXof507q1uAUr1sMlw4C1QaHYdKyrLOkkOk0Q+L8P8kviNNfuBYd9SkyT4kM+5CNvgcTSQ3IPMyytEoQe5hyMRSdIGj3JIIEMFRL2DsDBCidKJHQhcgtalAgJrE+FladknlADB6khgQJFhg44OPxSSYcZJOQq5OBpo0KMl6VV4UhcW2UyhCQXygeHtMBSQLIF2tjGk5zUS6iDq2iCkgBTe7nUo/V6vYaa76BQh/VRZj0UK6gADhn61EkbaoMEJtfM5IwKZH0Eo0IQ04iZZ2TYAllbffYti+CQG1cKGpRVz8P53hrt0YeIszgOP4d4ew56UMxXaYre55VSm++AQ2o0oaYQKaxVMm1YjD77EL49BmQWnzGlQKkLnJNsk7fmQP4x9H37f1oXZ8LbX+x5oKWDdEVvB53FZ+en4/g0/n42vkwufkjeX47iOP4TOKxLFWI7DrMwazUHkqT2z/WRW5P2wLGz1MH5Ir54o43aEMtNpbNv2Dt0zri3e/C1/PWgAqmV1PjYz8PjRXzxeLkr6P1xQRO9Ekpm7OrjhM3CAv6/9QzTU5v+mCjZOrX6cFDs0N4WeVjddUPofkUXGza5Bg4lUmH2AtUIExWQQNS7RtuBEtTAwaNb9bJVORUkisj6JIqEtaNeT5RY+FFqykhYGa3GEJbTY1o5SZtpaFvbmaHg7fsjrPwVN8D/XhZDpVLnpgnuunFnUU/lUje9XI2PFGtWSM+kb15nJq1K1NTwynLj2ItothAeM2Z0I3HhZbCfj8bMW0xl3o3EiD3oBz01JbLKY14ppqR+8smDPmX3d3kuUykU+wMXXhLO3/Ude35+PurYSRPzQVJRLZhDa/buy8bYtHUYtXs4AQ6ErvR3+RTdSqbYsfNKqqhxjrpBF2kz6FgKGVjtTD++DAqDp2SK2uNgNK8+fLxl56MY+GAo/gHk6Hby881v05twahirlqLxKB7FwWSNp1LoQaLXJvmA490kEa4pskrIZl8aZNtuxO93VxxwSIbX3ZxDYTwFl+028P+7U3UdzF8qdBtI7uccVsJJsQgDd7+FTPrwP9tdWy/Q7HQE3n3qbsAT9u9uzq8W1O+LDsuyEqoKT8DhCTcvrvB6XvN+af4z4tdgtOkOt3SHJnxTtA5XaYqWBu+ONDWoxE6Srm9ub2Y3UNd/Afb0NJU=",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"}},b={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,l.jsx)(r(),{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)(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 deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.b6ccaf5d.js b/assets/js/a88a3db3.b6ccaf5d.js new file mode 100644 index 000000000..31ce73023 --- /dev/null +++ b/assets/js/a88a3db3.b6ccaf5d.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:()=>I,frontMatter:()=>x,metadata:()=>j,toc:()=>v});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),p=s(41429),m=s(5397),o=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:"eJy9Vm1v4zYM/isaP10BJXbaXof507q1uAUr1sOlw4C1QaHYdKyrLOkkOk0Q+L8P8kviNNfuBYd9SkyT4kM+5CNvgcTSQ3IPd1haJQg9zDkYi06QNHqaQQIZKiTsHYCDFU6USOhC5Ba0KBESWI+ElSMyT6iBg9SQQIEiQwccHH6ppMMMEnIVcvC0USHGy9KqcCSurTIZQpIL5YNDWmApINkCbWzjSU7qJdTBVTRBSYCpvVzq8Xq9XkPNd1Cow/oosx6KFVQAhwx96qQNtUEC0ytmckYFsj6CUSGIacTMMzJsgaytPvuWRXDIjSsFDcqq5+F8b4326EPEaRyHn0O8PQc9KOarNEXv80qpzXfAITWaUFOIFNYqmTYsRp99CN8eAzKLz5hSoNQFzkm2yVtzIP8Y+r79P62LU+HtL/Ys0NJBuqS3g07j07PRJB7F399NLpLzH5L3F+M4jv8EDutShdiOwyzMWs2BJKn9c33k1qQ9cOwsdXA+j8/faKM2xHJT6ewb9g6dM+7tHnwtfz2oQGolNT728/B4Hp8/XuwKen9c0FSvhJIZu/w4ZXdhAf/feobpqU1/TJRsnVp9OCh2aG+LPKzuqiF0v6KLDZteAYcSqTB7gWqEiQpIIOpdo+1ACWrg4NGtetmqnAoSRWR9EkWexFLq5UhYO+51RYmFH6emjISV0WoCYUk9ppWTtJmF9rUdGgrfvk/Cyl9xA/zv5TFULHVumuCuK7cW9UwuddPT1eRIue4K6Zn0zevMpFWJmhp+WW4cexHNFsJjxoxupC68DPaz8YR5i6nMu9EYswf9oGemRFZ5zCvFlNRPPnnQI3Z/m+cylUKxP3DhJeH8Xd+55+fno46dNDEfJBXVgjm0Zu++bIxNW4dRu4cT4EDoSn+bz9CtZIodS6+kihrnqBt4kTYDj6WQgd3O9OPLoDCASqaoPQ5G9PLDxxt2No6BD4bjH0CObqY/X/82uw6nhvFqKZqM43EcTNZ4KoUeJHptog843k0S4Zoiq4Rs9qZBtu1G/X531QGHZHjtzTkUxlNw2W4D/787VdfB/KVCt4Hkfs5hJZwUizBw91vIpA//s9319QLNTk/g3afuJjxh/+4G/WpB/b7osCwroarwBByecPPiKq/nNe+X5j8jfg1Gm+5wS3dowrdF63CZpmhp8O5IW4NK7KTp6vrm+u4a6vovP143rw==",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:"eJy9Vm1v4zYM/isaP10BJXbaXof507q1uAUr1sOlw4C1QaHYdKyrLOkkOk0Q+L8P8kviNNfuBYd9SkyT4kM+5CNvgcTSQ3IPd1haJQg9zDkYi06QNHqaQQIZKiTsHYCDFU6USOhC5Ba0KBESWI+ElSMyT6iBg9SQQIEiQwccHH6ppMMMEnIVcvC0USHGy9KqcCSurTIZQpIL5YNDWmApINkCbWzjSU7qJdTBVTRBSYCpvVzq8Xq9XkPNd1Cow/oosx6KFVQAhwx96qQNtUEC0ytmckYFsj6CUSGIacTMMzJsgaytPvuWRXDIjSsFDcqq5+F8b4326EPEaRyHn0O8PQc9KOarNEXv80qpzXfAITWaUFOIFNYqmTYsRp99CN8eAzKLz5hSoNQFzkm2yVtzIP8Y+r79P62LU+HtL/Ys0NJBuqS3g07j07PRJB7F399NLpLzH5L3F+M4jv8EDutShdiOwyzMWs2BJKn9c33k1qQ9cOwsdXA+j8/faKM2xHJT6ewb9g6dM+7tHnwtfz2oQGolNT728/B4Hp8/XuwKen9c0FSvhJIZu/w4ZXdhAf/feobpqU1/TJRsnVp9OCh2aG+LPKzuqiF0v6KLDZteAYcSqTB7gWqEiQpIIOpdo+1ACWrg4NGtetmqnAoSRWR9EkWexFLq5UhYO+51RYmFH6emjISV0WoCYUk9ppWTtJmF9rUdGgrfvk/Cyl9xA/zv5TFULHVumuCuK7cW9UwuddPT1eRIue4K6Zn0zevMpFWJmhp+WW4cexHNFsJjxoxupC68DPaz8YR5i6nMu9EYswf9oGemRFZ5zCvFlNRPPnnQI3Z/m+cylUKxP3DhJeH8Xd+55+fno46dNDEfJBXVgjm0Zu++bIxNW4dRu4cT4EDoSn+bz9CtZIodS6+kihrnqBt4kTYDj6WQgd3O9OPLoDCASqaoPQ5G9PLDxxt2No6BD4bjH0CObqY/X/82uw6nhvFqKZqM43EcTNZ4KoUeJHptog843k0S4Zoiq4Rs9qZBtu1G/X531QGHZHjtzTkUxlNw2W4D/787VdfB/KVCt4Hkfs5hJZwUizBw91vIpA//s9319QLNTk/g3afuJjxh/+4G/WpB/b7osCwroarwBByecPPiKq/nNe+X5j8jfg1Gm+5wS3dowrdF63CZpmhp8O5IW4NK7KTp6vrm+u4a6vovP143rw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details: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)(p.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("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 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)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function I(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.11f0e461.js b/assets/js/bbdfc22d.11f0e461.js new file mode 100644 index 000000000..f9ae2609b --- /dev/null +++ b/assets/js/bbdfc22d.11f0e461.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:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>g,toc:()=>j});var t=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),n=a.n(r),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=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:"eJztVt1P4zgQ/1d887Sg0JbdvZc8LcshhA4BoqB7KBVyk2licGxjO/24Kv/7aZykTVtgQdrH44VmPJ8/z/w8K/A8cxCP4A4LI7lHB+MIUnSJFcYLrSCGuxxZe8xOLXKSs5ObC8al1HPHSofWMa9ZQofIktJ5XYh/+UQi863jiM1zkeTMoZ0h445NZInGCuUdm2rLMlRouRcqY6lOygLpYC58zozFFKdCYcqct2XiS4uux+6NVsyVSYLOTUu5jlSnIbSKmM8xJGrRl1Y5xlmpxEuJ7PCw1b5IDw+Zz7lnCVdsglRNSsU0+WAnmwmnM62CX2cwEVNByo2rHkSgTShCq4sUYqgBac8hAsMtL9CjJdBXoHiBEMPiiBtx5PUzKohAEOg58hQtRGDxpRQWU4i9LTEC55eSbJwojCSXuDBSpwjxlEtHCkmOBYd4BX5pgqa3QmVQkSoPRjGlqZzIVG+xWCygGtdx0PmfOl2SbaKVR+XpJzdGiiQU1X9y1BKr/SB68oSJpwotQeAFOjq9CgXuphLBVNuC+65kk5sLP9aoUuJX2n/azY1E7pBZnAmcM65SRgUznwu3vlLy/Ve32T8XYt1x3YGpIri/vfysq9x74+J+f6lLKwqeYS/RBfmipEO7rP1xa/myazyCJ40/soILGawieNK56gjGESwKSS6ahmudRjC33Ji2u6oIhMfCvZb8JlUK1nw14V53XkXghZdboopQkClaGo/PIbR4chN+fM4XN8HNdsydQeuE3j2pyNiiM1q5uke/Dgb0b4f0tsiEmGdNNHL5B0S/a0Bq8RYaqiwmaKmG0sr3r6LtmkZS2vq+q079Qkmh8LGt+PHrYPD4vYHh++DP/cov1IxLkQbevCNK+o3VorXavl9SN7yvw+9ft6iVasbcKrYrr4ss0OeayNhoFzLiPocY+nvcHB6mhpgD8mt4neeZUNkRN6bXMqfkE0dg97kR/dlx4FCHSWmFXw4JjrriLrV3RtiIv5Fm+JcPAFVAKN9u6Pmsxaql1z3GbAnzYxy4Q4Gvs1pDam/wVIemPkJGGwrYmmqqfKoDTM19XhtUQ8qYumF2DPuriXBMuHDc1lOvJ7RR7FhvP990SPJvveP2Ka+busce1IMa6iKsArRYSKGeXfygjtjoejoVieCS/YMTJzyOv7SAzOfzvd44CDbnwuflhFk0eqOeBWFooK7V+uMAIvBoC3c9HaKdiaQd9zdC9YNyvxlVnoRRRQKdOLAW/dg1IsilSFA57AzXyfnNJfvWG0DUGYMPpNy/vDg9uxqekVcapPqKjnuD3oBENH4FV51Ap/W62GnbdPstXrPO/zvoZ3bQhmQ8LnzfSC5U5y2p2W+0+yyOI8iJHuMRrFYU4t7KqiLxS4l2CfFoHMGMW0F40lcVtQxFdJkKRwfpegl98yK/3Db77AF7K9NnXO5R4ozLkjShilaNwmnt8+iOfGw09p6njcVJkqDx7+qOO+/FzfXwDiKYNBtxEZZssHxOWzmfQwwP8ABh5ycPge6DfAWSq6zkWdiWgl/6+w9TC68L",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",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:"eJztVt1P4zgQ/1d887Sg0JbdvZc8LcshhA4BoqB7KBVyk2licGxjO/24Kv/7aZykTVtgQdrH44VmPJ8/z/w8K/A8cxCP4A4LI7lHB+MIUnSJFcYLrSCGuxxZe8xOLXKSs5ObC8al1HPHSofWMa9ZQofIktJ5XYh/+UQi863jiM1zkeTMoZ0h445NZInGCuUdm2rLMlRouRcqY6lOygLpYC58zozFFKdCYcqct2XiS4uux+6NVsyVSYLOTUu5jlSnIbSKmM8xJGrRl1Y5xlmpxEuJ7PCw1b5IDw+Zz7lnCVdsglRNSsU0+WAnmwmnM62CX2cwEVNByo2rHkSgTShCq4sUYqgBac8hAsMtL9CjJdBXoHiBEMPiiBtx5PUzKohAEOg58hQtRGDxpRQWU4i9LTEC55eSbJwojCSXuDBSpwjxlEtHCkmOBYd4BX5pgqa3QmVQkSoPRjGlqZzIVG+xWCygGtdx0PmfOl2SbaKVR+XpJzdGiiQU1X9y1BKr/SB68oSJpwotQeAFOjq9CgXuphLBVNuC+65kk5sLP9aoUuJX2n/azY1E7pBZnAmcM65SRgUznwu3vlLy/Ve32T8XYt1x3YGpIri/vfysq9x74+J+f6lLKwqeYS/RBfmipEO7rP1xa/myazyCJ40/soILGawieNK56gjGESwKSS6ahmudRjC33Ji2u6oIhMfCvZb8JlUK1nw14V53XkXghZdboopQkClaGo/PIbR4chN+fM4XN8HNdsydQeuE3j2pyNiiM1q5uke/Dgb0b4f0tsiEmGdNNHL5B0S/a0Bq8RYaqiwmaKmG0sr3r6LtmkZS2vq+q079Qkmh8LGt+PHrYPD4vYHh++DP/cov1IxLkQbevCNK+o3VorXavl9SN7yvw+9ft6iVasbcKrYrr4ss0OeayNhoFzLiPocY+nvcHB6mhpgD8mt4neeZUNkRN6bXMqfkE0dg97kR/dlx4FCHSWmFXw4JjrriLrV3RtiIv5Fm+JcPAFVAKN9u6Pmsxaql1z3GbAnzYxy4Q4Gvs1pDam/wVIemPkJGGwrYmmqqfKoDTM19XhtUQ8qYumF2DPuriXBMuHDc1lOvJ7RR7FhvP990SPJvveP2Ka+busce1IMa6iKsArRYSKGeXfygjtjoejoVieCS/YMTJzyOv7SAzOfzvd44CDbnwuflhFk0eqOeBWFooK7V+uMAIvBoC3c9HaKdiaQd9zdC9YNyvxlVnoRRRQKdOLAW/dg1IsilSFA57AzXyfnNJfvWG0DUGYMPpNy/vDg9uxqekVcapPqKjnuD3oBENH4FV51Ap/W62GnbdPstXrPO/zvoZ3bQhmQ8LnzfSC5U5y2p2W+0+yyOI8iJHuMRrFYU4t7KqiLxS4l2CfFoHMGMW0F40lcVtQxFdJkKRwfpegl98yK/3Db77AF7K9NnXO5R4ozLkjShilaNwmnt8+iOfGw09p6njcVJkqDx7+qOO+/FzfXwDiKYNBtxEZZssHxOWzmfQwwP8ABh5ycPge6DfAWSq6zkWdiWgl/6+w9TC68L",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"}},f={},j=[{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)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\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)(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)(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)(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)(p.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(d.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)(c.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\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)(p.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper: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/bbdfc22d.37245826.js b/assets/js/bbdfc22d.37245826.js deleted file mode 100644 index 04d8274ea..000000000 --- a/assets/js/bbdfc22d.37245826.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:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var t=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=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:"eJztVktPIzkQ/iveOg3IJGFm9tKnYVmE0CJAE9AeIEJOdyVtcNvGduexUf/3Vbm7k04CLEhzXC6ky/X8XPW5VhDE1ENyD7dYWCUCehhxyNCnTtogjYYEbnNk7TE7dShIzk5uLphQysw9Kz06z4JhKR0iS0sfTCH/EWOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PXZnjWa+TFP0flKqdaQ6DWk0ZyHHmKjDUDrtmWClli8lssPDVvsiOzxkIReBpUKzMVI1GRXT5IOdbMaCzoyOfr3FVE4kKTeuesDB2FiE0RcZJFAD0p4DByucKDCgI9BXoEWBkMDiSFh5FMwzauAgCfQcRYYOODh8KaXDDJLgSuTgw1KRjZeFVeQSF1aZDCGZCOVJIc2xEJCsICxt1AxO6ilUpCqiUUJpai+nurdYLBZQjeo46MMfJluSbWp0QB3op7BWyTQW1X/y1BKr/SBm/IRpoAodQRAkejq9igXupsJhYlwhQleyyc3HH2tUKfErEz7t5kah8MgcziTOmdAZo4JZyKVfXyn5/rPb7J8Lse647sBUHO5+Xn7WVR6C9Um/vzSlk4WYYi81BfmipGO7rP0J58Sya3wPTwZ/TAshVbTi8GRy3RGMOCwKRS6ahmudcpg7YW3bXRUHGbDwryW/SZWCNV9NuNedVxyCDGpLVBEKKkNH4/E5hBZPfiyOz8XiJrrZjrkzaJ3QuycVGTv01mhf9+jXwYD+7ZDeFpkQ86yJRi1/A/6rBqQWb6Ghy2KMjmoonXr/KtquaSSlq++76tQvtZIaH9uKH78OBo/fGxi+D37fr/xCz4SSWeTNW6KkX1gtOmfc+yV1w4c6/P51y1qpZsytYrvyusgCQ26IjK3xMSMRckigv8fN8WFqiDkiv4ZXWNtrGVOJsSeQ+8LK/uw4cqfHtHQyLIcEQ11pl9I7o2vlX0iz+5/ET5kTuj83tHzWYtTS6h5TtkT5Me7bob7X2awhszf4qUNPHyGhzehvTTNVPjERpuYery3qIWVMXTA7hv2VRHomfTxu66nXEtokdqy3n206JPm33nH7hNfN3GMP+kEPTRFXAFoolNTPPnnQR+z+ejKRqRSK/Y1jLwOOvrSAzOfzvd44iDbnMuTlmDm0ZqM+jcLYQF2r9ccBcAjoCn89GaKbybQd8zdC9aNyvxlRkcYRRQKduK8W/dg1IsiVTFF77AzVyfnNJfvWGwDvtP8HUu5fXpyeXQ3PyCsNUH1Fx71Bb0AiGrtC6E6g03pN7LRttv0Gr9nm/93zM7tnQzIBF6FvlZC684bUrHe/+xyOOOREi8k9rFYU4s6pqiLxS4luCcn9iMNMOEl40lfFW4Yimsykp4NsvXy+eZFffjZ77AF7K9NnXO5R4kyokjSh4qtG4bT2eXRLPjYae8/SxuIkTdGGd3VHnXfi5np4CxzGzSZcxOUanJjTNi7mkMADPEDc9clDpPsoX4ESelqKadySol/6+xfmSavx",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:"eJztVktPIzkQ/iveOg3IJGFm9tKnYVmE0CJAE9AeIEJOdyVtcNvGduexUf/3Vbm7k04CLEhzXC6ky/X8XPW5VhDE1ENyD7dYWCUCehhxyNCnTtogjYYEbnNk7TE7dShIzk5uLphQysw9Kz06z4JhKR0iS0sfTCH/EWOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PXZnjWa+TFP0flKqdaQ6DWk0ZyHHmKjDUDrtmWClli8lssPDVvsiOzxkIReBpUKzMVI1GRXT5IOdbMaCzoyOfr3FVE4kKTeuesDB2FiE0RcZJFAD0p4DByucKDCgI9BXoEWBkMDiSFh5FMwzauAgCfQcRYYOODh8KaXDDJLgSuTgw1KRjZeFVeQSF1aZDCGZCOVJIc2xEJCsICxt1AxO6ilUpCqiUUJpai+nurdYLBZQjeo46MMfJluSbWp0QB3op7BWyTQW1X/y1BKr/SBm/IRpoAodQRAkejq9igXupsJhYlwhQleyyc3HH2tUKfErEz7t5kah8MgcziTOmdAZo4JZyKVfXyn5/rPb7J8Lse647sBUHO5+Xn7WVR6C9Um/vzSlk4WYYi81BfmipGO7rP0J58Sya3wPTwZ/TAshVbTi8GRy3RGMOCwKRS6ahmudcpg7YW3bXRUHGbDwryW/SZWCNV9NuNedVxyCDGpLVBEKKkNH4/E5hBZPfiyOz8XiJrrZjrkzaJ3QuycVGTv01mhf9+jXwYD+7ZDeFpkQ86yJRi1/A/6rBqQWb6Ghy2KMjmoonXr/KtquaSSlq++76tQvtZIaH9uKH78OBo/fGxi+D37fr/xCz4SSWeTNW6KkX1gtOmfc+yV1w4c6/P51y1qpZsytYrvyusgCQ26IjK3xMSMRckigv8fN8WFqiDkiv4ZXWNtrGVOJsSeQ+8LK/uw4cqfHtHQyLIcEQ11pl9I7o2vlX0iz+5/ET5kTuj83tHzWYtTS6h5TtkT5Me7bob7X2awhszf4qUNPHyGhzehvTTNVPjERpuYery3qIWVMXTA7hv2VRHomfTxu66nXEtokdqy3n206JPm33nH7hNfN3GMP+kEPTRFXAFoolNTPPnnQR+z+ejKRqRSK/Y1jLwOOvrSAzOfzvd44iDbnMuTlmDm0ZqM+jcLYQF2r9ccBcAjoCn89GaKbybQd8zdC9aNyvxlRkcYRRQKduK8W/dg1IsiVTFF77AzVyfnNJfvWGwDvtP8HUu5fXpyeXQ3PyCsNUH1Fx71Bb0AiGrtC6E6g03pN7LRttv0Gr9nm/93zM7tnQzIBF6FvlZC684bUrHe/+xyOOOREi8k9rFYU4s6pqiLxS4luCcn9iMNMOEl40lfFW4Yimsykp4NsvXy+eZFffjZ77AF7K9NnXO5R4kyokjSh4qtG4bT2eXRLPjYae8/SxuIkTdGGd3VHnXfi5np4CxzGzSZcxOUanJjTNi7mkMADPEDc9clDpPsoX4ESelqKadySol/6+xfmSavx",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"}},y={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\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)(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)(l.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)(p.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(d.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)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\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)(p.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.900b9b57.js b/assets/js/bfe4b778.900b9b57.js new file mode 100644 index 000000000..b261a5d10 --- /dev/null +++ b/assets/js/bfe4b778.900b9b57.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>b,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),d=a.n(t),r=(a(82723),a(9487)),m=a(41429),o=a(5397),c=a(4667),p=a(9472),h=a(85162);const u={id:"update-document",title:"Update document by ID",description:"Update document by ID",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZadtMX0aWmTtcGKxGgSDFhiGJR0splSJEtSfoGh/z6cZNly7KRNEWz+ZFF3vOe5d63A84mD6A7OdFLkqLyDUQDaoOVeaHWRQgSFSbnHRgACMNzyHD1a0lyB4jlCBIsON6Lj9TdUEIBQEMEUeYoWArD4vRAWU4i8LTAA55eSdJzIjUQIABdG6hQhyrh0JJBMMecQrcAvTSXprVATKEmUV0oRwVROTFR3sVgsoAw2UNI11rFIGyiG+ykEkKJLrDDEDSK4OGM6Y36KrNFgfso9U4ipY16zGFnNPn1NEgFk2ubct2iVo/p+dP6DTpekswvVWD0TKbIYpZ6zTQQIZI2QecyN5B4dO+KeSeTOM62wJdsQeAMBJFp5ima0Am6MFEkV796DI2urfeg6fsCkCr6l7PACHb29rBz+Y4LtsLnqz8blFNNL7V98zZAoIrM4EzhnXKWMcoH5qXA7d5+1/fgyE5usaMeiDOBPLVO0VBwvu+/Dg4v5IJ7qIZRlAF74HTPjVt6OY0qDsiQ5i85o5WqPD8JwPzua4myylbkiSdC5rJBy+dvrhbs+Pkx8S5O7dPDZDU8+G3LWGtKpf15pEA6OO/2wE76/6b+LTn6P3r7rhmH4DwSwyCXpNsXNPULbe9Vz60AoKRSOG6+NB2E4HqxdeXLIe+tMakpsxqVIWSZQpoxsuld0IFqr7S9m+jP4nqNPlBvyJ8+kjtKeZbpQ6f9N9xCi5wmejE82FN/uU7xQtctOhxfshubTf8Fwy6dt3tfmCepuVotaqB6fO2Tb5zXJXXa3dfvf9Kp4yS7OIIAc/VTT/DZFPbT9FCLoNXK9VavblBCAQztrRnphJY1v742Lej3n+USoSYcb021mruSx6yY673EjerM+0ABzmBRW+OU1+a52T3sp2DqJG/EXLiH48epAdCkkX7ez8bxxbDN99gZKM09+bkQ8mhCHm3675++0cYKb6YrbOmJXBtU1maF4z/p7S8cNWReuet3YqnKPZdqyR9os5g5TplW1pdBLOj/u9pkzmIhsnbZddq/u1bXOkRUOs0IyKdQ3F92rDru7yjKRCC7Z3xg74XF01AR2Pp/vBfRNpfNJ+GkRM4tGb8Un1WEV9bbW5oH2Co82d1fZNdqZSHCdRE+Y6lXCvXUx8qQqRsy5oORbH/3xWIlcLkWCymGrfE4/Db+w424IQSt3fwJy78vFx/PL63O6lbK/DlG/G3ZDOjLa+ZyrlqGnqi09uGV4XPiekVxUNV0hW60r8Q5aGRi1N9ZRAFPtPImsVhT/WyvLko6/F2iXEN2NAphxK3hMCXe3glQ4+p9uNs9HaDa9Do6+Njsge9nye5BQU86KannGZUFPEMA3XD7awstRGTQ1/cuIn4JRm9ttIhs09FlQC3ys7+zc0B1bib3uv9U4TRI0/lnZUavRDm9vIIB4vb/n1acAWD6nbwc+hwju4Z7coyuaVX+szlcguZoUfELy9bX0+xeBQbCs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update document by ID",description:"Update document by ID",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update document by ID",description:"Update document by ID",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZadtMX0aWmTtcGKxGgSDFhiGJR0splSJEtSfoGh/z6cZNly7KRNEWz+ZFF3vOe5d63A84mD6A7OdFLkqLyDUQDaoOVeaHWRQgSFSbnHRgACMNzyHD1a0lyB4jlCBIsON6Lj9TdUEIBQEMEUeYoWArD4vRAWU4i8LTAA55eSdJzIjUQIABdG6hQhyrh0JJBMMecQrcAvTSXprVATKEmUV0oRwVROTFR3sVgsoAw2UNI11rFIGyiG+ykEkKJLrDDEDSK4OGM6Y36KrNFgfso9U4ipY16zGFnNPn1NEgFk2ubct2iVo/p+dP6DTpekswvVWD0TKbIYpZ6zTQQIZI2QecyN5B4dO+KeSeTOM62wJdsQeAMBJFp5ima0Am6MFEkV796DI2urfeg6fsCkCr6l7PACHb29rBz+Y4LtsLnqz8blFNNL7V98zZAoIrM4EzhnXKWMcoH5qXA7d5+1/fgyE5usaMeiDOBPLVO0VBwvu+/Dg4v5IJ7qIZRlAF74HTPjVt6OY0qDsiQ5i85o5WqPD8JwPzua4myylbkiSdC5rJBy+dvrhbs+Pkx8S5O7dPDZDU8+G3LWGtKpf15pEA6OO/2wE76/6b+LTn6P3r7rhmH4DwSwyCXpNsXNPULbe9Vz60AoKRSOG6+NB2E4HqxdeXLIe+tMakpsxqVIWSZQpoxsuld0IFqr7S9m+jP4nqNPlBvyJ8+kjtKeZbpQ6f9N9xCi5wmejE82FN/uU7xQtctOhxfshubTf8Fwy6dt3tfmCepuVotaqB6fO2Tb5zXJXXa3dfvf9Kp4yS7OIIAc/VTT/DZFPbT9FCLoNXK9VavblBCAQztrRnphJY1v742Lej3n+USoSYcb021mruSx6yY673EjerM+0ABzmBRW+OU1+a52T3sp2DqJG/EXLiH48epAdCkkX7ez8bxxbDN99gZKM09+bkQ8mhCHm3675++0cYKb6YrbOmJXBtU1maF4z/p7S8cNWReuet3YqnKPZdqyR9os5g5TplW1pdBLOj/u9pkzmIhsnbZddq/u1bXOkRUOs0IyKdQ3F92rDru7yjKRCC7Z3xg74XF01AR2Pp/vBfRNpfNJ+GkRM4tGb8Un1WEV9bbW5oH2Co82d1fZNdqZSHCdRE+Y6lXCvXUx8qQqRsy5oORbH/3xWIlcLkWCymGrfE4/Db+w424IQSt3fwJy78vFx/PL63O6lbK/DlG/G3ZDOjLa+ZyrlqGnqi09uGV4XPiekVxUNV0hW60r8Q5aGRi1N9ZRAFPtPImsVhT/WyvLko6/F2iXEN2NAphxK3hMCXe3glQ4+p9uNs9HaDa9Do6+Njsge9nye5BQU86KannGZUFPEMA3XD7awstRGTQ1/cuIn4JRm9ttIhs09FlQC3ys7+zc0B1bib3uv9U4TRI0/lnZUavRDm9vIIB4vb/n1acAWD6nbwc+hwju4Z7coyuaVX+szlcguZoUfELy9bX0+xeBQbCs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},b={},y=[{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:"Update document by ID"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"Update document by 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)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(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)(r.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"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(s.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(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 updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(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)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function 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 diff --git a/assets/js/bfe4b778.bf29690d.js b/assets/js/bfe4b778.bf29690d.js deleted file mode 100644 index b738784c7..000000000 --- a/assets/js/bfe4b778.bf29690d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),i=s(58219),t=(s(62316),s(51039)),d=s.n(t),r=(s(82723),s(9487)),m=s(41429),o=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update document by ID",description:"Update document by ID",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoBxZadtMX0aWmTtcGKxGgSDFhiGJR0splSJEtSfoGh/z6cZNly7LhNEWz+ZFF3vOe5dy3B87GD6B7OdVLkqLyDYQDaoOVeaHWZQgSFSbnHRgACMNzyHD1a0lyC4jlCBPNjbsSx199QQQBCQQQT5ClaCMDi90JYTCHytsAAnF9I0nEiNxIhAJwbqVOEKOPSkUAywZxDtAS/MJWkt0KNoSRRXilFBFM5MVad+Xw+hzJYQ0lXWEcibaAY7icQQIouscIQN4jg8pzpjPkJskaD+Qn3TCGmjnnNYmQ1+/Q1SQSQaZtz36JVDuv70fkPOl2QzjZUY/VUpMhilHrG1hEgkDVC5jE3knt07Ih7JpE7z7TClmxD4A0EkGjlKZrRErgxUiRVvLuPjqwtd6Hr+BGTKviWssMLdPT2qnL4jwm2w+aqP2uXU0yvtH/xNQOiiMziVOCMcZUyygXmJ8Jt3X3e9uPLTKyzoh2LMoA/tUzRUnG87L4Pjy7m/XiiB1CWAXjht8yMWnk7iikNypLkLDqjlas93g/D3exoirPJVuaKJEHnskLKxW+vF+76eD/xDU3u0v5nNzj9bMhZK0hn/rBSP+yfHPfC4/D9be9ddPp79PZdJwzDfyCAeS5Jtylu7hHa3queWwdCSaFw1Hht1A/DUX/lytN93ltlUlNiUy5FyjKBMmVk072iA9FabX8x0w/gO0SfKDfkTw+kjtKeZbpQ6f9Ndx+iwwRPR6drim93KV6q2mVng0t2S/Ppv2C44dM272vzBHU7q0UtVI/PLbLt85rkNru7uv2ve1W8YJfnEECOfqJpfpuiHtp+AhF0G7nustVtSgjAoZ02I72wksa398ZF3S43ptPMWslj10l03uVGdKc9oMHlMCms8Isb8lntlvYysHEON+IvXEDw45WBaFIovm5m4kXj0Gbq7AySZo783Gh4Mhn2N/t2r99q3wQ30xW3VaSuDaobMkNxnvZ2lo1bsi5c9bqxVeUcy7RlT7RZzB2mTKtqO6GXdH7S6TFnMBHZKl077EE9qBudIyscZoVkUqhvLnpQx+z+OstEIrhkf2PshMfhURPQ2Wy2E9A3lc4n4SdFzCwavREfV4dV1Nta6wfaJzza3F1nN2inIsFV8jxjqlsJd1dFyJOqCDHngpJudfTHUyVyuRQJKoetsjn7NPjCTjohBK2c/QnI3S+XHy+ubi7oVsr6OkS9TtgJ6cho53OuWoaeq7J073bhce67RnJR1XKFbLmqwHtoZWDU3lSHAUy08ySyXFL876wsSzr+XqBdQHQ/DGDKreAxJdz9ElLh6H+63jifoFn3ODj62ux+7GVL715CTTkrquUplwU9QQDfcPFk+y6HZdDU9C8jfg5GbW67iazR0OdALfCxvvP4lu7YSOx0/Y3GWZKg8Qdlh60GO7i7hQDi1d6eV58AYPmMvhn4DCJ4gAdyj65oVv2xOl+C5Gpc8DHJ19fS718R7K2S",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update document by ID",description:"Update document by ID",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update document by ID",description:"Update document by ID",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoBxZadtMX0aWmTtcGKxGgSDFhiGJR0splSJEtSfoGh/z6cZNly7LhNEWz+ZFF3vOe5dy3B87GD6B7OdVLkqLyDYQDaoOVeaHWZQgSFSbnHRgACMNzyHD1a0lyC4jlCBPNjbsSx199QQQBCQQQT5ClaCMDi90JYTCHytsAAnF9I0nEiNxIhAJwbqVOEKOPSkUAywZxDtAS/MJWkt0KNoSRRXilFBFM5MVad+Xw+hzJYQ0lXWEcibaAY7icQQIouscIQN4jg8pzpjPkJskaD+Qn3TCGmjnnNYmQ1+/Q1SQSQaZtz36JVDuv70fkPOl2QzjZUY/VUpMhilHrG1hEgkDVC5jE3knt07Ih7JpE7z7TClmxD4A0EkGjlKZrRErgxUiRVvLuPjqwtd6Hr+BGTKviWssMLdPT2qnL4jwm2w+aqP2uXU0yvtH/xNQOiiMziVOCMcZUyygXmJ8Jt3X3e9uPLTKyzoh2LMoA/tUzRUnG87L4Pjy7m/XiiB1CWAXjht8yMWnk7iikNypLkLDqjlas93g/D3exoirPJVuaKJEHnskLKxW+vF+76eD/xDU3u0v5nNzj9bMhZK0hn/rBSP+yfHPfC4/D9be9ddPp79PZdJwzDfyCAeS5Jtylu7hHa3queWwdCSaFw1Hht1A/DUX/lytN93ltlUlNiUy5FyjKBMmVk072iA9FabX8x0w/gO0SfKDfkTw+kjtKeZbpQ6f9Ndx+iwwRPR6drim93KV6q2mVng0t2S/Ppv2C44dM272vzBHU7q0UtVI/PLbLt85rkNru7uv2ve1W8YJfnEECOfqJpfpuiHtp+AhF0G7nustVtSgjAoZ02I72wksa398ZF3S43ptPMWslj10l03uVGdKc9oMHlMCms8Isb8lntlvYysHEON+IvXEDw45WBaFIovm5m4kXj0Gbq7AySZo783Gh4Mhn2N/t2r99q3wQ30xW3VaSuDaobMkNxnvZ2lo1bsi5c9bqxVeUcy7RlT7RZzB2mTKtqO6GXdH7S6TFnMBHZKl077EE9qBudIyscZoVkUqhvLnpQx+z+OstEIrhkf2PshMfhURPQ2Wy2E9A3lc4n4SdFzCwavREfV4dV1Nta6wfaJzza3F1nN2inIsFV8jxjqlsJd1dFyJOqCDHngpJudfTHUyVyuRQJKoetsjn7NPjCTjohBK2c/QnI3S+XHy+ubi7oVsr6OkS9TtgJ6cho53OuWoaeq7J073bhce67RnJR1XKFbLmqwHtoZWDU3lSHAUy08ySyXFL876wsSzr+XqBdQHQ/DGDKreAxJdz9ElLh6H+63jifoFn3ODj62ux+7GVL715CTTkrquUplwU9QQDfcPFk+y6HZdDU9C8jfg5GbW67iazR0OdALfCxvvP4lu7YSOx0/Y3GWZKg8Qdlh60GO7i7hQDi1d6eV58AYPmMvhn4DCJ4gAdyj65oVv2xOl+C5Gpc8DHJ19fS718R7K2S",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},y={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update document by ID"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update document 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:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.1b07ddca.js b/assets/js/f0ff4a36.1b07ddca.js deleted file mode 100644 index 73f60fa8e..000000000 --- a/assets/js/f0ff4a36.1b07ddca.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var n=s(85893),l=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),d=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(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:"eJy9Vttu20YQ/ZXtPMUALVG2k6BEUdSoHVdNYAeVgwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiO7hQcZGjdBbGASRoYyO0E0pCBFfoGGdJwwABKI2G0+MwgQhm6Dpvmhueo0NDWkuQPEeIYHHMtTh26gklBCBIa4o8QQMBGPxcCIMJRM4UGIB1y4xkrMh1hhAALnSmEoRoyjNLDHGKOYeoBLfUntMZIWdQESv3QhFhlFbMZG+xWCygClZQWqwPImmhaO5S2PZaTR4xdsOEqSmLlXQ8dl8TbABTZXLuupQ1ev3LYJLGJ6meQFWNyazVSlq0pOgkDOnfJlxbxDFaOy0ytkoPBEDIKTFRCVzrTMT+of9oSajcRVd7TXk0pMaJ2mQbjEP9eHclnk5OJ+mnXyk7t8IR9TAV1v+g8iMV18odrEFnyC0yqoZ1FVcBvFMZVeCB2m40ypGYyb///ItdGDFHr0oc7ljqnLZRv99QCpP1YpWTtptneTiuR4Vsgh4NwfMNuNLAjeFLKneHuf1yuq99q+za37AGVRWAq1O67qrWNj3GBrnD5Nz9u66T8OT0eBAeh29vB2+is++j1296YRj+AQEs8oxk29blzvu3Mtp8Fzr5BnaqHbZOLW3HAaqKBM7Cs91WbUctk8qxqSpk8t3X61Q0Ru2tnXUc9tnv5lLITEh8aGfOw1l49nC6cuj1rkNDOeeZSNj5xyG7pRn/bf3pmne1+d1kiZqpXkEbznbptZMW48IIt/QbrLu6orsxTeMcXaqa1edXnkshgn6b+37Z2TEVkD4zbxdiYbJO73Ote+2myvjE0gTocy368wGQpRbJiKJVB2QDz7rBtXiP1OFfXLjkoJBT5YWbILQzzYdwPtjZhbepsExY/9z65tPJpsqwLWk24RYTpiRzKfpHop/2BsxqjMW0qYQeu5f3cqRyZIVF2luZkE82upfH7O5mOhWx4Bn7HSdWOBy/aiP2/Py8E7EjL3MlXFpMmEGt1uwzT/Rh7UqtPo4gAIcmtzfTEZq5iNvJ/IKpvmfuN/VNNwHVaM4FZbUh/bQtRPWWiRilxU5Fnl99/MBOeyEEnaL4D5D7H4Y/X16PLkkrlVWdokEv7IVE0sq6nMuOIbrf2qyxyZINL7YTXK67dffaayrM4cL1dcaFbx+PuGxK/w467FH3wBoHkCrriKUsqS4+mayqiPy5QEMNNg5gzo3gEyrEuxISYel3sjqgXgT66rfmFjti+2+1vcDbfpHULHOeFfQFATzhcus4rMZV0DbN/0b2Eoza3GaXrtDQtVoznMcxatd52xmlG/Po6vIWAuAFJaU7Gp78aGh+kC97o7CJpgZAfwnOXoEfqLHf4/LHFXv98qLA6uavuSkU46qq/gFblj3m",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:"eJy9Vttu20YQ/ZXtPMUALVG2k6BEUdSoHVdNYAeVgwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiO7hQcZGjdBbGASRoYyO0E0pCBFfoGGdJwwABKI2G0+MwgQhm6Dpvmhueo0NDWkuQPEeIYHHMtTh26gklBCBIa4o8QQMBGPxcCIMJRM4UGIB1y4xkrMh1hhAALnSmEoRoyjNLDHGKOYeoBLfUntMZIWdQESv3QhFhlFbMZG+xWCygClZQWqwPImmhaO5S2PZaTR4xdsOEqSmLlXQ8dl8TbABTZXLuupQ1ev3LYJLGJ6meQFWNyazVSlq0pOgkDOnfJlxbxDFaOy0ytkoPBEDIKTFRCVzrTMT+of9oSajcRVd7TXk0pMaJ2mQbjEP9eHclnk5OJ+mnXyk7t8IR9TAV1v+g8iMV18odrEFnyC0yqoZ1FVcBvFMZVeCB2m40ypGYyb///ItdGDFHr0oc7ljqnLZRv99QCpP1YpWTtptneTiuR4Vsgh4NwfMNuNLAjeFLKneHuf1yuq99q+za37AGVRWAq1O67qrWNj3GBrnD5Nz9u66T8OT0eBAeh29vB2+is++j1296YRj+AQEs8oxk29blzvu3Mtp8Fzr5BnaqHbZOLW3HAaqKBM7Cs91WbUctk8qxqSpk8t3X61Q0Ru2tnXUc9tnv5lLITEh8aGfOw1l49nC6cuj1rkNDOeeZSNj5xyG7pRn/bf3pmne1+d1kiZqpXkEbznbptZMW48IIt/QbrLu6orsxTeMcXaqa1edXnkshgn6b+37Z2TEVkD4zbxdiYbJO73Ote+2myvjE0gTocy368wGQpRbJiKJVB2QDz7rBtXiP1OFfXLjkoJBT5YWbILQzzYdwPtjZhbepsExY/9z65tPJpsqwLWk24RYTpiRzKfpHop/2BsxqjMW0qYQeu5f3cqRyZIVF2luZkE82upfH7O5mOhWx4Bn7HSdWOBy/aiP2/Py8E7EjL3MlXFpMmEGt1uwzT/Rh7UqtPo4gAIcmtzfTEZq5iNvJ/IKpvmfuN/VNNwHVaM4FZbUh/bQtRPWWiRilxU5Fnl99/MBOeyEEnaL4D5D7H4Y/X16PLkkrlVWdokEv7IVE0sq6nMuOIbrf2qyxyZINL7YTXK67dffaayrM4cL1dcaFbx+PuGxK/w467FH3wBoHkCrriKUsqS4+mayqiPy5QEMNNg5gzo3gEyrEuxISYel3sjqgXgT66rfmFjti+2+1vcDbfpHULHOeFfQFATzhcus4rMZV0DbN/0b2Eoza3GaXrtDQtVoznMcxatd52xmlG/Po6vIWAuAFJaU7Gp78aGh+kC97o7CJpgZAfwnOXoEfqLHf4/LHFXv98qLA6uavuSkU46qq/gFblj3m",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(a.p,{children:"Get a document"}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(o.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)(s,{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)(a.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.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,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(s,{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)(a.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,n.jsx)(c.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)(a.p,{children:"]"})})})]})]})}),(0,n.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(c.Z,{collapsible:!1,name:"error",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)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.37f7ec3b.js b/assets/js/f0ff4a36.37f7ec3b.js new file mode 100644 index 000000000..c749c00e0 --- /dev/null +++ b/assets/js/f0ff4a36.37f7ec3b.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:()=>v,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),d=(a(82723),a(9487)),m=a(41429),c=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:"eJy9Vttu20YQ/ZXtPMUAJVG2k6BEUdSoHVdNYAe1gwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiOzhXcZGjdBbGASRoYyO0E0pCBJfoGGdJwwABKI2G0+MogQhm6Dpvmhueo0NDWkuQPEeIYNHjWvScekIJAQjSmiJP0EAABj8XwmACkTMFBmDdMiMZK3KdIQSAC52pBCGa8swSQ5xiziEqwS2153RGyBlUxMq9UEQYpRUz2V8sFguoghWUFuuDSFoomrsUtr1Wk0eM3ShhaspiJR2P3dcEG8BUmZy7LmWNXv8ynKTxcaonUFVjMmu1khYtKToOQ/q3CdcWcYzWTouMrdIDARBySkxUAtc6E7F/GDxaEip30dVeUx4NqXGiNtkG41A/3l2Kp+OTSfrpV8rOrXBEPUyF9T+o/EjFlXIHa9AZcouMqmFdxVUA71RGFXigtmuN8kbM5N9//sXOjZijVyUOdyx1TttoMGgohcn6scpJ2/WzPBzXo0I2QY+G4PkGXGngxvAllbvD3H453Ve+VXbtb1iDqgrA1Sldd1Vrmx5jg9xhcub+XddxeHzSG4a98O3t8E10+n30+k0/DMM/IIBFnpFs27rcef9WRpvvQiffwE61w9appe04QFWRwGl4utuq7ahlUjk2VYVMvvt6nYrGqL21s47DPvvdXAqZCYkP7cx5OA1PH05WDr3edWgk5zwTCTv7OGK3NOO/rT9d8642v5ssUTPVK2jD2S69dtJiXBjhln6DdVdXdDemaZyjS1Wz+vzKcylEMGhzPyg7O6YC0mfm7UIsTNbpfev4TMhZj2vdbzdWxieWJsGAazGYD4EstohuKGp1YDZwrRtdi/dInf7FxUuOCjlVXrgJRjvbfCjnw52deJsKy4T1z62PPq1sqgzbkmYTbjFhSjKXon8k+kl/yKzGWEybiuize3kvb1SOrLBI+ysT8slG97LH7q6nUxELnrHfcWKFw/GrNnLPz887ETvyMpfCpcWEGdRqzT7zRB/WrtTq4wgCcGhyez29QTMXcTuhXzA18MyDps7pNqBazbmg7Dakn7aFqO4yEaO02KnMs8uPH9hJP4SgUxz/AfLgw+jni6ubC9JK5VWnaNgP+yGRtLIu57JjiO64NmtssmSj8+0El+uu3b36mgpzuHADnXHh28gjLpsWuIMOe9Q9tMYBpMo6YilLqotPJqsqIn8u0FCjjQOYcyP4hArxroREWPqdrA6pF4G++q25yY7Y/pttL/C2XyQ1y5xnBX1BAE+43DoSq3EVtE3zv5G9BKM2t9mlKzR0tdYMZ3GM2nXedkbqxly6vLiFAHhBSemOhic/Gpof5MveKGyiqQHQX4KzV+AHauz3uPxxxV6/vCiwuv1rbgrFuKqqfwBRxEEA",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:"eJy9Vttu20YQ/ZXtPMUAJVG2k6BEUdSoHVdNYAe1gwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiOzhXcZGjdBbGASRoYyO0E0pCBJfoGGdJwwABKI2G0+MogQhm6Dpvmhueo0NDWkuQPEeIYNHjWvScekIJAQjSmiJP0EAABj8XwmACkTMFBmDdMiMZK3KdIQSAC52pBCGa8swSQ5xiziEqwS2153RGyBlUxMq9UEQYpRUz2V8sFguoghWUFuuDSFoomrsUtr1Wk0eM3ShhaspiJR2P3dcEG8BUmZy7LmWNXv8ynKTxcaonUFVjMmu1khYtKToOQ/q3CdcWcYzWTouMrdIDARBySkxUAtc6E7F/GDxaEip30dVeUx4NqXGiNtkG41A/3l2Kp+OTSfrpV8rOrXBEPUyF9T+o/EjFlXIHa9AZcouMqmFdxVUA71RGFXigtmuN8kbM5N9//sXOjZijVyUOdyx1TttoMGgohcn6scpJ2/WzPBzXo0I2QY+G4PkGXGngxvAllbvD3H453Ve+VXbtb1iDqgrA1Sldd1Vrmx5jg9xhcub+XddxeHzSG4a98O3t8E10+n30+k0/DMM/IIBFnpFs27rcef9WRpvvQiffwE61w9appe04QFWRwGl4utuq7ahlUjk2VYVMvvt6nYrGqL21s47DPvvdXAqZCYkP7cx5OA1PH05WDr3edWgk5zwTCTv7OGK3NOO/rT9d8642v5ssUTPVK2jD2S69dtJiXBjhln6DdVdXdDemaZyjS1Wz+vzKcylEMGhzPyg7O6YC0mfm7UIsTNbpfev4TMhZj2vdbzdWxieWJsGAazGYD4EstohuKGp1YDZwrRtdi/dInf7FxUuOCjlVXrgJRjvbfCjnw52deJsKy4T1z62PPq1sqgzbkmYTbjFhSjKXon8k+kl/yKzGWEybiuize3kvb1SOrLBI+ysT8slG97LH7q6nUxELnrHfcWKFw/GrNnLPz887ETvyMpfCpcWEGdRqzT7zRB/WrtTq4wgCcGhyez29QTMXcTuhXzA18MyDps7pNqBazbmg7Dakn7aFqO4yEaO02KnMs8uPH9hJP4SgUxz/AfLgw+jni6ubC9JK5VWnaNgP+yGRtLIu57JjiO64NmtssmSj8+0El+uu3b36mgpzuHADnXHh28gjLpsWuIMOe9Q9tMYBpMo6YilLqotPJqsqIn8u0FCjjQOYcyP4hArxroREWPqdrA6pF4G++q25yY7Y/pttL/C2XyQ1y5xnBX1BAE+43DoSq3EVtE3zv5G9BKM2t9mlKzR0tdYMZ3GM2nXedkbqxly6vLiFAHhBSemOhic/Gpof5MveKGyiqQHQX4KzV+AHauz3uPxxxV6/vCiwuv1rbgrFuKqqfwBRxEEA",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"}},g={},y=[{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,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)(r(),{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)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,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)(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,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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.73929fb9.js b/assets/js/fa40969b.73929fb9.js deleted file mode 100644 index f9187a369..000000000 --- a/assets/js/fa40969b.73929fb9.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:()=>y,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV19v2zYQ/yoc+9IGsi3nT4cJw7CgTYOsRVMkKQYsMQJaOltsKJIhKceGobd9kn20fZLhKFGWY6dNiq5PfUms4/2/H++OS+rY1NLkkr5WaVmAdJaOIpqBTQ3XjitJE/rs2TMSjsnFQoNNruQZOMNhBoQRwa0jakKyoIKMmYWMKEncQsOVvJLDPtnZeW3YxLWabLKzcyUJIaS3ohGXM0eYAZKWxoB0YkG4JJmXtI650vZR3y7qO+dTyVxpgJzBbQn2cyoN3JbcAHE5kIUqDbFB2OvbQ30nsvfBqKkBa7/KS90Ie437qPGVKrQAB9lj9OVsBmQMIIkt0xSsnZRCLEja6rjjLidMiBBMtgqitnmANo/m2p891iI0/ExmPiSpiFByCoYw7wUfizpHL30NIRVcPjWgLEiNF74CpQXTv5I0okqDYYizk4wmdAougAhBRSOqmWEFODAI0iWVrACa0EyliCwaUY4A1czl9D5qL3Lw8FtHplPENMilEQ2JpIkzJUTUuoVA/ZZjzmlEYa6FyoAmEyYsMqQ5FIwmS+rtJ9Q6w+UUOWVZ4D3yUG3t0Yi2NTI1SL3TASpdxrbQHVpTnA4lpHJ1XasqahMz7zHNe07dgAzJyYFlYL5lsBWyMi+UYAElhtifz+dz2nFF8IK74MRtCWax5kOw0TgxUaboutC4eN8DWRZjMGseDOOOUXvD9XewGVcj1Gu1khYs8u7GMf5bh+DqHpMW577Q0oF0yM+0Fjz1B4NPFoWWmw6o8SdI/WUwqMbx2qQBWwrX4WPGMAyYOyjsl+VrMt67TTRjaphbw3db8TfH/GZ3b5x//ANzcsEdUp+mwvofeC1RxXvlnqxBC2AWfANsbzfqeqMEov2J2k41SJwm//79D3lt+Ay8Kv70wHLntE0Gg4ZSGtFPVYHaTu/k0/36pHwDRXl0z3fBry33e39DtjSurjVaVRF1dUlpyOt1sI2HqQHmIDt0n9e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSFQNrRy5nx8rdHmu9TZd7BTbbB1sHQ/D7TqZodL7MPXoQtc78bx9R6yVBHdj/c3u8EZaGUckcoRNmNcsLGAn75dOwBj1FaArZK13YPPBbUf718ftEEdbAZ1ImdM8IwcfjghFzh2vm9EXfOuNr9ZU14z1VNxLdguvQ7SQloa7hZ+2+hO0+RyhE2/AJerZlXx64nLaUIH3a1lsGzWkwqnP5hZWF5KIzotgmndD8NTsLHFRjFgmg9mQ4qWgifnmK06IWv+rPqA5m8BG8EXdwAMkMuJ8sJNEkLr8ymcDbesUdwSbv1xiNKXk0yUIfekO4t/Dv4Q6Xv9IbEaUj5pkNAnuE+eq8JvgjgeBZc3+KrokcvTyYSnnAnyJ4wtdzB6HjJ2d3e3kbEXXuaYu7wcEwNardinnujT2pVqP17QiDowhT2dnIOZ8TQ08AdMDTzzoME3Sz2+oWAcq9qQfr8vhHgTPAVpoYPIw+MP78heP6ZRBxSPcHnw7uTV0fvzI9SKsKpLNOzH/RhJWllXMNkxdAyurVr9ThsvyGp7Xiv1cnVvfzz5fjz5/rcnX9O2HMzdQAvGfU/212DZ9NNLeu8VmATIjiKaK+uQZblEyH00oqqQXG/72GYzbnGwrfb9G1h03iMzJkq0798qD/A2z4gV6wg/DEfe7TYevEnPz5rKvSCPeZFuTU5o9HLRdSo4G3JTjaoodPqv9vEhF2pT66NlLZM1w2Gagu5meWP+rw3R46MLGlFWYtG78+zGz7PmB8ayNQPr3tQO4F90Z6vArziN3sLit5a9PnlQoH0719yYilFVVf8BUqWQ2Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV19v2zYQ/yoc+9IGsi3nT4cJw7CgTYOsRVMkKQYsMQJaOltsKJIhKceGobd9kn20fZLhKFGWY6dNiq5PfUms4/2/H++OS+rY1NLkkr5WaVmAdJaOIpqBTQ3XjitJE/rs2TMSjsnFQoNNruQZOMNhBoQRwa0jakKyoIKMmYWMKEncQsOVvJLDPtnZeW3YxLWabLKzcyUJIaS3ohGXM0eYAZKWxoB0YkG4JJmXtI650vZR3y7qO+dTyVxpgJzBbQn2cyoN3JbcAHE5kIUqDbFB2OvbQ30nsvfBqKkBa7/KS90Ie437qPGVKrQAB9lj9OVsBmQMIIkt0xSsnZRCLEja6rjjLidMiBBMtgqitnmANo/m2p891iI0/ExmPiSpiFByCoYw7wUfizpHL30NIRVcPjWgLEiNF74CpQXTv5I0okqDYYizk4wmdAougAhBRSOqmWEFODAI0iWVrACa0EyliCwaUY4A1czl9D5qL3Lw8FtHplPENMilEQ2JpIkzJUTUuoVA/ZZjzmlEYa6FyoAmEyYsMqQ5FIwmS+rtJ9Q6w+UUOWVZ4D3yUG3t0Yi2NTI1SL3TASpdxrbQHVpTnA4lpHJ1XasqahMz7zHNe07dgAzJyYFlYL5lsBWyMi+UYAElhtifz+dz2nFF8IK74MRtCWax5kOw0TgxUaboutC4eN8DWRZjMGseDOOOUXvD9XewGVcj1Gu1khYs8u7GMf5bh+DqHpMW577Q0oF0yM+0Fjz1B4NPFoWWmw6o8SdI/WUwqMbx2qQBWwrX4WPGMAyYOyjsl+VrMt67TTRjaphbw3db8TfH/GZ3b5x//ANzcsEdUp+mwvofeC1RxXvlnqxBC2AWfANsbzfqeqMEov2J2k41SJwm//79D3lt+Ay8Kv70wHLntE0Gg4ZSGtFPVYHaTu/k0/36pHwDRXl0z3fBry33e39DtjSurjVaVRF1dUlpyOt1sI2HqQHmIDt0n9e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSFQNrRy5nx8rdHmu9TZd7BTbbB1sHQ/D7TqZodL7MPXoQtc78bx9R6yVBHdj/c3u8EZaGUckcoRNmNcsLGAn75dOwBj1FaArZK13YPPBbUf718ftEEdbAZ1ImdM8IwcfjghFzh2vm9EXfOuNr9ZU14z1VNxLdguvQ7SQloa7hZ+2+hO0+RyhE2/AJerZlXx64nLaUIH3a1lsGzWkwqnP5hZWF5KIzotgmndD8NTsLHFRjFgmg9mQ4qWgifnmK06IWv+rPqA5m8BG8EXdwAMkMuJ8sJNEkLr8ymcDbesUdwSbv1xiNKXk0yUIfekO4t/Dv4Q6Xv9IbEaUj5pkNAnuE+eq8JvgjgeBZc3+KrokcvTyYSnnAnyJ4wtdzB6HjJ2d3e3kbEXXuaYu7wcEwNardinnujT2pVqP17QiDowhT2dnIOZ8TQ08AdMDTzzoME3Sz2+oWAcq9qQfr8vhHgTPAVpoYPIw+MP78heP6ZRBxSPcHnw7uTV0fvzI9SKsKpLNOzH/RhJWllXMNkxdAyurVr9ThsvyGp7Xiv1cnVvfzz5fjz5/rcnX9O2HMzdQAvGfU/212DZ9NNLeu8VmATIjiKaK+uQZblEyH00oqqQXG/72GYzbnGwrfb9G1h03iMzJkq0798qD/A2z4gV6wg/DEfe7TYevEnPz5rKvSCPeZFuTU5o9HLRdSo4G3JTjaoodPqv9vEhF2pT66NlLZM1w2Gagu5meWP+rw3R46MLGlFWYtG78+zGz7PmB8ayNQPr3tQO4F90Z6vArziN3sLit5a9PnlQoH0719yYilFVVf8BUqWQ2Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},y={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.d78cd316.js b/assets/js/fa40969b.d78cd316.js new file mode 100644 index 000000000..777e8f66e --- /dev/null +++ b/assets/js/fa40969b.d78cd316.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var n=a(85893),l=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmQlGPD0N2eZI+2JxkOJcpy7LRJ0fWqN4lFnv/z8fwsqWNTS5NL+lqlZQHSWTqKaAY2NVw7riRN6LNnz0i4JhcLDTa5kmfgDIcZEEYEt46oCcmCCDJmFjKiJHELDVfySg77ZGfntWET10qyyc7OlSSEkN7qjLicOcIMkLQ0BqQTC8IlyTyndcyVto/ydlHeOZ9K5koD5AxuS7CfE2ngtuQGiMuBLFRpiA3MXt4eyjuRvQ9GTQ1Y+1VW6obZS9xHia9UoQU4yB4jL2czIGMASWyZpmDtpBRiQdJWxh13OWFCBGeylRO1zgPUeTTX/u6xGqGhZzLzLklFhJJTMIR5K/hY1DF66XMIqeDyqQ5lgWu88BkoLZj+laQRVRoMQ5ydZDShU3ABRAgqGlHNDCvAgUGQLqlkBdCEZipFZNGIcgSoZi6n91F7kYOH3zoynSKmQS6NaAgkTZwpIaLWLQTKtxxjTiMKcy1UBjSZMGGRIM2hYDRZUq8/odYZLqdIKcsC35GHaquPRrTNkalB6o0OUOkStonunDXJ6ZyEUK6ea1VFbWDmPaZ5z6kbkCE4ObAMzLd0tkJS5pkSTKBEF/vz+XxOO6YIXnAXjLgtwSzWbAg6GiMmyhRdExoT71sgy2IMZs2CYdxRam+4/g4642qEcq1W0oJF2t04xn/rEFy9Y9Li3CdaOpAO6ZnWgqf+YvDJItNy0wA1/gSpfwwGxTheqzRgS+E6dMwYhg5zB4X9Mn99jO9uE80YGubW8N1m/M0xv9ndG+cf/8CYXHCHp08TYf0PfJYo4r1yT5agBTALvgC2rxtlvVEC0f5EaacaJHaTf//+h7w2fAZeFH+6Y7lz2iaDQXNSGtFPVYHSTu/k0+36pHwBRX40z1fBr033e/9CthSurjZaVRF1dUppiOt10I2XqQHmIDt0n5e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSGQN5Ry5rx/rdLmu9TZd9BTbZB1sHQ/DrTqRodLrMPXoQpc78bx9R6SVBHdj/c3q8EZaGUckcoRNmNcsLGAn75dOQBj1FaArYK13YLPObUf718ftE4dbDp1ImdM8IwcfjghF9h2vq9HXfWuVr+ZU14T1V1xzdnuee2khbQ03C38tNHtpsnlCIt+AS5XzajixxOX04QOulPLYNmMJxV2fzCzMLyURnRKhHVsyuW0x7TuhyYq2NhiwRgwzQezIUWNwaJzjFodmDW7VvVA87eABeGLswA6yuVEeeYmGKEE+lDOhlvGKW4Jt/46eOvTSibKkHvcnQUgB3+J53v9IbEaUj5pENEnOFeeq8JPhNgmBZc3uF30yOXpZMJTzgT5E8aWOxg9D5G7u7vbiNgLz3PMXV6OiQGtVuRTf+jD2uVqP17QiDowhT2dnIOZ8TQU8gdUDTzxoME5Sz3OoWAcs9sc/X6fCXEneArSQgeZh8cf3pG9fkyjDjgeYfLg3cmro/fnRygV4VWnaNiP+zEeaWVdwWRH0TG4Nmv1vjZekNUUvZbq5er9/lj9fqx+/9vq15QtB3M30IJxX5v9M1g2dfWS3tsGkwDZUURzZR2SLJcIuY9GVBUe11M/ltuMW2xwq7n/BhadvWTGRIn6/c7yAG2zTqxIR/hhONJu1/HgS3p+1mTuBXnMZro1OKHQy0XXqGBsiE01qqJQ6b/axodMqFWtt5a1SNYEh2kKuhvljTlgrZkeH13QiLISk97tZze+nzU/0JetEVi3pjYA/6I5Wxl+xW70Fha/teT1zYMM7Q5dU2MoRlVV/QfJ+pPz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmQlGPD0N2eZI+2JxkOJcpy7LRJ0fWqN4lFnv/z8fwsqWNTS5NL+lqlZQHSWTqKaAY2NVw7riRN6LNnz0i4JhcLDTa5kmfgDIcZEEYEt46oCcmCCDJmFjKiJHELDVfySg77ZGfntWET10qyyc7OlSSEkN7qjLicOcIMkLQ0BqQTC8IlyTyndcyVto/ydlHeOZ9K5koD5AxuS7CfE2ngtuQGiMuBLFRpiA3MXt4eyjuRvQ9GTQ1Y+1VW6obZS9xHia9UoQU4yB4jL2czIGMASWyZpmDtpBRiQdJWxh13OWFCBGeylRO1zgPUeTTX/u6xGqGhZzLzLklFhJJTMIR5K/hY1DF66XMIqeDyqQ5lgWu88BkoLZj+laQRVRoMQ5ydZDShU3ABRAgqGlHNDCvAgUGQLqlkBdCEZipFZNGIcgSoZi6n91F7kYOH3zoynSKmQS6NaAgkTZwpIaLWLQTKtxxjTiMKcy1UBjSZMGGRIM2hYDRZUq8/odYZLqdIKcsC35GHaquPRrTNkalB6o0OUOkStonunDXJ6ZyEUK6ea1VFbWDmPaZ5z6kbkCE4ObAMzLd0tkJS5pkSTKBEF/vz+XxOO6YIXnAXjLgtwSzWbAg6GiMmyhRdExoT71sgy2IMZs2CYdxRam+4/g4642qEcq1W0oJF2t04xn/rEFy9Y9Li3CdaOpAO6ZnWgqf+YvDJItNy0wA1/gSpfwwGxTheqzRgS+E6dMwYhg5zB4X9Mn99jO9uE80YGubW8N1m/M0xv9ndG+cf/8CYXHCHp08TYf0PfJYo4r1yT5agBTALvgC2rxtlvVEC0f5EaacaJHaTf//+h7w2fAZeFH+6Y7lz2iaDQXNSGtFPVYHSTu/k0+36pHwBRX40z1fBr033e/9CthSurjZaVRF1dUppiOt10I2XqQHmIDt0n5e1G+/u9YZxL/75Yvgy2f8lOXjZj+P4LxrReSGQN5Ry5rx/rdLmu9TZd9BTbZB1sHQ/DrTqRodLrMPXoQpc78bx9R6SVBHdj/c3q8EZaGUckcoRNmNcsLGAn75dOQBj1FaArYK13YLPObUf718ftE4dbDp1ImdM8IwcfjghF9h2vq9HXfWuVr+ZU14T1V1xzdnuee2khbQ03C38tNHtpsnlCIt+AS5XzajixxOX04QOulPLYNmMJxV2fzCzMLyURnRKhHVsyuW0x7TuhyYq2NhiwRgwzQezIUWNwaJzjFodmDW7VvVA87eABeGLswA6yuVEeeYmGKEE+lDOhlvGKW4Jt/46eOvTSibKkHvcnQUgB3+J53v9IbEaUj5pENEnOFeeq8JPhNgmBZc3uF30yOXpZMJTzgT5E8aWOxg9D5G7u7vbiNgLz3PMXV6OiQGtVuRTf+jD2uVqP17QiDowhT2dnIOZ8TQU8gdUDTzxoME5Sz3OoWAcs9sc/X6fCXEneArSQgeZh8cf3pG9fkyjDjgeYfLg3cmro/fnRygV4VWnaNiP+zEeaWVdwWRH0TG4Nmv1vjZekNUUvZbq5er9/lj9fqx+/9vq15QtB3M30IJxX5v9M1g2dfWS3tsGkwDZUURzZR2SLJcIuY9GVBUe11M/ltuMW2xwq7n/BhadvWTGRIn6/c7yAG2zTqxIR/hhONJu1/HgS3p+1mTuBXnMZro1OKHQy0XXqGBsiE01qqJQ6b/axodMqFWtt5a1SNYEh2kKuhvljTlgrZkeH13QiLISk97tZze+nzU/0JetEVi3pjYA/6I5Wxl+xW70Fha/teT1zYMM7Q5dU2MoRlVV/QfJ+pPz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.64bbdf4f.js b/assets/js/runtime~main.89debd07.js similarity index 63% rename from assets/js/runtime~main.64bbdf4f.js rename to assets/js/runtime~main.89debd07.js index 51310617e..3344feb09 100644 --- a/assets/js/runtime~main.64bbdf4f.js +++ b/assets/js/runtime~main.89debd07.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,b,c,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=f,r.c=t,e=[],r.O=(a,d,b,c)=>{if(!d){var f=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,b,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var f={};a=a||[null,d({}),d([]),d(d)];for(var t=2&b&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(c,f),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"73e99a0e",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"73929fb9",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"1b07ddca",1359:"49fdcec2",1477:"b31b2642",1520:"164785f5",1531:"37245826",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"bf29690d",2245:"0602d8f8",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"bd1f8bd5",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:"b6d65080",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:"2e469c24",7971:"86c34487",8106:"ae92b574",8140:"901b2f91",8163:"2c528911",8468:"580fe438",8475:"d27b3009",8489:"c9060b90",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"bb79ab65",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},c="OpenSign-Docs:",r.l=(e,a,d,f)=>{if(b[e])b[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var b=r.o(e,a)?e[a]:void 0;if(0!==b)if(b)d.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>b=e[a]=[d,c]));d.push(b[2]=c);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,b[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var b,c,f=d[0],t=d[1],o=d[2],n=0;if(f.some((a=>0!==e[a]))){for(b in t)r.o(t,b)&&(r.m[b]=t[b]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,d,c,b,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=f,r.c=t,e=[],r.O=(a,d,c,b)=>{if(!d){var f=1/0;for(i=0;i=b)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,b0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[d,c,b]},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 b=Object.create(null);r.r(b);var f={};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=>f[a]=()=>e[a]));return f.default=()=>e,r.d(b,f),b},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"73e99a0e",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"d78cd316",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"37f7ec3b",1359:"49fdcec2",1477:"b31b2642",1520:"5dce35a3",1531:"11f0e461",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"900b9b57",2245:"87a05c5b",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"6dd96ce6",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:"ff3f50af",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:"b6ccaf5d",7971:"ace1ce06",8106:"96f0357e",8140:"901b2f91",8163:"652d37f8",8468:"296814e0",8475:"d27b3009",8489:"e9e2536a",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"879f33f5",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={},b="OpenSign-Docs:",r.l=(e,a,d,f)=>{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 b=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var 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 b=new Promise(((d,b)=>c=e[a]=[d,b]));d.push(c[2]=b);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var b=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+f+")",t.name="ChunkLoadError",t.type=b,t.request=f,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var c,b,f=d[0],t=d[1],o=d[2],n=0;if(f.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 d63b0f67b..602bc5a83 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 58f93de5f..b9ac8a610 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 a7e5b07eb..0443664af 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 db1d45b3d..b83837e84 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 c259618c7..acc782780 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 c9f292aa3..97abaf309 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 dbe204117..0efe3ec9b 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 cf9c31fe8..e20f9a9bd 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 239b0f7da..327f08f56 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 b90e564e7..a3dd94427 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 0e01bbf2e..189a7d7d5 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 7dacf57ba..573702add 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 4bc37f227..7fb4a283a 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 0b3f279f2..53724afd7 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 272f9ef27..d5b977696 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 6072b5279..3c1fae251 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 c0b06b3b2..50108b01c 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 fa9e9af12..84613dedb 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 6c136311f..3d693cc85 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 c54b931cc..12e5bb74f 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index d7aee603e..ff32f431f 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get document by ID | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index fd097c4f8..a760bec87 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™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index d8161152f..3eb7a52a0 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 a6241aeef..0f475f67a 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 bac2dc923..41ddb7434 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 756ce8f25..6b879edcd 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update document by ID | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 32a7c121c..6de09c385 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 af63fdefa..7618364bd 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 1b576c4c9..fe6d29fc1 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 c8018b322..5ec381b19 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 56682a92d..300eca6a0 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 20bc63846..1428af52d 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 45b6e5ad1..081e7a6c1 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 ab578acb1..279b00941 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 8042453f9..d64d40058 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 1e1112056..b36b84387 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 5e9be4da0..1295f0e55 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 83ce47e53..13c918987 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 f7fb58af8..5ee3c8026 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 83a46faf0..28e72cf81 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 60c00406d..b407066d8 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 e5b47a53a..9431229d9 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 608a433af..d9864822f 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 ef047ff66..3165f7b8f 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 b75ee9db9..028b56f75 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 cd415dab9..9af20be4c 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 488c851cd..a9e090833 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 47fd40de5..66e40a485 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 f63b7837f..ba80816f9 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +