diff --git a/404.html b/404.html index 5619d9996..fa286d567 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@ Page Not Found | OpenSign™ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/05632a52.56636457.js b/assets/js/05632a52.56636457.js deleted file mode 100644 index ecd947b6a..000000000 --- a/assets/js/05632a52.56636457.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),c=a.n(i),r=(a(82723),a(9487)),o=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kBxZId94s4SkMJudDShHOO+5CYsJJG1ibS7nZ35dgI/fdjVrItx07blKNgbHnnZZ95ezQNOL6wEN/BJyUdT52FeQAZ2tQI7YSSEMMCHeMs7eQQgNJoOMmusk66E2lueIUODblsQPIKIYbVKdfi1KknlBCAIJ8F8gwNBGDwWy0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisOcQNurb2mM0IuoCVV7o1igiitWMjRarVaQRtsofRQH0S2QaK5K+BlyCp5xNRdZUzlg8D/N6wB5MpU3A1PduD1X+OkSCeFTqBt53St1UpatORoEkX0sw/X1mmK1uZ1ybbFgcAHi9KRPte6FKkXhI+WjJpDdF3UVEZDbpzorkx9SFstWVeJL90W8SSKWg+zLt2P3W1y++a0FOOkWE0eNZX6qy/n2xw8KmQJIplfVFyUv2CfIH7sD0apqsjVTaHkm6FMx2fjif9A2wawqjyY/R7N0HFRWrrDCVcekwxEQpZC4sOmVx4mUfQwgbYlnWk0PeyZft6ZVI7lqpbZH7+xY6bRtA2gQmv54mjydqk6gvN7cU+j6SDu94dxX8klL0XGzm+u2C1R0u+N+/3Pxj3E6Tqch60iOqWOWveyMjzvsmExrY1wa8/MQ0qO7+ZEMxW6QvWM7qncFRBD2Pdc2OyoswXyZpYbmq9NSZTunLZxGHKtRxv+LXliaVBCrkW4HAPds8Exo6R2edtDs00K1+IzriH48WuEwhMyV964T8G1RjkTC+kTuBwfUPxtISwT1oszldYVSuerznJl2AtrlnCLGVOSuQK9kM7PRmNmNaYi7xtmxO7lvZypClltkei4FPLJxvfylN1d57lIBS/Zv5hY4XD+bpOx5+fng4ydeJtL4Yo6YQa12qkv/KFP69Bq++cEAnBoKnudz9AsRYp9dV65KvTKYT8G9KqLG8COITdHH18aUbeVIkVpcdCP55c3X9jZKIJg0BQ/ATn8cvXp4uvsgrxSW3UlGo+iUURHWllXcTm46BLd4MW8V9lmN80Hq0vfWQ5XLtQlF35oPNKmb/g72GnHg21hHkChrCOFpqFu+MeUbUvH32o0NFTzAJbcCJ5Q+901kAlLz9l2G3gV5bu/+8XihB1fPI7C3kyJpBFZ8rKmfxDAE673F5123gabSfllYK+h6G7bH80tGFq8OoXzNEXtBrIDmt2joMuLWwiA11SRIR88eT7oHyiWo0nYR9MBoG+Cc9TgT5rmz7j+sFXvJK8abNfXTptSMW/b9j9RcNhE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get contact",description:"get a contact",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kBxZId94s4SkMJudDShHOO+5CYsJJG1ibS7nZ35dgI/fdjVrItx07blKNgbHnnZZ95ezQNOL6wEN/BJyUdT52FeQAZ2tQI7YSSEMMCHeMs7eQQgNJoOMmusk66E2lueIUODblsQPIKIYbVKdfi1KknlBCAIJ8F8gwNBGDwWy0MZhA7U2MA1q1LsrGi0iVCALjSpcoQ4pyXlhTSAisOcQNurb2mM0IuoCVV7o1igiitWMjRarVaQRtsofRQH0S2QaK5K+BlyCp5xNRdZUzlg8D/N6wB5MpU3A1PduD1X+OkSCeFTqBt53St1UpatORoEkX0sw/X1mmK1uZ1ybbFgcAHi9KRPte6FKkXhI+WjJpDdF3UVEZDbpzorkx9SFstWVeJL90W8SSKWg+zLt2P3W1y++a0FOOkWE0eNZX6qy/n2xw8KmQJIplfVFyUv2CfIH7sD0apqsjVTaHkm6FMx2fjif9A2wawqjyY/R7N0HFRWrrDCVcekwxEQpZC4sOmVx4mUfQwgbYlnWk0PeyZft6ZVI7lqpbZH7+xY6bRtA2gQmv54mjydqk6gvN7cU+j6SDu94dxX8klL0XGzm+u2C1R0u+N+/3Pxj3E6Tqch60iOqWOWveyMjzvsmExrY1wa8/MQ0qO7+ZEMxW6QvWM7qncFRBD2Pdc2OyoswXyZpYbmq9NSZTunLZxGHKtRxv+LXliaVBCrkW4HAPds8Exo6R2edtDs00K1+IzriH48WuEwhMyV964T8G1RjkTC+kTuBwfUPxtISwT1oszldYVSuerznJl2AtrlnCLGVOSuQK9kM7PRmNmNaYi7xtmxO7lvZypClltkei4FPLJxvfylN1d57lIBS/Zv5hY4XD+bpOx5+fng4ydeJtL4Yo6YQa12qkv/KFP69Bq++cEAnBoKnudz9AsRYp9dV65KvTKYT8G9KqLG8COITdHH18aUbeVIkVpcdCP55c3X9jZKIJg0BQ/ATn8cvXp4uvsgrxSW3UlGo+iUURHWllXcTm46BLd4MW8V9lmN80Hq0vfWQ5XLtQlF35oPNKmb/g72GnHg21hHkChrCOFpqFu+MeUbUvH32o0NFTzAJbcCJ5Q+901kAlLz9l2G3gV5bu/+8XihB1fPI7C3kyJpBFZ8rKmfxDAE673F5123gabSfllYK+h6G7bH80tGFq8OoXzNEXtBrIDmt2joMuLWwiA11SRIR88eT7oHyiWo0nYR9MBoG+Cc9TgT5rmz7j+sFXvJK8abNfXTptSMW/b9j9RcNhE",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get contact"})}),"\n",(0,l.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(s.p,{children:"get a contact"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"contactdetails"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.b6d65080.js b/assets/js/05632a52.b6d65080.js new file mode 100644 index 000000000..d1a0821a1 --- /dev/null +++ b/assets/js/05632a52.b6d65080.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>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/1f73ca32.b4037d80.js b/assets/js/1f73ca32.b4037d80.js deleted file mode 100644 index 152a6d268..000000000 --- a/assets/js/1f73ca32.b4037d80.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-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:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"Get your details"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"user"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"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:"4567832123"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.bd1f8bd5.js b/assets/js/1f73ca32.bd1f8bd5.js new file mode 100644 index 000000000..c89bf5f95 --- /dev/null +++ b/assets/js/1f73ca32.bd1f8bd5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>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.5a3fe832.js b/assets/js/2c586be5.5a3fe832.js deleted file mode 100644 index a7e1b150a..000000000 --- a/assets/js/2c586be5.5a3fe832.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),c=a.n(i),r=(a(82723),a(9487)),d=a(41429),o=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocument",title:"Create document",description:"Create document",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create document"})}),"\n",(0,l.jsx)(c(),{method:"post",path:"/createdocument"}),"\n",(0,l.jsx)(s.p,{children:"Create document"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document created successfully!"}}),(0,l.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Document created successfully!",\n "result": {\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.bb79ab65.js b/assets/js/2c586be5.bb79ab65.js new file mode 100644 index 000000000..5584f3ee5 --- /dev/null +++ b/assets/js/2c586be5.bb79ab65.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:()=>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.96975bf8.js b/assets/js/377084eb.96975bf8.js deleted file mode 100644 index 65926fd94..000000000 --- a/assets/js/377084eb.96975bf8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),m=(s(82723),s(9487)),d=s(41429),c=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:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",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:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",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 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:"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)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\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 }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "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)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.ae92b574.js b/assets/js/377084eb.ae92b574.js new file mode 100644 index 000000000..a687afd63 --- /dev/null +++ b/assets/js/377084eb.ae92b574.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:()=>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.0d9e94c0.js b/assets/js/52d5c0f9.0d9e94c0.js deleted file mode 100644 index 52e8e0301..000000000 --- a/assets/js/52d5c0f9.0d9e94c0.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:()=>v,contentTitle:()=>j,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},v={},y=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete document by ID"})}),"\n",(0,l.jsx)(d(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a document"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document deleted successfully!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Document deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.580fe438.js b/assets/js/52d5c0f9.580fe438.js new file mode 100644 index 000000000..64a9749e6 --- /dev/null +++ b/assets/js/52d5c0f9.580fe438.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:()=>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 new file mode 100644 index 000000000..d661e40b8 --- /dev/null +++ b/assets/js/5a2de241.2c528911.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:()=>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.8057ae9d.js b/assets/js/5a2de241.8057ae9d.js deleted file mode 100644 index cd7460c1a..000000000 --- a/assets/js/5a2de241.8057ae9d.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-template",title:"Update template by ID",description:"Update template by ID",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:200}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template upated sucessfully"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}})})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template upated sucessfully",\n "result": {\n "objectId": "asd2HsP4Hp"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:400}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 400,\n "message": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:404}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.164785f5.js b/assets/js/770b40a9.164785f5.js new file mode 100644 index 000000000..ee4686ad8 --- /dev/null +++ b/assets/js/770b40a9.164785f5.js @@ -0,0 +1 @@ +"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.c48a19a9.js b/assets/js/770b40a9.c48a19a9.js deleted file mode 100644 index 8fa8dabe4..000000000 --- a/assets/js/770b40a9.c48a19a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),p=a(5397),o=a(4667),c=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYsvJ7kWnpos0DbpIgrWLHmwjoKSxzYQiuSTlDxj674uhPqzY27gtivpieziPM3zzZsg9eL50kExhgoWR3KODeQTaoOVeaHWfQwJL9L5ZlcJ5iMBwywv0aAm6B8ULhAS2l9yIS69fUUEEQkECK+Q5WojA4rdSWMwh8bbECJzfScI4URiJEAFujdQ5QrLg0pFDtsKCQ7IHvzPB01uhllCRKw+ghPJUTizVYLvdbqGa13HQ+V90viNsppVH5eknN0aKLJxq+OK0IttJEJ2+YBZOaIkDL9DRqhSF8D03VRZpONZC24L7vqVLbhRXEbhXYf4hLq6qCLaFJFhDLLGe0omqCLzw8q2tIoBFZ7RydbpXcUxfObrMCkMnJv7KLEPnFqVkXXkh+q8YykLtTg/aHesqjus0S9lnklvLd6QWj4U7H6Y2kyqPddHjtLMchLId/Zaqwl09BQFNag5PtzgAXPjBWt0T6kH7M6DWmyldQ37VkuT/LmgRfFgoNUHEudRW3huXDIdttNKhHWS6IPTjRp2L1yWZWeReHyKPxVKFjv63xXkIan0v9otGliJC1RNym89zG786bYB+GY5xtX9rFUoKhc9tOzxfxfHz6Lppko/xp9O+uFdrLkXObp7u2YRm10//Y1d8jD9VERToHF+e4a6fp6/zPCVK1E71DH5DS99es/GWhjv0ndpZM+YL9CtNN4DRzdj3K0hgeHQbOLTr9ioorexJlBszaGe05KkjmQ65EcP1KExrh1lphd+Nic+asv4l0lOiEb8jSfHsVUMnozJ9PVwEty2H3SAfxe1opqEk1EKHWA1ZjwYViTFQvR7BMVWTlXBMuLCc66wsUPmgD7bQlh2hWcod5kwr5lcYFsl+PRgxZzATi0ZaAzZTMzXWBbLSIQ1pKdSrS2bqkk0fFwuRCS7Zn5g64XH+oSV4s9mcEHwRMHfCr8qUWTT64L4MxlCFPqr7cwEReLSFe1yM0a5F1s6bvwg1DM7DpmF4FhoGCy5IBI3p52MQ6VKKDJXDnnJv7p6+sOtBDFFPQ38j5eGX+8+3D+Nb2pVUWJdoNIgHMZlIuQVXvUA/Evqb+nai87j1QyO5CK0Usto3PTCFNz0wj2BFLZJMYb+ngv9hZVWR+VuJdgfJdB7BmlvBU1LYdF5FrV6paXLhaCHvHj9H+XTTCD58bd5RF4xK9aM8X3F30iBrLkvyhCraNw6f6z0vJ7THweNk2h0QN1mGxr/rO+/NjKfH8QQiSJuXWBFGIVi+odcg30ACM5gB0GOTdgjNH+x7kFwtyzAQod6XPt8B9R2o0A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/gettemplatelist",title:"Get template list",description:"Get template list",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYsvJ7kWnpos0DbpIgrWLHmwjoKSxzYQiuSTlDxj674uhPqzY27gtivpieziPM3zzZsg9eL50kExhgoWR3KODeQTaoOVeaHWfQwJL9L5ZlcJ5iMBwywv0aAm6B8ULhAS2l9yIS69fUUEEQkECK+Q5WojA4rdSWMwh8bbECJzfScI4URiJEAFujdQ5QrLg0pFDtsKCQ7IHvzPB01uhllCRKw+ghPJUTizVYLvdbqGa13HQ+V90viNsppVH5eknN0aKLJxq+OK0IttJEJ2+YBZOaIkDL9DRqhSF8D03VRZpONZC24L7vqVLbhRXEbhXYf4hLq6qCLaFJFhDLLGe0omqCLzw8q2tIoBFZ7RydbpXcUxfObrMCkMnJv7KLEPnFqVkXXkh+q8YykLtTg/aHesqjus0S9lnklvLd6QWj4U7H6Y2kyqPddHjtLMchLId/Zaqwl09BQFNag5PtzgAXPjBWt0T6kH7M6DWmyldQ37VkuT/LmgRfFgoNUHEudRW3huXDIdttNKhHWS6IPTjRp2L1yWZWeReHyKPxVKFjv63xXkIan0v9otGliJC1RNym89zG786bYB+GY5xtX9rFUoKhc9tOzxfxfHz6Lppko/xp9O+uFdrLkXObp7u2YRm10//Y1d8jD9VERToHF+e4a6fp6/zPCVK1E71DH5DS99es/GWhjv0ndpZM+YL9CtNN4DRzdj3K0hgeHQbOLTr9ioorexJlBszaGe05KkjmQ65EcP1KExrh1lphd+Nic+asv4l0lOiEb8jSfHsVUMnozJ9PVwEty2H3SAfxe1opqEk1EKHWA1ZjwYViTFQvR7BMVWTlXBMuLCc66wsUPmgD7bQlh2hWcod5kwr5lcYFsl+PRgxZzATi0ZaAzZTMzXWBbLSIQ1pKdSrS2bqkk0fFwuRCS7Zn5g64XH+oSV4s9mcEHwRMHfCr8qUWTT64L4MxlCFPqr7cwEReLSFe1yM0a5F1s6bvwg1DM7DpmF4FhoGCy5IBI3p52MQ6VKKDJXDnnJv7p6+sOtBDFFPQ38j5eGX+8+3D+Nb2pVUWJdoNIgHMZlIuQVXvUA/Evqb+nai87j1QyO5CK0Usto3PTCFNz0wj2BFLZJMYb+ngv9hZVWR+VuJdgfJdB7BmlvBU1LYdF5FrV6paXLhaCHvHj9H+XTTCD58bd5RF4xK9aM8X3F30iBrLkvyhCraNw6f6z0vJ7THweNk2h0QN1mGxr/rO+/NjKfH8QQiSJuXWBFGIVi+odcg30ACM5gB0GOTdgjNH+x7kFwtyzAQod6XPt8B9R2o0A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"Get template list"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"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)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe 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)("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)(p.Z,{responseExample:'{\n "code": 200,\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 }\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)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.04f4277f.js b/assets/js/7b076186.04f4277f.js deleted file mode 100644 index 12ba2eafb..000000000 --- a/assets/js/7b076186.04f4277f.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:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var l=s(85893),t=s(11151),n=s(58219),c=(s(62316),s(51039)),i=s.n(c),d=(s(82723),s(9487)),r=s(41429),o=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu2zgQ/RXuPDWAYimO+yIsFg3aoAgabIJ1FvuQGAEtjSw2FMmSlGND0L8XQ8mynEubXSz6YkvkGfLMmZsa8HzlIL2Fj1p5nnkHiwhydJkVxgutIIUcJXpknGUdBCLQBi2n7Yt8AOx3Dbe8Qo+WDm5A8Qohhc0xN+LY6wdUEIGgk0vkOVqIwOK3WljMIfW2xgic30qycaIyEiEC3Bipc4S04NIRICux4pA24LcmIL0VagUtQXkwSomlcmKlJpvNZgNtNFDpqd6LfMfEcF/CU8evrV6LHJlefsXMX+RMFzsNmNesc/v/ZB9BoW3F/Xhl744pp8tyyl0ObbugW53RyqGjc6ZJQn+H/PuQ9kRz5uosQ+eKWsrtbxAFGVB5MuTGSJGFkMZfHVk3z1l2OlCALSWAF93dWXBtQKm6WoagDsynSdJGUKFzfIUveb338ceU2zYCL3xACiWFwvudCvfTJLk/hbYlzCyZva6G0p4Vulb5r5Rglsz+rQQjnj/ye5bM7qeD3++f+32h1lyKnJ1dX7Abqr5f6/f7t/o95uk7nuTTppJk11eu6EBdFzlQZbzeqeEwq63w29CExt0nvV1QAVXoS73vX6Fx+RJSiPsij5t9o2iBDrTrXVOrraQG5r1xaRxzYya7biP50k0yXcXciHh9AnTVjsqcdO2kOyA06MKN+IJbiH7eNMlDoQodjHsVrgyquVipoOH65FlDuymFY8KF7VxndYXKh8CzQlv2xJotucOcacV8iWGT1k8nJ8wZzETR58yE3ak7NdcVstphUUsmhXpw6Z06ZrdXRSEywSX7B5dOeFy82yn2+Pj4TLGjYPNZ+LJeMotG7+GrsBhkHVsNL0cQgUdbuatijnYtMuyj88pVcQDHfSXQ2EobwIoLuR8PH54aUcJJkaFyOErJs8/Xl+x0kkA0Soo3UI4vLz6e/zk/p1MprboQnUySSUJLRjtfcTW66FNIUzcawwfRbfZF/dLI7hPM48bHRnIRyicQbvq8v4U9Oh2NyEUEpXaeAE1DSfG3lW1Ly99qtFReiwjW3Aq+pCy8bSAXjp7zYeC9SvTdX/3sPGJvnbYvOrIrH0W1s+aypjeI4AG3h/O+XbTRroT+M9XXWHS3HdbsQIa+PzrAWZah8aO9Zy34oD19Or88vzmHCHhNYRr3iofQK/oHcudFHQ4JdRzolxi9aPA7VfoX3P4xwLudVw2GD7kOTWos2rb9DjHmiwQ=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Deletes contact",description:"delete a contact",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu2zgQ/RXuPDWAYimO+yIsFg3aoAgabIJ1FvuQGAEtjSw2FMmSlGND0L8XQ8mynEubXSz6YkvkGfLMmZsa8HzlIL2Fj1p5nnkHiwhydJkVxgutIIUcJXpknGUdBCLQBi2n7Yt8AOx3Dbe8Qo+WDm5A8Qohhc0xN+LY6wdUEIGgk0vkOVqIwOK3WljMIfW2xgic30qycaIyEiEC3Bipc4S04NIRICux4pA24LcmIL0VagUtQXkwSomlcmKlJpvNZgNtNFDpqd6LfMfEcF/CU8evrV6LHJlefsXMX+RMFzsNmNesc/v/ZB9BoW3F/Xhl744pp8tyyl0ObbugW53RyqGjc6ZJQn+H/PuQ9kRz5uosQ+eKWsrtbxAFGVB5MuTGSJGFkMZfHVk3z1l2OlCALSWAF93dWXBtQKm6WoagDsynSdJGUKFzfIUveb338ceU2zYCL3xACiWFwvudCvfTJLk/hbYlzCyZva6G0p4Vulb5r5Rglsz+rQQjnj/ye5bM7qeD3++f+32h1lyKnJ1dX7Abqr5f6/f7t/o95uk7nuTTppJk11eu6EBdFzlQZbzeqeEwq63w29CExt0nvV1QAVXoS73vX6Fx+RJSiPsij5t9o2iBDrTrXVOrraQG5r1xaRxzYya7biP50k0yXcXciHh9AnTVjsqcdO2kOyA06MKN+IJbiH7eNMlDoQodjHsVrgyquVipoOH65FlDuymFY8KF7VxndYXKh8CzQlv2xJotucOcacV8iWGT1k8nJ8wZzETR58yE3ak7NdcVstphUUsmhXpw6Z06ZrdXRSEywSX7B5dOeFy82yn2+Pj4TLGjYPNZ+LJeMotG7+GrsBhkHVsNL0cQgUdbuatijnYtMuyj88pVcQDHfSXQ2EobwIoLuR8PH54aUcJJkaFyOErJs8/Xl+x0kkA0Soo3UI4vLz6e/zk/p1MprboQnUySSUJLRjtfcTW66FNIUzcawwfRbfZF/dLI7hPM48bHRnIRyicQbvq8v4U9Oh2NyEUEpXaeAE1DSfG3lW1Ly99qtFReiwjW3Aq+pCy8bSAXjp7zYeC9SvTdX/3sPGJvnbYvOrIrH0W1s+aypjeI4AG3h/O+XbTRroT+M9XXWHS3HdbsQIa+PzrAWZah8aO9Zy34oD19Or88vzmHCHhNYRr3iofQK/oHcudFHQ4JdRzolxi9aPA7VfoX3P4xwLudVw2GD7kOTWos2rb9DjHmiwQ=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"}},y={},b=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Deletes contact"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"delete a contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.c9060b90.js b/assets/js/7b076186.c9060b90.js new file mode 100644 index 000000000..c1aec9955 --- /dev/null +++ b/assets/js/7b076186.c9060b90.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:()=>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/8a725248.86c34487.js b/assets/js/8a725248.86c34487.js new file mode 100644 index 000000000..39605df0f --- /dev/null +++ b/assets/js/8a725248.86c34487.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:()=>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.e89d4ca1.js b/assets/js/8a725248.e89d4ca1.js deleted file mode 100644 index 4fd431249..000000000 --- a/assets/js/8a725248.e89d4ca1.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:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),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:"eJy9Vk1v2zgQ/SvcOTWAYsuOexEWi2aDoMi2aII6iz04RkBJY5sNRbIk5Q8Y+u+LoWRZttN8XHoJnOEMOfPezBttwfO5g2QCV1p5nnkH0wi0Qcu90OomhwQyi9xjVp9DBIZbXqBHS3FbULxASGB9zo049/oJFUQgFCSwQJ6jhQgs/iyFxRwSb0uMwPmNpBgnCiMRIsC1kTpHSGZcOnLIFlhwSLbgNyZ4eivUHCpy5SEooSyVE3PVW6/Xa6im9Tvo/N8631Bsji6zwlAhkICxeilyZClKvWJtEcxrVlfI9iXSL1SeLuHGSJEFNPo/HN207aS3r2wC1wUXEiL4RoBEcLfQCgnNpgSd/sAaP0v4eoGObgjeJ4VGMNO24L5r2Vf+Q1MZSHDUj74/PkX81Bh6mS7oqjrhd141GF4MBxeDi+EAqioCL3wwH/TMY0qEVHR+2AnB4IxWrsZiGMenvDWN2ZCUM1dmGTo3K6Xc/PEerl7mIQv913qpskhD77alDuO4iqBA5/j8WZj2oLyccl11Kf3rSdVmmsKXnrtbZE+Dhf5nmB9wIJQUCh93CD8O4/hx8Ng8/aoj8VVFMIpHp5SMdYF+IdScrVB5trJazSNmJHKHzNsN43MuFJPco/2dFI3i0Vspel8JL6E1ikcdtD6eonWjllyKnF3e3bB70sffC8nHt0LSzdPXeVJN6yLoSyPzonaqdf4Ala69RsNhVlrhN2FNdPdDMpmSXB/N+bEIE0GaFpDRrt47fgEJ9I/3kUO73C2j0kpaPN4bl/T73JjebktInjpSuj43or8chH2xS3BMaNeAHqTZosWN+IIbiF5fdlQ3kfh9v4qudwjvxL7V71a+n1PkVpAPNJZem+mQWoP8rUE1FnMVeFsO4BjX+4VwTLhwnOusLFD50Gxspi07imYpd5gzrZhfYDgk+0VvwJzBTMyaPu2xB/WgaIZY6XBWSiaFenLJgzpnk9vZTGSCS/Yfpk54nH7Y8bFarU74OAsxn4VflCmzaPTefR6MgbRuVPvPGUTg0RbudjZGuxQZNtz/4ql+cO4300fNk2wBGwYa06fjIIJcigyVw84YXH6++8ouejFEnZZ7Q8r9rzdX19/G13QrNW1N0aAX92IyUacXXHUeOpmKA3LbBvW49n0juQhDGVLaNgMzOfqAm0awoIFKJrDdEt3/WllVZP5ZoqVhnUaw5FbwlPprMq2iXXPThOXC0UHefqsdJdQKG3z43iz7MwbR84k+4eZkmpZcluQJVbRtHK7qO8/v6Y69x4lw7iMuswyNf9F32lGYu9vxPUSQNh+ORVBVsHxFH698BQk8wAMAfRnTDUEpgn0Lkqt5GbQV6ntJAXhJyHfl4ynIR/ODcNwdqU0ny0Mk6lLoLxX2bMCfNJ5fcPNX616f/DKg/SavvYmGaVVV/wOX6BvE",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/createcontact",title:"Create contact",description:"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:"eJy9Vk1v2zgQ/SvcOTWAYsuOexEWi2aDoMi2aII6iz04RkBJY5sNRbIk5Q8Y+u+LoWRZttN8XHoJnOEMOfPezBttwfO5g2QCV1p5nnkH0wi0Qcu90OomhwQyi9xjVp9DBIZbXqBHS3FbULxASGB9zo049/oJFUQgFCSwQJ6jhQgs/iyFxRwSb0uMwPmNpBgnCiMRIsC1kTpHSGZcOnLIFlhwSLbgNyZ4eivUHCpy5SEooSyVE3PVW6/Xa6im9Tvo/N8631Bsji6zwlAhkICxeilyZClKvWJtEcxrVlfI9iXSL1SeLuHGSJEFNPo/HN207aS3r2wC1wUXEiL4RoBEcLfQCgnNpgSd/sAaP0v4eoGObgjeJ4VGMNO24L5r2Vf+Q1MZSHDUj74/PkX81Bh6mS7oqjrhd141GF4MBxeDi+EAqioCL3wwH/TMY0qEVHR+2AnB4IxWrsZiGMenvDWN2ZCUM1dmGTo3K6Xc/PEerl7mIQv913qpskhD77alDuO4iqBA5/j8WZj2oLyccl11Kf3rSdVmmsKXnrtbZE+Dhf5nmB9wIJQUCh93CD8O4/hx8Ng8/aoj8VVFMIpHp5SMdYF+IdScrVB5trJazSNmJHKHzNsN43MuFJPco/2dFI3i0Vspel8JL6E1ikcdtD6eonWjllyKnF3e3bB70sffC8nHt0LSzdPXeVJN6yLoSyPzonaqdf4Ala69RsNhVlrhN2FNdPdDMpmSXB/N+bEIE0GaFpDRrt47fgEJ9I/3kUO73C2j0kpaPN4bl/T73JjebktInjpSuj43or8chH2xS3BMaNeAHqTZosWN+IIbiF5fdlQ3kfh9v4qudwjvxL7V71a+n1PkVpAPNJZem+mQWoP8rUE1FnMVeFsO4BjX+4VwTLhwnOusLFD50Gxspi07imYpd5gzrZhfYDgk+0VvwJzBTMyaPu2xB/WgaIZY6XBWSiaFenLJgzpnk9vZTGSCS/Yfpk54nH7Y8bFarU74OAsxn4VflCmzaPTefR6MgbRuVPvPGUTg0RbudjZGuxQZNtz/4ql+cO4300fNk2wBGwYa06fjIIJcigyVw84YXH6++8ouejFEnZZ7Q8r9rzdX19/G13QrNW1N0aAX92IyUacXXHUeOpmKA3LbBvW49n0juQhDGVLaNgMzOfqAm0awoIFKJrDdEt3/WllVZP5ZoqVhnUaw5FbwlPprMq2iXXPThOXC0UHefqsdJdQKG3z43iz7MwbR84k+4eZkmpZcluQJVbRtHK7qO8/v6Y69x4lw7iMuswyNf9F32lGYu9vxPUSQNh+ORVBVsHxFH698BQk8wAMAfRnTDUEpgn0Lkqt5GbQV6ntJAXhJyHfl4ynIR/ODcNwdqU0ny0Mk6lLoLxX2bMCfNJ5fcPNX616f/DKg/SavvYmGaVVV/wOX6BvE",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 N(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create contact"})}),"\n",(0,l.jsx)(t(),{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)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(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)(m.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(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)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,l.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Phck1hoJ2d"}})})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "Phck1hoJ2d"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.d8fb2ce8.js b/assets/js/935f2afb.73e99a0e.js similarity index 64% rename from assets/js/935f2afb.d8fb2ce8.js rename to assets/js/935f2afb.73e99a0e.js index b9b740892..531a29fcd 100644 --- a/assets/js/935f2afb.d8fb2ce8.js +++ b/assets/js/935f2afb.73e99a0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"New-Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}]}],"selfhostSidebar":[{"type":"link","label":"Tutorial Intro","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/self-host/tutorial-basics/create-a-page","docId":"self-host/tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/self-host/tutorial-basics/create-a-document","docId":"self-host/tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/self-host/tutorial-basics/create-a-blog-post","docId":"self-host/tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/self-host/tutorial-basics/markdown-features","docId":"self-host/tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/self-host/tutorial-basics/deploy-your-site","docId":"self-host/tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/self-host/tutorial-basics/congratulations","docId":"self-host/tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/self-host/tutorial-extras/manage-docs-versions","docId":"self-host/tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/self-host/tutorial-extras/translate-your-site","docId":"self-host/tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"COMMUNITY","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATION","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"REPORTING_GUIDELINES","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Deletes contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get contact list","href":"/docs/API-docs/contactlist","className":"api-method post","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Create document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Get document by ID","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Delete document by ID","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get document list by doctype","href":"/docs/API-docs/getdocumentlist","className":"api-method post","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get template by ID","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update template by ID","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete template by ID","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get template list","href":"/docs/API-docs/gettemplatelist","className":"api-method post","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get contact list","description":"","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create contact","description":"Create contact","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create document","description":"Create document","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete template by ID","description":"Delete template by ID","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Deletes contact","description":"delete a contact","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete document by ID","description":"delete a document","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get template by ID","description":"","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"Get your details","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get contact","description":"get a contact","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get document by ID","description":"Get a document","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get document list by doctype","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get template list","description":"Get template list","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update template by ID","description":"Update template by ID","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"COMMUNITY","description":"","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATION","description":"","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"REPORTING_GUIDELINES","description":"","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/intro":{"id":"self-host/intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/congratulations":{"id":"self-host/tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-blog-post":{"id":"self-host/tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-document":{"id":"self-host/tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-page":{"id":"self-host/tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/deploy-your-site":{"id":"self-host/tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/markdown-features":{"id":"self-host/tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/manage-docs-versions":{"id":"self-host/tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/translate-your-site":{"id":"self-host/tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"New-Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}]}],"selfhostSidebar":[{"type":"link","label":"Tutorial Intro","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/self-host/tutorial-basics/create-a-page","docId":"self-host/tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/self-host/tutorial-basics/create-a-document","docId":"self-host/tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/self-host/tutorial-basics/create-a-blog-post","docId":"self-host/tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/self-host/tutorial-basics/markdown-features","docId":"self-host/tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/self-host/tutorial-basics/deploy-your-site","docId":"self-host/tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/self-host/tutorial-basics/congratulations","docId":"self-host/tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/self-host/tutorial-extras/manage-docs-versions","docId":"self-host/tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/self-host/tutorial-extras/translate-your-site","docId":"self-host/tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"COMMUNITY","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATION","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"REPORTING_GUIDELINES","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Deletes contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Create document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Get document by ID","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update document by ID","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete document by ID","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get document list by doctype","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get template by ID","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update template by ID","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete template by ID","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get contact list","description":"","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create contact","description":"Create contact","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create document","description":"Create document","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete template by ID","description":"Delete template by ID","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Deletes contact","description":"delete a contact","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete document by ID","description":"delete a document","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get template by ID","description":"","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"Get your details","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get contact","description":"get a contact","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get document by ID","description":"Get a document","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get document list by doctype","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get template list","description":"Get template list","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/update-document":{"id":"API-docs/update-document","title":"Update document by ID","description":"Update document by ID","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update template by ID","description":"Update template by ID","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"COMMUNITY","description":"","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATION","description":"","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"REPORTING_GUIDELINES","description":"","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/intro":{"id":"self-host/intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/congratulations":{"id":"self-host/tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-blog-post":{"id":"self-host/tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-document":{"id":"self-host/tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-page":{"id":"self-host/tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/deploy-your-site":{"id":"self-host/tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/markdown-features":{"id":"self-host/tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/manage-docs-versions":{"id":"self-host/tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/translate-your-site":{"id":"self-host/tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.0602d8f8.js b/assets/js/a2bc1463.0602d8f8.js new file mode 100644 index 000000000..4f92e91a4 --- /dev/null +++ b/assets/js/a2bc1463.0602d8f8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>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.f4361f8a.js b/assets/js/a2bc1463.f4361f8a.js deleted file mode 100644 index 5f944091a..000000000 --- a/assets/js/a2bc1463.f4361f8a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),m=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/contactlist",title:"Get contact list",description:"",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivafWoAxZKd9IswDM2CIAhaNEGdYR9sI6Cks8WYIlmS8gsM/ffhKMmW7WZdhmGAYcvHO/LuuececQeOLSwkE7hV0rHMWZiFkKPNDNeOKwkJQAhKo2H09yGHBLLGVXDrIATNDCvRoaFtdiBZiZDA5pJpfunUEiWEwGmfAlmOBkIw+L3iBnNInKkwBOu2gmIsL7VACAE3WqgcIZkzYckhK7BkkOzAbbX3dIbLBdTkynxQQjlKyxdysNlsNlDPmnPQut9VvqVYShulo0emteCZryh6tVTl7vwQlb5i5is0VL/jaGlV8JK7npusytSXNVemZK5v2Sc3jOsQ7JLrd8bFdR3CphQU1gJLqKdUUR2C404c22oKMGi1krZJdxTH9HPcUltlGVo7r0Swby2E/xVCme/deaH7skZx3KRZiT6SzBi2JbY4LO3Pj2nMxMhTXvQw3VsORNHFMC02o1dNEH71qL5vg1eFQYpI4Xcl4+JfxKeIn1rDIFMlbfVUKPnuVK6HV8OR/8A5Vdo5zdExLmyfMKcrdW+NS8ElvnQkehnF8ct1y6zr+OM5mR7kigmeBzdPD8EzDfwv/yOVruOPdQglWssWP0TvgFU/T9fkeY4Zb5wa4TpCpW9v0LCYVYa7rde9vuAlkxnpT4muUCSYWrVK6QpIIDrWT4tm1YlnZQQJpXPaJlHEtB50qiZYaokpEdM8Wg29vnXnjwnMBq+jLA6DpflnpMn6qThTWdSjbwfpvOsA3EvfMO7EjMaYy7nyZ7VIPWqUY76QHufVEE5fJ88FtwG3fjlXWVWidJ4cwVyZ4CQ6SJnFPFAycAX6RbJfDYaB1ZjxecurQTCVUzlWJQaVRZI1weXSJlN5GUwe53OecSaCPzG13OHsQwfwer0+A/jCx9xzV1RpYFCrg/vCG30X+lH7PxcQgkNT2sf5GM2KZ9g2842jIu8ctdPCMj8t2ChKZ/p0GkSkFDxDabFH25v7py/B1SCGsMehf5By9OXh9u7r+I52JRY2LRoO4kFMJiJuyWTvoHt0QZta0BL4qL291yxdHFoCOty4SAvG/Uz5DHftOEyOrhOzEAoalmQCux31/g8j6prM3ys0NGmzEFbMcJYS2SazOuyoS/OTc0sL+f7m8GZuH761l5CL4K00l7g9m5UVExV5Qh3uWofbZs/LZ9rj4HGmeoeImyxD7f7Wt68eT4/jZwghba8xpZdEMGxNVym2hgSmMG1uabSD1wFv34FgclF5YYRmX5pvVhHufXFYenFoHwjHbklue1keI9GUQt9U2A8DfqVZ/Yzb3/buzcqbAfsbYuNNbZjVdf0XaweeNA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},b=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/contactlist"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.2e469c24.js b/assets/js/a88a3db3.2e469c24.js new file mode 100644 index 000000000..e273b60f7 --- /dev/null +++ b/assets/js/a88a3db3.2e469c24.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:()=>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.b9986137.js b/assets/js/a88a3db3.b9986137.js deleted file mode 100644 index 53732536e..000000000 --- a/assets/js/a88a3db3.b9986137.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),c=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete template by ID",description:"Delete template by ID",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,l.jsx)(d(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Delete template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Template deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.0130c100.js b/assets/js/bbdfc22d.0130c100.js deleted file mode 100644 index 4b517bffb..000000000 --- a/assets/js/bbdfc22d.0130c100.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:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),o=a(5397),p=a(4667),d=a(9472),u=a(85162);const h={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOs0gkwRm5rB9mll2hNAiQITRHiBCTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkFm6wsEoE9DDikKFPnbRBGg0J3OTI2mN24lCQnH27OmNCKTP3rPToPAuGpXSILC19MIX8KcYKWWgdczbPZZozj26GTHg2ViVaJ3XwbGIcm6JGJ4LUU5aZtCyQDuYy5Mw6zHAiNWbMB1emoXToe+yHNZr5Mk3R+0mp1jfVMKTRnIUcI1CHoXTaM8FKLZ9KZAcHrfZZdnDAQi4CS4VmY6TXZPSYBg920IwFnRkd/XqLqZxIUm5c9YCDsfERRp9lkEAdkPYcOFjhRIEBHQV9BVoUCAksDoWVh8E8ogYOkoKeo8jQAQeHT6V0mEESXIkcfFgqsvGysIpc4sIqkyEkE6E8KaQ5FgKSFYSljZrBST2FilRFNEoIpvZyqnuLxWIB1ai+B334w2RLsk2NDqgDfRTWKpnGR/UfPJXEav8SM37ANNALHYUgSPR0ehEfuAuFw8S4QoSuZIPNxw/rqBLwCxPe7eZKofDIHM4kzpnQGaMHs5BLv04p+f6zW+zvu2Jdcd2GqTj8uD5/r6s8BOuTfn9pSicLMcVeagryRaBjuaz9CefEsmt8Cw8Gv04LIVW04vBgct0RjDgsCkUumoJrnXKYO2FtW10VBxmw8M+B30Cly5pvzXXPO684BBnUlqiiKKgMHbXH+yK0ePBjcXQqFlfRzfadO43WuXr3pCJjh94a7esaPR4M6N8O6W2RCTHPmmjU8jfg/1aDpLF111q6LMax7dfvPh4MKg4Fei+mz/bAJkKvYK7fXarwOqpavJWjBlnFoXTq1zjaWm4kpaursOpkRWolNd63ebg/Hgzuf79v4L2q2GTx8+DLfuLO9EwomUXavyFG/S+T9Xnw5a3J6uIMNc79spa1Uj0ZtqLSldfRKDDkhoaONT5CFyGHBPp7MygO4GYAxVyuEyas7bWTQYmxp7T1hZX92VGcER7T0smwHFK86pB0R1eHoqz8C4mjXh1whJzScL0ZP9/bGLXjY28itAPhbRy/Q/HPs3ZD2i/wcIeG30K2G4rbYi16+cTEMDV5vLSoh4SYqmB2BPurl/RM+njcvqdev2hj2rHeXk/okOSfekftqlJXfY/d6Ts9NEVcdWhxUlI/+uROH7Lby8lEplIo9jeOvQw4+tAGZD6f79XGx2hzKkNejplDazbq0yiMBdS1Wn/5CBwCusJfToboZjJtieOFq/pRud/0skhjLyMFnTi+Fn3dNaKQK5mi9thpqm+nV+fsU28AvFP+b4DcPz87+X4x/E5eqYHqFB31Br0BiajtCqE7F53U63CnbLPtXWNNS//v2O/ZsRuSCbgIfauE1J2pVLPe7e7YH3HIiRaTW1it6IofTlUViZ9KdEtIbkccZsJJiid9q3jLUESTmfR0kK2X7BcT+eG62dc/speQPuJyjxJnQpWkCRVfNQontc/DG/Kx0dibXxuLb2mKNvxSd9SZE1eXwxvgMG42/iION3BiTr86xBwSuIM7iL9pyEOk+yhfgRJ6WsYRB7Vf+vsHohb7lQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOs0gkwRm5rB9mll2hNAiQITRHiBCTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkFm6wsEoE9DDikKFPnbRBGg0J3OTI2mN24lCQnH27OmNCKTP3rPToPAuGpXSILC19MIX8KcYKWWgdczbPZZozj26GTHg2ViVaJ3XwbGIcm6JGJ4LUU5aZtCyQDuYy5Mw6zHAiNWbMB1emoXToe+yHNZr5Mk3R+0mp1jfVMKTRnIUcI1CHoXTaM8FKLZ9KZAcHrfZZdnDAQi4CS4VmY6TXZPSYBg920IwFnRkd/XqLqZxIUm5c9YCDsfERRp9lkEAdkPYcOFjhRIEBHQV9BVoUCAksDoWVh8E8ogYOkoKeo8jQAQeHT6V0mEESXIkcfFgqsvGysIpc4sIqkyEkE6E8KaQ5FgKSFYSljZrBST2FilRFNEoIpvZyqnuLxWIB1ai+B334w2RLsk2NDqgDfRTWKpnGR/UfPJXEav8SM37ANNALHYUgSPR0ehEfuAuFw8S4QoSuZIPNxw/rqBLwCxPe7eZKofDIHM4kzpnQGaMHs5BLv04p+f6zW+zvu2Jdcd2GqTj8uD5/r6s8BOuTfn9pSicLMcVeagryRaBjuaz9CefEsmt8Cw8Gv04LIVW04vBgct0RjDgsCkUumoJrnXKYO2FtW10VBxmw8M+B30Cly5pvzXXPO684BBnUlqiiKKgMHbXH+yK0ePBjcXQqFlfRzfadO43WuXr3pCJjh94a7esaPR4M6N8O6W2RCTHPmmjU8jfg/1aDpLF111q6LMax7dfvPh4MKg4Fei+mz/bAJkKvYK7fXarwOqpavJWjBlnFoXTq1zjaWm4kpaursOpkRWolNd63ebg/Hgzuf79v4L2q2GTx8+DLfuLO9EwomUXavyFG/S+T9Xnw5a3J6uIMNc79spa1Uj0ZtqLSldfRKDDkhoaONT5CFyGHBPp7MygO4GYAxVyuEyas7bWTQYmxp7T1hZX92VGcER7T0smwHFK86pB0R1eHoqz8C4mjXh1whJzScL0ZP9/bGLXjY28itAPhbRy/Q/HPs3ZD2i/wcIeG30K2G4rbYi16+cTEMDV5vLSoh4SYqmB2BPurl/RM+njcvqdev2hj2rHeXk/okOSfekftqlJXfY/d6Ts9NEVcdWhxUlI/+uROH7Lby8lEplIo9jeOvQw4+tAGZD6f79XGx2hzKkNejplDazbq0yiMBdS1Wn/5CBwCusJfToboZjJtieOFq/pRud/0skhjLyMFnTi+Fn3dNaKQK5mi9thpqm+nV+fsU28AvFP+b4DcPz87+X4x/E5eqYHqFB31Br0BiajtCqE7F53U63CnbLPtXWNNS//v2O/ZsRuSCbgIfauE1J2pVLPe7e7YH3HIiRaTW1it6IofTlUViZ9KdEtIbkccZsJJiid9q3jLUESTmfR0kK2X7BcT+eG62dc/speQPuJyjxJnQpWkCRVfNQontc/DG/Kx0dibXxuLb2mKNvxSd9SZE1eXwxvgMG42/iION3BiTr86xBwSuIM7iL9pyEOk+yhfgRJ6WsYRB7Vf+vsHohb7lQ==",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={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(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)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(p.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)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(p.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)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(p.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 "code": 200,\n "message": "Template created successfully!",\n "result": {\n "objectId": 0,\n "url": "https://exampleurl.com"\n }\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.37245826.js b/assets/js/bbdfc22d.37245826.js new file mode 100644 index 000000000..04d8274ea --- /dev/null +++ b/assets/js/bbdfc22d.37245826.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:()=>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.bf29690d.js b/assets/js/bfe4b778.bf29690d.js new file mode 100644 index 000000000..b738784c7 --- /dev/null +++ b/assets/js/bfe4b778.bf29690d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>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 new file mode 100644 index 000000000..73f60fa8e --- /dev/null +++ b/assets/js/f0ff4a36.1b07ddca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>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.5ab2b8c7.js b/assets/js/f0ff4a36.5ab2b8c7.js deleted file mode 100644 index 967cf46d2..000000000 --- a/assets/js/f0ff4a36.5ab2b8c7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={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:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",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/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:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.73929fb9.js b/assets/js/fa40969b.73929fb9.js new file mode 100644 index 000000000..f9187a369 --- /dev/null +++ b/assets/js/fa40969b.73929fb9.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:()=>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.f555cec9.js b/assets/js/fa40969b.f555cec9.js deleted file mode 100644 index 8cf6297d4..000000000 --- a/assets/js/fa40969b.f555cec9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});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 u={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tuGzcQ/RV28pIYa2lty0WxKIqmiWO4CWLDdtAHSzCo3ZGWMZfckFxdIOxbv6Sf1i8phnvRyrITK0jzlBd7NZwZzuXMhStwfGohuoHXOi4yVM7CKIAEbWxE7oRWEMGzZ89Yc8yulznaaKgu0RmBM2ScSWEd0xOWNCrYmFtMmFbMLXMcqqE66LG9vdeGT1yryUZ7e0PFGGP7axpzKXeMG2RxYQwqJ5dMKJZ4Seu4K2yP9B2SvisxVdwVBtklfirQfk6lwU+FMMhcimypC8NsI+z1HZG+M7V/YfTUoLVfZWVeC3uNA9L4Sme5RIfJU/SlfIZsjKiYLeIYrZ0UUi5Z3OqYC5cyLmXjTLJ2orrzmO48WeT+7Kk3Ys3PVeJdUppJraZoGPdWiLGsYvSzzyHGUqhdHUoaqfHSZ6CwaHpDBQHoHA0nnJ0lEMEUXQMiAhUEkHPDM3RoCKQrUDxDiCDRMSELAhAE0Jy7FO6j9jpFD79NZDrNTI1cCKAJJETOFBiAdUtJ+q2gmEMAuMilThCiCZeWGOIUMw7RCvz9EVhnhJoSpyoyqiMP1fY+CKDNkalA6o1uoNJlbBPdodXJ6VCaUK7LtSyDNjCLfZ6LfafvUDXBSZEnaL6lsyWxci8UUQIVudhbLBYLKEfVPWjdHzpZkmyslUPl6JPnuRSxT3f/o6UsrbYv0eOPGPvUGwKHE2jpVIpMuA6bKrKxd2uiTcZdl9IadxCWAdg7ke8oF5ZlAItMklgdWILjmDwqA3DCyU1aSQIGba6Vrcw9DEP6twnJdV2zFvc+8d8kQrHP3bajrVuHYViZWchuJLkxfElocZjZL19Tkalct4ugjem6LFqgvDkVd4dH4/TDnxTD6yqGu6mw/oOqmVS8125nDblEbtH3zbYpkK43WlKR7KjtPEdFQ+jfv/9hr42YoVcldncsdS63Ub9fUwoje7HOSNv5XO1u10ft+y7Jk3m+eX5tut97/D/Q77q3Qdkpiyaut83d5XY5dWN/X67ib6hCUbu7bYrr9jAMb3+pK24QDraL7BJzbRxT2jE+40LyscSfvmOVDcJBGUCG1vLpFyL3sKmf834QDm4HrffH296fqRmXImEvL87YNY2B7+v68VNd79rpKju3USIqpmqcbUSlS6+iYTEujHBLvyZ0x2B0M6KplKFLNe0Yua4XC5dCBP3uvtFf1YtFSXMbzaxZOwojO1XK87zXjD3Jx5Zqtc9z0Z8d+AHYmHJFca1Ct2HQuhRz8RapFr84vclDStfleraeNLFsZ+NB2Ew76vNCTbS/qw5a06x8yGcHD+xLwjJh/XETFI8TNtGG3ZPubPgp+kOiH/UOmM0xFpMaYj1Gi+OVzvzKR3NPCnVHz4d9dnM+mYhYcMn+wrEVDkfPmwDP5/OtAL/wMqfCpcWYGcz1mn3qiT4LXan2xwsIwKHJ7PnkCs1MxE3LfeSqvmfu14XDY184mHFBIKhJv98XInxKEaOy2EHwy9OLd+yoF0LQwdATTO6/O3t18v7qhLQSCqsUHfTCXkgkwnDGVeeiU3Rt1qoH2XjJ1mvyRqo7O9mPt92Pt93/9raru5zDhevnkgvfw30ZrOr2ewP3nntRA9lRACk16ugGViuC3Acjy5LInwo01OVHAcy4ETQzfY9OhKXvpH2+PIr555d1jF+wpzwSH3Sj6eCK2veMy4J+QQB3uOy8T8tRGTQt/KttfMyE6qrNmdFaQm/CiuFVpXP/uuoEDcfWIrCWeBnHmLvP8nYH6sX51TUEMK7fe5nfEsDwOb05+RwiGMIQ/FufNPh56OkrkFxNC78rQKWX5hwvCBrdIXnnh2T9QXF8MPqbkahcob/k2IMCv9LMeovL31r26uRRgfYpXXFTGkZlWf4HmEGf/w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tuGzcQ/RV28pIYa2lty0WxKIqmiWO4CWLDdtAHSzCo3ZGWMZfckFxdIOxbv6Sf1i8phnvRyrITK0jzlBd7NZwZzuXMhStwfGohuoHXOi4yVM7CKIAEbWxE7oRWEMGzZ89Yc8yulznaaKgu0RmBM2ScSWEd0xOWNCrYmFtMmFbMLXMcqqE66LG9vdeGT1yryUZ7e0PFGGP7axpzKXeMG2RxYQwqJ5dMKJZ4Seu4K2yP9B2SvisxVdwVBtklfirQfk6lwU+FMMhcimypC8NsI+z1HZG+M7V/YfTUoLVfZWVeC3uNA9L4Sme5RIfJU/SlfIZsjKiYLeIYrZ0UUi5Z3OqYC5cyLmXjTLJ2orrzmO48WeT+7Kk3Ys3PVeJdUppJraZoGPdWiLGsYvSzzyHGUqhdHUoaqfHSZ6CwaHpDBQHoHA0nnJ0lEMEUXQMiAhUEkHPDM3RoCKQrUDxDiCDRMSELAhAE0Jy7FO6j9jpFD79NZDrNTI1cCKAJJETOFBiAdUtJ+q2gmEMAuMilThCiCZeWGOIUMw7RCvz9EVhnhJoSpyoyqiMP1fY+CKDNkalA6o1uoNJlbBPdodXJ6VCaUK7LtSyDNjCLfZ6LfafvUDXBSZEnaL6lsyWxci8UUQIVudhbLBYLKEfVPWjdHzpZkmyslUPl6JPnuRSxT3f/o6UsrbYv0eOPGPvUGwKHE2jpVIpMuA6bKrKxd2uiTcZdl9IadxCWAdg7ke8oF5ZlAItMklgdWILjmDwqA3DCyU1aSQIGba6Vrcw9DEP6twnJdV2zFvc+8d8kQrHP3bajrVuHYViZWchuJLkxfElocZjZL19Tkalct4ugjem6LFqgvDkVd4dH4/TDnxTD6yqGu6mw/oOqmVS8125nDblEbtH3zbYpkK43WlKR7KjtPEdFQ+jfv/9hr42YoVcldncsdS63Ub9fUwoje7HOSNv5XO1u10ft+y7Jk3m+eX5tut97/D/Q77q3Qdkpiyaut83d5XY5dWN/X67ib6hCUbu7bYrr9jAMb3+pK24QDraL7BJzbRxT2jE+40LyscSfvmOVDcJBGUCG1vLpFyL3sKmf834QDm4HrffH296fqRmXImEvL87YNY2B7+v68VNd79rpKju3USIqpmqcbUSlS6+iYTEujHBLvyZ0x2B0M6KplKFLNe0Yua4XC5dCBP3uvtFf1YtFSXMbzaxZOwojO1XK87zXjD3Jx5Zqtc9z0Z8d+AHYmHJFca1Ct2HQuhRz8RapFr84vclDStfleraeNLFsZ+NB2Ew76vNCTbS/qw5a06x8yGcHD+xLwjJh/XETFI8TNtGG3ZPubPgp+kOiH/UOmM0xFpMaYj1Gi+OVzvzKR3NPCnVHz4d9dnM+mYhYcMn+wrEVDkfPmwDP5/OtAL/wMqfCpcWYGcz1mn3qiT4LXan2xwsIwKHJ7PnkCs1MxE3LfeSqvmfu14XDY184mHFBIKhJv98XInxKEaOy2EHwy9OLd+yoF0LQwdATTO6/O3t18v7qhLQSCqsUHfTCXkgkwnDGVeeiU3Rt1qoH2XjJ1mvyRqo7O9mPt92Pt93/9raru5zDhevnkgvfw30ZrOr2ewP3nntRA9lRACk16ugGViuC3Acjy5LInwo01OVHAcy4ETQzfY9OhKXvpH2+PIr555d1jF+wpzwSH3Sj6eCK2veMy4J+QQB3uOy8T8tRGTQt/KttfMyE6qrNmdFaQm/CiuFVpXP/uuoEDcfWIrCWeBnHmLvP8nYH6sX51TUEMK7fe5nfEsDwOb05+RwiGMIQ/FufNPh56OkrkFxNC78rQKWX5hwvCBrdIXnnh2T9QXF8MPqbkahcob/k2IMCv9LMeovL31r26uRRgfYpXXFTGkZlWf4HmEGf/w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},f={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,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:"post",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(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:"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)(d.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/main.1edb8455.js b/assets/js/main.1edb8455.js new file mode 100644 index 000000000..a89b6668c --- /dev/null +++ b/assets/js/main.1edb8455.js @@ -0,0 +1,2 @@ +/*! For license information please see main.1edb8455.js.LICENSE.txt */ +(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[179],{69282:(e,t,n)=>{"use strict";var r=n(34155),o=n(25108);function a(e){return a="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},a(e)}function i(e,t){for(var n=0;n1?n-1:0),o=1;o1?n-1:0),o=1;o1?n-1:0),o=1;o1?n-1:0),o=1;o{"use strict";var r=n(34155);function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;te.length)&&(n=e.length),e.substring(n-t.length,n)===t}var w="",k="",x="",S="",E={deepStrictEqual:"Expected values to be strictly deep-equal:",strictEqual:"Expected values to be strictly equal:",strictEqualObject:'Expected "actual" to be reference-equal to "expected":',deepEqual:"Expected values to be loosely deep-equal:",equal:"Expected values to be loosely equal:",notDeepStrictEqual:'Expected "actual" not to be strictly deep-equal to:',notStrictEqual:'Expected "actual" to be strictly unequal to:',notStrictEqualObject:'Expected "actual" not to be reference-equal to "expected":',notDeepEqual:'Expected "actual" not to be loosely deep-equal to:',notEqual:'Expected "actual" to be loosely unequal to:',notIdentical:"Values identical but not reference-equal:"};function A(e){var t=Object.keys(e),n=Object.create(Object.getPrototypeOf(e));return t.forEach((function(t){n[t]=e[t]})),Object.defineProperty(n,"message",{value:e.message}),n}function _(e){return y(e,{compact:!1,customInspect:!1,depth:1e3,maxArrayLength:1/0,showHidden:!1,breakLength:1/0,showProxy:!1,sorted:!0,getters:!0})}function j(e,t,n){var o="",a="",i=0,l="",s=!1,c=_(e),u=c.split("\n"),d=_(t).split("\n"),p=0,f="";if("strictEqual"===n&&"object"===h(e)&&"object"===h(t)&&null!==e&&null!==t&&(n="strictEqualObject"),1===u.length&&1===d.length&&u[0]!==d[0]){var g=u[0].length+d[0].length;if(g<=10){if(!("object"===h(e)&&null!==e||"object"===h(t)&&null!==t||0===e&&0===t))return"".concat(E[n],"\n\n")+"".concat(u[0]," !== ").concat(d[0],"\n")}else if("strictEqualObject"!==n){if(g<(r.stderr&&r.stderr.isTTY?r.stderr.columns:80)){for(;u[0][p]===d[0][p];)p++;p>2&&(f="\n ".concat(function(e,t){if(t=Math.floor(t),0==e.length||0==t)return"";var n=e.length*t;for(t=Math.floor(Math.log(t)/Math.log(2));t;)e+=e,t--;return e+e.substring(0,n-e.length)}(" ",p),"^"),p=0)}}}for(var m=u[u.length-1],y=d[d.length-1];m===y&&(p++<2?l="\n ".concat(m).concat(l):o=m,u.pop(),d.pop(),0!==u.length&&0!==d.length);)m=u[u.length-1],y=d[d.length-1];var b=Math.max(u.length,d.length);if(0===b){var A=c.split("\n");if(A.length>30)for(A[26]="".concat(w,"...").concat(S);A.length>27;)A.pop();return"".concat(E.notIdentical,"\n\n").concat(A.join("\n"),"\n")}p>3&&(l="\n".concat(w,"...").concat(S).concat(l),s=!0),""!==o&&(l="\n ".concat(o).concat(l),o="");var j=0,C=E[n]+"\n".concat(k,"+ actual").concat(S," ").concat(x,"- expected").concat(S),T=" ".concat(w,"...").concat(S," Lines skipped");for(p=0;p1&&p>2&&(P>4?(a+="\n".concat(w,"...").concat(S),s=!0):P>3&&(a+="\n ".concat(d[p-2]),j++),a+="\n ".concat(d[p-1]),j++),i=p,o+="\n".concat(x,"-").concat(S," ").concat(d[p]),j++;else if(d.length1&&p>2&&(P>4?(a+="\n".concat(w,"...").concat(S),s=!0):P>3&&(a+="\n ".concat(u[p-2]),j++),a+="\n ".concat(u[p-1]),j++),i=p,a+="\n".concat(k,"+").concat(S," ").concat(u[p]),j++;else{var O=d[p],N=u[p],I=N!==O&&(!v(N,",")||N.slice(0,-1)!==O);I&&v(O,",")&&O.slice(0,-1)===N&&(I=!1,N+=","),I?(P>1&&p>2&&(P>4?(a+="\n".concat(w,"...").concat(S),s=!0):P>3&&(a+="\n ".concat(u[p-2]),j++),a+="\n ".concat(u[p-1]),j++),i=p,a+="\n".concat(k,"+").concat(S," ").concat(N),o+="\n".concat(x,"-").concat(S," ").concat(O),j+=2):(a+=o,o="",1!==P&&0!==p||(a+="\n ".concat(N),j++))}if(j>20&&p30)for(f[26]="".concat(w,"...").concat(S);f.length>27;)f.pop();t=1===f.length?p.call(this,"".concat(d," ").concat(f[0])):p.call(this,"".concat(d,"\n\n").concat(f.join("\n"),"\n"))}else{var g=_(i),m="",y=E[o];"notDeepEqual"===o||"notEqual"===o?(g="".concat(E[o],"\n\n").concat(g)).length>1024&&(g="".concat(g.slice(0,1021),"...")):(m="".concat(_(l)),g.length>512&&(g="".concat(g.slice(0,509),"...")),m.length>512&&(m="".concat(m.slice(0,509),"...")),"deepEqual"===o||"equal"===o?g="".concat(y,"\n\n").concat(g,"\n\nshould equal\n\n"):m=" ".concat(o," ").concat(m)),t=p.call(this,"".concat(g).concat(m))}return Error.stackTraceLimit=s,t.generatedMessage=!n,Object.defineProperty(u(t),"name",{value:"AssertionError [ERR_ASSERTION]",enumerable:!1,writable:!0,configurable:!0}),t.code="ERR_ASSERTION",t.actual=i,t.expected=l,t.operator=o,Error.captureStackTrace&&Error.captureStackTrace(u(t),a),t.stack,t.name="AssertionError",c(t)}return i=v,(s=[{key:"toString",value:function(){return"".concat(this.name," [").concat(this.code,"]: ").concat(this.message)}},{key:t,value:function(e,t){return y(this,a(a({},t),{},{customInspect:!1,depth:0}))}}])&&l(i.prototype,s),d&&l(i,d),Object.defineProperty(i,"prototype",{writable:!1}),v}(d(Error),y.custom);e.exports=C},62136:(e,t,n)=>{"use strict";function r(e){return r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},r(e)}function o(e,t){for(var n=0;n2?"one of ".concat(t," ").concat(e.slice(0,n-1).join(", "),", or ")+e[n-1]:2===n?"one of ".concat(t," ").concat(e[0]," or ").concat(e[1]):"of ".concat(t," ").concat(e[0])}return"of ".concat(t," ").concat(String(e))}d("ERR_AMBIGUOUS_ARGUMENT",'The "%s" argument is ambiguous. %s',TypeError),d("ERR_INVALID_ARG_TYPE",(function(e,t,o){var a,i,l,c;if(void 0===s&&(s=n(69282)),s("string"==typeof e,"'name' must be a string"),"string"==typeof t&&(i="not ",t.substr(!l||l<0?0:+l,i.length)===i)?(a="must not be",t=t.replace(/^not /,"")):a="must be",function(e,t,n){return(void 0===n||n>e.length)&&(n=e.length),e.substring(n-t.length,n)===t}(e," argument"))c="The ".concat(e," ").concat(a," ").concat(p(t,"type"));else{var u=function(e,t,n){return"number"!=typeof n&&(n=0),!(n+t.length>e.length)&&-1!==e.indexOf(t,n)}(e,".")?"property":"argument";c='The "'.concat(e,'" ').concat(u," ").concat(a," ").concat(p(t,"type"))}return c+=". Received type ".concat(r(o))}),TypeError),d("ERR_INVALID_ARG_VALUE",(function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"is invalid";void 0===c&&(c=n(89539));var o=c.inspect(t);return o.length>128&&(o="".concat(o.slice(0,128),"...")),"The argument '".concat(e,"' ").concat(r,". Received ").concat(o)}),TypeError,RangeError),d("ERR_INVALID_RETURN_VALUE",(function(e,t,n){var o;return o=n&&n.constructor&&n.constructor.name?"instance of ".concat(n.constructor.name):"type ".concat(r(n)),"Expected ".concat(e,' to be returned from the "').concat(t,'"')+" function but got ".concat(o,".")}),TypeError),d("ERR_MISSING_ARGS",(function(){for(var e=arguments.length,t=new Array(e),r=0;r0,"At least one arg needs to be specified");var o="The ",a=t.length;switch(t=t.map((function(e){return'"'.concat(e,'"')})),a){case 1:o+="".concat(t[0]," argument");break;case 2:o+="".concat(t[0]," and ").concat(t[1]," arguments");break;default:o+=t.slice(0,a-1).join(", "),o+=", and ".concat(t[a-1]," arguments")}return"".concat(o," must be specified")}),TypeError),e.exports.codes=u},19158:(e,t,n)=>{"use strict";function r(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,o,a,i,l=[],s=!0,c=!1;try{if(a=(n=n.call(e)).next,0===t){if(Object(n)!==n)return;s=!1}else for(;!(s=(r=a.call(n)).done)&&(l.push(r.value),l.length!==t);s=!0);}catch(e){c=!0,o=e}finally{try{if(!s&&null!=n.return&&(i=n.return(),Object(i)!==i))return}finally{if(c)throw o}}return l}}(e,t)||function(e,t){if(!e)return;if("string"==typeof e)return o(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);"Object"===n&&e.constructor&&(n=e.constructor.name);if("Map"===n||"Set"===n)return Array.from(e);if("Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return o(e,t)}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function o(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n10)return!0;for(var t=0;t57)return!0}return 10===e.length&&e>=Math.pow(2,32)}function I(e){return Object.keys(e).filter(N).concat(u(e).filter(Object.prototype.propertyIsEnumerable.bind(e)))}function R(e,t){if(e===t)return 0;for(var n=e.length,r=t.length,o=0,a=Math.min(n,r);o{"use strict";n.d(t,{Z:()=>p});n(67294);var r=n(68356),o=n.n(r),a=n(16887);const i={"01a85c17":[()=>Promise.all([n.e(532),n.e(4013)]).then(n.bind(n,20472)),"@theme/BlogTagsListPage",20472],"031793e1":[()=>n.e(1633).then(n.t.bind(n,62511,19)),"~blog/default/blog-tags-facebook-038.json",62511],"05632a52":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(4651)]).then(n.bind(n,97717)),"@site/docs/API-docs/getcontact.api.mdx",97717],"096bfee4":[()=>n.e(7178).then(n.t.bind(n,85010,19)),"~blog/default/blog-tags-facebook-038-list.json",85010],"0e384e19":[()=>n.e(9671).then(n.bind(n,47876)),"@site/docs/intro.md",47876],"14eb3368":[()=>Promise.all([n.e(532),n.e(9817)]).then(n.bind(n,34228)),"@theme/DocCategoryGeneratedIndexPage",34228],"17e5210b":[()=>n.e(6543).then(n.bind(n,38832)),"@site/docs/contribute/COMMUNITY.md",38832],"1d835c2e":[()=>n.e(292).then(n.bind(n,47346)),"@site/docs/self-host/tutorial-basics/create-a-page.md",47346],"1f391b9e":[()=>Promise.all([n.e(532),n.e(8531),n.e(4311),n.e(3085)]).then(n.bind(n,14247)),"@theme/MDXPage",14247],"1f73ca32":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(2832)]).then(n.bind(n,8484)),"@site/docs/API-docs/get-user.api.mdx",8484],"277a78f5":[()=>n.e(853).then(n.bind(n,26636)),"@site/docs/contribute/INSTALLATION.md",26636],"2c416566":[()=>n.e(7100).then(n.bind(n,43353)),"@site/docs/help/intro.md",43353],"2c586be5":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(9697)]).then(n.bind(n,45212)),"@site/docs/API-docs/createdocument.api.mdx",45212],"30a24c52":[()=>n.e(453).then(n.t.bind(n,98605,19)),"~blog/default/blog-tags-hello-039.json",98605],"3532e686":[()=>n.e(7729).then(n.t.bind(n,26740,19)),"~docs/default/category-docs-selfhostsidebar-category-tutorial-basics-500.json",26740],"377084eb":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(8106)]).then(n.bind(n,56181)),"@site/docs/API-docs/get-template.api.mdx",56181],"38e3d9c8":[()=>Promise.all([n.e(532),n.e(5900)]).then(n.bind(n,77808)),"@site/docs/API-docs/opensign-api-v-1.info.mdx",77808],"38ec836e":[()=>n.e(8892).then(n.bind(n,79153)),"@site/docs/self-host/intro.md",79153],"393be207":[()=>n.e(7414).then(n.bind(n,1181)),"@site/src/pages/markdown-page.md",1181],"3dbb8da8":[()=>n.e(6261).then(n.bind(n,4024)),"@site/docs/self-host/tutorial-basics/create-a-document.md",4024],"4c5e977b":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(4311),n.e(4682),n.e(1893)]).then(n.t.bind(n,94682,23)),"@theme/ApiItem",94682],"4c9e35b1":[()=>n.e(9035).then(n.t.bind(n,50499,19)),"~blog/default/blog-tags-hola-ea2-list.json",50499],"52d5c0f9":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(8468)]).then(n.bind(n,65313)),"@site/docs/API-docs/deletedocument.api.mdx",65313],59362658:[()=>n.e(2267).then(n.bind(n,27797)),"@site/blog/2021-08-01-mdx-blog-post.mdx",27797],"5a2de241":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(8163)]).then(n.bind(n,85763)),"@site/docs/API-docs/update-template.api.mdx",85763],"5e95c892":[()=>n.e(9661).then(n.bind(n,41892)),"@theme/DocsRoot",41892],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,36809)),"@generated/docusaurus.config",36809],"608ae6a4":[()=>n.e(6938).then(n.t.bind(n,84545,19)),"~blog/default/blog-tags-docusaurus-0e0-list.json",84545],"611db08b":[()=>n.e(6177).then(n.bind(n,52899)),"@site/docs/help/New-Document/sign-yourself.md",52899],"64ee8796":[()=>n.e(3101).then(n.t.bind(n,24469,19)),"/home/runner/work/OpenSign/OpenSign/docs/.docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json",24469],66406991:[()=>n.e(110).then(n.t.bind(n,70711,19)),"~blog/default/blog-tags-hello-039-list.json",70711],"6875c492":[()=>Promise.all([n.e(532),n.e(8531),n.e(4311),n.e(2529),n.e(8610)]).then(n.bind(n,41714)),"@theme/BlogTagsPostsPage",41714],"73664a40":[()=>n.e(3514).then(n.bind(n,81985)),"@site/blog/2019-05-29-long-blog-post.md",81985],"7661071f":[()=>n.e(9642).then(n.bind(n,13174)),"@site/blog/2021-08-26-welcome/index.md?truncated=true",13174],"770b40a9":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(1520)]).then(n.bind(n,9104)),"@site/docs/API-docs/gettemplatelist.api.mdx",9104],"7b076186":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(8489)]).then(n.bind(n,91945)),"@site/docs/API-docs/deletecontact.api.mdx",91945],"814f3328":[()=>n.e(2535).then(n.t.bind(n,45641,19)),"~blog/default/blog-post-list-prop-default.json",45641],"8320e026":[()=>n.e(5507).then(n.bind(n,29761)),"@site/docs/API-docs/intro.md",29761],"8717b14a":[()=>n.e(948).then(n.bind(n,67106)),"@site/blog/2019-05-29-long-blog-post.md?truncated=true",67106],"8a725248":[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(7971)]).then(n.bind(n,80288)),"@site/docs/API-docs/createcontact.api.mdx",80288],"925b3f96":[()=>n.e(9003).then(n.bind(n,43902)),"@site/blog/2019-05-28-first-blog-post.md?truncated=true",43902],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"976116a8":[()=>n.e(6586).then(n.bind(n,96711)),"@site/docs/self-host/tutorial-basics/create-a-blog-post.md",96711],"9e4087bc":[()=>n.e(3608).then(n.bind(n,63169)),"@theme/BlogArchivePage",63169],a2bc1463:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(2245)]).then(n.bind(n,87435)),"@site/docs/API-docs/contactlist.api.mdx",87435],a6aa9e1f:[()=>Promise.all([n.e(532),n.e(8531),n.e(4311),n.e(2529),n.e(3089)]).then(n.bind(n,80046)),"@theme/BlogListPage",80046],a7023ddc:[()=>n.e(1713).then(n.t.bind(n,53457,19)),"~blog/default/blog-tags-tags-4c2.json",53457],a7bd4aaa:[()=>n.e(8518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a80da1cf:[()=>n.e(3205).then(n.t.bind(n,24863,19)),"~blog/default/blog-tags-docusaurus-0e0.json",24863],a88a3db3:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(7894)]).then(n.bind(n,79523)),"@site/docs/API-docs/delete-template.api.mdx",79523],a94703ab:[()=>Promise.all([n.e(532),n.e(4368)]).then(n.bind(n,3394)),"@theme/DocRoot",3394],ac608ad7:[()=>n.e(119).then(n.bind(n,28083)),"@site/docs/self-host/tutorial-extras/manage-docs-versions.md",28083],b2b675dd:[()=>n.e(533).then(n.t.bind(n,28017,19)),"~blog/default/blog-c06.json",28017],b2f554cd:[()=>n.e(1477).then(n.t.bind(n,30010,19)),"~blog/default/blog-archive-80c.json",30010],b5b81866:[()=>n.e(4258).then(n.bind(n,18344)),"@site/docs/self-host/tutorial-basics/congratulations.md",18344],bbdfc22d:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(1531)]).then(n.bind(n,60877)),"@site/docs/API-docs/createtemplate.api.mdx",60877],bfe4b778:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(2087)]).then(n.bind(n,67554)),"@site/docs/API-docs/update-document.api.mdx",67554],c4f5d8e4:[()=>Promise.all([n.e(532),n.e(4195)]).then(n.bind(n,53261)),"@site/src/pages/index.js",53261],c5e4dae0:[()=>n.e(841).then(n.t.bind(n,83769,19)),"/home/runner/work/OpenSign/OpenSign/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",83769],c9fa5aa5:[()=>n.e(6759).then(n.bind(n,8449)),"@site/docs/contribute/CODE_OF_CONDUCT.md",8449],ca7b15b9:[()=>n.e(7608).then(n.t.bind(n,19825,19)),"~docs/default/category-docs-selfhostsidebar-category-tutorial-extras-5b9.json",19825],ccc49370:[()=>Promise.all([n.e(532),n.e(8531),n.e(4311),n.e(2529),n.e(6103)]).then(n.bind(n,65203)),"@theme/BlogPostPage",65203],d1393a72:[()=>n.e(4478).then(n.bind(n,48927)),"@site/docs/help/New-Document/request-signatures.md",48927],d6096017:[()=>n.e(7336).then(n.bind(n,72123)),"@site/docs/self-host/tutorial-basics/markdown-features.mdx",72123],d91ad230:[()=>n.e(230).then(n.bind(n,9702)),"@site/docs/contribute/REPORTING_GUIDELINES.md",9702],d9f32620:[()=>n.e(1914).then(n.bind(n,18123)),"@site/blog/2021-08-26-welcome/index.md",18123],debc6b9f:[()=>n.e(7429).then(n.bind(n,14953)),"@site/docs/self-host/tutorial-basics/deploy-your-site.md",14953],e16015ca:[()=>n.e(9700).then(n.t.bind(n,5688,19)),"~blog/default/blog-tags-hola-ea2.json",5688],e226bb09:[()=>n.e(4955).then(n.bind(n,45507)),"@site/docs/contribute/intro.md",45507],e273c56f:[()=>n.e(2362).then(n.bind(n,29954)),"@site/blog/2019-05-28-first-blog-post.md",29954],ef5d5d5d:[()=>n.e(1773).then(n.t.bind(n,15745,19)),"/home/runner/work/OpenSign/OpenSign/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",15745],f0349969:[()=>n.e(1359).then(n.bind(n,68063)),"@site/docs/self-host/tutorial-extras/translate-your-site.md",68063],f0ff4a36:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(1332)]).then(n.bind(n,94348)),"@site/docs/API-docs/getdocument.api.mdx",94348],f4f34a3a:[()=>n.e(8636).then(n.bind(n,80743)),"@site/blog/2021-08-01-mdx-blog-post.mdx?truncated=true",80743],fa40969b:[()=>Promise.all([n.e(532),n.e(8531),n.e(8140),n.e(8475),n.e(273)]).then(n.bind(n,61247)),"@site/docs/API-docs/getdocumentlist.api.mdx",61247]};var l=n(85893);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(99670),u=n(30226);function d(e,t){if("*"===e)return o()({loading:s,loader:()=>n.e(1772).then(n.bind(n,51772)),modules:["@theme/NotFound"],webpack:()=>[51772],render(e,t){const n=e.default;return(0,l.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},p=[],f=[],g=(0,c.Z)(r);return Object.entries(g).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),o().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;return delete o.__context,(0,l.jsx)(u.z,{value:i,children:(0,l.jsx)(a,{...o,...n})})}})}const p=[{path:"/blog",component:d("/blog","31f"),exact:!0},{path:"/blog/archive",component:d("/blog/archive","2a6"),exact:!0},{path:"/blog/first-blog-post",component:d("/blog/first-blog-post","2e6"),exact:!0},{path:"/blog/long-blog-post",component:d("/blog/long-blog-post","86f"),exact:!0},{path:"/blog/mdx-blog-post",component:d("/blog/mdx-blog-post","150"),exact:!0},{path:"/blog/tags",component:d("/blog/tags","4c7"),exact:!0},{path:"/blog/tags/docusaurus",component:d("/blog/tags/docusaurus","b3d"),exact:!0},{path:"/blog/tags/facebook",component:d("/blog/tags/facebook","cb9"),exact:!0},{path:"/blog/tags/hello",component:d("/blog/tags/hello","273"),exact:!0},{path:"/blog/tags/hola",component:d("/blog/tags/hola","18e"),exact:!0},{path:"/blog/welcome",component:d("/blog/welcome","7f4"),exact:!0},{path:"/markdown-page",component:d("/markdown-page","e98"),exact:!0},{path:"/docs",component:d("/docs","0dc"),routes:[{path:"/docs",component:d("/docs","ab2"),routes:[{path:"/docs",component:d("/docs","877"),routes:[{path:"/docs/API-docs/contactlist",component:d("/docs/API-docs/contactlist","b9c"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/createcontact",component:d("/docs/API-docs/createcontact","d4a"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/createdocument",component:d("/docs/API-docs/createdocument","685"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/createtemplate",component:d("/docs/API-docs/createtemplate","cd8"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/delete-template",component:d("/docs/API-docs/delete-template","7b5"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/deletecontact",component:d("/docs/API-docs/deletecontact","1a4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/deletedocument",component:d("/docs/API-docs/deletedocument","e08"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/get-template",component:d("/docs/API-docs/get-template","62e"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/get-user",component:d("/docs/API-docs/get-user","e5b"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/getcontact",component:d("/docs/API-docs/getcontact","b29"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/getdocument",component:d("/docs/API-docs/getdocument","84c"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/getdocumentlist",component:d("/docs/API-docs/getdocumentlist","219"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/gettemplatelist",component:d("/docs/API-docs/gettemplatelist","a04"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/intro",component:d("/docs/API-docs/intro","623"),exact:!0},{path:"/docs/API-docs/opensign-api-v-1",component:d("/docs/API-docs/opensign-api-v-1","5a4"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/update-document",component:d("/docs/API-docs/update-document","568"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/API-docs/update-template",component:d("/docs/API-docs/update-template","362"),exact:!0,sidebar:"apiSidebar"},{path:"/docs/category/tutorial---basics",component:d("/docs/category/tutorial---basics","ebd"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/category/tutorial---extras",component:d("/docs/category/tutorial---extras","9ce"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/contribute/CODE_OF_CONDUCT",component:d("/docs/contribute/CODE_OF_CONDUCT","716"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/COMMUNITY",component:d("/docs/contribute/COMMUNITY","a03"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/INSTALLATION",component:d("/docs/contribute/INSTALLATION","ca0"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/intro",component:d("/docs/contribute/intro","4c8"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/contribute/REPORTING_GUIDELINES",component:d("/docs/contribute/REPORTING_GUIDELINES","0fe"),exact:!0,sidebar:"contributeSidebar"},{path:"/docs/help/intro",component:d("/docs/help/intro","a77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/request-signatures",component:d("/docs/help/New-Document/request-signatures","2cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/help/New-Document/sign-yourself",component:d("/docs/help/New-Document/sign-yourself","700"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/intro",component:d("/docs/intro","a01"),exact:!0},{path:"/docs/self-host/intro",component:d("/docs/self-host/intro","f36"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/congratulations",component:d("/docs/self-host/tutorial-basics/congratulations","fce"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/create-a-blog-post",component:d("/docs/self-host/tutorial-basics/create-a-blog-post","d35"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/create-a-document",component:d("/docs/self-host/tutorial-basics/create-a-document","490"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/create-a-page",component:d("/docs/self-host/tutorial-basics/create-a-page","d29"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/deploy-your-site",component:d("/docs/self-host/tutorial-basics/deploy-your-site","9e1"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-basics/markdown-features",component:d("/docs/self-host/tutorial-basics/markdown-features","5e3"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-extras/manage-docs-versions",component:d("/docs/self-host/tutorial-extras/manage-docs-versions","637"),exact:!0,sidebar:"selfhostSidebar"},{path:"/docs/self-host/tutorial-extras/translate-your-site",component:d("/docs/self-host/tutorial-extras/translate-your-site","60b"),exact:!0,sidebar:"selfhostSidebar"}]}]}]},{path:"/",component:d("/","622"),exact:!0},{path:"*",component:d("*")}]},98934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>i});var r=n(67294),o=n(85893);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},97221:(e,t,n)=>{"use strict";var r=n(67294),o=n(20745),a=n(73727),i=n(70405),l=n(10412);const s=[n(32497),n(3310),n(18320),n(52295),n(96231)];var c=n(723),u=n(16550),d=n(18790),p=n(85893);function f(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var g=n(35742),m=n(52263),h=n(44996),y=n(86668),b=n(10833),v=n(94711),w=n(19727),k=n(43320),x=n(18780),S=n(90197);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,m.default)(),r=(0,v.l)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,p.jsxs)(g.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function A(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,m.default)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,m.default)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,h.default)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{property:"og:url",content:o}),(0,p.jsx)("link",{rel:"canonical",href:o})]})}function _(){const{i18n:{currentLocale:e}}=(0,m.default)(),{metadata:t,image:n}=(0,y.L)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:w.h})]}),n&&(0,p.jsx)(b.d,{image:n}),(0,p.jsx)(A,{}),(0,p.jsx)(E,{}),(0,p.jsx)(S.Z,{tag:k.HX,locale:e}),(0,p.jsx)(g.Z,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const j=new Map;function C(e){if(j.has(e.pathname))return{...e,pathname:j.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return j.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return j.set(e.pathname,t),{...e,pathname:t}}var T=n(98934),P=n(58940),O=n(20469);function N(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>o.forEach((e=>e?.()))}const I=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,O.Z)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,o=t.hash===n.hash,a=t.search===n.search;if(r&&o&&!a)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),N("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function R(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}var L=n(25108);class D extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.default.canUseDOM?N("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=N("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),R(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{L.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,p.jsx)(I,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(u.AW,{location:t,render:()=>e})})}}const F=D,M="__docusaurus-base-url-issue-banner-container",B="__docusaurus-base-url-issue-banner",z="__docusaurus-base-url-issue-banner-suggestion-container";function U(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var K=n(99670);const X=new Set,J=new Set,ee=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,te={prefetch(e){if(!(e=>!ee()&&!J.has(e)&&!X.has(e))(e))return!1;X.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(Y).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,K.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Q(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!ee()&&!J.has(e))(e)&&(J.add(e),R(e))},ne=Object.freeze(te);var re=n(25108);const oe=Boolean(!0);if(l.default.canUseDOM){window.docusaurus=ne;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(i.B6,{children:(0,p.jsx)(a.VK,{children:(0,p.jsx)(Z,{})})}),n=(e,t)=>{re.error("Docusaurus React Root onRecoverableError:",e,t)},l=()=>{if(oe)r.startTransition((()=>{o.hydrateRoot(e,t,{onRecoverableError:n})}));else{const a=o.createRoot(e,{onRecoverableError:n});r.startTransition((()=>{a.render(t)}))}};R(window.location.pathname).then(l)}},58940:(e,t,n)=>{"use strict";n.d(t,{_:()=>d,M:()=>p});var r=n(67294),o=n(36809);const a=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"help/intro","docs":[{"id":"API-docs/contactlist","path":"/docs/API-docs/contactlist","sidebar":"apiSidebar"},{"id":"API-docs/createcontact","path":"/docs/API-docs/createcontact","sidebar":"apiSidebar"},{"id":"API-docs/createdocument","path":"/docs/API-docs/createdocument","sidebar":"apiSidebar"},{"id":"API-docs/createtemplate","path":"/docs/API-docs/createtemplate","sidebar":"apiSidebar"},{"id":"API-docs/delete-template","path":"/docs/API-docs/delete-template","sidebar":"apiSidebar"},{"id":"API-docs/deletecontact","path":"/docs/API-docs/deletecontact","sidebar":"apiSidebar"},{"id":"API-docs/deletedocument","path":"/docs/API-docs/deletedocument","sidebar":"apiSidebar"},{"id":"API-docs/get-template","path":"/docs/API-docs/get-template","sidebar":"apiSidebar"},{"id":"API-docs/get-user","path":"/docs/API-docs/get-user","sidebar":"apiSidebar"},{"id":"API-docs/getcontact","path":"/docs/API-docs/getcontact","sidebar":"apiSidebar"},{"id":"API-docs/getdocument","path":"/docs/API-docs/getdocument","sidebar":"apiSidebar"},{"id":"API-docs/getdocumentlist","path":"/docs/API-docs/getdocumentlist","sidebar":"apiSidebar"},{"id":"API-docs/gettemplatelist","path":"/docs/API-docs/gettemplatelist","sidebar":"apiSidebar"},{"id":"API-docs/intro","path":"/docs/API-docs/intro"},{"id":"API-docs/opensign-api-v-1","path":"/docs/API-docs/opensign-api-v-1","sidebar":"apiSidebar"},{"id":"API-docs/update-document","path":"/docs/API-docs/update-document","sidebar":"apiSidebar"},{"id":"API-docs/update-template","path":"/docs/API-docs/update-template","sidebar":"apiSidebar"},{"id":"contribute/CODE_OF_CONDUCT","path":"/docs/contribute/CODE_OF_CONDUCT","sidebar":"contributeSidebar"},{"id":"contribute/COMMUNITY","path":"/docs/contribute/COMMUNITY","sidebar":"contributeSidebar"},{"id":"contribute/INSTALLATION","path":"/docs/contribute/INSTALLATION","sidebar":"contributeSidebar"},{"id":"contribute/intro","path":"/docs/contribute/intro","sidebar":"contributeSidebar"},{"id":"contribute/REPORTING_GUIDELINES","path":"/docs/contribute/REPORTING_GUIDELINES","sidebar":"contributeSidebar"},{"id":"help/intro","path":"/docs/help/intro","sidebar":"tutorialSidebar"},{"id":"help/New-Document/request-signatures","path":"/docs/help/New-Document/request-signatures","sidebar":"tutorialSidebar"},{"id":"help/New-Document/sign-yourself","path":"/docs/help/New-Document/sign-yourself","sidebar":"tutorialSidebar"},{"id":"intro","path":"/docs/intro"},{"id":"self-host/intro","path":"/docs/self-host/intro","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/congratulations","path":"/docs/self-host/tutorial-basics/congratulations","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/create-a-blog-post","path":"/docs/self-host/tutorial-basics/create-a-blog-post","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/create-a-document","path":"/docs/self-host/tutorial-basics/create-a-document","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/create-a-page","path":"/docs/self-host/tutorial-basics/create-a-page","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/deploy-your-site","path":"/docs/self-host/tutorial-basics/deploy-your-site","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-basics/markdown-features","path":"/docs/self-host/tutorial-basics/markdown-features","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-extras/manage-docs-versions","path":"/docs/self-host/tutorial-extras/manage-docs-versions","sidebar":"selfhostSidebar"},{"id":"self-host/tutorial-extras/translate-your-site","path":"/docs/self-host/tutorial-extras/translate-your-site","sidebar":"selfhostSidebar"},{"id":"/category/tutorial---basics","path":"/docs/category/tutorial---basics","sidebar":"selfhostSidebar"},{"id":"/category/tutorial---extras","path":"/docs/category/tutorial---extras","sidebar":"selfhostSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/help/intro","label":"help/intro"}},"selfhostSidebar":{"link":{"path":"/docs/self-host/intro","label":"self-host/intro"}},"contributeSidebar":{"link":{"path":"/docs/contribute/CODE_OF_CONDUCT","label":"contribute/CODE_OF_CONDUCT"}},"apiSidebar":{"link":{"path":"/docs/API-docs/opensign-api-v-1","label":"API-docs/opensign-api-v-1"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(57529);const s=JSON.parse('{"docusaurusVersion":"3.0.1","siteVersion":"0.1.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.0.1"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.0.1"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.0.1"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.0.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.0.1"},"docusaurus-plugin-openapi-docs":{"type":"package","name":"docusaurus-plugin-openapi-docs","version":"3.0.0-beta.3"},"docusaurus-theme-openapi":{"type":"package","name":"docusaurus-theme-openapi-docs","version":"3.0.0-beta.3"}}}');var c=n(85893);const u={siteConfig:o.default,siteMetadata:s,globalData:a,i18n:i,codeTranslations:l},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},44763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(67294),o=n(10412),a=n(35742),i=n(18780),l=n(70555),s=n(85893);function c(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,s.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,s.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,s.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)(f,{fallback:()=>(0,s.jsx)(c,{error:t,tryAgain:n}),children:[(0,s.jsx)(a.Z,{children:(0,s.jsx)("title",{children:"Page Error"})}),(0,s.jsx)(l.Z,{children:(0,s.jsx)(c,{error:t,tryAgain:n})})]})}const p=e=>(0,s.jsx)(d,{...e});class f extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.default.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},10412:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},35742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});n(67294);var r=n(70405),o=n(85893);function a(e){return(0,o.jsx)(r.ql,{...e})}},39960:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>f});var r=n(67294),o=n(73727),a=n(18780),i=n(52263),l=n(13919),s=n(10412),c=n(85893);const u=r.createContext({collectLink:()=>{}});var d=n(44996);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:g,isActive:m,"data-noBrokenLinkCheck":h,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,i.default)(),{withBaseUrl:k}=(0,d.useBaseUrlUtils)(),x=(0,r.useContext)(u),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const E=p||f;const A=(0,l.Z)(E),_=E?.replace("pathname://","");let j=void 0!==_?(C=_,y&&(e=>e.startsWith("/"))(C)?k(C):C):void 0;var C;j&&A&&(j=(0,a.applyTrailingSlash)(j,{trailingSlash:v,baseUrl:w}));const T=(0,r.useRef)(!1),P=n?o.OL:o.rU,O=s.default.canUseIntersectionObserver,N=(0,r.useRef)(),I=()=>{T.current||null==j||(window.docusaurus.preload(j),T.current=!0)};(0,r.useEffect)((()=>(!O&&A&&null!=j&&window.docusaurus.prefetch(j),()=>{O&&N.current&&N.current.disconnect()})),[N,j,O,A]);const R=j?.startsWith("#")??!1,L=!j||!A||R;return L||h||x.collectLink(j),L?(0,c.jsx)("a",{ref:S,href:j,...E&&!A&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,c.jsx)(P,{...b,onMouseEnter:I,onTouchStart:I,innerRef:e=>{S.current=e,O&&e&&A&&(N.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(N.current.unobserve(e),N.current.disconnect(),null!=j&&window.docusaurus.prefetch(j))}))})),N.current.observe(e))},to:j,...n&&{isActive:m,activeClassName:g}})}const f=r.forwardRef(p)},11875:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=()=>null},95999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u,I:()=>c});var r=n(67294),o=n(85893);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(57529),l=n(25108);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function c(e,t){let{message:n,id:r}=e;return a(s({message:n,id:r}),t)}function u(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw l.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=s({message:t,id:n});return(0,o.jsx)(o.Fragment,{children:a(i,r)})}},29935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},13919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>o,b:()=>r})},44996:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>l,useBaseUrlUtils:()=>i});var r=n(67294),o=n(52263),a=n(13919);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,o.default)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:o=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,a.b)(n))return n;if(o)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},52263:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(67294),o=n(58940);function a(){return(0,r.useContext)(o._)}},72389:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(67294),o=n(98934);function a(){return(0,r.useContext)(o._)}},20469:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294);const o=n(10412).default.canUseDOM?r.useLayoutEffect:r.useEffect},99670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const l=o?`${o}.${a}`:a;r(i)?e(i,l):t[l]=i}))}(e),t}},30226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>i});var r=n(67294),o=n(85893);const a=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(a),l=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,o.jsx)(a.Provider,{value:l,children:t})}},80143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>y,gA:()=>f,WS:()=>g,_r:()=>d,Jo:()=>b,zh:()=>p,yW:()=>h,gB:()=>m});var r=n(16550),o=n(52263),a=n(29935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,o.default)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}function c(e,t){const n=s(e,t),o=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:o,alternateDocVersions:o?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(o.id):{}}}const u={},d=()=>i("docusaurus-plugin-content-docs")??u,p=e=>function(e,t,n){void 0===t&&(t=a.m),void 0===n&&(n={});const r=i(e),o=r?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}("docusaurus-plugin-content-docs",e,{failfast:!0});function f(e){void 0===e&&(e={});const t=d(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const o=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return a}(t,n,e)}function g(e){void 0===e&&(e={});const t=f(e),{pathname:n}=(0,r.TH)();if(!t)return;return{activePlugin:t,activeVersion:s(t.pluginData,n)}}function m(e){return p(e).versions}function h(e){const t=p(e);return l(t)}function y(e){const t=p(e),{pathname:n}=(0,r.TH)();return c(t,n)}function b(e){const t=p(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:c(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},18320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(74865),o=n.n(r);o().configure({showSpinner:!1});const a={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{o().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(14965),o=n(36809);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(96854),n(6726)(`./prism-${e}`)})),delete globalThis.Prism}(r.p1)},92503:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});n(67294);var r=n(36905),o=n(95999),a=n(86668),i=n(39960);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var s=n(85893);function c(e){let{as:t,id:n,...c}=e;const{navbar:{hideOnScroll:u}}=(0,a.L)();if("h1"===t||!n)return(0,s.jsx)(t,{...c,id:void 0});const d=(0,o.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof c.children?c.children:n});return(0,s.jsxs)(t,{...c,className:(0,r.Z)("anchor",u?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,c.className),id:n,children:[c.children,(0,s.jsx)(i.default,{className:"hash-link",to:`#${n}`,"aria-label":d,title:d,children:"\u200b"})]})}},39471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});n(67294);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(85893);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},70555:(e,t,n)=>{"use strict";n.d(t,{Z:()=>ot});var r=n(67294),o=n(36905),a=n(44763),i=n(10833),l=n(55225),s=n(35281),c=n(19727);const u={skipToContent:"skipToContent_fXgn"};var d=n(85893);function p(){return(0,d.jsx)(l.l,{className:u.skipToContent})}var f=n(86668),g=n(59689),m=n(95999);function h(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:o=1.2,className:a,...i}=e;return(0,d.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,d.jsx)("g",{stroke:r,strokeWidth:o,children:(0,d.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const y={closeButton:"closeButton_CVFx"};function b(e){return(0,d.jsx)("button",{type:"button","aria-label":(0,m.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.Z)("clean-btn close",y.closeButton,e.className),children:(0,d.jsx)(h,{width:14,height:14,strokeWidth:3.1})})}const v={content:"content_knG7"};function w(e){const{announcementBar:t}=(0,f.L)(),{content:n}=t;return(0,d.jsx)("div",{...e,className:(0,o.Z)(v.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const k={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function x(){const{announcementBar:e}=(0,f.L)(),{isActive:t,close:n}=(0,g.nT)();if(!t)return null;const{backgroundColor:r,textColor:o,isCloseable:a}=e;return(0,d.jsxs)("div",{className:k.announcementBar,style:{backgroundColor:r,color:o},role:"banner",children:[a&&(0,d.jsx)("div",{className:k.announcementBarPlaceholder}),(0,d.jsx)(w,{className:k.announcementBarContent}),a&&(0,d.jsx)(b,{onClick:n,className:k.announcementBarClose})]})}var S=n(93163),E=n(99445),A=n(69800),_=n(76857);function j(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:a}=(0,_.Y)();return(0,d.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,d.jsxs)("div",{className:(0,o.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":a}),children:[(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var C=n(92949),T=n(72389);function P(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function O(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const N={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function I(e){let{className:t,buttonClassName:n,value:r,onChange:a}=e;const i=(0,T.default)(),l=(0,m.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,m.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,m.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,d.jsx)("div",{className:(0,o.Z)(N.toggle,t),children:(0,d.jsxs)("button",{className:(0,o.Z)("clean-btn",N.toggleButton,!i&&N.toggleButtonDisabled,n),type:"button",onClick:()=>a("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,d.jsx)(P,{className:(0,o.Z)(N.toggleIcon,N.lightToggleIcon)}),(0,d.jsx)(O,{className:(0,o.Z)(N.toggleIcon,N.darkToggleIcon)})]})})}const R=r.memo(I),L={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function D(e){let{className:t}=e;const n=(0,f.L)().navbar.style,r=(0,f.L)().colorMode.disableSwitch,{colorMode:o,setColorMode:a}=(0,C.I)();return r?null:(0,d.jsx)(R,{className:t,buttonClassName:"dark"===n?L.darkNavbarColorModeToggle:void 0,value:o,onChange:a})}var F=n(21327);function M(){return(0,d.jsx)(F.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function B(){const e=(0,S.e)();return(0,d.jsx)("button",{type:"button","aria-label":(0,m.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,d.jsx)(h,{color:"var(--ifm-color-emphasis-600)"})})}function z(){return(0,d.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,d.jsx)(M,{}),(0,d.jsx)(D,{className:"margin-right--md"}),(0,d.jsx)(B,{})]})}var U=n(39960),$=n(44996),q=n(13919),H=n(98022),G=n(39471);function V(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:o,label:a,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...c}=e;const u=(0,$.default)(r),p=(0,$.default)(t),f=(0,$.default)(o,{forcePrependBaseUrl:!0}),g=a&&o&&!(0,q.Z)(o),m=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,d.jsxs)(d.Fragment,{children:[a,g&&(0,d.jsx)(G.Z,{...l&&{width:12,height:12}})]})};return o?(0,d.jsx)(U.default,{href:s?f:o,...c,...m}):(0,d.jsx)(U.default,{to:u,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?(0,H.F)(n,t.pathname):t.pathname.startsWith(p)},...c,...m})}function W(e){let{className:t,isDropdownItem:n=!1,...r}=e;const a=(0,d.jsx)(V,{className:(0,o.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,d.jsx)("li",{children:a}):a}function Z(e){let{className:t,isDropdownItem:n,...r}=e;return(0,d.jsx)("li",{className:"menu__list-item",children:(0,d.jsx)(V,{className:(0,o.Z)("menu__link",t),...r})})}function Y(e){let{mobile:t=!1,position:n,...r}=e;const o=t?Z:W;return(0,d.jsx)(o,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var Q=n(86043),K=n(48596),X=n(51753);const J={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ee(e,t){return e.some((e=>function(e,t){return!!(0,K.Mg)(e.to,t)||!!(0,H.F)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function te(e){let{items:t,position:n,className:a,onClick:i,...l}=e;const s=(0,r.useRef)(null),[c,u]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&u(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[s]),(0,d.jsxs)("div",{ref:s,className:(0,o.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,d.jsx)(V,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:l.to?void 0:"#",className:(0,o.Z)("navbar__link",a),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),u(!c))},children:l.children??l.label}),(0,d.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(ye,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function ne(e){let{items:t,className:n,position:a,onClick:i,...l}=e;const s=(0,X.b)(),c=ee(t,s),{collapsed:u,toggleCollapsed:p,setCollapsed:f}=(0,Q.u)({initialState:()=>!c});return(0,r.useEffect)((()=>{c&&f(!c)}),[s,c,f]),(0,d.jsxs)("li",{className:(0,o.Z)("menu__list-item",{"menu__list-item--collapsed":u}),children:[(0,d.jsx)(V,{role:"button",className:(0,o.Z)(J.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...l,onClick:e=>{e.preventDefault(),p()},children:l.children??l.label}),(0,d.jsx)(Q.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:u,children:t.map(((e,t)=>(0,r.createElement)(ye,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function re(e){let{mobile:t=!1,...n}=e;const r=t?ne:te;return(0,d.jsx)(r,{...n})}var oe=n(52263),ae=n(94711),ie=n(16550);function le(e){let{width:t=20,height:n=20,...r}=e;return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const se="iconLanguage_nlXk";var ce=n(11875);const ue={navbarSearchContainer:"navbarSearchContainer_Bca1"};function de(e){let{children:t,className:n}=e;return(0,d.jsx)("div",{className:(0,o.Z)(n,ue.navbarSearchContainer),children:t})}var pe=n(80143),fe=n(53438);var ge=n(60373);const me=e=>e.docs.find((t=>t.id===e.mainDocId));const he={default:Y,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:o="",...a}=e;const{i18n:{currentLocale:i,locales:l,localeConfigs:s}}=(0,oe.default)(),c=(0,ae.l)(),{search:u,hash:p}=(0,ie.TH)(),f=[...n,...l.map((e=>{const n=`${`pathname://${c.createUrl({locale:e,fullyQualified:!1})}`}${u}${p}${o}`;return{label:s[e].label,lang:s[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,m.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):s[i].label;return(0,d.jsx)(re,{...a,mobile:t,label:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(le,{className:se}),g]}),items:f})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,d.jsx)(de,{className:n,children:(0,d.jsx)(ce.Z,{})})},dropdown:re,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:a=!1}=e;const i=a?"li":"div";return(0,d.jsx)(i,{className:(0,o.Z)({navbar__item:!r&&!a,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,pe.Iw)(r),i=(0,fe.vY)(t,r),l=a?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,d.jsx)(Y,{exact:!0,...o,isActive:()=>l||!!a?.sidebar&&a.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,pe.Iw)(r),i=(0,fe.oz)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,d.jsx)(Y,{exact:!0,...o,isActive:()=>a?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...o}=e;const a=(0,fe.lO)(r)[0],i=t??a.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(a).path;return(0,d.jsx)(Y,{...o,label:i,to:l})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:o,dropdownItemsAfter:a,...i}=e;const{search:l,hash:s}=(0,ie.TH)(),c=(0,pe.Iw)(n),u=(0,pe.gB)(n),{savePreferredVersionName:p}=(0,ge.J)(n),f=[...o,...u.map((e=>{const t=c.alternateDocVersions[e.name]??me(e);return{label:e.label,to:`${t.path}${l}${s}`,isActive:()=>e===c.activeVersion,onClick:()=>p(e.name)}})),...a],g=(0,fe.lO)(n)[0],h=t&&f.length>1?(0,m.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,y=t&&f.length>1?void 0:me(g).path;return f.length<=1?(0,d.jsx)(Y,{...i,mobile:t,label:h,to:y,isActive:r?()=>!1:void 0}):(0,d.jsx)(re,{...i,mobile:t,label:h,to:y,items:f,isActive:r?()=>!1:void 0})}};function ye(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=he[r];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,d.jsx)(o,{...n})}function be(){const e=(0,S.e)(),t=(0,f.L)().navbar.items;return(0,d.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(ye,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function ve(e){return(0,d.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,d.jsx)(m.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function we(){const e=0===(0,f.L)().navbar.items.length,t=(0,_.Y)();return(0,d.jsxs)(d.Fragment,{children:[!e&&(0,d.jsx)(ve,{onClick:()=>t.hide()}),t.content]})}function ke(){const e=(0,S.e)();return(0,A.N)(e.shown),e.shouldRender?(0,d.jsx)(j,{header:(0,d.jsx)(z,{}),primaryMenu:(0,d.jsx)(be,{}),secondaryMenu:(0,d.jsx)(we,{})}):null}const xe={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Se(e){return(0,d.jsx)("div",{role:"presentation",...e,className:(0,o.Z)("navbar-sidebar__backdrop",e.className)})}function Ee(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:r}}=(0,f.L)(),a=(0,S.e)(),{navbarRef:i,isNavbarVisible:l}=(0,E.c)(n);return(0,d.jsxs)("nav",{ref:i,"aria-label":(0,m.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.Z)("navbar","navbar--fixed-top",n&&[xe.navbarHideable,!l&&xe.navbarHidden],{"navbar--dark":"dark"===r,"navbar--primary":"primary"===r,"navbar-sidebar--show":a.shown}),children:[t,(0,d.jsx)(Se,{onClick:a.toggle}),(0,d.jsx)(ke,{})]})}var Ae=n(69690),_e=n(58978);function je(e){let{width:t=30,height:n=30,className:r,...o}=e;return(0,d.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...o,children:(0,d.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Ce(){const{toggle:e,shown:t}=(0,S.e)();return(0,d.jsx)("button",{onClick:e,"aria-label":(0,m.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,d.jsx)(je,{})})}const Te={colorModeToggle:"colorModeToggle_DEke"};function Pe(e){let{items:t}=e;return(0,d.jsx)(d.Fragment,{children:t.map(((e,t)=>(0,d.jsx)(Ae.QW,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,d.jsx)(ye,{...e})},t)))})}function Oe(e){let{left:t,right:n}=e;return(0,d.jsxs)("div",{className:"navbar__inner",children:[(0,d.jsx)("div",{className:"navbar__items",children:t}),(0,d.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function Ne(){const e=(0,S.e)(),t=(0,f.L)().navbar.items,[n,r]=(0,_e.A)(t),o=t.find((e=>"search"===e.type));return(0,d.jsx)(Oe,{left:(0,d.jsxs)(d.Fragment,{children:[!e.disabled&&(0,d.jsx)(Ce,{}),(0,d.jsx)(M,{}),(0,d.jsx)(Pe,{items:n})]}),right:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(Pe,{items:r}),(0,d.jsx)(D,{className:Te.colorModeToggle}),!o&&(0,d.jsx)(de,{children:(0,d.jsx)(ce.Z,{})})]})})}function Ie(){return(0,d.jsx)(Ee,{children:(0,d.jsx)(Ne,{})})}var Re=n(42489);function Le(e){let{item:t}=e;const{to:n,href:r,label:o,prependBaseUrlToHref:a,...i}=t,l=(0,$.default)(n),s=(0,$.default)(r,{forcePrependBaseUrl:!0});return(0,d.jsxs)(U.default,{className:"footer__link-item",...r?{href:a?s:r}:{to:l},...i,children:[o,r&&!(0,q.Z)(r)&&(0,d.jsx)(G.Z,{})]})}function De(e){let{item:t}=e;return t.html?(0,d.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)("li",{className:"footer__item",children:(0,d.jsx)(Le,{item:t})},t.href??t.to)}function Fe(e){let{column:t}=e;return(0,d.jsxs)("div",{className:"col footer__col",children:[(0,d.jsx)("div",{className:"footer__title",children:t.title}),(0,d.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,d.jsx)(De,{item:e},t)))})]})}function Me(e){let{columns:t}=e;return(0,d.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,d.jsx)(Fe,{column:e},t)))})}function Be(){return(0,d.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function ze(e){let{item:t}=e;return t.html?(0,d.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)(Le,{item:t})}function Ue(e){let{links:t}=e;return(0,d.jsx)("div",{className:"footer__links text--center",children:(0,d.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,d.jsxs)(r.Fragment,{children:[(0,d.jsx)(ze,{item:e}),t.length!==n+1&&(0,d.jsx)(Be,{})]},n)))})})}function $e(e){let{links:t}=e;return(0,Re.a)(t)?(0,d.jsx)(Me,{columns:t}):(0,d.jsx)(Ue,{links:t})}var qe=n(59637);const He={footerLogoLink:"footerLogoLink_BH7S"};function Ge(e){let{logo:t}=e;const{withBaseUrl:n}=(0,$.useBaseUrlUtils)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,d.jsx)(qe.default,{className:(0,o.Z)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function Ve(e){let{logo:t}=e;return t.href?(0,d.jsx)(U.default,{href:t.href,className:He.footerLogoLink,target:t.target,children:(0,d.jsx)(Ge,{logo:t})}):(0,d.jsx)(Ge,{logo:t})}function We(e){let{copyright:t}=e;return(0,d.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function Ze(e){let{style:t,links:n,logo:r,copyright:a}=e;return(0,d.jsx)("footer",{className:(0,o.Z)("footer",{"footer--dark":"dark"===t}),children:(0,d.jsxs)("div",{className:"container container-fluid",children:[n,(r||a)&&(0,d.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,d.jsx)("div",{className:"margin-bottom--sm",children:r}),a]})]})})}function Ye(){const{footer:e}=(0,f.L)();if(!e)return null;const{copyright:t,links:n,logo:r,style:o}=e;return(0,d.jsx)(Ze,{style:o,links:n&&n.length>0&&(0,d.jsx)($e,{links:n}),logo:r&&(0,d.jsx)(Ve,{logo:r}),copyright:t&&(0,d.jsx)(We,{copyright:t})})}const Qe=r.memo(Ye);var Ke=n(902),Xe=n(12466);const Je=(0,Ke.Qc)([C.S,g.pl,Xe.OC,ge.L5,i.VC,_e.V]);function et(e){let{children:t}=e;return(0,d.jsx)(Je,{children:t})}var tt=n(92503);function nt(e){let{error:t,tryAgain:n}=e;return(0,d.jsx)("main",{className:"container margin-vert--xl",children:(0,d.jsx)("div",{className:"row",children:(0,d.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,d.jsx)(tt.Z,{as:"h1",className:"hero__title",children:(0,d.jsx)(m.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,d.jsx)("div",{className:"margin-vert--lg",children:(0,d.jsx)(Ae.Cw,{onClick:n,className:"button button--primary shadow--lw"})}),(0,d.jsx)("hr",{}),(0,d.jsx)("div",{className:"margin-vert--md",children:(0,d.jsx)(Ae.aG,{error:t})})]})})})}const rt={mainWrapper:"mainWrapper_z2l0"};function ot(e){const{children:t,noFooter:n,wrapperClassName:r,title:u,description:f}=e;return(0,c.t)(),(0,d.jsxs)(et,{children:[(0,d.jsx)(i.d,{title:u,description:f}),(0,d.jsx)(p,{}),(0,d.jsx)(x,{}),(0,d.jsx)(Ie,{}),(0,d.jsx)("div",{id:l.u,className:(0,o.Z)(s.k.wrapper.main,rt.mainWrapper,r),children:(0,d.jsx)(a.Z,{fallback:e=>(0,d.jsx)(nt,{...e}),children:t})}),!n&&(0,d.jsx)(Qe,{})]})}},21327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(67294);var r=n(39960),o=n(44996),a=n(52263),i=n(86668),l=n(59637),s=n(85893);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.default)(t.src),dark:(0,o.default)(t.srcDark||t.src)},i=(0,s.jsx)(l.default,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.default)(),{navbar:{title:n,logo:l}}=(0,i.L)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.default)(l?.href||"/"),g=n?"":t,m=l?.alt??g;return(0,s.jsxs)(r.default,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(c,{logo:l,alt:m,imageClassName:u}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},90197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});n(67294);var r=n(35742),o=n(85893);function a(e){let{locale:t,version:n,tag:a}=e;const i=t;return(0,o.jsxs)(r.Z,{children:[t&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,o.jsx)("meta",{name:"docusaurus_version",content:n}),a&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:a}),i&&(0,o.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,o.jsx)("meta",{name:"docsearch:version",content:n}),a&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:a})]})}},59637:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});n(67294);var r=n(18431),o=n(85893);function a(e){const{sources:t,className:n,alt:a,...i}=e;return(0,o.jsx)(r.Z,{className:n,children:e=>{let{theme:n,className:r}=e;return(0,o.jsx)("img",{src:t[n],alt:a,className:r,...i})}})}},86043:(e,t,n)=>{"use strict";n.d(t,{u:()=>c,z:()=>y});var r=n(67294),o=n(10412),a=n(20469),i=n(91442),l=n(85893);const s="ease-in-out";function c(e){let{initialState:t}=e;const[n,o]=(0,r.useState)(t??!1),a=(0,r.useCallback)((()=>{o((e=>!e))}),[]);return{collapsed:n,setCollapsed:o,toggleCollapsed:a}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:o}=e;const a=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=o?.duration??function(e){if((0,i.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${o?.easing??s}`,height:`${t}px`}}function l(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!a.current)return p(e,n),void(a.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(l(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,o])}function g(e){if(!o.default.canUseDOM)return e?u:d}function m(e){let{as:t="div",collapsed:n,children:o,animation:a,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:a}),(0,l.jsx)(t,{ref:u,style:c?void 0:g(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:s,children:o})}function h(e){let{collapsed:t,...n}=e;const[o,i]=(0,r.useState)(!t),[s,c]=(0,r.useState)(t);return(0,a.Z)((()=>{t||i(!0)}),[t]),(0,a.Z)((()=>{o&&c(t)}),[o,t]),o?(0,l.jsx)(m,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?h:m;return(0,l.jsx)(r,{...n})}},18431:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});var r=n(67294),o=n(788),a=n(72389),i=n(92949);const l={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var s=n(85893);function c(e){let{className:t,children:n}=e;const c=(0,a.default)(),{colorMode:u}=(0,i.I)();return(0,s.jsx)(s.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const a=n({theme:e,className:(0,o.Z)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:a},e)}))})}},59689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>g});var r=n(67294),o=n(72389),a=n(50012),i=n(902),l=n(86668),s=n(85893);const c=(0,a.WA)("docusaurus.announcement.dismiss"),u=(0,a.WA)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function g(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,o.default)(),[n,a]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{a(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),a(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||a(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,s.jsx)(f.Provider,{value:n,children:t})}function m(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},92949:(e,t,n)=>{"use strict";n.d(t,{I:()=>y,S:()=>h});var r=n(67294),o=n(10412),a=n(902),i=n(50012),l=n(86668),s=n(85893);const c=r.createContext(void 0),u="theme",d=(0,i.WA)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,g=e=>o.default.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),m=e=>{d.set(f(e))};function h(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[o,a]=(0,r.useState)(g(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&m(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[o,i])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(c);if(null==e)throw new a.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},60373:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>y,Oh:()=>w});var r=n(67294),o=n(80143),a=n(29935),i=n(86668),l=n(53438),s=n(902),c=n(50012),u=n(85893);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,c.WA)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.WA)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.WA)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const g=r.createContext(null);function m(){const e=(0,o._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[a,l]=(0,r.useState)((()=>f(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function o(e){const t=p.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,o(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[a,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=m();return(0,u.jsx)(g.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.cE?(0,u.jsx)(h,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function b(){const e=(0,r.useContext)(g);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=a.m);const t=(0,o.zh)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}function w(){const e=(0,o._r)(),[t]=b();function n(n){const r=e[n],{preferredVersionName:o}=t[n];return r.versions.find((e=>e.name===o))??null}const r=Object.keys(e);return Object.fromEntries(r.map((e=>[e,n(e)])))}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(67294),o=n(902),a=n(85893);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(l.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(l);if(e===i)throw new o.i6("DocsSidebarProvider");return e}},74477:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>l});var r=n(67294),o=n(902),a=n(85893);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new o.i6("DocsVersionProvider");return e}},93163:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(67294),o=n(13102),a=n(87524),i=n(91980),l=n(86668),s=n(902),c=n(85893);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.HY)(),{items:t}=(0,l.L)().navbar;return 0===t.length&&!e.component}(),t=(0,a.i)(),n=!e&&"mobile"===t,[s,c]=(0,r.useState)(!1);(0,i.Rb)((()=>{if(s)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:s})),[e,n,u,s])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},13102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>l});var r=n(67294),o=n(902),a=n(85893);const i=r.createContext(null);function l(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,a.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(!e)throw new o.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const a=(0,r.useContext)(i);if(!a)throw new o.i6("NavbarSecondaryMenuContentProvider");const[,l]=a,s=(0,o.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},76857:(e,t,n)=>{"use strict";n.d(t,{P:()=>c,Y:()=>d});var r=n(67294),o=n(902),a=n(93163),i=n(13102),l=n(85893);const s=r.createContext(null);function c(e){let{children:t}=e;const n=function(){const e=(0,a.e)(),t=(0,i.HY)(),[n,l]=(0,r.useState)(!1),s=null!==t.component,c=(0,o.D9)(s);return(0,r.useEffect)((()=>{s&&!c&&l(!0)}),[s,c]),(0,r.useEffect)((()=>{s?e.shown||l(!0):l(!1)}),[e.shown,s]),(0,r.useMemo)((()=>[n,l]),[n])}();return(0,l.jsx)(s.Provider,{value:n,children:t})}function u(e){if(e.component){const t=e.component;return(0,l.jsx)(t,{...e.props})}}function d(){const e=(0,r.useContext)(s);if(!e)throw new o.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),l=(0,i.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:u(l)})),[a,l,t])}},99445:(e,t,n)=>{"use strict";n.d(t,{c:()=>i});var r=n(67294),o=n(85936),a=n(12466);function i(e){const[t,n]=(0,r.useState)(e),i=(0,r.useRef)(!1),l=(0,r.useRef)(0),s=(0,r.useCallback)((e=>{null!==e&&(l.current=e.getBoundingClientRect().height)}),[]);return(0,a.RF)(((t,r)=>{let{scrollY:o}=t;if(!e)return;if(o=a?n(!1):o+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return i.current=!0,void n(!1);n(!0)})),{navbarRef:s,isNavbarVisible:t}}},19727:(e,t,n)=>{"use strict";n.d(t,{h:()=>o,t:()=>a});var r=n(67294);const o="navigation-with-keyboard";function a(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},69800:(e,t,n)=>{"use strict";n.d(t,{N:()=>o});var r=n(67294);function o(e){void 0===e&&(e=!0),(0,r.useEffect)((()=>(document.body.style.overflow=e?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[e])}},87524:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(67294),o=n(10412);const a={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(){const[e,t]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){t(function(){if(!o.default.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>i?a.desktop:a.mobile}())}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[]),e}},35281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},91442:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},53438:(e,t,n)=>{"use strict";n.d(t,{LM:()=>m,MN:()=>C,SN:()=>j,_F:()=>v,cE:()=>p,em:()=>g,f:()=>k,jA:()=>h,lO:()=>E,oz:()=>A,pC:()=>w,s1:()=>S,vY:()=>_,xz:()=>f});var r=n(67294),o=n(16550),a=n(18790),i=n(80143),l=n(60373),s=n(74477),c=n(1116),u=n(67392),d=n(48596);const p=!!i._r;function f(e){const t=(0,s.E)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function g(e,t){for(const n of e)if("category"===n.type){if(t(n))return n;const e=g(n.items,t);if(e)return e}}function m(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=m(t);if(e)return e}}(e):void 0:e.href}function h(){const{pathname:e}=(0,o.TH)(),t=(0,c.V)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=x({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const y=(e,t)=>void 0!==e&&(0,d.Mg)(e,t),b=(e,t)=>e.some((e=>v(e,t)));function v(e,t){return"link"===e.type?y(e.href,t):"category"===e.type&&(y(e.href,t)||b(e.items,t))}function w(e,t){switch(e.type){case"category":return v(e,t)||e.items.some((e=>w(e,t)));case"link":return!e.unlisted||v(e,t);default:return!0}}function k(e,t){return(0,r.useMemo)((()=>e.filter((e=>w(e,t)))),[e,t])}function x(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const o=[];return function e(t){for(const a of t)if("category"===a.type&&((0,d.Mg)(a.href,n)||e(a.items))||"link"===a.type&&(0,d.Mg)(a.href,n)){return r&&"category"!==a.type||o.unshift(a),!0}return!1}(t),o}function S(){const e=(0,c.V)(),{pathname:t}=(0,o.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?x({sidebarItems:e.items,pathname:t}):null}function E(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),o=(0,i.yW)(e);return(0,r.useMemo)((()=>(0,u.j)([t,n,o].filter(Boolean))),[t,n,o])}function A(e,t){const n=E(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function _(e,t){const n=E(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,u.j)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function j(e){let{route:t}=e;const n=(0,o.TH)(),r=(0,s.E)(),i=t.routes,l=i.find((e=>(0,o.LX)(n.pathname,e)));if(!l)return null;const c=l.sidebar,u=c?r.docsSidebars[c]:void 0;return{docElement:(0,a.H)(i),sidebarName:c,sidebarItems:u}}function C(e){return e.filter((e=>!("category"===e.type||"link"===e.type)||!!m(e)))}},69690:(e,t,n)=>{"use strict";n.d(t,{aG:()=>u,Ac:()=>c,Cw:()=>s,QW:()=>d});var r=n(67294),o=n(95999),a=n(18780);const i={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};var l=n(85893);function s(e){return(0,l.jsx)("button",{type:"button",...e,children:(0,l.jsx)(o.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function c(e){let{error:t,tryAgain:n}=e;return(0,l.jsxs)("div",{className:i.errorBoundaryFallback,children:[(0,l.jsx)("p",{children:t.message}),(0,l.jsx)(s,{onClick:n})]})}function u(e){let{error:t}=e;const n=(0,a.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,l.jsx)("p",{className:i.errorBoundaryError,children:n})}class d extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}},42489:(e,t,n)=>{"use strict";function r(e){return"title"in e[0]}n.d(t,{a:()=>r})},82128:(e,t,n)=>{"use strict";n.d(t,{p:()=>o});var r=n(52263);function o(e){const{siteConfig:t}=(0,r.default)(),{title:n,titleDelimiter:o}=t;return e?.trim().length?`${e.trim()} ${o} ${n}`:n}},91980:(e,t,n)=>{"use strict";n.d(t,{Nc:()=>c,Rb:()=>i,_X:()=>s,xL:()=>l});var r=n(67294),o=n(16550),a=n(902);function i(e){!function(e){const t=(0,o.k6)(),n=(0,a.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function l(e){const t=(0,o.k6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function s(e){return l((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function c(e){const t=s(e)??"",n=function(){const e=(0,o.k6)();return(0,r.useCallback)(((t,n,r)=>{const o=new URLSearchParams(e.location.search);n?o.set(t,n):o.delete(t),(r?.push?e.push:e.replace)({search:o.toString()})}),[e])}();return[t,(0,r.useCallback)(((t,r)=>{n(e,t,r)}),[n,e])]}},67392:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function o(e){return Array.from(new Set(e))}n.d(t,{j:()=>o,l:()=>r})},10833:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>d,VC:()=>g});var r=n(67294),o=n(788),a=n(35742),i=n(30226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(44996),c=n(82128),u=n(85893);function d(e){let{title:t,description:n,keywords:r,image:o,children:i}=e;const l=(0,c.p)(t),{withBaseUrl:d}=(0,s.useBaseUrlUtils)(),p=o?d(o,{absolute:!0}):void 0;return(0,u.jsxs)(a.Z,{children:[t&&(0,u.jsx)("title",{children:l}),t&&(0,u.jsx)("meta",{property:"og:title",content:l}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),r&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,u.jsx)("meta",{property:"og:image",content:p}),p&&(0,u.jsx)("meta",{name:"twitter:image",content:p}),i]})}const p=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(p),l=(0,o.Z)(i,t);return(0,u.jsxs)(p.Provider,{value:l,children:[(0,u.jsx)(a.Z,{children:(0,u.jsx)("html",{className:l})}),n]})}function g(e){let{children:t}=e;const n=l(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const a=`plugin-id-${n.plugin.id}`;return(0,u.jsx)(f,{className:(0,o.Z)(r,a),children:t})}},58978:(e,t,n)=>{"use strict";n.d(t,{A:()=>s,V:()=>c});n(67294);var r=n(93163),o=n(13102),a=n(76857),i=n(85893);const l="right";function s(e){function t(e){return"left"===(e.position??l)}return[e.filter(t),e.filter((e=>!t(e)))]}function c(e){let{children:t}=e;return(0,i.jsx)(o.n2,{children:(0,i.jsx)(r.M,{children:(0,i.jsx)(a.P,{children:t})})})}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>l,Qc:()=>u,Ql:()=>c,i6:()=>s,zX:()=>i});var r=n(67294),o=n(20469),a=n(85893);function i(e){const t=(0,r.useRef)(e);return(0,o.Z)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,o.Z)((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,a.jsx)(a.Fragment,{children:e.reduceRight(((e,t)=>(0,a.jsx)(t,{children:e})),n)})}}},98022:(e,t,n)=>{"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{F:()=>r})},48596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(67294),o=n(723),a=n(52263);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,a.default)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function o(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(o).flatMap((e=>e.routes??[])))}(n)}({routes:o.Z,baseUrl:e})),[e])}},12466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>m,OC:()=>u,RF:()=>f,o5:()=>g,sG:()=>d});var r=n(67294),o=n(10412),a=n(72389),i=n(20469),l=n(902),s=n(85893);const c=r.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new l.i6("ScrollControllerProvider");return e}const p=()=>o.default.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),o=(0,r.useRef)(p()),a=(0,l.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();a(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[a,n,...t])}function g(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),o=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.Z)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:o}}function m(){const e=(0,r.useRef)(null),t=(0,a.default)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const o=document.documentElement.scrollTop;(n&&o>e||!n&&ot&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},43320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>i,_q:()=>s,os:()=>l});var r=n(80143),o=n(52263),a=n(60373);const i="default";function l(e,t){return`docs-${e}-${t}`}function s(){const{i18n:e}=(0,o.default)(),t=(0,r._r)(),n=(0,r.WS)(),s=(0,a.Oh)();const c=[i,...Object.keys(t).map((function(e){const r=n?.activePlugin.pluginId===e?n.activeVersion:void 0,o=s[e],a=t[e].versions.find((e=>e.isLast));return l(e,(r??o??a).name)}))];return{locale:e.currentLocale,tags:c}}},55225:(e,t,n)=>{"use strict";n.d(t,{l:()=>p,u:()=>s});var r=n(67294),o=n(16550),a=n(95999),i=n(85936),l=n(85893);const s="__docusaurus_skipToContent_fallback";function c(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function u(){const e=(0,r.useRef)(null),{action:t}=(0,o.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(s);t&&c(t)}),[]);return(0,i.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&c(e.current)})),{containerRef:e,onClick:n}}const d=(0,a.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function p(e){const t=e.children??d,{containerRef:n,onClick:r}=u();return(0,l.jsx)("div",{ref:n,role:"region","aria-label":d,children:(0,l.jsx)("a",{...e,href:`#${s}`,onClick:r,children:t})})}},50012:(e,t,n)=>{"use strict";n.d(t,{Nk:()=>d,WA:()=>u,_f:()=>p});var r=n(67294),o=n(25108);const a="localStorage";function i(e){let{key:t,oldValue:n,newValue:r,storage:o}=e;if(n===r)return;const a=document.createEvent("StorageEvent");a.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,o),window.dispatchEvent(a)}function l(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,s||(o.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),s=!0),null}var t}let s=!1;const c={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=l(t?.persistence);return null===n?c:{get:()=>{try{return n.getItem(e)}catch(t){return o.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),i({key:e,oldValue:r,newValue:t,storage:n})}catch(r){o.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),i({key:e,oldValue:t,newValue:null,storage:n})}catch(t){o.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return o.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}function d(e,t){const n=(0,r.useRef)((()=>null===e?c:u(e,t))).current(),o=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(o,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}function p(e){void 0===e&&(e=a);const t=l(e);if(!t)return[];const n=[];for(let r=0;r{"use strict";n.d(t,{l:()=>i});var r=n(52263),o=n(16550),a=n(18780);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.default)(),{pathname:s}=(0,o.TH)(),c=(0,a.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),u=l===i?e:e.replace(`/${l}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},51753:(e,t,n)=>{"use strict";n.d(t,{b:()=>a});var r=n(16550),o=n(52263);function a(){const{siteConfig:{baseUrl:e}}=(0,o.default)(),{pathname:t}=(0,r.TH)();return t.replace(e,"/")}},85936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(67294),o=n(16550),a=n(902);function i(e){const t=(0,o.TH)(),n=(0,a.D9)(t),i=(0,a.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},86668:(e,t,n)=>{"use strict";n.d(t,{L:()=>o});var r=n(52263);function o(){return(0,r.default)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[o]=e.split(/[#?]/),a="/"===o||o===r?o:(i=o,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(o,a)}},54143:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},18780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var o=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(o).default}});var a=n(54143);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return a.getErrorCausalChain}})},21924:(e,t,n)=>{"use strict";var r=n(40210),o=n(55559),a=o(r("String.prototype.indexOf"));e.exports=function(e,t){var n=r(e,!!t);return"function"==typeof n&&a(e,".prototype.")>-1?o(n):n}},55559:(e,t,n)=>{"use strict";var r=n(58612),o=n(40210),a=n(67771),i=o("%TypeError%"),l=o("%Function.prototype.apply%"),s=o("%Function.prototype.call%"),c=o("%Reflect.apply%",!0)||r.call(s,l),u=o("%Object.defineProperty%",!0),d=o("%Math.max%");if(u)try{u({},"a",{value:1})}catch(f){u=null}e.exports=function(e){if("function"!=typeof e)throw new i("a function is required");var t=c(r,s,arguments);return a(t,1+d(0,e.length-(arguments.length-1)),!0)};var p=function(){return c(r,l,arguments)};u?u(e.exports,"apply",{value:p}):e.exports.apply=p},25108:(e,t,n)=>{var r=n(89539),o=n(69282);function a(){return(new Date).getTime()}var i,l=Array.prototype.slice,s={};i=void 0!==n.g&&n.g.console?n.g.console:"undefined"!=typeof window&&window.console?window.console:{};for(var c=[[function(){},"log"],[function(){i.log.apply(i,arguments)},"info"],[function(){i.log.apply(i,arguments)},"warn"],[function(){i.warn.apply(i,arguments)},"error"],[function(e){s[e]=a()},"time"],[function(e){var t=s[e];if(!t)throw new Error("No such label: "+e);delete s[e];var n=a()-t;i.log(e+": "+n+"ms")},"timeEnd"],[function(){var e=new Error;e.name="Trace",e.message=r.format.apply(null,arguments),i.error(e.stack)},"trace"],[function(e){i.log(r.inspect(e)+"\n")},"dir"],[function(e){if(!e){var t=l.call(arguments,1);o.ok(!1,r.format.apply(null,t))}},"assert"]],u=0;u{"use strict";var r=n(31044)(),o=n(40210),a=r&&o("%Object.defineProperty%",!0);if(a)try{a({},"a",{value:1})}catch(c){a=!1}var i=o("%SyntaxError%"),l=o("%TypeError%"),s=n(27296);e.exports=function(e,t,n){if(!e||"object"!=typeof e&&"function"!=typeof e)throw new l("`obj` must be an object or a function`");if("string"!=typeof t&&"symbol"!=typeof t)throw new l("`property` must be a string or a symbol`");if(arguments.length>3&&"boolean"!=typeof arguments[3]&&null!==arguments[3])throw new l("`nonEnumerable`, if provided, must be a boolean or null");if(arguments.length>4&&"boolean"!=typeof arguments[4]&&null!==arguments[4])throw new l("`nonWritable`, if provided, must be a boolean or null");if(arguments.length>5&&"boolean"!=typeof arguments[5]&&null!==arguments[5])throw new l("`nonConfigurable`, if provided, must be a boolean or null");if(arguments.length>6&&"boolean"!=typeof arguments[6])throw new l("`loose`, if provided, must be a boolean");var r=arguments.length>3?arguments[3]:null,o=arguments.length>4?arguments[4]:null,c=arguments.length>5?arguments[5]:null,u=arguments.length>6&&arguments[6],d=!!s&&s(e,t);if(a)a(e,t,{configurable:null===c&&d?d.configurable:!c,enumerable:null===r&&d?d.enumerable:!r,value:n,writable:null===o&&d?d.writable:!o});else{if(!u&&(r||o||c))throw new i("This environment does not support defining a property as non-configurable, non-writable, or non-enumerable.");e[t]=n}}},4289:(e,t,n)=>{"use strict";var r=n(82215),o="function"==typeof Symbol&&"symbol"==typeof Symbol("foo"),a=Object.prototype.toString,i=Array.prototype.concat,l=n(12296),s=n(31044)(),c=function(e,t,n,r){if(t in e)if(!0===r){if(e[t]===n)return}else if("function"!=typeof(o=r)||"[object Function]"!==a.call(o)||!r())return;var o;s?l(e,t,n,!0):l(e,t,n)},u=function(e,t){var n=arguments.length>2?arguments[2]:{},a=r(t);o&&(a=i.call(a,Object.getOwnPropertySymbols(t)));for(var l=0;l{"use strict";var r=n(95320),o=Object.prototype.toString,a=Object.prototype.hasOwnProperty;e.exports=function(e,t,n){if(!r(t))throw new TypeError("iterator must be a function");var i;arguments.length>=3&&(i=n),"[object Array]"===o.call(e)?function(e,t,n){for(var r=0,o=e.length;r{"use strict";var t=Object.prototype.toString,n=Math.max,r=function(e,t){for(var n=[],r=0;r{"use strict";var r=n(17648);e.exports=Function.prototype.bind||r},40210:(e,t,n)=>{"use strict";var r,o=SyntaxError,a=Function,i=TypeError,l=function(e){try{return a('"use strict"; return ('+e+").constructor;")()}catch(t){}},s=Object.getOwnPropertyDescriptor;if(s)try{s({},"")}catch(P){s=null}var c=function(){throw new i},u=s?function(){try{return c}catch(e){try{return s(arguments,"callee").get}catch(t){return c}}}():c,d=n(41405)(),p=n(28185)(),f=Object.getPrototypeOf||(p?function(e){return e.__proto__}:null),g={},m="undefined"!=typeof Uint8Array&&f?f(Uint8Array):r,h={"%AggregateError%":"undefined"==typeof AggregateError?r:AggregateError,"%Array%":Array,"%ArrayBuffer%":"undefined"==typeof ArrayBuffer?r:ArrayBuffer,"%ArrayIteratorPrototype%":d&&f?f([][Symbol.iterator]()):r,"%AsyncFromSyncIteratorPrototype%":r,"%AsyncFunction%":g,"%AsyncGenerator%":g,"%AsyncGeneratorFunction%":g,"%AsyncIteratorPrototype%":g,"%Atomics%":"undefined"==typeof Atomics?r:Atomics,"%BigInt%":"undefined"==typeof BigInt?r:BigInt,"%BigInt64Array%":"undefined"==typeof BigInt64Array?r:BigInt64Array,"%BigUint64Array%":"undefined"==typeof BigUint64Array?r:BigUint64Array,"%Boolean%":Boolean,"%DataView%":"undefined"==typeof DataView?r:DataView,"%Date%":Date,"%decodeURI%":decodeURI,"%decodeURIComponent%":decodeURIComponent,"%encodeURI%":encodeURI,"%encodeURIComponent%":encodeURIComponent,"%Error%":Error,"%eval%":eval,"%EvalError%":EvalError,"%Float32Array%":"undefined"==typeof Float32Array?r:Float32Array,"%Float64Array%":"undefined"==typeof Float64Array?r:Float64Array,"%FinalizationRegistry%":"undefined"==typeof FinalizationRegistry?r:FinalizationRegistry,"%Function%":a,"%GeneratorFunction%":g,"%Int8Array%":"undefined"==typeof Int8Array?r:Int8Array,"%Int16Array%":"undefined"==typeof Int16Array?r:Int16Array,"%Int32Array%":"undefined"==typeof Int32Array?r:Int32Array,"%isFinite%":isFinite,"%isNaN%":isNaN,"%IteratorPrototype%":d&&f?f(f([][Symbol.iterator]())):r,"%JSON%":"object"==typeof JSON?JSON:r,"%Map%":"undefined"==typeof Map?r:Map,"%MapIteratorPrototype%":"undefined"!=typeof Map&&d&&f?f((new Map)[Symbol.iterator]()):r,"%Math%":Math,"%Number%":Number,"%Object%":Object,"%parseFloat%":parseFloat,"%parseInt%":parseInt,"%Promise%":"undefined"==typeof Promise?r:Promise,"%Proxy%":"undefined"==typeof Proxy?r:Proxy,"%RangeError%":RangeError,"%ReferenceError%":ReferenceError,"%Reflect%":"undefined"==typeof Reflect?r:Reflect,"%RegExp%":RegExp,"%Set%":"undefined"==typeof Set?r:Set,"%SetIteratorPrototype%":"undefined"!=typeof Set&&d&&f?f((new Set)[Symbol.iterator]()):r,"%SharedArrayBuffer%":"undefined"==typeof SharedArrayBuffer?r:SharedArrayBuffer,"%String%":String,"%StringIteratorPrototype%":d&&f?f(""[Symbol.iterator]()):r,"%Symbol%":d?Symbol:r,"%SyntaxError%":o,"%ThrowTypeError%":u,"%TypedArray%":m,"%TypeError%":i,"%Uint8Array%":"undefined"==typeof Uint8Array?r:Uint8Array,"%Uint8ClampedArray%":"undefined"==typeof Uint8ClampedArray?r:Uint8ClampedArray,"%Uint16Array%":"undefined"==typeof Uint16Array?r:Uint16Array,"%Uint32Array%":"undefined"==typeof Uint32Array?r:Uint32Array,"%URIError%":URIError,"%WeakMap%":"undefined"==typeof WeakMap?r:WeakMap,"%WeakRef%":"undefined"==typeof WeakRef?r:WeakRef,"%WeakSet%":"undefined"==typeof WeakSet?r:WeakSet};if(f)try{null.error}catch(P){var y=f(f(P));h["%Error.prototype%"]=y}var b=function e(t){var n;if("%AsyncFunction%"===t)n=l("async function () {}");else if("%GeneratorFunction%"===t)n=l("function* () {}");else if("%AsyncGeneratorFunction%"===t)n=l("async function* () {}");else if("%AsyncGenerator%"===t){var r=e("%AsyncGeneratorFunction%");r&&(n=r.prototype)}else if("%AsyncIteratorPrototype%"===t){var o=e("%AsyncGenerator%");o&&f&&(n=f(o.prototype))}return h[t]=n,n},v={"%ArrayBufferPrototype%":["ArrayBuffer","prototype"],"%ArrayPrototype%":["Array","prototype"],"%ArrayProto_entries%":["Array","prototype","entries"],"%ArrayProto_forEach%":["Array","prototype","forEach"],"%ArrayProto_keys%":["Array","prototype","keys"],"%ArrayProto_values%":["Array","prototype","values"],"%AsyncFunctionPrototype%":["AsyncFunction","prototype"],"%AsyncGenerator%":["AsyncGeneratorFunction","prototype"],"%AsyncGeneratorPrototype%":["AsyncGeneratorFunction","prototype","prototype"],"%BooleanPrototype%":["Boolean","prototype"],"%DataViewPrototype%":["DataView","prototype"],"%DatePrototype%":["Date","prototype"],"%ErrorPrototype%":["Error","prototype"],"%EvalErrorPrototype%":["EvalError","prototype"],"%Float32ArrayPrototype%":["Float32Array","prototype"],"%Float64ArrayPrototype%":["Float64Array","prototype"],"%FunctionPrototype%":["Function","prototype"],"%Generator%":["GeneratorFunction","prototype"],"%GeneratorPrototype%":["GeneratorFunction","prototype","prototype"],"%Int8ArrayPrototype%":["Int8Array","prototype"],"%Int16ArrayPrototype%":["Int16Array","prototype"],"%Int32ArrayPrototype%":["Int32Array","prototype"],"%JSONParse%":["JSON","parse"],"%JSONStringify%":["JSON","stringify"],"%MapPrototype%":["Map","prototype"],"%NumberPrototype%":["Number","prototype"],"%ObjectPrototype%":["Object","prototype"],"%ObjProto_toString%":["Object","prototype","toString"],"%ObjProto_valueOf%":["Object","prototype","valueOf"],"%PromisePrototype%":["Promise","prototype"],"%PromiseProto_then%":["Promise","prototype","then"],"%Promise_all%":["Promise","all"],"%Promise_reject%":["Promise","reject"],"%Promise_resolve%":["Promise","resolve"],"%RangeErrorPrototype%":["RangeError","prototype"],"%ReferenceErrorPrototype%":["ReferenceError","prototype"],"%RegExpPrototype%":["RegExp","prototype"],"%SetPrototype%":["Set","prototype"],"%SharedArrayBufferPrototype%":["SharedArrayBuffer","prototype"],"%StringPrototype%":["String","prototype"],"%SymbolPrototype%":["Symbol","prototype"],"%SyntaxErrorPrototype%":["SyntaxError","prototype"],"%TypedArrayPrototype%":["TypedArray","prototype"],"%TypeErrorPrototype%":["TypeError","prototype"],"%Uint8ArrayPrototype%":["Uint8Array","prototype"],"%Uint8ClampedArrayPrototype%":["Uint8ClampedArray","prototype"],"%Uint16ArrayPrototype%":["Uint16Array","prototype"],"%Uint32ArrayPrototype%":["Uint32Array","prototype"],"%URIErrorPrototype%":["URIError","prototype"],"%WeakMapPrototype%":["WeakMap","prototype"],"%WeakSetPrototype%":["WeakSet","prototype"]},w=n(58612),k=n(48824),x=w.call(Function.call,Array.prototype.concat),S=w.call(Function.apply,Array.prototype.splice),E=w.call(Function.call,String.prototype.replace),A=w.call(Function.call,String.prototype.slice),_=w.call(Function.call,RegExp.prototype.exec),j=/[^%.[\]]+|\[(?:(-?\d+(?:\.\d+)?)|(["'])((?:(?!\2)[^\\]|\\.)*?)\2)\]|(?=(?:\.|\[\])(?:\.|\[\]|%$))/g,C=/\\(\\)?/g,T=function(e,t){var n,r=e;if(k(v,r)&&(r="%"+(n=v[r])[0]+"%"),k(h,r)){var a=h[r];if(a===g&&(a=b(r)),void 0===a&&!t)throw new i("intrinsic "+e+" exists, but is not available. Please file an issue!");return{alias:n,name:r,value:a}}throw new o("intrinsic "+e+" does not exist!")};e.exports=function(e,t){if("string"!=typeof e||0===e.length)throw new i("intrinsic name must be a non-empty string");if(arguments.length>1&&"boolean"!=typeof t)throw new i('"allowMissing" argument must be a boolean');if(null===_(/^%?[^%]*%?$/,e))throw new o("`%` may not be present anywhere but at the beginning and end of the intrinsic name");var n=function(e){var t=A(e,0,1),n=A(e,-1);if("%"===t&&"%"!==n)throw new o("invalid intrinsic syntax, expected closing `%`");if("%"===n&&"%"!==t)throw new o("invalid intrinsic syntax, expected opening `%`");var r=[];return E(e,j,(function(e,t,n,o){r[r.length]=n?E(o,C,"$1"):t||e})),r}(e),r=n.length>0?n[0]:"",a=T("%"+r+"%",t),l=a.name,c=a.value,u=!1,d=a.alias;d&&(r=d[0],S(n,x([0,1],d)));for(var p=1,f=!0;p=n.length){var b=s(c,g);c=(f=!!b)&&"get"in b&&!("originalValue"in b.get)?b.get:c[g]}else f=k(c,g),c=c[g];f&&!u&&(h[l]=c)}}return c}},27296:(e,t,n)=>{"use strict";var r=n(40210)("%Object.getOwnPropertyDescriptor%",!0);if(r)try{r([],"length")}catch(o){r=null}e.exports=r},31044:(e,t,n)=>{"use strict";var r=n(40210)("%Object.defineProperty%",!0),o=function(){if(r)try{return r({},"a",{value:1}),!0}catch(e){return!1}return!1};o.hasArrayLengthDefineBug=function(){if(!o())return null;try{return 1!==r([],"length",{value:1}).length}catch(e){return!0}},e.exports=o},28185:e=>{"use strict";var t={foo:{}},n=Object;e.exports=function(){return{__proto__:t}.foo===t.foo&&!({__proto__:null}instanceof n)}},41405:(e,t,n)=>{"use strict";var r="undefined"!=typeof Symbol&&Symbol,o=n(55419);e.exports=function(){return"function"==typeof r&&("function"==typeof Symbol&&("symbol"==typeof r("foo")&&("symbol"==typeof Symbol("bar")&&o())))}},55419:e=>{"use strict";e.exports=function(){if("function"!=typeof Symbol||"function"!=typeof Object.getOwnPropertySymbols)return!1;if("symbol"==typeof Symbol.iterator)return!0;var e={},t=Symbol("test"),n=Object(t);if("string"==typeof t)return!1;if("[object Symbol]"!==Object.prototype.toString.call(t))return!1;if("[object Symbol]"!==Object.prototype.toString.call(n))return!1;for(t in e[t]=42,e)return!1;if("function"==typeof Object.keys&&0!==Object.keys(e).length)return!1;if("function"==typeof Object.getOwnPropertyNames&&0!==Object.getOwnPropertyNames(e).length)return!1;var r=Object.getOwnPropertySymbols(e);if(1!==r.length||r[0]!==t)return!1;if(!Object.prototype.propertyIsEnumerable.call(e,t))return!1;if("function"==typeof Object.getOwnPropertyDescriptor){var o=Object.getOwnPropertyDescriptor(e,t);if(42!==o.value||!0!==o.enumerable)return!1}return!0}},96410:(e,t,n)=>{"use strict";var r=n(55419);e.exports=function(){return r()&&!!Symbol.toStringTag}},48824:(e,t,n)=>{"use strict";var r=Function.prototype.call,o=Object.prototype.hasOwnProperty,a=n(58612);e.exports=a.call(r,o)},99318:(e,t,n)=>{"use strict";n.d(t,{lX:()=>w,q_:()=>_,ob:()=>f,PP:()=>C,Ep:()=>p});var r=n(87462);function o(e){return"/"===e.charAt(0)}function a(e,t){for(var n=t,r=n+1,o=e.length;r=0;p--){var f=i[p];"."===f?a(i,p):".."===f?(a(i,p),d++):d&&(a(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&o(i[0])||i.unshift("");var g=i.join("/");return n&&"/"!==g.substr(-1)&&(g+="/"),g};var l=n(38776);function s(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function f(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.Z)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function g(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",o=f(e,t,m(),w.location);u.confirmTransitionTo(o,r,n,(function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(59864),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||o}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,g=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(g){var o=f(n);o&&o!==g&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),m=s(n),h=0;h{"function"==typeof Object.create?e.exports=function(e,t){t&&(e.super_=t,e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}))}:e.exports=function(e,t){if(t){e.super_=t;var n=function(){};n.prototype=t.prototype,e.prototype=new n,e.prototype.constructor=e}}},41143:e=>{"use strict";e.exports=function(e,t,n,r,o,a,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},82584:(e,t,n)=>{"use strict";var r=n(96410)(),o=n(21924)("Object.prototype.toString"),a=function(e){return!(r&&e&&"object"==typeof e&&Symbol.toStringTag in e)&&"[object Arguments]"===o(e)},i=function(e){return!!a(e)||null!==e&&"object"==typeof e&&"number"==typeof e.length&&e.length>=0&&"[object Array]"!==o(e)&&"[object Function]"===o(e.callee)},l=function(){return a(arguments)}();a.isLegacyArguments=i,e.exports=l?a:i},95320:e=>{"use strict";var t,n,r=Function.prototype.toString,o="object"==typeof Reflect&&null!==Reflect&&Reflect.apply;if("function"==typeof o&&"function"==typeof Object.defineProperty)try{t=Object.defineProperty({},"length",{get:function(){throw n}}),n={},o((function(){throw 42}),null,t)}catch(f){f!==n&&(o=null)}else o=null;var a=/^\s*class\b/,i=function(e){try{var t=r.call(e);return a.test(t)}catch(n){return!1}},l=function(e){try{return!i(e)&&(r.call(e),!0)}catch(t){return!1}},s=Object.prototype.toString,c="function"==typeof Symbol&&!!Symbol.toStringTag,u=!(0 in[,]),d=function(){return!1};if("object"==typeof document){var p=document.all;s.call(p)===s.call(document.all)&&(d=function(e){if((u||!e)&&(void 0===e||"object"==typeof e))try{var t=s.call(e);return("[object HTMLAllCollection]"===t||"[object HTML document.all class]"===t||"[object HTMLCollection]"===t||"[object Object]"===t)&&null==e("")}catch(n){}return!1})}e.exports=o?function(e){if(d(e))return!0;if(!e)return!1;if("function"!=typeof e&&"object"!=typeof e)return!1;try{o(e,null,t)}catch(r){if(r!==n)return!1}return!i(e)&&l(e)}:function(e){if(d(e))return!0;if(!e)return!1;if("function"!=typeof e&&"object"!=typeof e)return!1;if(c)return l(e);if(i(e))return!1;var t=s.call(e);return!("[object Function]"!==t&&"[object GeneratorFunction]"!==t&&!/^\[object HTML/.test(t))&&l(e)}},48662:(e,t,n)=>{"use strict";var r,o=Object.prototype.toString,a=Function.prototype.toString,i=/^\s*(?:function)?\*/,l=n(96410)(),s=Object.getPrototypeOf;e.exports=function(e){if("function"!=typeof e)return!1;if(i.test(a.call(e)))return!0;if(!l)return"[object GeneratorFunction]"===o.call(e);if(!s)return!1;if(void 0===r){var t=function(){if(!l)return!1;try{return Function("return function*() {}")()}catch(e){}}();r=!!t&&s(t)}return s(e)===r}},98611:e=>{"use strict";e.exports=function(e){return e!=e}},20360:(e,t,n)=>{"use strict";var r=n(55559),o=n(4289),a=n(98611),i=n(29415),l=n(23194),s=r(i(),Number);o(s,{getPolyfill:i,implementation:a,shim:l}),e.exports=s},29415:(e,t,n)=>{"use strict";var r=n(98611);e.exports=function(){return Number.isNaN&&Number.isNaN(NaN)&&!Number.isNaN("a")?Number.isNaN:r}},23194:(e,t,n)=>{"use strict";var r=n(4289),o=n(29415);e.exports=function(){var e=o();return r(Number,{isNaN:e},{isNaN:function(){return Number.isNaN!==e}}),e}},85692:(e,t,n)=>{"use strict";var r=n(86430);e.exports=function(e){return!!r(e)}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},96231:(e,t,n)=>{"use strict";n.r(t)},32497:(e,t,n)=>{"use strict";n.r(t)},52295:(e,t,n)=>{"use strict";n.r(t)},74865:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){s(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),l=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},24244:e=>{"use strict";var t=function(e){return e!=e};e.exports=function(e,n){return 0===e&&0===n?1/e==1/n:e===n||!(!t(e)||!t(n))}},20609:(e,t,n)=>{"use strict";var r=n(4289),o=n(55559),a=n(24244),i=n(75624),l=n(52281),s=o(i(),Object);r(s,{getPolyfill:i,implementation:a,shim:l}),e.exports=s},75624:(e,t,n)=>{"use strict";var r=n(24244);e.exports=function(){return"function"==typeof Object.is?Object.is:r}},52281:(e,t,n)=>{"use strict";var r=n(75624),o=n(4289);e.exports=function(){var e=r();return o(Object,{is:e},{is:function(){return Object.is!==e}}),e}},18987:(e,t,n)=>{"use strict";var r;if(!Object.keys){var o=Object.prototype.hasOwnProperty,a=Object.prototype.toString,i=n(21414),l=Object.prototype.propertyIsEnumerable,s=!l.call({toString:null},"toString"),c=l.call((function(){}),"prototype"),u=["toString","toLocaleString","valueOf","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","constructor"],d=function(e){var t=e.constructor;return t&&t.prototype===e},p={$applicationCache:!0,$console:!0,$external:!0,$frame:!0,$frameElement:!0,$frames:!0,$innerHeight:!0,$innerWidth:!0,$onmozfullscreenchange:!0,$onmozfullscreenerror:!0,$outerHeight:!0,$outerWidth:!0,$pageXOffset:!0,$pageYOffset:!0,$parent:!0,$scrollLeft:!0,$scrollTop:!0,$scrollX:!0,$scrollY:!0,$self:!0,$webkitIndexedDB:!0,$webkitStorageInfo:!0,$window:!0},f=function(){if("undefined"==typeof window)return!1;for(var e in window)try{if(!p["$"+e]&&o.call(window,e)&&null!==window[e]&&"object"==typeof window[e])try{d(window[e])}catch(t){return!0}}catch(t){return!0}return!1}();r=function(e){var t=null!==e&&"object"==typeof e,n="[object Function]"===a.call(e),r=i(e),l=t&&"[object String]"===a.call(e),p=[];if(!t&&!n&&!r)throw new TypeError("Object.keys called on a non-object");var g=c&&n;if(l&&e.length>0&&!o.call(e,0))for(var m=0;m0)for(var h=0;h{"use strict";var r=Array.prototype.slice,o=n(21414),a=Object.keys,i=a?function(e){return a(e)}:n(18987),l=Object.keys;i.shim=function(){if(Object.keys){var e=function(){var e=Object.keys(arguments);return e&&e.length===arguments.length}(1,2);e||(Object.keys=function(e){return o(e)?l(r.call(e)):l(e)})}else Object.keys=i;return Object.keys||i},e.exports=i},21414:e=>{"use strict";var t=Object.prototype.toString;e.exports=function(e){var n=t.call(e),r="[object Arguments]"===n;return r||(r="[object Array]"!==n&&null!==e&&"object"==typeof e&&"number"==typeof e.length&&e.length>=0&&"[object Function]"===t.call(e.callee)),r}},92837:(e,t,n)=>{"use strict";var r=n(82215),o=n(55419)(),a=n(21924),i=Object,l=a("Array.prototype.push"),s=a("Object.prototype.propertyIsEnumerable"),c=o?Object.getOwnPropertySymbols:null;e.exports=function(e,t){if(null==e)throw new TypeError("target must be an object");var n=i(e);if(1===arguments.length)return n;for(var a=1;a{"use strict";var r=n(92837);e.exports=function(){return Object.assign?function(){if(!Object.assign)return!1;for(var e="abcdefghijklmnopqrst",t=e.split(""),n={},r=0;r{var r=n(5826);e.exports=f,e.exports.parse=a,e.exports.compile=function(e,t){return l(a(e,t),t)},e.exports.tokensToFunction=l,e.exports.tokensToRegExp=p;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function a(e,t){for(var n,r=[],a=0,i=0,l="",u=t&&t.delimiter||"/";null!=(n=o.exec(e));){var d=n[0],p=n[1],f=n.index;if(l+=e.slice(i,f),i=f+d.length,p)l+=p[1];else{var g=e[i],m=n[2],h=n[3],y=n[4],b=n[5],v=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=m&&null!=g&&g!==m,x="+"===v||"*"===v,S="?"===v||"*"===v,E=n[2]||u,A=y||b;r.push({name:h||a++,prefix:m||"",delimiter:E,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:A?c(A):w?".*":"[^"+s(E)+"]+?"})}}return i{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{var r=n(25108);const o=n(29901),a=n(39642),i=new Set;function l(e){void 0===e?e=Object.keys(o.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];a(o,e,t).load((e=>{if(!(e in o.languages))return void(l.silent||r.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(16500).resolve(t)],delete Prism.languages[e],n(16500)(t),i.add(e)}))}l.silent=!1,e.exports=l},96854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=a.length);s++){var c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),g=p.indexOf(f);if(g>-1){++o;var m=p.substring(0,g),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(g+f.length),b=[];m&&b.push.apply(b,i([m])),b.push(h),y&&b.push.apply(b,i([y])),"string"==typeof c?l.splice.apply(l,[s,1].concat(b)):c.content=b}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(Prism)},6726:(e,t,n)=>{var r={"./":2885};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=6726},16500:(e,t,n)=>{var r={"./":2885};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=16500},39642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in o(t,a),l[t]=!0,n[t])l[i]=!0}t(s.require,c),t(s.optional,c),t(s.modify,c)}n[r]=l,a.pop()}}return function(e){var t=n[e];return t||(o(e,r),t=n[e]),t}}function o(e){for(var t in e)return!0;return!1}return function(a,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var o in r)if("meta"!=o){var a=r[o];t[o]="string"==typeof a?{title:a}:a}}return t}(a),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var o in n={},e){var a=e[o];t(a&&a.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+o+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+o+" because it is a component.");n[t]=o}))}return n[r]||r}}(s);i=i.map(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),g=u;o(g);){for(var m in p={},g){var h=s[m];t(h&&h.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in u))for(var b in f(y))if(b in u){p[y]=!0;break}for(var v in g=p)u[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,o){var a=o?o.series:void 0,i=o?o.parallel:e,l={},s={};function c(e){if(e in l)return l[e];s[e]=!0;var o,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)o=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));a?o=a(p,(function(){return r(e)})):r(e)}return l[e]=o}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},34155:e=>{var t,n,r=e.exports={};function o(){throw new Error("setTimeout has not been defined")}function a(){throw new Error("clearTimeout has not been defined")}function i(e){if(t===setTimeout)return setTimeout(e,0);if((t===o||!t)&&setTimeout)return t=setTimeout,setTimeout(e,0);try{return t(e,0)}catch(n){try{return t.call(null,e,0)}catch(n){return t.call(this,e,0)}}}!function(){try{t="function"==typeof setTimeout?setTimeout:o}catch(e){t=o}try{n="function"==typeof clearTimeout?clearTimeout:a}catch(e){n=a}}();var l,s=[],c=!1,u=-1;function d(){c&&l&&(c=!1,l.length?s=l.concat(s):u=-1,s.length&&p())}function p(){if(!c){var e=i(d);c=!0;for(var t=s.length;t;){for(l=s,s=[];++u1)for(var n=1;n{"use strict";var r=n(50414);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},45697:(e,t,n)=>{e.exports=n(92703)()},50414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},64448:(e,t,n)=>{"use strict";var r=n(25108),o=n(67294),a=n(63840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n