diff --git a/404.html b/404.html index 159932f4f..9ee496db7 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.3868ea9d.js b/assets/js/05632a52.3868ea9d.js new file mode 100644 index 000000000..12e8be48c --- /dev/null +++ b/assets/js/05632a52.3868ea9d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>j,metadata:()=>u,toc:()=>f});var s=t(85893),i=t(11151),n=t(58219),o=(t(62316),t(51039)),l=t.n(o),c=(t(82723),t(9487)),r=t(41429),d=t(5397),p=t(4667),m=t(9472),h=t(85162);const j={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1v2zgM/isaP62AGidt98U4DCuGogs2rMXSw31og0G26VitLWmSnCYw/N8PlJ3EaVLcdRgQJLb49ojkQ6YBLxYO4ntItfIi9Q7mHDJ0qZXGS60ghgV6JlgvBw7aoBUkm2addCcywooKPVpy2YASFUIMq1Nh5KnXT6iAgySfBYoMLXCw+KuWFjOIva2Rg/PrkmycrEyJwAFXptQZQpyL0pFCWmAlIG7Ar03Q9FaqBbSkKoJRTBCVkws1Wq1WK2j5FkoP9afMNkiM8AW8vLJOHjH104zpfHDxP4aVQ65tJfzwZAfefJkkRXpWmATadk5hndHKoSNHZ+Mx/ezDdXWaonN5XbJtcYCHy6LypC+MKWUaBNGjI6PmEF13ayqjJTdediE3yXjzPYpJUqzOHg3V5nvI/9scPGpkCSKZX1VClr9hnyB+6g9Gqa7I1W2h1ZuhXEzOJ2fhA23LYVUFMPtNlaEXsnQUw0tfHpO0ZHwxvjgs4edOkyntWa5rlb2DoPrhUHWqlqKUGbu8nbI7ItW7gMlhWlvp14F5Q8rF93Nqowp9oXvGBqr6AmKIeohRs6NGC+TNLjc0rm1JlPXeuDiKhDGjDb9KkTjKaySMjJYToDgbHDNqr66D9tBsEy+M/Ipr4P89Juh6UuU6GPepvTGoZnKhQhqWkwMK3xXSMemCONNpXaHyof9Zri17Yc0S4TBjWjFfYBDS+flowpzBVOY9dUbsQT2oma6Q1Q6JbqVUTy5+UKfs/ibPZSpFyf7BxEmP8/ebjD0/Px9k7CTYXEtf1AmzaPROfREOQ1qHVtuXE+Dg0VbuJp+hXcoU++q8EioKylE/EGiUxQ1gR6jN0aeXRtR9pUxRORx0+uX17Td2PhoDHzTF/4AcfZt+vvo+uyKv1FZdiSaj8WhMR0Y7Xwk1CHSNfjB49yrb7ObawWrqO8vjykemFFKR94C06Rt+u+iAQzzYBnMOhXaeFJqGuuFvW7YtHf+q0RKp5hyWwkqRUPvdN5BJR8/Zdtq/ivL9j35xnLDji+Uo7A1LFFFkKcqa3oDDE673F1k7b/mGKb8N7DUUXbR9am7B0GLtFC7TFI0fyA4Wzt4Iur66Aw6ipooM58FTmAf9A93laBL20XQA6JvgHDX4i9j8Fdcft+qd5FWD7d+TTptSMW/b9l/KEh2p",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/getcontact",title:"Get contact",description:"get a contact",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1v2zgM/isaP62AGidt98U4DCuGogs2rMXSw31og0G26VitLWmSnCYw/N8PlJ3EaVLcdRgQJLb49ojkQ6YBLxYO4ntItfIi9Q7mHDJ0qZXGS60ghgV6JlgvBw7aoBUkm2addCcywooKPVpy2YASFUIMq1Nh5KnXT6iAgySfBYoMLXCw+KuWFjOIva2Rg/PrkmycrEyJwAFXptQZQpyL0pFCWmAlIG7Ar03Q9FaqBbSkKoJRTBCVkws1Wq1WK2j5FkoP9afMNkiM8AW8vLJOHjH104zpfHDxP4aVQ65tJfzwZAfefJkkRXpWmATadk5hndHKoSNHZ+Mx/ezDdXWaonN5XbJtcYCHy6LypC+MKWUaBNGjI6PmEF13ayqjJTdediE3yXjzPYpJUqzOHg3V5nvI/9scPGpkCSKZX1VClr9hnyB+6g9Gqa7I1W2h1ZuhXEzOJ2fhA23LYVUFMPtNlaEXsnQUw0tfHpO0ZHwxvjgs4edOkyntWa5rlb2DoPrhUHWqlqKUGbu8nbI7ItW7gMlhWlvp14F5Q8rF93Nqowp9oXvGBqr6AmKIeohRs6NGC+TNLjc0rm1JlPXeuDiKhDGjDb9KkTjKaySMjJYToDgbHDNqr66D9tBsEy+M/Ipr4P89Juh6UuU6GPepvTGoZnKhQhqWkwMK3xXSMemCONNpXaHyof9Zri17Yc0S4TBjWjFfYBDS+flowpzBVOY9dUbsQT2oma6Q1Q6JbqVUTy5+UKfs/ibPZSpFyf7BxEmP8/ebjD0/Px9k7CTYXEtf1AmzaPROfREOQ1qHVtuXE+Dg0VbuJp+hXcoU++q8EioKylE/EGiUxQ1gR6jN0aeXRtR9pUxRORx0+uX17Td2PhoDHzTF/4AcfZt+vvo+uyKv1FZdiSaj8WhMR0Y7Xwk1CHSNfjB49yrb7ObawWrqO8vjykemFFKR94C06Rt+u+iAQzzYBnMOhXaeFJqGuuFvW7YtHf+q0RKp5hyWwkqRUPvdN5BJR8/Zdtq/ivL9j35xnLDji+Uo7A1LFFFkKcqa3oDDE673F1k7b/mGKb8N7DUUXbR9am7B0GLtFC7TFI0fyA4Wzt4Iur66Aw6ipooM58FTmAf9A93laBL20XQA6JvgHDX4i9j8Fdcft+qd5FWD7d+TTptSMW/b9l/KEh2p",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 b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Get contact"})}),"\n",(0,s.jsx)(l(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,s.jsx)(a.p,{children:"get a contact"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(n.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"successful operation"})}),(0,s.jsx)("div",{children:(0,s.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,s.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,s.jsx)(p.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,s.jsx)(p.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Contact not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.95345333.js b/assets/js/05632a52.95345333.js deleted file mode 100644 index 29eefeffb..000000000 --- a/assets/js/05632a52.95345333.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>w,frontMatter:()=>u,metadata:()=>x,toc:()=>b});var t=s(85893),n=s(11151),l=s(58219),i=(s(62316),s(51039)),c=s.n(i),o=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1r4zgQ/iva+bQFN07a3hdzHFuW0gu7bMulx31owyLL41itLWklOU0w/u/LyI7rNCl3XQ5C4mjenhnNM+MGPF85SO5BaOW58A6WEWTohJXGS60ggRV6xlkvhwi0QctJNs866YvIcMsr9GjJZQOKVwgJbE65kadeP6GCCCT5LJBnaOF1KIjA4o9aWswg8bbGCJzfluTEycqUCBHgxpQ6Q0hyXjpSEAVWHJIG/NYETW+lWkHbRgOCHuF3me0AGO6Lg/A6fUTh5xnT+Sjf/w1RBLm2FffjE9zw4CUB8+csLcRZYVJo2yWFdUYrh44cnU2n9LMP19VCoHN5XbLhTiAKyaLypM+NKaUIgvjRkVFziK7Lmm7Pkhsvu5C7Yrw7j2KWFpuzRwNtBN9C/d/n4FEjSxHJ/KrisvwF+xTxU38wEboiV7eFVu+GcjE7n52FD7UTbKoAZr+pMvRclo5ieOnLY5KWjC+mF4dX+LnTZEp7lutaZR8gqP52qDpXa17KjF3eztkdcelDwORQ1Fb6bSAcN/L7E9LzklqoQl/onqSBnb6ABOIeXty80KIF8mTXO+bWtiSWem9cEsfcmIk2qJxcqZKnjmoacyPj9Qwozg7Dglqr654ByVBwbuQX3EL071OB0pIq18G4L+mNQbWQKxXSX88OqHtXSMekC+JMi7pC5UPfs1xb9sqapdxhxrRivsAgpPPzyYw5g0LmPWUm7EE9qIWukNUOiWalVE8ueVCn7P4mz6WQvGT/YOqkx+XHXbWen58PqnUSbK6lL+qUWTT6RX0VDkNJx1bDnxOIwKOt3E2+QLuWAvubeSNUHJTjfhDQCEsawI5Iu6NPr42o60opUDkcdfjl9e1Xdj6ZQjRqiP8AOf46/3z1bXFFXqmluiuaTaaTKR0Z7XzF1SjQNfrRwN272eZlnh1sor6zPG58bEouFXkPSJu+2Ye9BhEkoy2wjKDQzpNC01A3/G3LtqXjHzXaQKAI1txKnlL73TeQSUfP2TDl30T58a9+YZyw4wvlKOwdSxRRZM3LGrt9GEg0XmDtso12TPllYG+h6KLtU3MAQwu1U7gUAo0fyQ4Wzd74ub66gwh4TTcyngdPYR70D5TL0SLso+kA0DfBOWrwO7H5C27/GNQ7yZsGw9tIp02lWLZt+xP1dhda",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/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:"eJytVm1r4zgQ/iva+bQFN07a3hdzHFuW0gu7bMulx31owyLL41itLWklOU0w/u/LyI7rNCl3XQ5C4mjenhnNM+MGPF85SO5BaOW58A6WEWTohJXGS60ggRV6xlkvhwi0QctJNs866YvIcMsr9GjJZQOKVwgJbE65kadeP6GCCCT5LJBnaOF1KIjA4o9aWswg8bbGCJzfluTEycqUCBHgxpQ6Q0hyXjpSEAVWHJIG/NYETW+lWkHbRgOCHuF3me0AGO6Lg/A6fUTh5xnT+Sjf/w1RBLm2FffjE9zw4CUB8+csLcRZYVJo2yWFdUYrh44cnU2n9LMP19VCoHN5XbLhTiAKyaLypM+NKaUIgvjRkVFziK7Lmm7Pkhsvu5C7Yrw7j2KWFpuzRwNtBN9C/d/n4FEjSxHJ/KrisvwF+xTxU38wEboiV7eFVu+GcjE7n52FD7UTbKoAZr+pMvRclo5ieOnLY5KWjC+mF4dX+LnTZEp7lutaZR8gqP52qDpXa17KjF3eztkdcelDwORQ1Fb6bSAcN/L7E9LzklqoQl/onqSBnb6ABOIeXty80KIF8mTXO+bWtiSWem9cEsfcmIk2qJxcqZKnjmoacyPj9Qwozg7Dglqr654ByVBwbuQX3EL071OB0pIq18G4L+mNQbWQKxXSX88OqHtXSMekC+JMi7pC5UPfs1xb9sqapdxhxrRivsAgpPPzyYw5g0LmPWUm7EE9qIWukNUOiWalVE8ueVCn7P4mz6WQvGT/YOqkx+XHXbWen58PqnUSbK6lL+qUWTT6RX0VDkNJx1bDnxOIwKOt3E2+QLuWAvubeSNUHJTjfhDQCEsawI5Iu6NPr42o60opUDkcdfjl9e1Xdj6ZQjRqiP8AOf46/3z1bXFFXqmluiuaTaaTKR0Z7XzF1SjQNfrRwN272eZlnh1sor6zPG58bEouFXkPSJu+2Ye9BhEkoy2wjKDQzpNC01A3/G3LtqXjHzXaQKAI1txKnlL73TeQSUfP2TDl30T58a9+YZyw4wvlKOwdSxRRZM3LGrt9GEg0XmDtso12TPllYG+h6KLtU3MAQwu1U7gUAo0fyQ4Wzd74ub66gwh4TTcyngdPYR70D5TL0SLso+kA0DfBOWrwO7H5C27/GNQ7yZsGw9tIp02lWLZt+xP1dhda",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 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,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)(r.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)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})}),(0,t.jsx)(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}',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",{})]}),(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",{})]})]})})})]})}function w(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.90d94c1d.js b/assets/js/1f73ca32.90d94c1d.js new file mode 100644 index 000000000..3a7ebc0e3 --- /dev/null +++ b/assets/js/1f73ca32.90d94c1d.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:()=>f,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=a(85893),t=a(11151),n=a(58219),r=(a(62316),a(51039)),l=a.n(r),d=(a(82723),a(9487)),o=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:"eJyVVm1v2kgQ/ivb+dRIDjaQpHfW6dRcL4eSVk1UElUqQdHaHmCDvbvdXRMQ8n+vZm2IA0l6+QJ45nlmZ+flMWtwfGohHkFp0cA4AKXRcCeUPM8ghim6G3IEoLnhBTo0hF6D5AVCDMtDrsWhU3OUEICQEMMMeeYZBn+WwmAGsTMlBmDdKieOFYXOEQLApc5VhhBPeG4JkM6w4BCvwa20Rzoj5BQqgnJPiik/acVUdpbL5RKqMZ1jtZIWLTF7UURfGdrUCE33gBiGZZqitZMyZ9vrQQCpkg6lIzzXOhepd4T3lkjr/XRUco+po1oYCuNEfWRtpnLtJh7ARJmCu7bl8Sb/DcS8109mNxd0w6++oG+LcKGQ/YNI9LOCi/yt/HuFCeLHxtBJVUGhrmZKvjmVo+OTD3/0e91en0JcqORauPzNUTJcEP2TKjSXq7eyN6PhQ5TWqQLNnXi2L4+ktAWsAhiWyXZy7Avk13Kwu3xqLS7dXSLyXMjpXcYd/n6m7u5q/2uZ/0uRqgCEVa8De1Gvf9iNDqMP192T+OjP+PikE0XRD6iqAJaFH5tmn7Mmpqu71zzvwbxYtGD1c0XAo+hofwG/YapMxqRybKJKmb0DjzzeR57LBc9Fxk6vztk1yco7f7zFtDTCrbz2tEUnHo1JA54GGaBjK1UalqHjIrcQQIFuphpF82rmZhBDOEVX1vpm0Sw24laanITMOW3jMORadzajlfPE0p6EXItw0fX6s8ltSHpRt+9JhtvWcC0+4wqC34snXVnISd3XpsaXGuVQTKUvzaILu5e+ngnLhPXuTKVlgdJ5QWMTZdgOmyXcYsaUZG6G3kn2fqfLrMZUTBot7LBbeSuHqkBWWiT9zIWc2/hWHrLR5WQiUsFz9h0TKxyO328q9vDwsFexA88ZCDcrE2ZQq0f41Bt9Wdus7cMBBODQFPZyMkSzECk23XnhqNCDw0bheeoVHmuB3Jg+7pJoInORorTYGvTTwdUX1u9EELSG4n+kHH45/3T2dXhGUWms6hZ1O1EnIpNW1hVctg56ZmSftHc7RA6XLtQ5F17mfFLrZpxHsBnncQAzZR2Z1mtq9Y3Jq4rMP0s0tEXjABbcCJ7QbI3GVbAZPZr/TFhyZNs3804q2xcnvP/WvOQPGDXpuRTnuNqb9QXPS0JCFawbwGmaonYt394rmXZtu8aDs2sIgJd07/aCzf2CNT/oLhuXXLViP82mToA+KZ1nCX/RenzG1d9beO15kbD9F1SjqRTjqqp+AXpALzs=",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:"eJyVVm1v2kgQ/ivb+dRIDjaQpHfW6dRcL4eSVk1UElUqQdHaHmCDvbvdXRMQ8n+vZm2IA0l6+QJ45nlmZ+flMWtwfGohHkFp0cA4AKXRcCeUPM8ghim6G3IEoLnhBTo0hF6D5AVCDMtDrsWhU3OUEICQEMMMeeYZBn+WwmAGsTMlBmDdKieOFYXOEQLApc5VhhBPeG4JkM6w4BCvwa20Rzoj5BQqgnJPiik/acVUdpbL5RKqMZ1jtZIWLTF7UURfGdrUCE33gBiGZZqitZMyZ9vrQQCpkg6lIzzXOhepd4T3lkjr/XRUco+po1oYCuNEfWRtpnLtJh7ARJmCu7bl8Sb/DcS8109mNxd0w6++oG+LcKGQ/YNI9LOCi/yt/HuFCeLHxtBJVUGhrmZKvjmVo+OTD3/0e91en0JcqORauPzNUTJcEP2TKjSXq7eyN6PhQ5TWqQLNnXi2L4+ktAWsAhiWyXZy7Avk13Kwu3xqLS7dXSLyXMjpXcYd/n6m7u5q/2uZ/0uRqgCEVa8De1Gvf9iNDqMP192T+OjP+PikE0XRD6iqAJaFH5tmn7Mmpqu71zzvwbxYtGD1c0XAo+hofwG/YapMxqRybKJKmb0DjzzeR57LBc9Fxk6vztk1yco7f7zFtDTCrbz2tEUnHo1JA54GGaBjK1UalqHjIrcQQIFuphpF82rmZhBDOEVX1vpm0Sw24laanITMOW3jMORadzajlfPE0p6EXItw0fX6s8ltSHpRt+9JhtvWcC0+4wqC34snXVnISd3XpsaXGuVQTKUvzaILu5e+ngnLhPXuTKVlgdJ5QWMTZdgOmyXcYsaUZG6G3kn2fqfLrMZUTBot7LBbeSuHqkBWWiT9zIWc2/hWHrLR5WQiUsFz9h0TKxyO328q9vDwsFexA88ZCDcrE2ZQq0f41Bt9Wdus7cMBBODQFPZyMkSzECk23XnhqNCDw0bheeoVHmuB3Jg+7pJoInORorTYGvTTwdUX1u9EELSG4n+kHH45/3T2dXhGUWms6hZ1O1EnIpNW1hVctg56ZmSftHc7RA6XLtQ5F17mfFLrZpxHsBnncQAzZR2Z1mtq9Y3Jq4rMP0s0tEXjABbcCJ7QbI3GVbAZPZr/TFhyZNs3804q2xcnvP/WvOQPGDXpuRTnuNqb9QXPS0JCFawbwGmaonYt394rmXZtu8aDs2sIgJd07/aCzf2CNT/oLhuXXLViP82mToA+KZ1nCX/RenzG1d9beO15kbD9F1SjqRTjqqp+AXpALzs=",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 q(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,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)(l(),{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)(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,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)(d.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:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})})]})]})}),(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 "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Record not found!"})}),(0,i.jsx)("div",{})]}),(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",{})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(q,{...e})}):q(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.af8b6278.js b/assets/js/1f73ca32.af8b6278.js deleted file mode 100644 index 21854c8dd..000000000 --- a/assets/js/1f73ca32.af8b6278.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:()=>u,contentTitle:()=>g,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const 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:"eJztVlFv2zYQ/ivsPTUAY9lr1gdhGBZ0QRC0WII6wR4SY6Cls8xGIlny5MQw9N+Ho2RZthOs2PaYF1vifXf87vidjhsgVQRI76EO6GEmwTr0irQ1VzmkUCDdsUGCU15VSOgZvQGjKoQUnk+V06dkH9GABG0ghSWqPHrkGDKvHceCFECCx++19phDSr5GCYHWJQcJunIlggR8dqXNEdKFKgMDsiVWCtIN0NpFJHltCmiaGUcLzpqAge0/jcf8t7/ltM4yDGFRl6LPCiRk1hAaYrxyrtRZNCTfAjttBpvu+N63+UpwS0v2zpeBS9WRsvNvmBEbPW9DuqWk8wFxbQiLWJWF9ZWidunjWUxaxfTTybiRXV0PEx6gILdFoREaCZkiLKxfD/D/G5cfovK7LQI0jYTnqmRkJ4qeVyOBNEXop8Haroi76Mp7tYY+0pNXzm2V0kjQhFV4icz+ztvI0DCrVtr/dov/VMpXy3dcLVLFsFC3qgUFUlS/mPK+yB2SaLFCG0FLFIGsj91k6oqlq1ZKl2oeO8yhydsowZY5zI7pOKQhnRt+beRep3QOb43y1ihvjbLfKAw7G58dz6KvmFmfC2NJLGxt8ncQkT8fI6/MSpU6F+c3V+KWB+u7Nk3Maq9pHaevcvqvR+TnGY/C/QCXSGJtay9yJKXLABIqpKXt5nmc5bSEFJICqW6ne0C/2o722pc8xolcSJNEOTeyDk3QhSnVPIwyWyXK6WQ1Ad57y2vKX4P25Ht2O0U5/RlZUv94beBUtVnY6NyV9tqhmerCxJKsJkcne7vUQegQzbnN6goNxS+VWFgvDrzFXAXMhW0lwEZe/zCaiOAw04vuIzcSD+bBTG2Fog7IV4hSm8eQPphTcX+9WOhMq1L8ifOgCWfvt9V6eno6qtZJ9LnUtKznwqOzO3gRF2NJh179ywlIIPRVuF5M0a90ht3JvLJVEsFJd8lRWbzkYKU0n2i39NuhEyux1BmagAN5n1/efBEfRmOQA0H8AOXky9Wniz+mFxyVJdUe0WQ0Ho3jJ80GqpQZbPSCXPeOtxcR4TMlrlTacKBIatNJ+R62Up5JWNpAvLTZ8FHf+bJpePl7jT52jISV8jr2OfeP3EqPtZ/rwIa8v4IeUOnvjvD+azf0TgTIlynGHjjQ+kqVNSOhkZsOcJ5l6GhgO7qVcp/1LXx5cQsSVM15DxvsMTZY98C5bE1mPYi9z6YlwL9M50WHX7g9PuP61x7eWl516O//LZpLMWua5m+fCDCp",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=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:"eJztVlFv2zYQ/ivsPTUAY9lr1gdhGBZ0QRC0WII6wR4SY6Cls8xGIlny5MQw9N+Ho2RZthOs2PaYF1vifXf87vidjhsgVQRI76EO6GEmwTr0irQ1VzmkUCDdsUGCU15VSOgZvQGjKoQUnk+V06dkH9GABG0ghSWqPHrkGDKvHceCFECCx++19phDSr5GCYHWJQcJunIlggR8dqXNEdKFKgMDsiVWCtIN0NpFJHltCmiaGUcLzpqAge0/jcf8t7/ltM4yDGFRl6LPCiRk1hAaYrxyrtRZNCTfAjttBpvu+N63+UpwS0v2zpeBS9WRsvNvmBEbPW9DuqWk8wFxbQiLWJWF9ZWidunjWUxaxfTTybiRXV0PEx6gILdFoREaCZkiLKxfD/D/G5cfovK7LQI0jYTnqmRkJ4qeVyOBNEXop8Haroi76Mp7tYY+0pNXzm2V0kjQhFV4icz+ztvI0DCrVtr/dov/VMpXy3dcLVLFsFC3qgUFUlS/mPK+yB2SaLFCG0FLFIGsj91k6oqlq1ZKl2oeO8yhydsowZY5zI7pOKQhnRt+beRep3QOb43y1ihvjbLfKAw7G58dz6KvmFmfC2NJLGxt8ncQkT8fI6/MSpU6F+c3V+KWB+u7Nk3Maq9pHaevcvqvR+TnGY/C/QCXSGJtay9yJKXLABIqpKXt5nmc5bSEFJICqW6ne0C/2o722pc8xolcSJNEOTeyDk3QhSnVPIwyWyXK6WQ1Ad57y2vKX4P25Ht2O0U5/RlZUv94beBUtVnY6NyV9tqhmerCxJKsJkcne7vUQegQzbnN6goNxS+VWFgvDrzFXAXMhW0lwEZe/zCaiOAw04vuIzcSD+bBTG2Fog7IV4hSm8eQPphTcX+9WOhMq1L8ifOgCWfvt9V6eno6qtZJ9LnUtKznwqOzO3gRF2NJh179ywlIIPRVuF5M0a90ht3JvLJVEsFJd8lRWbzkYKU0n2i39NuhEyux1BmagAN5n1/efBEfRmOQA0H8AOXky9Wniz+mFxyVJdUe0WQ0Ho3jJ80GqpQZbPSCXPeOtxcR4TMlrlTacKBIatNJ+R62Up5JWNpAvLTZ8FHf+bJpePl7jT52jISV8jr2OfeP3EqPtZ/rwIa8v4IeUOnvjvD+azf0TgTIlynGHjjQ+kqVNSOhkZsOcJ5l6GhgO7qVcp/1LXx5cQsSVM15DxvsMTZY98C5bE1mPYi9z6YlwL9M50WHX7g9PuP61x7eWl516O//LZpLMWua5m+fCDCp",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"}},u={},y=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,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)(r(),{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",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\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.jsxs)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:[(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "id": 10,\n "name": "doggie",\n "category": {\n "id": 1,\n "name": "Dogs"\n },\n "photoUrls": [\n "string"\n ],\n "tags": [\n {\n "id": 0,\n "name": "string"\n }\n ],\n "status": "available"\n}',language:"json"})})]})}),(0,i.jsx)(h.default,{label:"application/xml",value:"application/xml",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:"\n 10\n doggie\n \n 1\n Dogs\n \n string\n \n 0\n string\n \n available\n",language:"xml"})})]})})]})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Record not found!"})}),(0,i.jsx)("div",{})]}),(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",{})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.b70fa041.js b/assets/js/2c586be5.b70fa041.js new file mode 100644 index 000000000..bf3dc1bd5 --- /dev/null +++ b/assets/js/2c586be5.b70fa041.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>b,contentTitle:()=>x,default:()=>g,frontMatter:()=>p,metadata:()=>j,toc:()=>f});var s=t(85893),n=t(11151),i=t(58219),d=(t(62316),t(51039)),o=t.n(d),r=(t(82723),t(9487)),l=t(41429),c=t(5397),m=t(4667),u=t(9472),h=t(85162);const p={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJyVVd1v0zAQ/1fMPTEpa7oBLxFCTIDQBGITHeKhq5DrXJrbHMfYTtdS5X9H5yYha0HAS9fdh32/j3N3EOTKQzaHvFZNhSZ4WCRQW3QyUG0uc8hAOZQB+wJIwEonKwzouHMHRlYIGWxOpaXTUN+jgQTIQAYlyhwdJODwe0MOc8iCazABH7aaezxVViMkgBur6xwhK6T2XKBKrCRkOwhbGyuDI7OClktlbMp4TONpZSabzWYD7YLv8bY2Hj13nk+n/CdHrxxZhgMZvO1giA6V8I1S6H3RaL19Agmo2gSGme1AWqtJRSLSO8/tu+PB6uUdqsiKY9oC7S+n/Hj4BIraVTKMI7/QlHd0/mOj1ufXjLJx+r8PCMH6LE27yETVFbRtAoFCzJPRZPBbz9E35qdtueL59MUxU5dmLTXl4uL6Utywqk/iaR5V4yhso/RjzbP5giV4fMibyLIYmafCUNZsK1v7vZlCCRmkRy7z6Na9xSIbA0Bp7aTXXsulZ6SptJSuz6IL+hFnrNVejkeDDrRKSx9wC8nfLczIyRR1bO74vLJoZrQykaH1GRxivynJC/Ix3eOKZhJF7cRBt1hKj7mojQglxiTHn03OhLeoqOh8OBG35tbM6gpF47FotNBk7n12a07F/KooSJHU4isuPQVcPO0Ze3h4OGLsJPa8p1A2S+HQ1r/KVzEYaR13Df+cQAIBXeWvihm6Nanefn+4Ko3FabddUsXtwkoSq9qFXh828RZoUmg8cnkn0cX764/i2WQKycgU/zBy+vHyzbtPs3d8KttqL9HZZDqZcojNWEkzuujYuY/UHTwUcBNSqyWZ0druTT0/fDoXCZTs+mwOux0L/sXptuXw9wYdr9QigbV0JJfssPmiTXoD8hbk5DmRD6/kwUTD0wVPP3cP7olgqX436T1ujxy/lrrhSmiTXVdwoRTaMModPYq8ccNSX1/NbiAB2TD+8Z7dxz3rvjCYPmW2o8Mfj7OfgD95nt82vOQt+YDbV0P5PvPHhuEnaV/NXCzatv0JlttnFw==",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:"eJyVVd1v0zAQ/1fMPTEpa7oBLxFCTIDQBGITHeKhq5DrXJrbHMfYTtdS5X9H5yYha0HAS9fdh32/j3N3EOTKQzaHvFZNhSZ4WCRQW3QyUG0uc8hAOZQB+wJIwEonKwzouHMHRlYIGWxOpaXTUN+jgQTIQAYlyhwdJODwe0MOc8iCazABH7aaezxVViMkgBur6xwhK6T2XKBKrCRkOwhbGyuDI7OClktlbMp4TONpZSabzWYD7YLv8bY2Hj13nk+n/CdHrxxZhgMZvO1giA6V8I1S6H3RaL19Agmo2gSGme1AWqtJRSLSO8/tu+PB6uUdqsiKY9oC7S+n/Hj4BIraVTKMI7/QlHd0/mOj1ufXjLJx+r8PCMH6LE27yETVFbRtAoFCzJPRZPBbz9E35qdtueL59MUxU5dmLTXl4uL6Utywqk/iaR5V4yhso/RjzbP5giV4fMibyLIYmafCUNZsK1v7vZlCCRmkRy7z6Na9xSIbA0Bp7aTXXsulZ6SptJSuz6IL+hFnrNVejkeDDrRKSx9wC8nfLczIyRR1bO74vLJoZrQykaH1GRxivynJC/Ix3eOKZhJF7cRBt1hKj7mojQglxiTHn03OhLeoqOh8OBG35tbM6gpF47FotNBk7n12a07F/KooSJHU4isuPQVcPO0Ze3h4OGLsJPa8p1A2S+HQ1r/KVzEYaR13Df+cQAIBXeWvihm6Nanefn+4Ko3FabddUsXtwkoSq9qFXh828RZoUmg8cnkn0cX764/i2WQKycgU/zBy+vHyzbtPs3d8KttqL9HZZDqZcojNWEkzuujYuY/UHTwUcBNSqyWZ0druTT0/fDoXCZTs+mwOux0L/sXptuXw9wYdr9QigbV0JJfssPmiTXoD8hbk5DmRD6/kwUTD0wVPP3cP7olgqX436T1ujxy/lrrhSmiTXVdwoRTaMModPYq8ccNSX1/NbiAB2TD+8Z7dxz3rvjCYPmW2o8Mfj7OfgD95nt82vOQt+YDbV0P5PvPHhuEnaV/NXCzatv0JlttnFw==",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:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},b={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Create document"})}),"\n",(0,s.jsx)(o(),{method:"post",path:"/createdocument"}),"\n",(0,s.jsx)(a.p,{children:"Create document"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(l.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Document created successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(u.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "id": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.bfe72b32.js b/assets/js/2c586be5.bfe72b32.js deleted file mode 100644 index 98c9f3f33..000000000 --- a/assets/js/2c586be5.bfe72b32.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=t(85893),n=t(11151),i=t(58219),r=(t(62316),t(51039)),d=t.n(r),l=(t(82723),t(9487)),c=t(41429),o=t(5397),p=t(4667),m=t(9472),h=t(85162);const u={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJyVVVFv2zgM/isan1ZAjdNu92IMhyt2w1BsWItLhz2kQaHIdMxWljVJTpML/N8PVGwvTTbc3YvtkB8p8uNHZQdRrQLkcyga3dZoY4CFhMahV5Eae11ADtqjijgAQIJTXtUY0XPkDqyqEXLYnCtH57F5QgsSyEIOFaoCPUgoMGhPjlNCDiDB4/eWPBaQR9+ihBC3hpMEqp1BkIAbZ5oCIS+VCQzQFdYK8h3ErUvI6MmuoOsWnC24xgYM7L+cTvn18sg/++pF34wIrdYYQtkas30FEnRjI3eX70A5Z0in/rPHwOG70+Ob5SPqRIZntiLtD6fitEQJZeNrFQ8tuFGp0RyqR7r8e6PXl7fQSWi9+d8JYnQhz7LeMtFNDV0nIVJMfrKGLD4MHD0wP13HiLfT306ZurZrZagQV7fX4o6H+SplC6hbT3GbJq4cPTwhfy+Y/pcJ3ieGxYFeaoxVw0pyTdjrJ1aQQ3YirIB+PagqMTE2p5ybNA5toJU1ahm4y0w5ytYXwCUM5c14TvtRjEWOdCpHn3AL8t8Vyx2TLZsU3PN449DOaGUTM+uLE1XfVRQEheQeekoiEmXjxVG0WKqAhWisiBUmJ9vfTC5EcKip7PU3Eff23s6aGkUbsGyNMGSfQn5vz8X8pixJkzLiGy4DRVy8Hth6fn4+YessxXykWLVL4dE1P+CrZEyUHkaNP85AQkRfh5tyhn5NepDdL47KEjjrt0rptFVYK+KJ9qY/joNY/YY02oAM70d09fH2s3gzmYI8EMR/KDn7fP3+w5fZB87KktqP6GIynUzZxEKslT046FS1L6Y7aijiJmbOKLIH67oX9Pz4plxIqFjx+Rx2Ox74V2+6js3fW/RpfSSslSe1ZIXNF50cBMgbUFBgRzHegUcVjVcWvP6rv07PBI/qZ5WmTThS/FqZlpHQyV0PuNIaXTzwnVyGvG3jQt/ezO5Agmq5/8M9e0p71n9wM4PLbg+SvyxnXwE/uZ6fBrzjLfmE299H+N7zy4DxH2iPZi4WXdf9A1UNYMg=",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:"eJyVVVFv2zgM/isan1ZAjdNu92IMhyt2w1BsWItLhz2kQaHIdMxWljVJTpML/N8PVGwvTTbc3YvtkB8p8uNHZQdRrQLkcyga3dZoY4CFhMahV5Eae11ADtqjijgAQIJTXtUY0XPkDqyqEXLYnCtH57F5QgsSyEIOFaoCPUgoMGhPjlNCDiDB4/eWPBaQR9+ihBC3hpMEqp1BkIAbZ5oCIS+VCQzQFdYK8h3ErUvI6MmuoOsWnC24xgYM7L+cTvn18sg/++pF34wIrdYYQtkas30FEnRjI3eX70A5Z0in/rPHwOG70+Ob5SPqRIZntiLtD6fitEQJZeNrFQ8tuFGp0RyqR7r8e6PXl7fQSWi9+d8JYnQhz7LeMtFNDV0nIVJMfrKGLD4MHD0wP13HiLfT306ZurZrZagQV7fX4o6H+SplC6hbT3GbJq4cPTwhfy+Y/pcJ3ieGxYFeaoxVw0pyTdjrJ1aQQ3YirIB+PagqMTE2p5ybNA5toJU1ahm4y0w5ytYXwCUM5c14TvtRjEWOdCpHn3AL8t8Vyx2TLZsU3PN449DOaGUTM+uLE1XfVRQEheQeekoiEmXjxVG0WKqAhWisiBUmJ9vfTC5EcKip7PU3Eff23s6aGkUbsGyNMGSfQn5vz8X8pixJkzLiGy4DRVy8Hth6fn4+YessxXykWLVL4dE1P+CrZEyUHkaNP85AQkRfh5tyhn5NepDdL47KEjjrt0rptFVYK+KJ9qY/joNY/YY02oAM70d09fH2s3gzmYI8EMR/KDn7fP3+w5fZB87KktqP6GIynUzZxEKslT046FS1L6Y7aijiJmbOKLIH67oX9Pz4plxIqFjx+Rx2Ox74V2+6js3fW/RpfSSslSe1ZIXNF50cBMgbUFBgRzHegUcVjVcWvP6rv07PBI/qZ5WmTThS/FqZlpHQyV0PuNIaXTzwnVyGvG3jQt/ezO5Agmq5/8M9e0p71n9wM4PLbg+SvyxnXwE/uZ6fBrzjLfmE299H+N7zy4DxH2iPZi4WXdf9A1UNYMg=",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:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},y=[{value:"Request",id:"request",level:2}];function P(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:t}=s;return t||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create document"})}),"\n",(0,a.jsx)(d(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(s.p,{children:"Create document"}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Header Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.jsx)(p.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "id": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(P,{...e})}):P(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.2d0f90d1.js b/assets/js/377084eb.2d0f90d1.js new file mode 100644 index 000000000..6ac73b125 --- /dev/null +++ b/assets/js/377084eb.2d0f90d1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>g,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),m=s.n(n),r=(s(82723),s(9487)),d=s(41429),p=s(5397),c=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:"eJytVt9P4zgQ/le887KLZJpyu/eSp0UHQtUhQAure4Dq5CaTxpDYXntSWlX530/jJm1oYW853VOS8fz2fN9kDaTmAdJ7IKxdpQgDTCXkGDKvHWlrIAWQYB16xZ+THFKYI9116iDBKa9qJPTsZw1G1QgpLI+V08dkn9CABM1+SlQ5epDg8UejPeaQkm9QQqBVxTZB165il7h0lc0R0kJVgRWyEmsF6Rpo5aImeW3m0LKqikYp52iCnpvRcrlcQiu3qfSl/a3zPhWnqIT9Oidnwhai1xZUKhIGMQ+CrJihKJCyEvP/swAJhfW1oo2EK2qn7D44awIGNvhtPObHy1RDk2UYQtFUYns1ICGzhtAQ6yvnKp3Fg+QxsNH6MAs7e8SM+A49uyG9CXkV+/bzXDeSXfdDfNl2j6/mytK73dxUqAIKjwuNz0KZXPCVCip1ELnNmprLayWcDdvxvhDbCx62tJXw/dvle12VRC6kSbKyjde1muMoszX74qQjILb+lPdqNTS+h0eLX+e10lW0kvBoSzMQTCUs64pddHPcO5Xw7JVz/fi1EjRhHV5LfpcqB+u+unCvO28lkKbqhajlLlQ5ekb/+zq0fAwzdXKhljfRzcuYmUdFOByZPvT+ScvGX8ZfDpHQE5EwlkRhG5N/gKj7+6HuxCxUpXNxejMRd8xMHz7GrGqk0nbEFgmNSkgh6cMn6wGDtCAhoF/0dNf4ajAIyrlRz0OVmgVudaKcThYnwMgOmDVe0+qWkbgB25AoB+Pi9J/I8/KvdMoFaFPYaNy179qhuWXccKWLkwOmu2M46RCPe1RFqhCF9WLPWsxUwFxYRiHGQ5Z/Hp2I4DDTRccyI/FgHsytrVE0AZmZKm2eQvpgjsX9dVHoTKtK/IWzoAmnn/qOPT8/H3TsKNpcaCqbmfDo7E59HoWxrUOr7ccRSCD0dbgubtEvdNbD9I1QSVROOu5UWeROZAzyFG5EX/eNeMAqnaEJOJjm04ubS/F5NAY5GIpfSDm5nPxxfnV7zl55rDZXdDIaj8YscjZQrcwg0AXSbkvNVmJytn/B690m4O3dzRThkhJXKR3pLua47oZ9t/9BQjpcmFMJpQ3EKus1T8J3X7Uti3806FeQ3k8lLJTXahZZbQ25Dvyeb5ffm6l9+tbt0SPx67v31WJ61BiGzEJVDW4qf8LV3g9AO21lD53/nO1baWzCvcTqNhv+I9konGYZOhqcHSxr5ootK12c30Hb/gOJmFAN",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={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:"eJytVt9P4zgQ/le887KLZJpyu/eSp0UHQtUhQAure4Dq5CaTxpDYXntSWlX530/jJm1oYW853VOS8fz2fN9kDaTmAdJ7IKxdpQgDTCXkGDKvHWlrIAWQYB16xZ+THFKYI9116iDBKa9qJPTsZw1G1QgpLI+V08dkn9CABM1+SlQ5epDg8UejPeaQkm9QQqBVxTZB165il7h0lc0R0kJVgRWyEmsF6Rpo5aImeW3m0LKqikYp52iCnpvRcrlcQiu3qfSl/a3zPhWnqIT9Oidnwhai1xZUKhIGMQ+CrJihKJCyEvP/swAJhfW1oo2EK2qn7D44awIGNvhtPObHy1RDk2UYQtFUYns1ICGzhtAQ6yvnKp3Fg+QxsNH6MAs7e8SM+A49uyG9CXkV+/bzXDeSXfdDfNl2j6/mytK73dxUqAIKjwuNz0KZXPCVCip1ELnNmprLayWcDdvxvhDbCx62tJXw/dvle12VRC6kSbKyjde1muMoszX74qQjILb+lPdqNTS+h0eLX+e10lW0kvBoSzMQTCUs64pddHPcO5Xw7JVz/fi1EjRhHV5LfpcqB+u+unCvO28lkKbqhajlLlQ5ekb/+zq0fAwzdXKhljfRzcuYmUdFOByZPvT+ScvGX8ZfDpHQE5EwlkRhG5N/gKj7+6HuxCxUpXNxejMRd8xMHz7GrGqk0nbEFgmNSkgh6cMn6wGDtCAhoF/0dNf4ajAIyrlRz0OVmgVudaKcThYnwMgOmDVe0+qWkbgB25AoB+Pi9J/I8/KvdMoFaFPYaNy179qhuWXccKWLkwOmu2M46RCPe1RFqhCF9WLPWsxUwFxYRiHGQ5Z/Hp2I4DDTRccyI/FgHsytrVE0AZmZKm2eQvpgjsX9dVHoTKtK/IWzoAmnn/qOPT8/H3TsKNpcaCqbmfDo7E59HoWxrUOr7ccRSCD0dbgubtEvdNbD9I1QSVROOu5UWeROZAzyFG5EX/eNeMAqnaEJOJjm04ubS/F5NAY5GIpfSDm5nPxxfnV7zl55rDZXdDIaj8YscjZQrcwg0AXSbkvNVmJytn/B690m4O3dzRThkhJXKR3pLua47oZ9t/9BQjpcmFMJpQ3EKus1T8J3X7Uti3806FeQ3k8lLJTXahZZbQ25Dvyeb5ffm6l9+tbt0SPx67v31WJ61BiGzEJVDW4qf8LV3g9AO21lD53/nO1baWzCvcTqNhv+I9konGYZOhqcHSxr5ootK12c30Hb/gOJmFAN",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,t.jsx)(m(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.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,t.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(c.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)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{})]}),(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",{})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.52a2b54f.js b/assets/js/377084eb.52a2b54f.js deleted file mode 100644 index 51542685d..000000000 --- a/assets/js/377084eb.52a2b54f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>y});var s=t(85893),i=t(11151),l=t(58219),n=(t(62316),t(51039)),r=t.n(n),m=(t(82723),t(9487)),d=t(41429),o=t(5397),p=t(4667),c=t(9472),h=t(85162);const u={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVt9P4zgQ/le883KLZJpyu/eSp0UHqqpDgBZW9wDVyk0mjUtie+1JaVXlf1+Nm5RA4W453RPNeH58Hs/3DVsgtQiQ3gFh7SpFGGAmIceQee1IWwMpgATr0Cv+nOaQwgLptnMHCU55VSOh5zxbMKpGSGF9rJw+JvuABiRozlOiytHDK+k9/mi0xxxS8g1KCLSpOEnQtau4Bq5dZXOEtFBVYIesxFpBugXauOhJXpsFtK3cI+hv9F3nPQKnqDyoPz0TthC9t6BSkTCIeRBkxRxFgZSVmP+fMCUU1teKdpaIe8bpg7MmYOCA38dj/vMcamiyDEMomkrsXwQkZNYQGmJ/5Vyls3iQLAMHbQ9R2PkSM+Kn85yG9K7kZezbP2PdWXCt4o1TCPHHvnvQSri09O401xWqgMLjSuOjUCYXQS+MoFIHkdusqfl6rYSzYTveV2L/wMOWthK+fb14b6qSyIU0STa28bpWCxxltuZcDDryYJ9Pea82w+A7WFr8sqiVrmKUhKUtzcAwk7CuK07RzXGfVMKjV87149dK0IR1eA38E1Qu1n115V5P3kogTdUzU8tdqHL0TPr3dWi9DHN1MlHr65jmec3MoyIcjkxf+uVJy8Gfx58PmdDrjzCWRGEbk3+A6PvHoe/UrFSlc3F6PRW3LEgffouoaqTSdnoWdYxKSCHpyyfbgYK0ICGgX/Uq1/hqMAjKuZF1aLh1lZoHbnWinE5WJ8DMDpg1XtPmhpm4I5ty+vsDboaj4vRfyLPyrwrK4LUpbAzuWnfl0NwwZ/iWq5MDlbtlKukQj3tGRZkQhfXiRbSYq4C5sMxAjIds/zQ6EcFhpotOYUbi3tybG1ujaAKyKlXaPIT03hyLu6ui0JlWlfgb50ETzj723Xp8fDzo1lGMmWgqm7nw6OyT+yIaY0uHUfuPI5BA6OtwVdygX+msp+gbpZLonHS6qbKom8j84wncmb68DOLhqnSGJuBgkk8n1xfi02gMcjAQvwA5uZj+eX55c85ZeaR2T3QyGo/GbHI2UK3MoNAE6WlDzTdievbygbdPW4A3ajdThGtKXKV0lLqIcdsN+tPKBwnpcFnOJJQ2ELtstzwJ33zVtmz+0aDfQHo3k7BSXqt5VLQt5Drw73y/+N6E9vFrt0OPxK/v3Vcv07PGMGVWqmpwd/NIqmfLv521sqfOf0b7Foxduedc3aPh/0Z2DqdZho4GZweLmnVir0iT81to258lQUsJ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={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:"eJytVt9P4zgQ/le883KLZJpyu/eSp0UHqqpDgBZW9wDVyk0mjUtie+1JaVXlf1+Nm5RA4W453RPNeH58Hs/3DVsgtQiQ3gFh7SpFGGAmIceQee1IWwMpgATr0Cv+nOaQwgLptnMHCU55VSOh5zxbMKpGSGF9rJw+JvuABiRozlOiytHDK+k9/mi0xxxS8g1KCLSpOEnQtau4Bq5dZXOEtFBVYIesxFpBugXauOhJXpsFtK3cI+hv9F3nPQKnqDyoPz0TthC9t6BSkTCIeRBkxRxFgZSVmP+fMCUU1teKdpaIe8bpg7MmYOCA38dj/vMcamiyDEMomkrsXwQkZNYQGmJ/5Vyls3iQLAMHbQ9R2PkSM+Kn85yG9K7kZezbP2PdWXCt4o1TCPHHvnvQSri09O401xWqgMLjSuOjUCYXQS+MoFIHkdusqfl6rYSzYTveV2L/wMOWthK+fb14b6qSyIU0STa28bpWCxxltuZcDDryYJ9Pea82w+A7WFr8sqiVrmKUhKUtzcAwk7CuK07RzXGfVMKjV87149dK0IR1eA38E1Qu1n115V5P3kogTdUzU8tdqHL0TPr3dWi9DHN1MlHr65jmec3MoyIcjkxf+uVJy8Gfx58PmdDrjzCWRGEbk3+A6PvHoe/UrFSlc3F6PRW3LEgffouoaqTSdnoWdYxKSCHpyyfbgYK0ICGgX/Uq1/hqMAjKuZF1aLh1lZoHbnWinE5WJ8DMDpg1XtPmhpm4I5ty+vsDboaj4vRfyLPyrwrK4LUpbAzuWnfl0NwwZ/iWq5MDlbtlKukQj3tGRZkQhfXiRbSYq4C5sMxAjIds/zQ6EcFhpotOYUbi3tybG1ujaAKyKlXaPIT03hyLu6ui0JlWlfgb50ETzj723Xp8fDzo1lGMmWgqm7nw6OyT+yIaY0uHUfuPI5BA6OtwVdygX+msp+gbpZLonHS6qbKom8j84wncmb68DOLhqnSGJuBgkk8n1xfi02gMcjAQvwA5uZj+eX55c85ZeaR2T3QyGo/GbHI2UK3MoNAE6WlDzTdievbygbdPW4A3ajdThGtKXKV0lLqIcdsN+tPKBwnpcFnOJJQ2ELtstzwJ33zVtmz+0aDfQHo3k7BSXqt5VLQt5Drw73y/+N6E9vFrt0OPxK/v3Vcv07PGMGVWqmpwd/NIqmfLv521sqfOf0b7Foxduedc3aPh/0Z2DqdZho4GZweLmnVir0iT81to258lQUsJ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},j={},y=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,s.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(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,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(l.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"successful operation"})}),(0,s.jsx)("div",{children:(0,s.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,s.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,s.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,s.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,s.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,s.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!'"})}),(0,s.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.8e99cdc5.js b/assets/js/38e3d9c8.8e99cdc5.js deleted file mode 100644 index 241445d76..000000000 --- a/assets/js/38e3d9c8.8e99cdc5.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5900],{77808:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=n(85893),o=n(11151),a=(n(39620),n(9472)),s=n(85162);n(3158);const i={id:"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_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},l=void 0,c={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.",source:"@site/docs/API-docs/opensign-api-v-1.info.mdx",sourceDirName:"API-docs",slug:"/API-docs/opensign-api-v-1",permalink:"/docs/API-docs/opensign-api-v-1",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"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_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},sidebar:"apiSidebar",next:{title:"Get your details",permalink:"/docs/API-docs/get-user"}},u={},d=[];function p(e){const t={a:"a",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:(0,r.jsx)(t.p,{children:"Version: 1.0.0"})}),"\n",(0,r.jsx)("h1",{className:"openapi__heading",children:(0,r.jsx)(t.p,{children:"OpenSign API v1"})}),"\n",(0,r.jsx)(t.p,{children:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."}),"\n",(0,r.jsx)(t.p,{children:"Some useful links:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"Official Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"Github repo"})}),"\n"]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,r.jsx)("h2",{id:"authentication",style:{marginBottom:"1rem"},children:(0,r.jsx)(t.p,{children:"Authentication"})}),(0,r.jsx)(a.default,{className:"openapi-tabs__security-schemes",children:(0,r.jsx)(s.default,{label:"API Key: api_key",value:"api_key",children:(0,r.jsx)("div",{children:(0,r.jsx)("table",{children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"apiKey"})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Header parameter name:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,r.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Contact"})}),(0,r.jsx)("span",{children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"mailto:contact@opensignlabs.com",children:"contact@opensignlabs.com"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Terms of Service"})}),(0,r.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"License"})}),(0,r.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,r.jsx)(t.p,{children:"AGPL 3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},85162:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>s});n(67294);var r=n(36905);const o={tabItem:"tabItem_Ymn6"};var a=n(85893);function s(e){let{children:t,hidden:n,className:s}=e;return(0,a.jsx)("div",{role:"tabpanel",className:(0,r.Z)(o.tabItem,s),hidden:n,children:t})}},66412:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(92949),o=n(86668);function a(){const{prism:e}=(0,o.L)(),{colorMode:t}=(0,r.I)(),n=e.theme,a=e.darkTheme||n;return"dark"===t?a:n}},30913:(e,t,n)=>{"use strict";n.r(t),n.d(t,{Collapsible:()=>c.z,ErrorBoundaryError:()=>O.aG,ErrorBoundaryErrorMessageFallback:()=>O.Ac,ErrorBoundaryTryAgainButton:()=>O.Cw,ErrorCauseBoundary:()=>O.QW,HtmlClassNameProvider:()=>f.FG,NavbarSecondaryMenuFiller:()=>m.Zo,PageMetadata:()=>f.d,ReactContextError:()=>p.i6,SkipToContentFallbackId:()=>P.u,SkipToContentLink:()=>P.l,ThemeClassNames:()=>u.k,ThemedComponent:()=>o.Z,UnlistedBannerMessage:()=>C.eU,UnlistedBannerTitle:()=>C.cI,UnlistedMetadata:()=>C.T$,composeProviders:()=>p.Qc,createStorageSlot:()=>a.WA,duplicates:()=>T.l,filterDocCardListItems:()=>i.MN,isMultiColumnFooterLinks:()=>S.a,isRegexpStringMatch:()=>A.F,listStorageKeys:()=>a._f,listTagsByLetters:()=>b.P,prefersReducedMotion:()=>d.n,processAdmonitionProps:()=>E.X,translateTagsPageTitle:()=>b.M,uniq:()=>T.j,useCollapsible:()=>c.u,useColorMode:()=>h.I,useContextualSearchFilters:()=>s._q,useCurrentSidebarCategory:()=>i.jA,useDocsPreferredVersion:()=>I.J,useEvent:()=>p.zX,usePluralForm:()=>l.c,usePrevious:()=>p.D9,usePrismTheme:()=>k.p,useSearchLinkCreator:()=>_,useSearchQueryString:()=>w,useStorageSlot:()=>a.Nk,useThemeConfig:()=>r.L,useWindowSize:()=>g.i});var r=n(86668),o=n(18431),a=n(50012),s=n(43320),i=n(53438),l=n(88824),c=n(86043),u=n(35281),d=n(91442),p=n(902),f=n(10833),h=n(92949),m=n(13102),g=n(87524),b=n(35155),v=n(67294),x=n(52263),y=n(91980);const j="q";function w(){return(0,y.Nc)(j)}function _(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,x.default)(),{algolia:{searchPagePath:n}}=t;return(0,v.useCallback)((t=>`${e}${n}?${j}=${encodeURIComponent(t)}`),[e,n])}var S=n(42489),A=n(98022),T=n(67392),k=n(66412),I=n(60373),E=n(94697),P=n(55225),C=n(35835),O=n(69690)},94697:(e,t,n)=>{"use strict";n.d(t,{X:()=>a});var r=n(67294),o=n(85893);function a(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),a=t.filter((e=>e!==n)),s=n?.props.children;return{mdxAdmonitionTitle:s,rest:a.length>0?(0,o.jsx)(o.Fragment,{children:a}):null}}(e.children),a=e.title??t;return{...e,...a&&{title:a},children:n}}},70989:(e,t,n)=>{"use strict";n.d(t,{Y:()=>f,h:()=>c});var r=n(67294),o=n(16550),a=n(20469),s=n(91980),i=n(67392),l=n(50012);function c(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:t,children:n}=e;return(0,r.useMemo)((()=>{const e=t??function(e){return c(e).map((e=>{let{props:{value:t,label:n,attributes:r,default:o}}=e;return{value:t,label:n,attributes:r,default:o}}))}(n);return function(e){const t=(0,i.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function d(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const a=(0,o.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,s._X)(i),(0,r.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(a.location.search);t.set(i,e),a.replace({...a.location,search:t.toString()})}),[i,a])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:o}=e,s=u(e),[i,c]=(0,r.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const r=n.find((e=>e.default))??n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:t,tabValues:s}))),[f,h]=p({queryString:n,groupId:o}),[m,g]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[o,a]=(0,l.Nk)(n);return[o,(0,r.useCallback)((e=>{n&&a.set(e)}),[n,a])]}({groupId:o}),b=(()=>{const e=f??m;return d({value:e,tabValues:s})?e:null})();(0,a.Z)((()=>{b&&c(b)}),[b]);return{selectedValue:i,selectValue:(0,r.useCallback)((e=>{if(!d({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),h(e),g(e)}),[h,g,s]),tabValues:s}}},35155:(e,t,n)=>{"use strict";n.d(t,{M:()=>o,P:()=>a});var r=n(95999);const o=()=>(0,r.I)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});function a(e){const t={};return Object.values(e).forEach((e=>{const n=function(e){return e[0].toUpperCase()}(e.label);t[n]??=[],t[n].push(e)})),Object.entries(t).sort(((e,t)=>{let[n]=e,[r]=t;return n.localeCompare(r)})).map((e=>{let[t,n]=e;return{letter:t,tags:n.sort(((e,t)=>e.label.localeCompare(t.label)))}}))}},35835:(e,t,n)=>{"use strict";n.d(t,{T$:()=>l,cI:()=>s,eU:()=>i});n(67294);var r=n(95999),o=n(35742),a=n(85893);function s(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function i(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function l(){return(0,a.jsx)(o.Z,{children:(0,a.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}},88824:(e,t,n)=>{"use strict";n.d(t,{c:()=>u});var r=n(67294),o=n(52263),a=n(25108);const s=["zero","one","two","few","many","other"];function i(e){return s.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:i(["one","other"]),select:e=>1===e?"one":"other"};function c(){const{i18n:{currentLocale:e}}=(0,o.default)();return(0,r.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:i(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return a.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function u(){const e=c();return{selectMessage:(t,n)=>function(e,t,n){const r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&a.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${r.length}: ${e}`);const o=n.select(t),s=n.pluralForms.indexOf(o);return r[Math.min(s,r.length-1)]}(n,t,e)}}},3158: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});const o=r(n(67294)),a=r(n(93162));t.default=function(e){let{url:t,proxy:n}=e;return o.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},o.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),o.default.createElement("ul",{className:"export-dropdown dropdown__menu"},o.default.createElement("li",null,o.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),a.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},39620: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});const o=r(n(67294)),a=n(30913),s=r(n(44996)),i=r(n(59637));t.default=function(e){const{colorMode:t}=(0,a.useColorMode)(),{logo:n,darkLogo:r}=e,l=()=>"dark"===t?r?.altText??n?.altText:n?.altText,c=(0,s.default)(n?.url),u=(0,s.default)(r?.url);return n&&r?o.default.createElement(i.default,{alt:l(),sources:{light:c,dark:u},className:"openapi__logo"}):n||r?o.default.createElement(i.default,{alt:l(),sources:{light:c??u,dark:c??u},className:"openapi__logo"}):void 0}},9472:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>h});var r=n(67294),o=n(12466),a=n(70989),s=n(72389),i=n(86010),l=n(85564),c=n.n(l),u=n(85893);function d(e){let{className:t,block:n,selectedValue:a,selectValue:s,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:d}=(0,o.o5)(),p=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(d(t),s(r))},f=e=>{let t=null;switch(e.key){case"Enter":p(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()},h=(0,r.useRef)(null),[m,g]=(0,r.useState)(!1);(0,r.useEffect)((()=>{const e=new ResizeObserver((e=>{for(let t of e)t.target.offsetWidth{e.disconnect()}}),[]);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-tabs-container",children:[m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow left",onClick:()=>{h.current.scrollLeft-=90}}),(0,u.jsx)("ul",{ref:h,role:"tablist","aria-orientation":"horizontal",className:(0,i.default)("openapi-tabs__schema-list-container","tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:r}=e;return(0,u.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:f,onClick:p,...r,className:(0,i.default)("tabs__item","openapi-tabs__schema-item",r?.className,{active:a===t}),children:(0,u.jsx)("span",{className:"openapi-tabs__schema-label",children:n??t})},t)}))}),m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow right",onClick:()=>{h.current.scrollLeft+=90}})]})}function p(e){let{lazy:t,children:n,selectedValue:o}=e;n=Array.isArray(n)?n:[n];const a=c()(n);if(t){const e=a.find((e=>e.props.value===o));return e?(0,r.cloneElement)(e,{className:"margin-top--md"}):null}return(0,u.jsx)("div",{className:"margin-top--md",children:n.map(((e,t)=>(0,r.cloneElement)(e,{key:t,hidden:e.props.value!==o})))})}function f(e){const t=(0,a.Y)(e);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-container",children:[(0,u.jsx)(d,{...e,...t}),(0,u.jsx)(p,{...e,...t})]})}function h(e){const t=(0,s.default)();return(0,u.jsx)(f,{...e},String(t))}},86010:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;to,default:()=>a});const a=o},93162:function(e,t,n){var r,o,a,s=n(25108);o=[],void 0===(a="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(s.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){c(r.response,t,n)},r.onerror=function(){s.error("could not download file")},r.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function a(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,l=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),c=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!l?function(e,t,n){var s=i.URL||i.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?a(l):o(l.href)?r(e,t,n):a(l,l.target="_blank")):(l.href=s.createObjectURL(e),setTimeout((function(){s.revokeObjectURL(l.href)}),4e4),setTimeout((function(){a(l)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,s){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,s),n);else if(o(e))r(e,n,s);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){a(i)}))}}:function(e,t,n,o){if((o=o||open("","_blank"))&&(o.document.title=o.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var a="application/octet-stream"===e.type,s=/constructor/i.test(i.HTMLElement)||i.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||a&&s||l)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),o?o.location.href=e:location=e,o=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);o?o.location=p:location.href=p,o=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=c.saveAs=c,e.exports=c})?r.apply(t,o):r)||(e.exports=a)},62705:(e,t,n)=>{var r=n(55639).Symbol;e.exports=r},62488:e=>{e.exports=function(e,t){for(var n=-1,r=t.length,o=e.length;++n{var r=n(62488),o=n(37285);e.exports=function e(t,n,a,s,i){var l=-1,c=t.length;for(a||(a=o),i||(i=[]);++l0&&a(u)?n>1?e(u,n-1,a,s,i):r(i,u):s||(i[i.length]=u)}return i}},44239:(e,t,n)=>{var r=n(62705),o=n(89607),a=n(2333),s=r?r.toStringTag:void 0;e.exports=function(e){return null==e?void 0===e?"[object Undefined]":"[object Null]":s&&s in Object(e)?o(e):a(e)}},9454:(e,t,n)=>{var r=n(44239),o=n(37005);e.exports=function(e){return o(e)&&"[object Arguments]"==r(e)}},31957:(e,t,n)=>{var r="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g;e.exports=r},89607:(e,t,n)=>{var r=n(62705),o=Object.prototype,a=o.hasOwnProperty,s=o.toString,i=r?r.toStringTag:void 0;e.exports=function(e){var t=a.call(e,i),n=e[i];try{e[i]=void 0;var r=!0}catch(l){}var o=s.call(e);return r&&(t?e[i]=n:delete e[i]),o}},37285:(e,t,n)=>{var r=n(62705),o=n(35694),a=n(1469),s=r?r.isConcatSpreadable:void 0;e.exports=function(e){return a(e)||o(e)||!!(s&&e&&e[s])}},2333:e=>{var t=Object.prototype.toString;e.exports=function(e){return t.call(e)}},55639:(e,t,n)=>{var r=n(31957),o="object"==typeof self&&self&&self.Object===Object&&self,a=r||o||Function("return this")();e.exports=a},85564:(e,t,n)=>{var r=n(21078);e.exports=function(e){return(null==e?0:e.length)?r(e,1):[]}},35694:(e,t,n)=>{var r=n(9454),o=n(37005),a=Object.prototype,s=a.hasOwnProperty,i=a.propertyIsEnumerable,l=r(function(){return arguments}())?r:function(e){return o(e)&&s.call(e,"callee")&&!i.call(e,"callee")};e.exports=l},1469:e=>{var t=Array.isArray;e.exports=t},37005:e=>{e.exports=function(e){return null!=e&&"object"==typeof e}},11151:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i,a:()=>s});var r=n(67294);const o={},a=r.createContext(o);function s(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/38e3d9c8.a995c609.js b/assets/js/38e3d9c8.a995c609.js new file mode 100644 index 000000000..6befecde7 --- /dev/null +++ b/assets/js/38e3d9c8.a995c609.js @@ -0,0 +1 @@ +(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5900],{77808:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=n(85893),o=n(11151),a=(n(39620),n(9472)),s=n(85162);n(3158);const i={id:"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_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},l=void 0,c={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.",source:"@site/docs/API-docs/opensign-api-v-1.info.mdx",sourceDirName:"API-docs",slug:"/API-docs/opensign-api-v-1",permalink:"/docs/API-docs/opensign-api-v-1",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"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_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},sidebar:"apiSidebar",next:{title:"Get your details",permalink:"/docs/API-docs/get-user"}},u={},d=[];function p(e){const t={a:"a",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:(0,r.jsx)(t.p,{children:"Version: 1.0.0"})}),"\n",(0,r.jsx)("h1",{className:"openapi__heading",children:(0,r.jsx)(t.p,{children:"OpenSign API v1"})}),"\n",(0,r.jsx)(t.p,{children:"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."}),"\n",(0,r.jsx)(t.p,{children:"Some useful links:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"Official Website"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"Github repo"})}),"\n"]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,r.jsx)("h2",{id:"authentication",style:{marginBottom:"1rem"},children:(0,r.jsx)(t.p,{children:"Authentication"})}),(0,r.jsx)(a.default,{className:"openapi-tabs__security-schemes",children:(0,r.jsx)(s.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,r.jsx)("div",{children:(0,r.jsx)("table",{children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"apiKey"})})]}),(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:(0,r.jsx)(t.p,{children:"Header parameter name:"})}),(0,r.jsx)("td",{children:(0,r.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,r.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Contact"})}),(0,r.jsx)("span",{children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"mailto:contact@opensignlabs.com",children:"contact@opensignlabs.com"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"Terms of Service"})}),(0,r.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})})})]}),"\n",(0,r.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,r.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,r.jsx)(t.p,{children:"License"})}),(0,r.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,r.jsx)(t.p,{children:"AGPL 3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},85162:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>s});n(67294);var r=n(36905);const o={tabItem:"tabItem_Ymn6"};var a=n(85893);function s(e){let{children:t,hidden:n,className:s}=e;return(0,a.jsx)("div",{role:"tabpanel",className:(0,r.Z)(o.tabItem,s),hidden:n,children:t})}},66412:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(92949),o=n(86668);function a(){const{prism:e}=(0,o.L)(),{colorMode:t}=(0,r.I)(),n=e.theme,a=e.darkTheme||n;return"dark"===t?a:n}},30913:(e,t,n)=>{"use strict";n.r(t),n.d(t,{Collapsible:()=>c.z,ErrorBoundaryError:()=>O.aG,ErrorBoundaryErrorMessageFallback:()=>O.Ac,ErrorBoundaryTryAgainButton:()=>O.Cw,ErrorCauseBoundary:()=>O.QW,HtmlClassNameProvider:()=>f.FG,NavbarSecondaryMenuFiller:()=>m.Zo,PageMetadata:()=>f.d,ReactContextError:()=>p.i6,SkipToContentFallbackId:()=>P.u,SkipToContentLink:()=>P.l,ThemeClassNames:()=>u.k,ThemedComponent:()=>o.Z,UnlistedBannerMessage:()=>C.eU,UnlistedBannerTitle:()=>C.cI,UnlistedMetadata:()=>C.T$,composeProviders:()=>p.Qc,createStorageSlot:()=>a.WA,duplicates:()=>T.l,filterDocCardListItems:()=>i.MN,isMultiColumnFooterLinks:()=>_.a,isRegexpStringMatch:()=>A.F,listStorageKeys:()=>a._f,listTagsByLetters:()=>b.P,prefersReducedMotion:()=>d.n,processAdmonitionProps:()=>E.X,translateTagsPageTitle:()=>b.M,uniq:()=>T.j,useCollapsible:()=>c.u,useColorMode:()=>h.I,useContextualSearchFilters:()=>s._q,useCurrentSidebarCategory:()=>i.jA,useDocsPreferredVersion:()=>I.J,useEvent:()=>p.zX,usePluralForm:()=>l.c,usePrevious:()=>p.D9,usePrismTheme:()=>k.p,useSearchLinkCreator:()=>S,useSearchQueryString:()=>w,useStorageSlot:()=>a.Nk,useThemeConfig:()=>r.L,useWindowSize:()=>g.i});var r=n(86668),o=n(18431),a=n(50012),s=n(43320),i=n(53438),l=n(88824),c=n(86043),u=n(35281),d=n(91442),p=n(902),f=n(10833),h=n(92949),m=n(13102),g=n(87524),b=n(35155),v=n(67294),x=n(52263),y=n(91980);const j="q";function w(){return(0,y.Nc)(j)}function S(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,x.default)(),{algolia:{searchPagePath:n}}=t;return(0,v.useCallback)((t=>`${e}${n}?${j}=${encodeURIComponent(t)}`),[e,n])}var _=n(42489),A=n(98022),T=n(67392),k=n(66412),I=n(60373),E=n(94697),P=n(55225),C=n(35835),O=n(69690)},94697:(e,t,n)=>{"use strict";n.d(t,{X:()=>a});var r=n(67294),o=n(85893);function a(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),a=t.filter((e=>e!==n)),s=n?.props.children;return{mdxAdmonitionTitle:s,rest:a.length>0?(0,o.jsx)(o.Fragment,{children:a}):null}}(e.children),a=e.title??t;return{...e,...a&&{title:a},children:n}}},70989:(e,t,n)=>{"use strict";n.d(t,{Y:()=>f,h:()=>c});var r=n(67294),o=n(16550),a=n(20469),s=n(91980),i=n(67392),l=n(50012);function c(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:t,children:n}=e;return(0,r.useMemo)((()=>{const e=t??function(e){return c(e).map((e=>{let{props:{value:t,label:n,attributes:r,default:o}}=e;return{value:t,label:n,attributes:r,default:o}}))}(n);return function(e){const t=(0,i.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function d(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function p(e){let{queryString:t=!1,groupId:n}=e;const a=(0,o.k6)(),i=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,s._X)(i),(0,r.useCallback)((e=>{if(!i)return;const t=new URLSearchParams(a.location.search);t.set(i,e),a.replace({...a.location,search:t.toString()})}),[i,a])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:o}=e,s=u(e),[i,c]=(0,r.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const r=n.find((e=>e.default))??n[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:t,tabValues:s}))),[f,h]=p({queryString:n,groupId:o}),[m,g]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[o,a]=(0,l.Nk)(n);return[o,(0,r.useCallback)((e=>{n&&a.set(e)}),[n,a])]}({groupId:o}),b=(()=>{const e=f??m;return d({value:e,tabValues:s})?e:null})();(0,a.Z)((()=>{b&&c(b)}),[b]);return{selectedValue:i,selectValue:(0,r.useCallback)((e=>{if(!d({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);c(e),h(e),g(e)}),[h,g,s]),tabValues:s}}},35155:(e,t,n)=>{"use strict";n.d(t,{M:()=>o,P:()=>a});var r=n(95999);const o=()=>(0,r.I)({id:"theme.tags.tagsPageTitle",message:"Tags",description:"The title of the tag list page"});function a(e){const t={};return Object.values(e).forEach((e=>{const n=function(e){return e[0].toUpperCase()}(e.label);t[n]??=[],t[n].push(e)})),Object.entries(t).sort(((e,t)=>{let[n]=e,[r]=t;return n.localeCompare(r)})).map((e=>{let[t,n]=e;return{letter:t,tags:n.sort(((e,t)=>e.label.localeCompare(t.label)))}}))}},35835:(e,t,n)=>{"use strict";n.d(t,{T$:()=>l,cI:()=>s,eU:()=>i});n(67294);var r=n(95999),o=n(35742),a=n(85893);function s(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function i(){return(0,a.jsx)(r.Z,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function l(){return(0,a.jsx)(o.Z,{children:(0,a.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}},88824:(e,t,n)=>{"use strict";n.d(t,{c:()=>u});var r=n(67294),o=n(52263),a=n(25108);const s=["zero","one","two","few","many","other"];function i(e){return s.filter((t=>e.includes(t)))}const l={locale:"en",pluralForms:i(["one","other"]),select:e=>1===e?"one":"other"};function c(){const{i18n:{currentLocale:e}}=(0,o.default)();return(0,r.useMemo)((()=>{try{return function(e){const t=new Intl.PluralRules(e);return{locale:e,pluralForms:i(t.resolvedOptions().pluralCategories),select:e=>t.select(e)}}(e)}catch(t){return a.error(`Failed to use Intl.PluralRules for locale "${e}".\nDocusaurus will fallback to the default (English) implementation.\nError: ${t.message}\n`),l}}),[e])}function u(){const e=c();return{selectMessage:(t,n)=>function(e,t,n){const r=e.split("|");if(1===r.length)return r[0];r.length>n.pluralForms.length&&a.error(`For locale=${n.locale}, a maximum of ${n.pluralForms.length} plural forms are expected (${n.pluralForms.join(",")}), but the message contains ${r.length}: ${e}`);const o=n.select(t),s=n.pluralForms.indexOf(o);return r[Math.min(s,r.length-1)]}(n,t,e)}}},3158: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});const o=r(n(67294)),a=r(n(93162));t.default=function(e){let{url:t,proxy:n}=e;return o.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},o.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),o.default.createElement("ul",{className:"export-dropdown dropdown__menu"},o.default.createElement("li",null,o.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),a.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},39620: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});const o=r(n(67294)),a=n(30913),s=r(n(44996)),i=r(n(59637));t.default=function(e){const{colorMode:t}=(0,a.useColorMode)(),{logo:n,darkLogo:r}=e,l=()=>"dark"===t?r?.altText??n?.altText:n?.altText,c=(0,s.default)(n?.url),u=(0,s.default)(r?.url);return n&&r?o.default.createElement(i.default,{alt:l(),sources:{light:c,dark:u},className:"openapi__logo"}):n||r?o.default.createElement(i.default,{alt:l(),sources:{light:c??u,dark:c??u},className:"openapi__logo"}):void 0}},9472:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>h});var r=n(67294),o=n(12466),a=n(70989),s=n(72389),i=n(86010),l=n(85564),c=n.n(l),u=n(85893);function d(e){let{className:t,block:n,selectedValue:a,selectValue:s,tabValues:l}=e;const c=[],{blockElementScrollPositionUntilNextRender:d}=(0,o.o5)(),p=e=>{const t=e.currentTarget,n=c.indexOf(t),r=l[n].value;r!==a&&(d(t),s(r))},f=e=>{let t=null;switch(e.key){case"Enter":p(e);break;case"ArrowRight":{const n=c.indexOf(e.currentTarget)+1;t=c[n]??c[0];break}case"ArrowLeft":{const n=c.indexOf(e.currentTarget)-1;t=c[n]??c[c.length-1];break}}t?.focus()},h=(0,r.useRef)(null),[m,g]=(0,r.useState)(!1);(0,r.useEffect)((()=>{const e=new ResizeObserver((e=>{for(let t of e)t.target.offsetWidth{e.disconnect()}}),[]);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-tabs-container",children:[m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow left",onClick:()=>{h.current.scrollLeft-=90}}),(0,u.jsx)("ul",{ref:h,role:"tablist","aria-orientation":"horizontal",className:(0,i.default)("openapi-tabs__schema-list-container","tabs",{"tabs--block":n},t),children:l.map((e=>{let{value:t,label:n,attributes:r}=e;return(0,u.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>c.push(e),onKeyDown:f,onClick:p,...r,className:(0,i.default)("tabs__item","openapi-tabs__schema-item",r?.className,{active:a===t}),children:(0,u.jsx)("span",{className:"openapi-tabs__schema-label",children:n??t})},t)}))}),m&&(0,u.jsx)("button",{className:"openapi-tabs__arrow right",onClick:()=>{h.current.scrollLeft+=90}})]})}function p(e){let{lazy:t,children:n,selectedValue:o}=e;n=Array.isArray(n)?n:[n];const a=c()(n);if(t){const e=a.find((e=>e.props.value===o));return e?(0,r.cloneElement)(e,{className:"margin-top--md"}):null}return(0,u.jsx)("div",{className:"margin-top--md",children:n.map(((e,t)=>(0,r.cloneElement)(e,{key:t,hidden:e.props.value!==o})))})}function f(e){const t=(0,a.Y)(e);return(0,u.jsxs)("div",{className:"openapi-tabs__schema-container",children:[(0,u.jsx)(d,{...e,...t}),(0,u.jsx)(p,{...e,...t})]})}function h(e){const t=(0,s.default)();return(0,u.jsx)(f,{...e},String(t))}},86010:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;to,default:()=>a});const a=o},93162:function(e,t,n){var r,o,a,s=n(25108);o=[],void 0===(a="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(s.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){c(r.response,t,n)},r.onerror=function(){s.error("could not download file")},r.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function a(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,l=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),c=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!l?function(e,t,n){var s=i.URL||i.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?a(l):o(l.href)?r(e,t,n):a(l,l.target="_blank")):(l.href=s.createObjectURL(e),setTimeout((function(){s.revokeObjectURL(l.href)}),4e4),setTimeout((function(){a(l)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,s){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,s),n);else if(o(e))r(e,n,s);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){a(i)}))}}:function(e,t,n,o){if((o=o||open("","_blank"))&&(o.document.title=o.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var a="application/octet-stream"===e.type,s=/constructor/i.test(i.HTMLElement)||i.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||a&&s||l)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),o?o.location.href=e:location=e,o=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);o?o.location=p:location.href=p,o=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=c.saveAs=c,e.exports=c})?r.apply(t,o):r)||(e.exports=a)},62705:(e,t,n)=>{var r=n(55639).Symbol;e.exports=r},62488:e=>{e.exports=function(e,t){for(var n=-1,r=t.length,o=e.length;++n{var r=n(62488),o=n(37285);e.exports=function e(t,n,a,s,i){var l=-1,c=t.length;for(a||(a=o),i||(i=[]);++l0&&a(u)?n>1?e(u,n-1,a,s,i):r(i,u):s||(i[i.length]=u)}return i}},44239:(e,t,n)=>{var r=n(62705),o=n(89607),a=n(2333),s=r?r.toStringTag:void 0;e.exports=function(e){return null==e?void 0===e?"[object Undefined]":"[object Null]":s&&s in Object(e)?o(e):a(e)}},9454:(e,t,n)=>{var r=n(44239),o=n(37005);e.exports=function(e){return o(e)&&"[object Arguments]"==r(e)}},31957:(e,t,n)=>{var r="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g;e.exports=r},89607:(e,t,n)=>{var r=n(62705),o=Object.prototype,a=o.hasOwnProperty,s=o.toString,i=r?r.toStringTag:void 0;e.exports=function(e){var t=a.call(e,i),n=e[i];try{e[i]=void 0;var r=!0}catch(l){}var o=s.call(e);return r&&(t?e[i]=n:delete e[i]),o}},37285:(e,t,n)=>{var r=n(62705),o=n(35694),a=n(1469),s=r?r.isConcatSpreadable:void 0;e.exports=function(e){return a(e)||o(e)||!!(s&&e&&e[s])}},2333:e=>{var t=Object.prototype.toString;e.exports=function(e){return t.call(e)}},55639:(e,t,n)=>{var r=n(31957),o="object"==typeof self&&self&&self.Object===Object&&self,a=r||o||Function("return this")();e.exports=a},85564:(e,t,n)=>{var r=n(21078);e.exports=function(e){return(null==e?0:e.length)?r(e,1):[]}},35694:(e,t,n)=>{var r=n(9454),o=n(37005),a=Object.prototype,s=a.hasOwnProperty,i=a.propertyIsEnumerable,l=r(function(){return arguments}())?r:function(e){return o(e)&&s.call(e,"callee")&&!i.call(e,"callee")};e.exports=l},1469:e=>{var t=Array.isArray;e.exports=t},37005:e=>{e.exports=function(e){return null!=e&&"object"==typeof e}},11151:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i,a:()=>s});var r=n(67294);const o={},a=r.createContext(o);function s(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4eb531f8.2a371478.js b/assets/js/4eb531f8.2a371478.js deleted file mode 100644 index d7f782ab9..000000000 --- a/assets/js/4eb531f8.2a371478.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5763],{82719:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>u,contentTitle:()=>g,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var i=a(85893),l=a(11151),n=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:"add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",sidebar_label:"Add a new pet to the store",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF1v2zYU/SvEfWoA+avt9iAMw9IsKIIWTVCn2INjDLR0LbORSJak7BiG/vtwScmS7Tgttu5NL4ZNnfvJcyj67sDxzEI8g9KisTCPIEWbGKGdUBJiuExTxpnEDdPomFPMrZBZpwxCBEqj4QS8SSEGnqZ36CACzQ0v0JG/eLYDyQuEGJ4GXIuBU48oIQJBzlfIUzRwHBMiMPitFAZTiJ0pMQLrtjk5saLQOYXGJ52rFCFe8twSIFlhwSHegdtqj3RGyAyqah68oXXvVLolxGG0K4PcYadIIQ+KTJR0KB0Zcq1zkfiKR18tWe86gducZ6HmCPRKOfXF5L6xdWJq8RUT3yZD/XMCLVmLtJO8kA4z35mlMgV3YenXt75w7lsQT8ZVVPf2uOgOClKVZQKhiiDhDjNlth38T8vlh1L5U2UWqiqCpyInZE2MfV5VBE44D73qrLVNbL1zY/gW9p42hmvdsKWKQDgs7HPJHEZuPENFWQUl/NsQ/6mVZ9t32i3Hs26j7nkAWcdd+WzJh2wnggfsMc9RlgVRl6+5yPnCq0yjTIMXq/IU5qfpaHTddOgAIFBXKbVBL5ReKL1QXhTKYLPZDKjiQWlylIlKMe2l00unl86pdKrjS6JfsFpJG7ryejw+vexNyyRBa5dlzvaX1/6O1+uv119/x+uF0gvl/3hRVRG8Hf9y+i66kWuei5QJqcugKItJaYTb+rEJ1+LvR6Tvc5phFOhWisYsWtkwZHEriGGU+PEFTW8oMTTrZuxSmpxGLM5pG49GXOuh0iityGTOF3aYqGLEtRitJ0Dum9BTUnDYrX0CLQu0+IBEg++OdKgaent+bicv1w31Aw8m472bWpWHovSYPSSo5YD+s2ZX5w1bZ8GqddzwZt5SorOjxFu5VL6+esduNcqpyCS7vLth68kJYe5XwjJh/eNUJWWB0vkDkC2VYUfWbMEtpkwFZtFDWn8znDCrMRHL+uwcsgf5IKeqQFZapJtJLuSjjR/kgM1ul0uRCJ6zv3BhhcP5q2ZDN5vNyYZeeJv3wq3KBTOoVQvP/KLf9a7V/scFRODQFPZ2OUWzFgnW5DkTauTBo/ruxBN/d8KCCyJdvfTHsRG1PBcJSosd1Vy+v/vI3gzHEHU4+wMpjz7eXF1/ml6TV2J92KLJcDwce6oo6wouu4FemmUebPSuvRG+bFULw+GTG+mcC0mRfRW7WqEz6Ch0HsGK5BvPYLcjenwxeVXR8rcSjdd6BGtuhCcoKT9qFEXsToWlB+l+6nk26Vef6/fvBTuXpZf2kYTXPC8JCVW0qwFXwefgnny0iO//b21dXCYJanfG2N+xDw64u9vpPUSwqKe1hR/zQsdz1P0RmsRL6nX3oHr0B1X9hZrXPJLbTiaH5Yd06ZOSf9bgN9LwB9z+voeHJ2cN9jPugKbez6uq+gcAHewe",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,j={id:"API-docs/add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",source:"@site/docs/API-docs/add-pet.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/add-pet",permalink:"/docs/API-docs/add-pet",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",sidebar_label:"Add a new pet to the store",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF1v2zYU/SvEfWoA+avt9iAMw9IsKIIWTVCn2INjDLR0LbORSJak7BiG/vtwScmS7Tgttu5NL4ZNnfvJcyj67sDxzEI8g9KisTCPIEWbGKGdUBJiuExTxpnEDdPomFPMrZBZpwxCBEqj4QS8SSEGnqZ36CACzQ0v0JG/eLYDyQuEGJ4GXIuBU48oIQJBzlfIUzRwHBMiMPitFAZTiJ0pMQLrtjk5saLQOYXGJ52rFCFe8twSIFlhwSHegdtqj3RGyAyqah68oXXvVLolxGG0K4PcYadIIQ+KTJR0KB0Zcq1zkfiKR18tWe86gducZ6HmCPRKOfXF5L6xdWJq8RUT3yZD/XMCLVmLtJO8kA4z35mlMgV3YenXt75w7lsQT8ZVVPf2uOgOClKVZQKhiiDhDjNlth38T8vlh1L5U2UWqiqCpyInZE2MfV5VBE44D73qrLVNbL1zY/gW9p42hmvdsKWKQDgs7HPJHEZuPENFWQUl/NsQ/6mVZ9t32i3Hs26j7nkAWcdd+WzJh2wnggfsMc9RlgVRl6+5yPnCq0yjTIMXq/IU5qfpaHTddOgAIFBXKbVBL5ReKL1QXhTKYLPZDKjiQWlylIlKMe2l00unl86pdKrjS6JfsFpJG7ryejw+vexNyyRBa5dlzvaX1/6O1+uv119/x+uF0gvl/3hRVRG8Hf9y+i66kWuei5QJqcugKItJaYTb+rEJ1+LvR6Tvc5phFOhWisYsWtkwZHEriGGU+PEFTW8oMTTrZuxSmpxGLM5pG49GXOuh0iityGTOF3aYqGLEtRitJ0Dum9BTUnDYrX0CLQu0+IBEg++OdKgaent+bicv1w31Aw8m472bWpWHovSYPSSo5YD+s2ZX5w1bZ8GqddzwZt5SorOjxFu5VL6+esduNcqpyCS7vLth68kJYe5XwjJh/eNUJWWB0vkDkC2VYUfWbMEtpkwFZtFDWn8znDCrMRHL+uwcsgf5IKeqQFZapJtJLuSjjR/kgM1ul0uRCJ6zv3BhhcP5q2ZDN5vNyYZeeJv3wq3KBTOoVQvP/KLf9a7V/scFRODQFPZ2OUWzFgnW5DkTauTBo/ruxBN/d8KCCyJdvfTHsRG1PBcJSosd1Vy+v/vI3gzHEHU4+wMpjz7eXF1/ml6TV2J92KLJcDwce6oo6wouu4FemmUebPSuvRG+bFULw+GTG+mcC0mRfRW7WqEz6Ch0HsGK5BvPYLcjenwxeVXR8rcSjdd6BGtuhCcoKT9qFEXsToWlB+l+6nk26Vef6/fvBTuXpZf2kYTXPC8JCVW0qwFXwefgnny0iO//b21dXCYJanfG2N+xDw64u9vpPUSwqKe1hR/zQsdz1P0RmsRL6nX3oHr0B1X9hZrXPJLbTiaH5Yd06ZOSf9bgN9LwB9z+voeHJ2cN9jPugKbez6uq+gcAHewe",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},u={},y=[{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:"Add a new pet to the store"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createuser"}),"\n",(0,i.jsx)(s.p,{children:"Add a new pet to the store"}),"\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",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,i.jsxs)(m.Z,{className:"openapi-tabs__mime",schemaType:"request",children:[(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(s.p,{children:"Create a new pet in the store"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"application/xml",value:"application/xml",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(s.p,{children:"Create a new pet in the store"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"application/x-www-form-urlencoded",value:"application/x-www-form-urlencoded",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(s.p,{children:"Create a new pet in the store"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})})]}),"\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.jsxs)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:[(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "id": 10,\n "name": "doggie",\n "category": {\n "id": 1,\n "name": "Dogs"\n },\n "photoUrls": [\n "string"\n ],\n "tags": [\n {\n "id": 0,\n "name": "string"\n }\n ],\n "status": "available"\n}',language:"json"})})]})}),(0,i.jsx)(h.default,{label:"application/xml",value:"application/xml",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:"\n 10\n doggie\n \n 1\n Dogs\n \n string\n \n 0\n string\n \n available\n",language:"xml"})})]})})]})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid input"})}),(0,i.jsx)("div",{})]})]})})})]})}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/4eb531f8.9c40b018.js b/assets/js/4eb531f8.9c40b018.js new file mode 100644 index 000000000..1e06ade15 --- /dev/null +++ b/assets/js/4eb531f8.9c40b018.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5763],{82719:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>q,frontMatter:()=>x,metadata:()=>g,toc:()=>b});var i=a(85893),t=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),d=(a(82723),a(9487)),m=a(41429),o=a(5397),c=a(4667),p=a(9472),h=a(85162);const x={id:"add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",sidebar_label:"Add a new pet to the store",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21vGjkQ/ivWfGqkBRZI2t7qdGqay0VJqyYqqU46giKzO4CTXdu1vbwI7X8/jXeBBQK9SPcxXxBrzzOesZ9nPF6C42MLUR9yi8bCIIAEbWyEdkJJiOA8SRhnEmdMo2NOMTdBZp0yCAEojYaT4XUCEfAkuUMHAWhueIaO/EX9JUieIUQwb3AtGk49o4QABDmfIE/QQAAGf+bCYAKRMzkGYN0iJYwVmU5pJZzrVCUI0YinlgziCWYcoiW4hfaWzgg5hoJMuQdFFJ60Yiyb8/l8DsWgXAet+6ySBWG3U70wyB3WshVyK9tYSYfSEZBrnYrYp956soRe7oekhk8Y+/0wtFFOoKXZcph2bDf4AEbKZNzVRzbZ/HUlnjvd4eTHDWX5zW/q6zzcKGSfEQl+mXGRvhb/pHCI+KkaaMYqI1d3EyVfHcrp2fsPH7uddqdLLm7U8F649NVeEpwS/EJlmsvFa9ErengXuXUqQ/MoXjyXDSiuGRYB9PLhmkL2APhYDHYXT0eLc/c4FGkq5Pgx4Q5/zanHx3L+WOR/kqciAGHVccNO2Ok22mEj/HDffh+d/hadvW+GYfgPFEUA88zTptJ0Uvl05elV33tmVFvqZuU32W0L3w9YraQt0+qE4b5Me3kco7WjPGXr+vOmzjd1vqnzf1ZnEcBpeLYvwGs55alImJA6d96fxTg3wi38dV+/56P+gK7dDN1EUYuglS0bBDeBCFqxv3H9euTETFctQ25Sag+c0zZqtbjWzRUdUj60xO0W16I1bftbfbV8jzRebvlWEOvt5Fp8wQUEv25JKCsqHd83DcPl6gjqRaKu+5Xs10peC/klba6lWVdbXWxePzX5bBSxI4gt1r9E+n0eH6DxiqglGysyHmeckKOSsFXQtxplT4wlO7+7ZtM27PaT9xNhmbB+OlFxnqF0vlKzkTJsB82G3GLCVNmH0SSNd5ttZjXGYlQV+SZ7kA+ypzJkuUW6GFIhn230IBusfzsaiVjwlP2NQyscDt6taDWbzfZodeIxV8JN8iEzqNXGfOwHPffqqPXHCQTg0GT2dtRDMxUxVhQ+sFTLG7eqq4vH/urCijDV0KddEOk0FTFKizUFn1/dfWXdZghBTTn/IeTW1+uLy2+9S/JK2iuPqN0MmyENkVozLusLHXsNbB30cnMhH0dVjHM4dy2dcuELvs9iWdWJPtTqxCCACRWRqA/LJdHjh0mLgoZ/5mioAg0CmHIj+JD42B8UwUrTVFgSYWkiWT8kDgb97nvVmpywQ1E+42KviEx5mpMlFMGyMrgofTbuycfGYq9L2SDO4xi1O2pbr6p3t717CGBYvWoy/1ACw2f0suIziOABHsC/13wFICM/voSUy3HOx75/8H5J0zynba9XzWdfNas/tI+rKbmoRbm9E2Uq9EuJvQj4neT8BRd/rM3LmYOA9YOxtKZjGBRF8S8mWvZt",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",source:"@site/docs/API-docs/add-pet.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/add-pet",permalink:"/docs/API-docs/add-pet",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"add-pet",title:"Add a new pet to the store",description:"Add a new pet to the store",sidebar_label:"Add a new pet to the store",hide_title:!0,hide_table_of_contents:!0,api:"eJztV21vGjkQ/ivWfGqkBRZI2t7qdGqay0VJqyYqqU46giKzO4CTXdu1vbwI7X8/jXeBBQK9SPcxXxBrzzOesZ9nPF6C42MLUR9yi8bCIIAEbWyEdkJJiOA8SRhnEmdMo2NOMTdBZp0yCAEojYaT4XUCEfAkuUMHAWhueIaO/EX9JUieIUQwb3AtGk49o4QABDmfIE/QQAAGf+bCYAKRMzkGYN0iJYwVmU5pJZzrVCUI0YinlgziCWYcoiW4hfaWzgg5hoJMuQdFFJ60Yiyb8/l8DsWgXAet+6ySBWG3U70wyB3WshVyK9tYSYfSEZBrnYrYp956soRe7oekhk8Y+/0wtFFOoKXZcph2bDf4AEbKZNzVRzbZ/HUlnjvd4eTHDWX5zW/q6zzcKGSfEQl+mXGRvhb/pHCI+KkaaMYqI1d3EyVfHcrp2fsPH7uddqdLLm7U8F649NVeEpwS/EJlmsvFa9ErengXuXUqQ/MoXjyXDSiuGRYB9PLhmkL2APhYDHYXT0eLc/c4FGkq5Pgx4Q5/zanHx3L+WOR/kqciAGHVccNO2Ok22mEj/HDffh+d/hadvW+GYfgPFEUA88zTptJ0Uvl05elV33tmVFvqZuU32W0L3w9YraQt0+qE4b5Me3kco7WjPGXr+vOmzjd1vqnzf1ZnEcBpeLYvwGs55alImJA6d96fxTg3wi38dV+/56P+gK7dDN1EUYuglS0bBDeBCFqxv3H9euTETFctQ25Sag+c0zZqtbjWzRUdUj60xO0W16I1bftbfbV8jzRebvlWEOvt5Fp8wQUEv25JKCsqHd83DcPl6gjqRaKu+5Xs10peC/klba6lWVdbXWxePzX5bBSxI4gt1r9E+n0eH6DxiqglGysyHmeckKOSsFXQtxplT4wlO7+7ZtM27PaT9xNhmbB+OlFxnqF0vlKzkTJsB82G3GLCVNmH0SSNd5ttZjXGYlQV+SZ7kA+ypzJkuUW6GFIhn230IBusfzsaiVjwlP2NQyscDt6taDWbzfZodeIxV8JN8iEzqNXGfOwHPffqqPXHCQTg0GT2dtRDMxUxVhQ+sFTLG7eqq4vH/urCijDV0KddEOk0FTFKizUFn1/dfWXdZghBTTn/IeTW1+uLy2+9S/JK2iuPqN0MmyENkVozLusLHXsNbB30cnMhH0dVjHM4dy2dcuELvs9iWdWJPtTqxCCACRWRqA/LJdHjh0mLgoZ/5mioAg0CmHIj+JD42B8UwUrTVFgSYWkiWT8kDgb97nvVmpywQ1E+42KviEx5mpMlFMGyMrgofTbuycfGYq9L2SDO4xi1O2pbr6p3t717CGBYvWoy/1ACw2f0suIziOABHsC/13wFICM/voSUy3HOx75/8H5J0zynba9XzWdfNas/tI+rKbmoRbm9E2Uq9EuJvQj4neT8BRd/rM3LmYOA9YOxtKZjGBRF8S8mWvZt",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},j={},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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Add a new pet to the store"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createuser"}),"\n",(0,i.jsx)(s.p,{children:"Add a new pet to the store"}),"\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)(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,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(s.p,{children:"Create a new pet in the store"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid input"})}),(0,i.jsx)("div",{})]})]})})})]})}function q(e={}){const{wrapper:s}={...(0,t.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/52d5c0f9.1e6d4a52.js b/assets/js/52d5c0f9.1e6d4a52.js deleted file mode 100644 index a09f276bb..000000000 --- a/assets/js/52d5c0f9.1e6d4a52.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,d,s)=>{s.r(d),s.d(d,{assets:()=>p,contentTitle:()=>m,default:()=>I,frontMatter:()=>c,metadata:()=>u,toc:()=>h});var t=s(85893),n=s(11151),a=s(58219),i=(s(62316),s(51039)),l=s.n(i),o=(s(82723),s(9487),s(41429)),r=(s(5397),s(4667),s(9472),s(85162));const c={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:"eJytVdtu2zgQ/RV2nhpAsZy0+yIsFi0aozAaNME6RR8So6DFkcWGIlmScmII+vdiqEvlJEaLxb7YEjmXMzNnjhoIfOshu4Xc6MDz4GGdgECfO2mDNBoyEKgwIONMmLyuUAdIwFh0nO6XYrSYXFvueIUBHYVuQPMKIYPHU27laTD3qCEBSbFL5AIdPE0JCTj8UUuHArLgakzAh72iIF5WViEkgI9WGYGQFVx5MshLrDhkDYS9jZbBSb2Ftk1GBAPEb1IMCCwP5bP8187spEBmNt8xD0vBTDFWz4JhXcH/J8oECuMqHqYn+MhjlAxseb4pz7kX0LZryuqt0R49xTmfz+nvsIAP3TR7oIL5Os/R+6JWav8K2gTezt8e99ImsMLUWvSmfz03XeodV1Kw99dLdkMTfUWNBo957WTYx7FzK7/dIz2vCXWFoTS/6BJpEkrIIB1amzaTAbVA4dxuIFHtFBEmBOuzNOXWzoxF7eVWK77xs9xUKbcy3Z0BJRuArKjfXaNGOGPvuZWfcA/J7wlKtUldmOgsQxzKlUW9klsde7A7e0aim1J6Jn28HuqKO8MK49gTb7bhHgUzmoUS4yWdv5mdMW8xl4XMo+uM3ek7vTIVstpjUSumpL732Z0+ZbdXRSFzyRX7ihsvA65fD916eHh41q2T6PNRhrLeMIfW/DLfxsPY0qnX+HICCQR0lb8qVuh2Msd+MkdSpdE4hWRQGWojVlzSRPujd0+diHpK5qg9knk/ovcfry/Zm9kckgkh/gByern8sPi8WlBUolQ3orPZfDanI2t8qLieJLroVG/c+s2eLS+ezriJ6EnzXpbJnmcBH0NqFZeackXcTU/+W5iYZ1N9WidQGh/IpGmIHV+cals6/lGji1uVwI47yTdEx9sGhPT0LEaxOYr19b+9bp2wP5a6F2sZFknTFu24qrFT77hnB3Lbrttk2Kb/DPYYjC7d4fqOaA6052JxubhZQAK8pvZPpeA+SkH/QBBfLO4wSZeYfukr86LD37TIn3D/z2je3Rx1GL+JnTVVuG7b9idiKpzB",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,u={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:"eJytVdtu2zgQ/RV2nhpAsZy0+yIsFi0aozAaNME6RR8So6DFkcWGIlmScmII+vdiqEvlJEaLxb7YEjmXMzNnjhoIfOshu4Xc6MDz4GGdgECfO2mDNBoyEKgwIONMmLyuUAdIwFh0nO6XYrSYXFvueIUBHYVuQPMKIYPHU27laTD3qCEBSbFL5AIdPE0JCTj8UUuHArLgakzAh72iIF5WViEkgI9WGYGQFVx5MshLrDhkDYS9jZbBSb2Ftk1GBAPEb1IMCCwP5bP8187spEBmNt8xD0vBTDFWz4JhXcH/J8oECuMqHqYn+MhjlAxseb4pz7kX0LZryuqt0R49xTmfz+nvsIAP3TR7oIL5Os/R+6JWav8K2gTezt8e99ImsMLUWvSmfz03XeodV1Kw99dLdkMTfUWNBo957WTYx7FzK7/dIz2vCXWFoTS/6BJpEkrIIB1amzaTAbVA4dxuIFHtFBEmBOuzNOXWzoxF7eVWK77xs9xUKbcy3Z0BJRuArKjfXaNGOGPvuZWfcA/J7wlKtUldmOgsQxzKlUW9klsde7A7e0aim1J6Jn28HuqKO8MK49gTb7bhHgUzmoUS4yWdv5mdMW8xl4XMo+uM3ek7vTIVstpjUSumpL732Z0+ZbdXRSFzyRX7ihsvA65fD916eHh41q2T6PNRhrLeMIfW/DLfxsPY0qnX+HICCQR0lb8qVuh2Msd+MkdSpdE4hWRQGWojVlzSRPujd0+diHpK5qg9knk/ovcfry/Zm9kckgkh/gByern8sPi8WlBUolQ3orPZfDanI2t8qLieJLroVG/c+s2eLS+ezriJ6EnzXpbJnmcBH0NqFZeackXcTU/+W5iYZ1N9WidQGh/IpGmIHV+cals6/lGji1uVwI47yTdEx9sGhPT0LEaxOYr19b+9bp2wP5a6F2sZFknTFu24qrFT77hnB3Lbrttk2Kb/DPYYjC7d4fqOaA6052JxubhZQAK8pvZPpeA+SkH/QBBfLO4wSZeYfukr86LD37TIn3D/z2je3Rx1GL+JnTVVuG7b9idiKpzB",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 list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},p={},h=[{value:"Request",id:"request",level:2}];function x(e){const d={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=d;return s||function(e,d){throw new Error("Expected "+(d?"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)(d.p,{children:"Delete document by ID"})}),"\n",(0,t.jsx)(l(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,t.jsx)(d.p,{children:"delete a document"}),"\n",(0,t.jsx)(d.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)(d.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,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)(d.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",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(a.Z,{children:[(0,t.jsxs)(r.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(d.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(r.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(d.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(r.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(d.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function I(e={}){const{wrapper:d}={...(0,n.a)(),...e.components};return d?(0,t.jsx)(d,{...e,children:(0,t.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.415bedce.js b/assets/js/52d5c0f9.415bedce.js new file mode 100644 index 000000000..09f1b2db6 --- /dev/null +++ b/assets/js/52d5c0f9.415bedce.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,t,d)=>{d.r(t),d.d(t,{assets:()=>u,contentTitle:()=>m,default:()=>x,frontMatter:()=>r,metadata:()=>p,toc:()=>h});var s=d(85893),l=d(11151),a=d(58219),i=(d(62316),d(51039)),n=d.n(i),c=(d(82723),d(9487),d(41429)),o=(d(5397),d(4667),d(9472),d(85162));const r={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:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/5kXQNXmwcxEtItPIi8Q5WHFJ0iZXGS60ghhQL9MgES3VSlag8cNAGraDzeTogRsdGWFGiR0tX16BEiRDD7kIYeeH1EyrgIOnuHEWKFjhY/F5JiynE3lbIwfl9QT5OlqZA4IA7U+gUIc5E4QiQ5FgKiGvwexOQ3kq1gYagIjjFRFM5uVGT3W63g4YPVHqu32TaUzHC53Cc+73VW5ki0+v/MPHzlOlsKAPzmrWZ/07+HDJtS+HHlpeETH61zq+ES6FpVhTVGa0cOrrnajqlv8MErltZO6Ipc1WSoHNZVRT7MyrWh+mH015Ke5bpSqUd9I/X0LnaikKm7PP9nD2QtGfQNBwcJpWVfh/0HwsfL1fEvESf65feCT3jc4gh6ssb1SORGqAr7bbvqMoW1D3eGxdHkTBm0ktdiLWbJLqMhJHR9hIoWE9mQTVvi3VAadBAGPkV98B/3LGUo1SZDs7SB3HuDKqF3KhQi+3lq2Z6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBDt1ToSKAjgC3q8dKiOWQpKqnenTsRO1YCETVA4J3kn0+cv9LXs/mQIfNcVPUI5u59ezvxYzupXaqpXocjKdTMlktPOlUKNAN+0aHKZ/vWfzm2ON68CeluDbe7PrM487H5lCSEWxAu+6G4AljODxeE+tOOTaeYLUNXXHP7ZoGjJ/r9DSpK04bIWVYk3tuKwhlY6e02HpnOT67u9uf52zn155b+bSD5KiKdqKoqI34PCE+6O126wa3k/TL5M9RaMNdzi+A5uD/XMzu509zICDqKj841XwFFZB90AU30zuMEgbmH7pa/Omw580yF9x/3GAtycnHYaPZIumDFdN0/wP+K+jEA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,p={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:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/5kXQNXmwcxEtItPIi8Q5WHFJ0iZXGS60ghhQL9MgES3VSlag8cNAGraDzeTogRsdGWFGiR0tX16BEiRDD7kIYeeH1EyrgIOnuHEWKFjhY/F5JiynE3lbIwfl9QT5OlqZA4IA7U+gUIc5E4QiQ5FgKiGvwexOQ3kq1gYagIjjFRFM5uVGT3W63g4YPVHqu32TaUzHC53Cc+73VW5ki0+v/MPHzlOlsKAPzmrWZ/07+HDJtS+HHlpeETH61zq+ES6FpVhTVGa0cOrrnajqlv8MErltZO6Ipc1WSoHNZVRT7MyrWh+mH015Ke5bpSqUd9I/X0LnaikKm7PP9nD2QtGfQNBwcJpWVfh/0HwsfL1fEvESf65feCT3jc4gh6ssb1SORGqAr7bbvqMoW1D3eGxdHkTBm0ktdiLWbJLqMhJHR9hIoWE9mQTVvi3VAadBAGPkV98B/3LGUo1SZDs7SB3HuDKqF3KhQi+3lq2Z6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBDt1ToSKAjgC3q8dKiOWQpKqnenTsRO1YCETVA4J3kn0+cv9LXs/mQIfNcVPUI5u59ezvxYzupXaqpXocjKdTMlktPOlUKNAN+0aHKZ/vWfzm2ON68CeluDbe7PrM487H5lCSEWxAu+6G4AljODxeE+tOOTaeYLUNXXHP7ZoGjJ/r9DSpK04bIWVYk3tuKwhlY6e02HpnOT67u9uf52zn155b+bSD5KiKdqKoqI34PCE+6O126wa3k/TL5M9RaMNdzi+A5uD/XMzu509zICDqKj841XwFFZB90AU30zuMEgbmH7pa/Omw580yF9x/3GAtycnHYaPZIumDFdN0/wP+K+jEA==",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 list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},u={},h=[{value:"Request",id:"request",level:2}];function j(e){const t={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:d}=t;return d||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Delete document by ID"})}),"\n",(0,s.jsx)(n(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,s.jsx)(t.p,{children:"delete a document"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(a.Z,{children:[(0,s.jsxs)(o.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(o.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Contact not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(o.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function x(e={}){const{wrapper:t}={...(0,l.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.5158ea15.js b/assets/js/5a2de241.5158ea15.js deleted file mode 100644 index b5db7e992..000000000 --- a/assets/js/5a2de241.5158ea15.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>u,contentTitle:()=>h,default:()=>b,frontMatter:()=>c,metadata:()=>x,toc:()=>j});var s=a(85893),l=a(11151),i=a(58219),d=(a(62316),a(51039)),r=a.n(d),n=(a(82723),a(9487)),p=a(41429),o=(a(5397),a(4667)),m=(a(9472),a(85162));const c={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:"eJytVk1v4zgM/SsCTx3AjVNMsQefdnbaLYIdtMW0xR7aoJAtOlFrSxqJzgcC//cF5Th1mhY7HUxODkWRj+QjqQ2QnAXI7oGwdpUkDDBNwDr0krQ1EwUZNE5JwtutAiTgpJc1Enq+uQEja4QMVsfS6WOyz2ggAW0ggzlKhR4SUBgKrx2bhAwgAY8/Gu1RQUa+wQQCrSs2EnTtKvaBK1dZhZCVsgqsUMyxlpBtgNYuapLXZgZtm+wQ9DE8atUjcJLmB/4nZ8KWguYorFfoBc0lCYOogiArchRdxOq34NSGcBaTUFpfS+pEf5xC2047+xjoL6vWfGcfp/N2oRWKHCu7FLusM8gOodhVTRxJEhXKQMIaHOj2AXyCBAprCA2xI+lcpYtY4/QpsLfNIXSbP2FBXHDPjCCNgU8vY7ZfF2IQ306CKxnTlEGIHzu80CZwaenDZq45RBQeFxqXQholgp4ZQXMdhLJFU3N4bQJnwzx+zEUPUQxr0Sbwt60Uem6Ij9lbPYVcnlzI1TVzFUjTnpvHAWkfc6ZB27Kex+CsCV3GT8fjQ3ZMzEJWWonJmQgNlxMV4zwdnx7qXkWeG0uitI1REcm+xt0+oUS+FpMzSKBGmlueAq6JTOB+yiDt9dLNAH8LCQT0i34wNL7iIUDkQpam0rmRdWi4YpXMw6iwdSqdThcnwK0QsGi8pvUN07CLWzr9+IzrQcql0//gGpL/HzocIjP7+0uHnfdF6Tl8QMuelT9HtFc8e5s6Q+bskYHhljbGtuXElUNzw26+XE/E4uRgbt2ydx3icQ8itrAorRevbotcBlTCmjjo+JDln0cnIjgsdLnt/pF4MA/mxtYomoBlU4lKm+eQPZhjcX9VlrrQshL/Yh404fSoL+ZyuTwo5qd450LTvMmFR2df1GdRGCs+vLX7w9OJ0NfhqrxBv9AFbonzjqs0KqfbmSaLONOwlpoJtxX9+foSp7zSBZoQKbBl0JeL62/i82gMyYCvPwE5/Tb5en55c85WmfFdiU5G49GYRc4GqqUZOHqvw9Sbs4pwRamrpI7DJyLbbLvvZVlDAtlw6U0TmNtArLLZcP3vfNW2LP7RoF9Ddj9NYCG9ljkT7n4DSgf+Vrv99QrNbmXA0fd+k4gP7M83o+l72XAjL2TVYPcoiK2+t8XbaZv0Df3LcN+D0bnbnyA7NPys6BS+djaPb9nGi8bBBuUZtpuW13e3kEC+Xet1fCGAl0t+UsglZPAADxyyjdDjsIvyDVTSzBo5Y/3OLP/+A562VBs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={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:"eJytVk1v4zgM/SsCTx3AjVNMsQefdnbaLYIdtMW0xR7aoJAtOlFrSxqJzgcC//cF5Th1mhY7HUxODkWRj+QjqQ2QnAXI7oGwdpUkDDBNwDr0krQ1EwUZNE5JwtutAiTgpJc1Enq+uQEja4QMVsfS6WOyz2ggAW0ggzlKhR4SUBgKrx2bhAwgAY8/Gu1RQUa+wQQCrSs2EnTtKvaBK1dZhZCVsgqsUMyxlpBtgNYuapLXZgZtm+wQ9DE8atUjcJLmB/4nZ8KWguYorFfoBc0lCYOogiArchRdxOq34NSGcBaTUFpfS+pEf5xC2047+xjoL6vWfGcfp/N2oRWKHCu7FLusM8gOodhVTRxJEhXKQMIaHOj2AXyCBAprCA2xI+lcpYtY4/QpsLfNIXSbP2FBXHDPjCCNgU8vY7ZfF2IQ306CKxnTlEGIHzu80CZwaenDZq45RBQeFxqXQholgp4ZQXMdhLJFU3N4bQJnwzx+zEUPUQxr0Sbwt60Uem6Ij9lbPYVcnlzI1TVzFUjTnpvHAWkfc6ZB27Kex+CsCV3GT8fjQ3ZMzEJWWonJmQgNlxMV4zwdnx7qXkWeG0uitI1REcm+xt0+oUS+FpMzSKBGmlueAq6JTOB+yiDt9dLNAH8LCQT0i34wNL7iIUDkQpam0rmRdWi4YpXMw6iwdSqdThcnwK0QsGi8pvUN07CLWzr9+IzrQcql0//gGpL/HzocIjP7+0uHnfdF6Tl8QMuelT9HtFc8e5s6Q+bskYHhljbGtuXElUNzw26+XE/E4uRgbt2ydx3icQ8itrAorRevbotcBlTCmjjo+JDln0cnIjgsdLnt/pF4MA/mxtYomoBlU4lKm+eQPZhjcX9VlrrQshL/Yh404fSoL+ZyuTwo5qd450LTvMmFR2df1GdRGCs+vLX7w9OJ0NfhqrxBv9AFbonzjqs0KqfbmSaLONOwlpoJtxX9+foSp7zSBZoQKbBl0JeL62/i82gMyYCvPwE5/Tb5en55c85WmfFdiU5G49GYRc4GqqUZOHqvw9Sbs4pwRamrpI7DJyLbbLvvZVlDAtlw6U0TmNtArLLZcP3vfNW2LP7RoF9Ddj9NYCG9ljkT7n4DSgf+Vrv99QrNbmXA0fd+k4gP7M83o+l72XAjL2TVYPcoiK2+t8XbaZv0Df3LcN+D0bnbnyA7NPys6BS+djaPb9nGi8bBBuUZtpuW13e3kEC+Xet1fCGAl0t+UsglZPAADxyyjdDjsIvyDVTSzBo5Y/3OLP/+A562VBs=",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"}},u={},j=[{value:"Request",id:"request",level:2}];function g(e){const t={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=t;return a||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Update template by ID"})}),"\n",(0,s.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,s.jsx)(t.p,{children:"Update template by ID"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(p.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the order that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"integer",format:"int64"}}})})})]}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(p.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,s.jsx)(n.Z,{className:"openapi-tabs__mime",children:(0,s.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,s.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,s.jsx)(t.p,{children:"Body"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,s.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,s.jsx)(t.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,s.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,s.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,s.jsx)(o.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(m.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid ID supplied"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(m.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Order not found"})}),(0,s.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:t}={...(0,l.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.ee68edbb.js b/assets/js/5a2de241.ee68edbb.js new file mode 100644 index 000000000..763b3ab22 --- /dev/null +++ b/assets/js/5a2de241.ee68edbb.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:()=>u,contentTitle:()=>h,default:()=>I,frontMatter:()=>c,metadata:()=>x,toc:()=>j});var t=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),n=s.n(l),d=(s(82723),s(9487)),p=s(41429),m=(s(5397),s(4667)),o=(s(9472),s(85162));const c={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:"eJytVk1v4zgM/SsCTx1AjVNMsQefdnbaLYIdtMGkxR7aoJAtOlFrSxpJzgcC//cF5ThxkhY7HUxODk2Rj+LjozcQxMxD+ggBK1uKgB6mHIxFJ4IyeiQhhdpKEfB+6wAcrHCiwoCOTm5AiwohhdW5sOo8mFfUwEFpSGGOQqIDDg5/1MqhhDS4Gjn4sC7pjFeVLSkkrmxpJEJaiNKTQz7HSkC6gbC20TM4pWfQkKuIh1KCqb2a6cFqtVpBw3dQumKeleygWBHmwEGiz52yVBukMLpipmBhjsw4iY6FuQhMI0rPgmEZsrZ0+VsqUDrgLN5GYVwlQmv64xKaZtrGRx/+MnJNZw5xWmcWSiLLsDRLtrt+AtkiZLv2sTMRWInCB2Y09ny7Aj4Bh9zogDpQImFtqfLY7OTFU7bNKXSTvWAeqPOOqBEUenp7G2/7uEW9+naWfc98fNjhpYbemvDhMGMqEZnDhcIlE1oyIgILc+WZNHldUXkNh6v+PX4sRQeR9XvRcPjblBIdTcbH4q1efCYubsRqDE3DIahwkOa5R9rnjGjQNOTn0FujfXvjl8PhKTtGeiFKJdnoivma2omScF4OL0997yLPtQmsMLWWEcmhx8MhoVi2ZqMr4FBhmBuSA1tHJtA8pZB0fsmmh78BDh7dolOI2pWkBiFYnyaJsHbQjW4pMj/ITZUIq5LFBdAoeMxrp8J6QjRs6+5ry/7ahVX/4Br4/ysQlUns/r6fsuuuMR2PT6jZMfPnyHbEtbfp02fPASEIbmFibVte3FnUE0rzZTxii4sT7bqn7MrH1x2IOMasMI4dnWaZ8CiZ0VHs6CXZPw8umLeYq2KrAAP2pJ/0xFTIao9FXbJS6VefPulz9nhXFCpXomT/YuZVwOlZ19DlcnnS0E/xzI0K8zpjDq3Zu8+iMXa9f2r3hxQqoKv8XTFBt1A5bsnzTqokOidbXRN51DWshCLSbU1/Hh+iKy9VjtpHCmwZ9OVm/I19HgyB9zj7E5CTb6Ov17eTa4pKrG9bdDEYDoZkssaHSuheovemTL6pVwFXIbGlUFGAIrLNdgL3mxs4pP3FN+UwNz6Qy2ZD/X9wZdOQ+UeNbg3p45TDQjglMiLc4wak8vQsdzvsCM1ubcDZ926bsA/s0Der6WZZ0yAvRFnTP+DwiuujTd5MG94N9C/DfQ9Gm+5QQXZo6NOidfjaxjy/pxh7j5MtSjq2U8zxwz1wyLarvYpfCeDEkj4rxBJSeIInKtlE6FHwon0DpdCzWszIvw1Lv/8AQ8RZHw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={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:"eJytVk1v4zgM/SsCTx1AjVNMsQefdnbaLYIdtMGkxR7aoJAtOlFrSxpJzgcC//cF5ThxkhY7HUxODk2Rj+LjozcQxMxD+ggBK1uKgB6mHIxFJ4IyeiQhhdpKEfB+6wAcrHCiwoCOTm5AiwohhdW5sOo8mFfUwEFpSGGOQqIDDg5/1MqhhDS4Gjn4sC7pjFeVLSkkrmxpJEJaiNKTQz7HSkC6gbC20TM4pWfQkKuIh1KCqb2a6cFqtVpBw3dQumKeleygWBHmwEGiz52yVBukMLpipmBhjsw4iY6FuQhMI0rPgmEZsrZ0+VsqUDrgLN5GYVwlQmv64xKaZtrGRx/+MnJNZw5xWmcWSiLLsDRLtrt+AtkiZLv2sTMRWInCB2Y09ny7Aj4Bh9zogDpQImFtqfLY7OTFU7bNKXSTvWAeqPOOqBEUenp7G2/7uEW9+naWfc98fNjhpYbemvDhMGMqEZnDhcIlE1oyIgILc+WZNHldUXkNh6v+PX4sRQeR9XvRcPjblBIdTcbH4q1efCYubsRqDE3DIahwkOa5R9rnjGjQNOTn0FujfXvjl8PhKTtGeiFKJdnoivma2omScF4OL0997yLPtQmsMLWWEcmhx8MhoVi2ZqMr4FBhmBuSA1tHJtA8pZB0fsmmh78BDh7dolOI2pWkBiFYnyaJsHbQjW4pMj/ITZUIq5LFBdAoeMxrp8J6QjRs6+5ry/7ahVX/4Br4/ysQlUns/r6fsuuuMR2PT6jZMfPnyHbEtbfp02fPASEIbmFibVte3FnUE0rzZTxii4sT7bqn7MrH1x2IOMasMI4dnWaZ8CiZ0VHs6CXZPw8umLeYq2KrAAP2pJ/0xFTIao9FXbJS6VefPulz9nhXFCpXomT/YuZVwOlZ19DlcnnS0E/xzI0K8zpjDq3Zu8+iMXa9f2r3hxQqoKv8XTFBt1A5bsnzTqokOidbXRN51DWshCLSbU1/Hh+iKy9VjtpHCmwZ9OVm/I19HgyB9zj7E5CTb6Ov17eTa4pKrG9bdDEYDoZkssaHSuheovemTL6pVwFXIbGlUFGAIrLNdgL3mxs4pP3FN+UwNz6Qy2ZD/X9wZdOQ+UeNbg3p45TDQjglMiLc4wak8vQsdzvsCM1ubcDZ926bsA/s0Der6WZZ0yAvRFnTP+DwiuujTd5MG94N9C/DfQ9Gm+5QQXZo6NOidfjaxjy/pxh7j5MtSjq2U8zxwz1wyLarvYpfCeDEkj4rxBJSeIInKtlE6FHwon0DpdCzWszIvw1Lv/8AQ8RZHw==",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"}},u={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,t.jsx)(n(),{method:"put",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.p,{children:"Update template by ID"}),"\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)(p.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the order that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"integer",format:"int64"}}})})})]}),"\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)(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,t.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(o.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.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)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(m.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)(m.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(m.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)(r.Z,{children:[(0,t.jsxs)(o.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid ID supplied"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(o.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Order not found"})}),(0,t.jsx)("div",{})]})]})})})]})}function I(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.59fcada6.js b/assets/js/770b40a9.59fcada6.js new file mode 100644 index 000000000..976717559 --- /dev/null +++ b/assets/js/770b40a9.59fcada6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),o=a(5397),c=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVttu4zYQ/RXuPG0AxZck3Qc9NZumqdFgE8RZ9CE2Cloa20wokkuOfIGhfy+GlmytnSYpUL9YGs4h53LmiBsgOQuQPgFh4bQkDDBOwDr0kpQ1gxxSmCE1q1oFggSc9LJAQs/QDRhZIKSwOpVOnZJ9QQMJKAMpzFHm6CEBjz9K5TGHlHyJCQRaa8YEVTiNkACunLY5QjqVOrBDNsdCQroBWrvoSV6ZGVTsKiMo5ThNUDPTWa1WK6jG23Mw0FebrxmbWUNoiB+lc1plMavuc7CGbUeH2MkzZjFDzzUghYFXtSoUtdyUIZzFvKbWF5K2pvMzaAXX71UJhBfl/iOuV1UJrArNsLqwXPUJZ1QlQIr0z7aKAR6DsyZswz3r9fgvx5B55Thjrl+ZZRjCtNRi115I/q8Kqfy4Va0sd5Z971b9PyamCGf3saffH25f22DvPidyIe12GyaWAX0nswWDv8UyvYUO8UE04Aiy9A6o8RbGbiG/tQv6MSRHViXwu9U8B2+CptFnBxmqmYkDtsNI7+WaJ4uwCO+3ZGse5O/y78vFx4r4bBGqFgWbLP9uQuXFK4+S8Ov6gwXK2N02WR8xv92ww2Nr5l/0Lo7J/oDOehIqcO+EXEil5UTjJ4iAX44BA7OQWuXi8n4gHlnBPsVofna6QdpRSNRSWCDNLauks7U00hxS6B4oZkC/aOSy9LpFaOlcp9ExLSeBSd2VTnUX/ahoAbPSK1oPeRK3nW0LbYseTv2JzI935Zgz4wF/2IvlddOandj1e418sZApM7XxrLoJdw4Ntz0WbNGHw1I9zlXg8vNybrOyQENRWcTUenGAFhMZMBfWCJpjXGT7eacvgsNMTWtR6oiRGZmhLVCUAVnItDIvIR2ZU/F0N52qTEkt/sJJUITjz02Bl8vlUYFPIuZG0bycCI/O7t1n0Ri70EbtXk4gAUJfhLvpEP1CZY06/ctR3ejcraVWZlFqsZCKSVCbfj0EMU+1ytAEbE3D5c39rTjv9CBpcegDIXdvB1fX34bXvCuzcNuifqfX6bGJmVtI0zroNaLnr4of4Yq6TktleKcY1aaegf2dIu4wTmDOI5I+wWbDDf/udVWx+UeJfg3p0ziBhfSKB5XfqqThKw9NrgIv5LsLwkE8u+8YfH6o7xonglv1WpwvuD4akIXUJXtClWxqh6vtnqePvMfe4+g7uUdcZhk6etN33NKM+7vhIyQwqW8rRbwAgZdLvjHJJaQwghEAX8h4hzj80b4BLc2slLOoy3Ff/v0DlSRbtg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get template list",description:"Get template list",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVttu4zYQ/RXuPG0AxZck3Qc9NZumqdFgE8RZ9CE2Cloa20wokkuOfIGhfy+GlmytnSYpUL9YGs4h53LmiBsgOQuQPgFh4bQkDDBOwDr0kpQ1gxxSmCE1q1oFggSc9LJAQs/QDRhZIKSwOpVOnZJ9QQMJKAMpzFHm6CEBjz9K5TGHlHyJCQRaa8YEVTiNkACunLY5QjqVOrBDNsdCQroBWrvoSV6ZGVTsKiMo5ThNUDPTWa1WK6jG23Mw0FebrxmbWUNoiB+lc1plMavuc7CGbUeH2MkzZjFDzzUghYFXtSoUtdyUIZzFvKbWF5K2pvMzaAXX71UJhBfl/iOuV1UJrArNsLqwXPUJZ1QlQIr0z7aKAR6DsyZswz3r9fgvx5B55Thjrl+ZZRjCtNRi115I/q8Kqfy4Va0sd5Z971b9PyamCGf3saffH25f22DvPidyIe12GyaWAX0nswWDv8UyvYUO8UE04Aiy9A6o8RbGbiG/tQv6MSRHViXwu9U8B2+CptFnBxmqmYkDtsNI7+WaJ4uwCO+3ZGse5O/y78vFx4r4bBGqFgWbLP9uQuXFK4+S8Ov6gwXK2N02WR8xv92ww2Nr5l/0Lo7J/oDOehIqcO+EXEil5UTjJ4iAX44BA7OQWuXi8n4gHlnBPsVofna6QdpRSNRSWCDNLauks7U00hxS6B4oZkC/aOSy9LpFaOlcp9ExLSeBSd2VTnUX/ahoAbPSK1oPeRK3nW0LbYseTv2JzI935Zgz4wF/2IvlddOandj1e418sZApM7XxrLoJdw4Ntz0WbNGHw1I9zlXg8vNybrOyQENRWcTUenGAFhMZMBfWCJpjXGT7eacvgsNMTWtR6oiRGZmhLVCUAVnItDIvIR2ZU/F0N52qTEkt/sJJUITjz02Bl8vlUYFPIuZG0bycCI/O7t1n0Ri70EbtXk4gAUJfhLvpEP1CZY06/ctR3ejcraVWZlFqsZCKSVCbfj0EMU+1ytAEbE3D5c39rTjv9CBpcegDIXdvB1fX34bXvCuzcNuifqfX6bGJmVtI0zroNaLnr4of4Yq6TktleKcY1aaegf2dIu4wTmDOI5I+wWbDDf/udVWx+UeJfg3p0ziBhfSKB5XfqqThKw9NrgIv5LsLwkE8u+8YfH6o7xonglv1WpwvuD4akIXUJXtClWxqh6vtnqePvMfe4+g7uUdcZhk6etN33NKM+7vhIyQwqW8rRbwAgZdLvjHJJaQwghEAX8h4hzj80b4BLc2slLOoy3Ff/v0DlSRbtg==",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"},next:{title:"Add a new pet to the store",permalink:"/docs/API-docs/add-pet"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template list"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,t.jsx)(s.p,{children:"Get template list"}),"\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)(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)(m.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(c.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "id": "x1Hbnms2Pg",\n "URL": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "objectId": 0,\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.8c254a88.js b/assets/js/770b40a9.8c254a88.js deleted file mode 100644 index d4acce3b4..000000000 --- a/assets/js/770b40a9.8c254a88.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:()=>x,default:()=>b,frontMatter:()=>j,metadata:()=>u,toc:()=>f});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),m=a.n(n),r=(a(82723),a(9487)),d=a(41429),c=a(5397),p=a(4667),o=a(9472),h=a(85162);const j={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVt9P4zgQ/le887RIoWmBu4c8HctxHDq0IMrqHmi1cpNJanBsr+30h6r876dxkzS0LLDS8UI7nm88P7756g14XjhIHsFjaST36GAagTZouRdaXWeQQIG+PZXCeYjAcMtL9GgJugHFS4QEVsfciGOvn1FBBEJBAnPkGVqIIEOXWmEoJiQAEVj8UQmLGSTeVhiB82tJQZwojUSIAFdG6gwhybl05JDOseSQbMCvTfD0VqgC6nq6jYbOf9HZmjxSrTwqTx+5MVKkoZj4ydHtm8NQevaEaSjMUuleoKNTKUrhe25CeSxCObm2Jfdb0+lJyJaHvJPRsI7APQvzi7hhXUewKiXBmn5Ss2dUUR2BF16+tNUEsOiMVm6b7slwSP9ettpVaYrO5ZVk3VQh+r86JLLDgfSq7CxdmbAa/T1TpTu5K6isb/c3rwXYuc+9Ny6J45aAlUM7SHVJ4K+hTW+hXfjAWnAAaf8OqPVmSm8hf/Yb+jEkZVZH8JeWRP83QXnw6SBjUaiwVx2GW8vXtFAeS/f+SLbm6+xd/v1+9rEmPmmEukfBtsrvbap0eGGRe/yy/mCDUnLXbdUHzO8PbP/ahvlnw7NDst+j0dYz4Wh2jC+4kHwm8RMEwG+HgGu14FJk7Pzumj2QcH0K2bx0ukLfUYg1Cliin2sSR6MbRfRzSCDeE0qHdtGqZGVlj9DcmIE2qJwolOQzR6SOuRHxYgSkaA7Tygq/HtMmbifLjfj+jP0WcyP+QeLGuwpMVdFy3++E8rIdSyd0o2ErXSRiQuU63NUM4NagopGHZi1GB6L+MBeOWk/HmU6rEpUPqsJybdkems24w4xpxfwcwyHZTwcj5gymIm8EacAmaqLGukRWOSQRk0I9u2SijtnjbZ6LVHDJ/sWZEx6nn9vmLpfLg+YeBcyV8PNqxiwavXMvgjFMoI/qvhxBBB5t6W7zMdqFSFtl+slVcXCOG5nlaZBZLLkgAjSmP/ZBxFEpUlQOe5twfnV3w04HQ4h6/PlAyvHN9cXl1/ElRSUGbkc0GgwHQzIRa0uuehe9RvLsVeHzuPKxkVwoihSy2jT83z0jQoRpBHNaj+QRNhsa+Dcr65rMPyq0a0gepxEsuBW0pPStjlq+0sJkwtFB1j0B9vLpfsPg833zmjhiNKrX8gyLs7cgCy4r8oQ62jQOF9uYxw8UY+dx8Bu5Q5ynKRr/pu+0pxd3t+MHiGDWvFTK8MQBy5f0JuJLSGACE3og6VBnWPxg34Dkqqh4ETQ5xKW//wBuJFay",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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:"eJytVt9P4zgQ/le887RIoWmBu4c8HctxHDq0IMrqHmi1cpNJanBsr+30h6r876dxkzS0LLDS8UI7nm88P7756g14XjhIHsFjaST36GAagTZouRdaXWeQQIG+PZXCeYjAcMtL9GgJugHFS4QEVsfciGOvn1FBBEJBAnPkGVqIIEOXWmEoJiQAEVj8UQmLGSTeVhiB82tJQZwojUSIAFdG6gwhybl05JDOseSQbMCvTfD0VqgC6nq6jYbOf9HZmjxSrTwqTx+5MVKkoZj4ydHtm8NQevaEaSjMUuleoKNTKUrhe25CeSxCObm2Jfdb0+lJyJaHvJPRsI7APQvzi7hhXUewKiXBmn5Ss2dUUR2BF16+tNUEsOiMVm6b7slwSP9ettpVaYrO5ZVk3VQh+r86JLLDgfSq7CxdmbAa/T1TpTu5K6isb/c3rwXYuc+9Ny6J45aAlUM7SHVJ4K+hTW+hXfjAWnAAaf8OqPVmSm8hf/Yb+jEkZVZH8JeWRP83QXnw6SBjUaiwVx2GW8vXtFAeS/f+SLbm6+xd/v1+9rEmPmmEukfBtsrvbap0eGGRe/yy/mCDUnLXbdUHzO8PbP/ahvlnw7NDst+j0dYz4Wh2jC+4kHwm8RMEwG+HgGu14FJk7Pzumj2QcH0K2bx0ukLfUYg1Cliin2sSR6MbRfRzSCDeE0qHdtGqZGVlj9DcmIE2qJwolOQzR6SOuRHxYgSkaA7Tygq/HtMmbifLjfj+jP0WcyP+QeLGuwpMVdFy3++E8rIdSyd0o2ErXSRiQuU63NUM4NagopGHZi1GB6L+MBeOWk/HmU6rEpUPqsJybdkems24w4xpxfwcwyHZTwcj5gymIm8EacAmaqLGukRWOSQRk0I9u2SijtnjbZ6LVHDJ/sWZEx6nn9vmLpfLg+YeBcyV8PNqxiwavXMvgjFMoI/qvhxBBB5t6W7zMdqFSFtl+slVcXCOG5nlaZBZLLkgAjSmP/ZBxFEpUlQOe5twfnV3w04HQ4h6/PlAyvHN9cXl1/ElRSUGbkc0GgwHQzIRa0uuehe9RvLsVeHzuPKxkVwoihSy2jT83z0jQoRpBHNaj+QRNhsa+Dcr65rMPyq0a0gepxEsuBW0pPStjlq+0sJkwtFB1j0B9vLpfsPg833zmjhiNKrX8gyLs7cgCy4r8oQ62jQOF9uYxw8UY+dx8Bu5Q5ynKRr/pu+0pxd3t+MHiGDWvFTK8MQBy5f0JuJLSGACE3og6VBnWPxg34Dkqqh4ETQ5xKW//wBuJFay",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"},next:{title:"Add a new pet to the store",permalink:"/docs/API-docs/add-pet"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template list"})}),"\n",(0,t.jsx)(m(),{method:"post",path:"/templatelist"}),"\n",(0,t.jsx)(s.p,{children:"Get template list"}),"\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)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.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)(o.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "id": "x1Hbnms2Pg",\n "URL": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "objectId": 0,\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.b9990d5c.js b/assets/js/7b076186.b9990d5c.js new file mode 100644 index 000000000..280683e9f --- /dev/null +++ b/assets/js/7b076186.b9990d5c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>h,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>m,toc:()=>j});var c=s(85893),a=s(11151),d=s(58219),l=(s(62316),s(51039)),i=s.n(l),n=(s(82723),s(9487),s(41429)),o=(s(5397),s(4667),s(9472),s(85162));const r={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVVFv2zYQ/ivsPTUAYzlp9yIMw4rWKIwGSzBn2ENiDLR4srhQJEtSjg1B/304WpLtJMaKYS+2RH53993dd6cWolgHyB+gsCaKIgZYcpAYCq9cVNZADhI1RmSC9RDgYB16QddzOQIOt054UWNET45bMKJGyGF7KZy6jPYJDXBQ5LlCIdEDB4/fG+VRQh59gxxC3GmyCap2GoEDbp22EiEvhQ4EKCqsBeQtxJ1LyOiVWUNHUJGMcmJpglqbyXa73ULHRyo91b+UHJg4ESt4mfidtxslkdnV31jEuWS2HGrAomX7tP9P9hxK62sRj08O6bjqelVdiyCh65YUNThrAgbycz2d0t8p/8891z1RyUJTFBhC2Wi9e0el+jj9eN7K2MhK2xjZQ396DZ2bjdBKsk93c3ZPjX0HXcchYNF4FXep+8dtzx+WxLzGWNmDcJJiYgU5ZH11s/bQoQ7Iod8Mamq8JuXE6EKeZcK5ydBmLVZhUtg6E05lmyugUAOVBVV8X6oTQmMHhFPfcAf839VKGSpT2mSsYmrNrUOzUGuTKrG5eqWk+0oFpkK6lrZoajQxzQ8rrWcvrNlKBJTMGhYrTJd0/mFyxYLDQpWqSKYT9mgezcLWyJqAZaOZVuYp5I/mkj3clqUqlNDsT1wFFXH5fqjY8/Pzq4pdJJuvKlbNinl09gBfp8NU1mOr8eUCOET0dbgtF+g3qsC+O2dCZQmcAR+GkMqItVD6MJe/vjQiAWpVoAlI8L5Fn77e3bAPkynwI1H8AOXsZv559ttiRl5JVvsWXU2mkykdORtiLcxRoC9JpuFo/510t0280cS3d2UvsIjbmDktlKEgiXDb635cvsAhP9pNSw6VDZEAbUui+MPrrqPj7w16Gq8lh43wSqxIhQ8tSBXoWY6b5izR97/3S+uC/eiaezORYXwMzc5G6IbegMMT7k4Xbbfs+DBC/5nqORb7aKczO5I5WTlfZjez+xlwEA2V/nj+n9L89w9E8c3cToPsA9MvfV7eNPiZpvcb7n4Z4fubswbjV3GPpgyXXdf9A+OJnHc=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},p=void 0,m={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:"eJytVVFv2zYQ/ivsPTUAYzlp9yIMw4rWKIwGSzBn2ENiDLR4srhQJEtSjg1B/304WpLtJMaKYS+2RH53993dd6cWolgHyB+gsCaKIgZYcpAYCq9cVNZADhI1RmSC9RDgYB16QddzOQIOt054UWNET45bMKJGyGF7KZy6jPYJDXBQ5LlCIdEDB4/fG+VRQh59gxxC3GmyCap2GoEDbp22EiEvhQ4EKCqsBeQtxJ1LyOiVWUNHUJGMcmJpglqbyXa73ULHRyo91b+UHJg4ESt4mfidtxslkdnV31jEuWS2HGrAomX7tP9P9hxK62sRj08O6bjqelVdiyCh65YUNThrAgbycz2d0t8p/8891z1RyUJTFBhC2Wi9e0el+jj9eN7K2MhK2xjZQ396DZ2bjdBKsk93c3ZPjX0HXcchYNF4FXep+8dtzx+WxLzGWNmDcJJiYgU5ZH11s/bQoQ7Iod8Mamq8JuXE6EKeZcK5ydBmLVZhUtg6E05lmyugUAOVBVV8X6oTQmMHhFPfcAf839VKGSpT2mSsYmrNrUOzUGuTKrG5eqWk+0oFpkK6lrZoajQxzQ8rrWcvrNlKBJTMGhYrTJd0/mFyxYLDQpWqSKYT9mgezcLWyJqAZaOZVuYp5I/mkj3clqUqlNDsT1wFFXH5fqjY8/Pzq4pdJJuvKlbNinl09gBfp8NU1mOr8eUCOET0dbgtF+g3qsC+O2dCZQmcAR+GkMqItVD6MJe/vjQiAWpVoAlI8L5Fn77e3bAPkynwI1H8AOXsZv559ttiRl5JVvsWXU2mkykdORtiLcxRoC9JpuFo/510t0280cS3d2UvsIjbmDktlKEgiXDb635cvsAhP9pNSw6VDZEAbUui+MPrrqPj7w16Gq8lh43wSqxIhQ8tSBXoWY6b5izR97/3S+uC/eiaezORYXwMzc5G6IbegMMT7k4Xbbfs+DBC/5nqORb7aKczO5I5WTlfZjez+xlwEA2V/nj+n9L89w9E8c3cToPsA9MvfV7eNPiZpvcb7n4Z4fubswbjV3GPpgyXXdf9A+OJnHc=",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"}},h={},j=[{value:"Request",id:"request",level:2}];function x(e){const t={h2:"h2",p:"p",...(0,a.a)(),...e.components},{Details:s}=t;return s||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)("h1",{className:"openapi__heading",children:(0,c.jsx)(t.p,{children:"Deletes contact"})}),"\n",(0,c.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,c.jsx)(t.p,{children:"delete a contact"}),"\n",(0,c.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,c.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,c.jsx)("summary",{style:{},children:(0,c.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,c.jsx)(t.p,{children:"Path Parameters"})})}),(0,c.jsx)("div",{children:(0,c.jsx)("ul",{children:(0,c.jsx)(n.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,c.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,c.jsx)("summary",{style:{},children:(0,c.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,c.jsx)(t.p,{children:"Header Parameters"})})}),(0,c.jsx)("div",{children:(0,c.jsx)("ul",{children:(0,c.jsx)(n.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,c.jsx)("div",{children:(0,c.jsx)("div",{children:(0,c.jsxs)(d.Z,{children:[(0,c.jsxs)(o.default,{label:"200",value:"200",children:[(0,c.jsx)("div",{children:(0,c.jsx)(t.p,{children:"Contact deleted successfully!"})}),(0,c.jsx)("div",{})]}),(0,c.jsxs)(o.default,{label:"404",value:"404",children:[(0,c.jsx)("div",{children:(0,c.jsx)(t.p,{children:"Contact not found!"})}),(0,c.jsx)("div",{})]}),(0,c.jsxs)(o.default,{label:"405",value:"405",children:[(0,c.jsx)("div",{children:(0,c.jsx)(t.p,{children:"Invalid API Token!"})}),(0,c.jsx)("div",{})]})]})})})]})}function u(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.f6b0b808.js b/assets/js/7b076186.f6b0b808.js deleted file mode 100644 index df2b3ac03..000000000 --- a/assets/js/7b076186.f6b0b808.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>h,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>m,toc:()=>x});var a=s(85893),c=s(11151),d=s(58219),i=(s(62316),s(51039)),l=s.n(i),n=(s(82723),s(9487),s(41429)),o=(s(5397),s(4667),s(9472),s(85162));const r={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVVFv2zgM/isan1ZAjdNu92IcDhu2YAhWXItLD/fQBoNi0bGusqRJctrA8H8fKDtO0jbYcLiXxJY+kh/Jj3QLUawD5HdQWBNFEQMsOUgMhVcuKmsgB4kaIzLBBghwsA69oOu5HAH7Wye8qDGiJ8ctGFEj5PB0Lpw6j/YBDXBQ5LlCIdHD84DAweP3RnmUkEffIIcQt5qcBFU7jcABn5y2EiEvhQ4EKCqsBeQtxK1LyOiVWUPX8ZHBwPCbkjsCTsTqRfgbbzdKIrOrf7GIc8lsuUudRcv6bP9PjhxK62sRD0/wSSQvObjqclVdiiCh65YUNThrAgbyczmd0t8x/08D156oZKEpCgyhbLTevoGOw/vp+9NWxkZW2sbIAfrbS+jcbIRWkn28mbNb6ucbKjMELBqv4jY1XTj17QHpeUmsa4yV3WsliSRWkEM2VDZr993pgJz5zU5AjdcklhhdyLNMODexDk1Qa6PFKkwKW2fCqWxzARRqR2NB1e7LNJIZKy+c+opb4D8XJ2WmTGmTsYqpJdcOzUKtTarA5uKFgm4rFZgK6VraoqnRxDQurLSePbNmKxFQMmtYrDBd0vm7yQULDgtVqiKZTti9uTcLWyNrApaNZlqZh5Dfm3N2d12WqlBCs39wFVTE5dtdtR4fH19U6yzZfFGxalbMo7N7+DodppIeWo0vZ8Ahoq/DdblAv1EFDp05ESpL4Az4bviojFgLpffz+OG5EQlPqwJNQIIPLfr45eaKvZtMgR8I4hcoZ1fzT7M/FzPySpLqW3QxmU6mdORsiLUwB4E+J4mGg3V31N028UYTX1+Ng8AiPsXMaaEMBUmE20Hz464FDvnBTlpyqGyIBGhbEsXfXncdHX9v0KdR4rARXokVqfCuBakCPctxw5wk+vavYVmdsV9db68mshsfQ7OzEbrBfl+n6TpcsN2y47sR+s9UT7Hoox3P7EjmaN18nl3NbmfAQTRU+sP5f0jzPzwQxVdzOw7SB6Zf+qy8avA7Te9X3P4xwvubkwbjR7BHU4bLrut+AL3xlig=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},p=void 0,m={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:"eJytVVFv2zgM/isan1ZAjdNu92IcDhu2YAhWXItLD/fQBoNi0bGusqRJctrA8H8fKDtO0jbYcLiXxJY+kh/Jj3QLUawD5HdQWBNFEQMsOUgMhVcuKmsgB4kaIzLBBghwsA69oOu5HAH7Wye8qDGiJ8ctGFEj5PB0Lpw6j/YBDXBQ5LlCIdHD84DAweP3RnmUkEffIIcQt5qcBFU7jcABn5y2EiEvhQ4EKCqsBeQtxK1LyOiVWUPX8ZHBwPCbkjsCTsTqRfgbbzdKIrOrf7GIc8lsuUudRcv6bP9PjhxK62sRD0/wSSQvObjqclVdiiCh65YUNThrAgbyczmd0t8x/08D156oZKEpCgyhbLTevoGOw/vp+9NWxkZW2sbIAfrbS+jcbIRWkn28mbNb6ucbKjMELBqv4jY1XTj17QHpeUmsa4yV3WsliSRWkEM2VDZr993pgJz5zU5AjdcklhhdyLNMODexDk1Qa6PFKkwKW2fCqWxzARRqR2NB1e7LNJIZKy+c+opb4D8XJ2WmTGmTsYqpJdcOzUKtTarA5uKFgm4rFZgK6VraoqnRxDQurLSePbNmKxFQMmtYrDBd0vm7yQULDgtVqiKZTti9uTcLWyNrApaNZlqZh5Dfm3N2d12WqlBCs39wFVTE5dtdtR4fH19U6yzZfFGxalbMo7N7+DodppIeWo0vZ8Ahoq/DdblAv1EFDp05ESpL4Az4bviojFgLpffz+OG5EQlPqwJNQIIPLfr45eaKvZtMgR8I4hcoZ1fzT7M/FzPySpLqW3QxmU6mdORsiLUwB4E+J4mGg3V31N028UYTX1+Ng8AiPsXMaaEMBUmE20Hz464FDvnBTlpyqGyIBGhbEsXfXncdHX9v0KdR4rARXokVqfCuBakCPctxw5wk+vavYVmdsV9db68mshsfQ7OzEbrBfl+n6TpcsN2y47sR+s9UT7Hoox3P7EjmaN18nl3NbmfAQTRU+sP5f0jzPzwQxVdzOw7SB6Zf+qy8avA7Te9X3P4xwvubkwbjR7BHU4bLrut+AL3xlig=",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"}},h={},x=[{value:"Request",id:"request",level:2}];function j(e){const t={h2:"h2",p:"p",...(0,c.a)(),...e.components},{Details:s}=t;return s||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(t.p,{children:"Deletes contact"})}),"\n",(0,a.jsx)(l(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,a.jsx)(t.p,{children:"delete a contact"}),"\n",(0,a.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(t.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(n.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,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(t.p,{children:"Header Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(n.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(d.Z,{children:[(0,a.jsxs)(o.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(t.p,{children:"Contact deleted successfully!"})}),(0,a.jsx)("div",{})]}),(0,a.jsxs)(o.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(t.p,{children:"Contact not found!"})}),(0,a.jsx)("div",{})]}),(0,a.jsxs)(o.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(t.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{})]})]})})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.135d9700.js b/assets/js/8a725248.135d9700.js new file mode 100644 index 000000000..65db02a5b --- /dev/null +++ b/assets/js/8a725248.135d9700.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:()=>j,contentTitle:()=>g,default:()=>N,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVt9v2zgM/lc0Pq2Am8RJ78U4HNYriqHYsBZLD/eQBoNsM7FaWdIkOT8Q+H8fKDuOk3Tb9fGAokgokiL5ffyiHXi+dJDMINPK88w7mEegDVruhVZ3OSSQWeQe23OIwHDLS/RoKW4HipcICWwuuRGXXr+gggiEggQK5DlaiMDi90pYzCHxtsIInN9KinGiNBIhAtwYqXOEZMGlI4eswJJDsgO/NcHTW6GWUJMrD0EJVamcWKrBZrPZQD1v7kHn/9b5lmJzdJkVhhqBBIzVK5EjS1HqNeuaYF6zpkN2aJE+ofKUhBsjRRamMXx2lGnXK+/Q2QxuSy4kRPCFBhLBQ6EV0jTbFnT6jM38LM3XC3SUIXifNRrBQtuS+77l0PmzpjaQxtFc+vb4FPFDaxhkuqRUTcFvTBWPJ+N4Ek/GMdR1BF74YD7izLeUAKnp/JgJweCMVq6ZxXg0OsfNVVmGzi0qyTpevgWiX4+/MRPP39a3KeK02IyfDU3uf47hVTyJx+EvYLgpQzHtXrcY5ui5kA76GJ+cBICvRlfnEE51ib4QasnWqDxbW62WETMSuUPm7ZbxJReKSe7RvoOQ5Y/zLHdqxaXI2fXDHXsknXkXynWYVVb4bRCjvgolszmJwnGSm9NVp8o0yZzRrlE3X0ACw1PVc2hXe8mrrCR58964ZDjkxgz2WiR56giLITdiuIqDKu0LnBIlG9YdldmBxY34hFuIfi+p1Dcx/etB8G73cO4lpWNYR7DXONNR5miT6baFDqW1YN8bVFOxVGH6qxhO5/pYCMeEC8e5zqoSlQ8byRbaspNolnKHOdOK+QLDIdkng5g5g5lYtMs8YE/qSRF5WOWQBEAK9eKSJ3XJZveLhcgEl+xfTJ3wOH+/x2O9Xp/hcRFiPgpfVCmzaPTBfRmMAbR+VPflAiLwaEt3v5iiXYkMW+x/ctUwOA9biSLyJDvAFoHW9OE0iEYuRYbKYW/3rj8+fGaTwQiiHuX+Q8nDz3c3t1+mt5SVSNtAFA9GgxGZiOklV72LzrbiCNyOoB43fmgkF4rShJJ27cLMTp4J8wgKWqhkBrsdwf2PlXVN5u8VWlrWeQQrbgVPiV+zeR3tyU0blgtHB3n3IjgpqFN/eP+1/Um5YBC9XugLbs+2acVlRZ5QR7vW4abJeflIOQ4eZ78uh4jrLEPjf+k77ynMw/30ESJI2+dJGV48YPmankh8DQk8wRMAvb8oQ1CKYN+B5GpZ8WVY65CXFIBXNPm+fLwE+Wg/0Bz3R2rbq/J4Ek0r9J8aezXgT1rPT7j9q3NvTn4a0L38Gm+CYV7X9Q8zF4p5",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=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:"eJzVVt9v2zgM/lc0Pq2Am8RJ78U4HNYriqHYsBZLD/eQBoNsM7FaWdIkOT8Q+H8fKDuOk3Tb9fGAokgokiL5ffyiHXi+dJDMINPK88w7mEegDVruhVZ3OSSQWeQe23OIwHDLS/RoKW4HipcICWwuuRGXXr+gggiEggQK5DlaiMDi90pYzCHxtsIInN9KinGiNBIhAtwYqXOEZMGlI4eswJJDsgO/NcHTW6GWUJMrD0EJVamcWKrBZrPZQD1v7kHn/9b5lmJzdJkVhhqBBIzVK5EjS1HqNeuaYF6zpkN2aJE+ofKUhBsjRRamMXx2lGnXK+/Q2QxuSy4kRPCFBhLBQ6EV0jTbFnT6jM38LM3XC3SUIXifNRrBQtuS+77l0PmzpjaQxtFc+vb4FPFDaxhkuqRUTcFvTBWPJ+N4Ek/GMdR1BF74YD7izLeUAKnp/JgJweCMVq6ZxXg0OsfNVVmGzi0qyTpevgWiX4+/MRPP39a3KeK02IyfDU3uf47hVTyJx+EvYLgpQzHtXrcY5ui5kA76GJ+cBICvRlfnEE51ib4QasnWqDxbW62WETMSuUPm7ZbxJReKSe7RvoOQ5Y/zLHdqxaXI2fXDHXsknXkXynWYVVb4bRCjvgolszmJwnGSm9NVp8o0yZzRrlE3X0ACw1PVc2hXe8mrrCR58964ZDjkxgz2WiR56giLITdiuIqDKu0LnBIlG9YdldmBxY34hFuIfi+p1Dcx/etB8G73cO4lpWNYR7DXONNR5miT6baFDqW1YN8bVFOxVGH6qxhO5/pYCMeEC8e5zqoSlQ8byRbaspNolnKHOdOK+QLDIdkng5g5g5lYtMs8YE/qSRF5WOWQBEAK9eKSJ3XJZveLhcgEl+xfTJ3wOH+/x2O9Xp/hcRFiPgpfVCmzaPTBfRmMAbR+VPflAiLwaEt3v5iiXYkMW+x/ctUwOA9biSLyJDvAFoHW9OE0iEYuRYbKYW/3rj8+fGaTwQiiHuX+Q8nDz3c3t1+mt5SVSNtAFA9GgxGZiOklV72LzrbiCNyOoB43fmgkF4rShJJ27cLMTp4J8wgKWqhkBrsdwf2PlXVN5u8VWlrWeQQrbgVPiV+zeR3tyU0blgtHB3n3IjgpqFN/eP+1/Um5YBC9XugLbs+2acVlRZ5QR7vW4abJeflIOQ4eZ78uh4jrLEPjf+k77ynMw/30ESJI2+dJGV48YPmankh8DQk8wRMAvb8oQ1CKYN+B5GpZ8WVY65CXFIBXNPm+fLwE+Wg/0Bz3R2rbq/J4Ek0r9J8aezXgT1rPT7j9q3NvTn4a0L38Gm+CYV7X9Q8zF4p5",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"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create contact"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,i.jsx)(a.p,{children:"Create contact"}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.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,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function N(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.98b57710.js b/assets/js/8a725248.98b57710.js deleted file mode 100644 index 5973808f2..000000000 --- a/assets/js/8a725248.98b57710.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var i=a(85893),t=a(11151),n=a(58219),r=(a(62316),a(51039)),l=a.n(r),c=(a(82723),a(9487)),o=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVttu2zgQ/RV2nhpAsS07+yIsFs0GQRG0aII6i31wjIKSxhITimRJyhcY+vdiKFm+pe12sS8LBIE8Nw3nnDniFjwvHCQzyLTyPPMO5hFog5Z7odVdDglkFrnHzg8RGG55hR4t5W1B8QohgfUlN+LS6xdUEIFQkECJPEcLEeToMisMVYQEIAKLX2thMYfE2xojcH4jqYgTlZEIEeDaSJ0jJAsuHQVkJVYcki34jQmR3gpVQNPM22ro/J8631DE8duM1UuRI0tR6hXre2des/ZgbH8yekLlqQg3RoosDGH47KjS9rwJnT5jOxJLI/MCHXk/hYmcthrBQtuK+0MLrnk4cALPmlpEaCK4rbiQ/yI/RXzXGQaZrqjUQ6nVL7cSjyfjeBJPxjE0TQRe+GA+osGXlIbdkP8Yy2BwRivXzmI8Gp1j4uosQ+cWtWQ91f678bdmou6vnduUcVqux8+GJvc/x/AqnsTj8BcwXFehmW5VOwxz9FxIB4cYn3gCwFejq3MIp7pCXwpVsBUqz1ZWqyJiRiJ3yLzdMF5woZjkHu0bCFV+O69yp5ZcipxdP9yxR5KON6Fdh1lthd8EfeFGfHlBep7Tsh8XuDldYepKk2oZ7Vqx8iUkMDwVMYd2uVOw2kpSK++NS4ZDbsxAG1ROFEry1BEOQ27EcBkDNbBrbkp0bBnXt9iDxI34gBuIfq6OdF5i+Oe9iN3uYNxJSc+snlivcaWnytEG09sWOrTWgXxvUE1FocLUl/GZPj+WwjHhgjvXWV2h8mET2UJbdpLNUu4wZ1oxX2Jwkn0yiJkzmIlFt8QD9qSeFJGG1Q5p8aVQLy55Updsdr9YiExwyf7G1AmP87c7LFar1RkWFyHnvfBlnTKLRu/Di2AMgB1m9T8uIAKPtnL3iynapciww/07rxqG4GEnTUScZAvYIdCZ3p0m0cilyFA5PNi56/cPH9lkMILogG7/oOXhx7ub20/TW6pKhG0higejwYhMxPKKq4MXnW3EEbg9QT2u/dBILhSVCS1tu2WZnXzx5xGUtEzJDLZbgvsvK5uGzF9rtGExI1hyK3hK/JrNm2hHbtquXDhy5P23/KShXvXh7efuU3LBCKjXGg1bdrJNSy5rioQm2nYBN23Ny0eqsY84+6rsM66zDI3/Yez8QF0e7qePEEHaXTmqcFcBy1d0ueErSOAJnuimo8M5g0oE+xYkV0XNi7DWoS4pAK9p8ofy8RLko3ugOe5canPQ5fEk2qPQfzrYqwm/03p+wM0ffXjr+W5Cf4lrowmGedM03wBMnXjg",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:"eJzVVttu2zgQ/RV2nhpAsS07+yIsFs0GQRG0aII6i31wjIKSxhITimRJyhcY+vdiKFm+pe12sS8LBIE8Nw3nnDniFjwvHCQzyLTyPPMO5hFog5Z7odVdDglkFrnHzg8RGG55hR4t5W1B8QohgfUlN+LS6xdUEIFQkECJPEcLEeToMisMVYQEIAKLX2thMYfE2xojcH4jqYgTlZEIEeDaSJ0jJAsuHQVkJVYcki34jQmR3gpVQNPM22ro/J8631DE8duM1UuRI0tR6hXre2des/ZgbH8yekLlqQg3RoosDGH47KjS9rwJnT5jOxJLI/MCHXk/hYmcthrBQtuK+0MLrnk4cALPmlpEaCK4rbiQ/yI/RXzXGQaZrqjUQ6nVL7cSjyfjeBJPxjE0TQRe+GA+osGXlIbdkP8Yy2BwRivXzmI8Gp1j4uosQ+cWtWQ91f678bdmou6vnduUcVqux8+GJvc/x/AqnsTj8BcwXFehmW5VOwxz9FxIB4cYn3gCwFejq3MIp7pCXwpVsBUqz1ZWqyJiRiJ3yLzdMF5woZjkHu0bCFV+O69yp5ZcipxdP9yxR5KON6Fdh1lthd8EfeFGfHlBep7Tsh8XuDldYepKk2oZ7Vqx8iUkMDwVMYd2uVOw2kpSK++NS4ZDbsxAG1ROFEry1BEOQ27EcBkDNbBrbkp0bBnXt9iDxI34gBuIfq6OdF5i+Oe9iN3uYNxJSc+snlivcaWnytEG09sWOrTWgXxvUE1FocLUl/GZPj+WwjHhgjvXWV2h8mET2UJbdpLNUu4wZ1oxX2Jwkn0yiJkzmIlFt8QD9qSeFJGG1Q5p8aVQLy55Updsdr9YiExwyf7G1AmP87c7LFar1RkWFyHnvfBlnTKLRu/Di2AMgB1m9T8uIAKPtnL3iynapciww/07rxqG4GEnTUScZAvYIdCZ3p0m0cilyFA5PNi56/cPH9lkMILogG7/oOXhx7ub20/TW6pKhG0higejwYhMxPKKq4MXnW3EEbg9QT2u/dBILhSVCS1tu2WZnXzx5xGUtEzJDLZbgvsvK5uGzF9rtGExI1hyK3hK/JrNm2hHbtquXDhy5P23/KShXvXh7efuU3LBCKjXGg1bdrJNSy5rioQm2nYBN23Ny0eqsY84+6rsM66zDI3/Yez8QF0e7qePEEHaXTmqcFcBy1d0ueErSOAJnuimo8M5g0oE+xYkV0XNi7DWoS4pAK9p8ofy8RLko3ugOe5canPQ5fEk2qPQfzrYqwm/03p+wM0ffXjr+W5Cf4lrowmGedM03wBMnXjg",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},y=[{value:"Request",id:"request",level:2}];function f(e){const 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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create contact"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/createcontact"}),"\n",(0,i.jsx)(s.p,{children:"Create contact"}),"\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)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,i.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,i.jsx)(s.p,{children:"provide below parameter to create contact"})})}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(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:"1232131321"}})]})]})})}),"\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)(c.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:"ph1bhx2jp"}}),(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:"4131231231"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{})]}),(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",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.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/a2bc1463.2d551218.js b/assets/js/a2bc1463.2d551218.js deleted file mode 100644 index 084704e32..000000000 --- a/assets/js/a2bc1463.2d551218.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:()=>y,contentTitle:()=>h,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),c=a.n(n),d=(a(82723),a(9487)),r=a(41429),o=a(5397),m=a(4667),p=a(9472),u=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:"eJytVt9v2zYQ/lfY60sDMJbddC/CMCwrgiBosQRxhj3ExkBLJ/tqimRJyolh6H8fjpJ/xcm6AXuxJfLuePfd9x21gajmAfJHKKyJqogBphJKDIUnF8kayAEkWIde8etNCfnWVFOIIMEpr2qM6DnMBoyqEXJ4PleOzqNdogEJxHEWqEr08Ep4j98b8lhCHn2DEkJcaw4SqHYaQQI+O21LhLxSOrBBscBaQb6BuHbJMnoyc2jbaRcNQ/zNlmu24GzRRH5UzmkqUiHZt8Cnb05D2dk3LFJhnsuOhIF3NdUUD8zIRJyncirraxW7pYuPKVuV8s5Hw1ZCWJL7j37DtpXwXGt26/FksGdcUSshUtTHay07eAzOmtCl+3E45L9jqENTFBhC1Wix6yjI/wuhInXox4VyBcnkpHsSagxBzV/bO0Hk/fsSK9XoeAjJpaP7HoYelU/DT6dA3KOzPgoKwtgo1EqRVjON7yA5/HTqcGNWSlMpLu9uxAOT+l3KKGDReIrrxHzl6K8l8vOUaVhjXFiWi7O9TuICcsiO1RPQr7bSabxmmcToQp5lyrmBdWgCzY1WszAobJ0pR9lqBBx/e/aY29N1YJfBDj3l6AuuQf5YllwOd/x+r56rLR937B8Nt3xmZpOpbDqrB//WoRnT3CSUVqMTpT8sKDDmvF3aoqnRxEQ1UVkvXniLmQpYCmtEXGDa5PWLwUgEhwVVPUsHYmImZmxrFE1AZrYmswz5xJyLx9uqooKUFn/iLFDE6YctuE9PTyfgniWfa4qLZiY8Ors3n6fF1IFDr93LGUiI6OtwW43Rr6jAvpFvHJUl46zXniqS9rBWpPfj9deXTkxOTQUyt/cyuLy++youBkOQB/z5FylnX28+X/0+vuKozMCuRaPBcDDkJSZtrczBQdcYRZ+a6Ml71N6DScszvSdgxOeYOa3IcNSU4aaXwuPRRTKVsGCh5I+w2XDv//C6bXn5e4M+qUrCSnlioSaNyS11WTslBd4od1fEm7l9uO9vmzPxVppJQy+0slK6YUto5aY3+NzFPH/gGHuLkxm697gsCnTxH20PJ8fd7fgBJMz6m6xOAxa8euI7Uz1BDhOYdPczR0gzIK1vQCszb9IkhS4u61s1jPvhcFim4dA/MI7bLbM+yPIYia4U/uXCXnX4mbX6Bde/7My7nTcddt8GnTW3Ydq27d/J2uzw",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/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:"eJytVt9v2zYQ/lfY60sDMJbddC/CMCwrgiBosQRxhj3ExkBLJ/tqimRJyolh6H8fjpJ/xcm6AXuxJfLuePfd9x21gajmAfJHKKyJqogBphJKDIUnF8kayAEkWIde8etNCfnWVFOIIMEpr2qM6DnMBoyqEXJ4PleOzqNdogEJxHEWqEr08Ep4j98b8lhCHn2DEkJcaw4SqHYaQQI+O21LhLxSOrBBscBaQb6BuHbJMnoyc2jbaRcNQ/zNlmu24GzRRH5UzmkqUiHZt8Cnb05D2dk3LFJhnsuOhIF3NdUUD8zIRJyncirraxW7pYuPKVuV8s5Hw1ZCWJL7j37DtpXwXGt26/FksGdcUSshUtTHay07eAzOmtCl+3E45L9jqENTFBhC1Wix6yjI/wuhInXox4VyBcnkpHsSagxBzV/bO0Hk/fsSK9XoeAjJpaP7HoYelU/DT6dA3KOzPgoKwtgo1EqRVjON7yA5/HTqcGNWSlMpLu9uxAOT+l3KKGDReIrrxHzl6K8l8vOUaVhjXFiWi7O9TuICcsiO1RPQr7bSabxmmcToQp5lyrmBdWgCzY1WszAobJ0pR9lqBBx/e/aY29N1YJfBDj3l6AuuQf5YllwOd/x+r56rLR937B8Nt3xmZpOpbDqrB//WoRnT3CSUVqMTpT8sKDDmvF3aoqnRxEQ1UVkvXniLmQpYCmtEXGDa5PWLwUgEhwVVPUsHYmImZmxrFE1AZrYmswz5xJyLx9uqooKUFn/iLFDE6YctuE9PTyfgniWfa4qLZiY8Ors3n6fF1IFDr93LGUiI6OtwW43Rr6jAvpFvHJUl46zXniqS9rBWpPfj9deXTkxOTQUyt/cyuLy++youBkOQB/z5FylnX28+X/0+vuKozMCuRaPBcDDkJSZtrczBQdcYRZ+a6Ml71N6DScszvSdgxOeYOa3IcNSU4aaXwuPRRTKVsGCh5I+w2XDv//C6bXn5e4M+qUrCSnlioSaNyS11WTslBd4od1fEm7l9uO9vmzPxVppJQy+0slK6YUto5aY3+NzFPH/gGHuLkxm697gsCnTxH20PJ8fd7fgBJMz6m6xOAxa8euI7Uz1BDhOYdPczR0gzIK1vQCszb9IkhS4u61s1jPvhcFim4dA/MI7bLbM+yPIYia4U/uXCXnX4mbX6Bde/7My7nTcddt8GnTW3Ydq27d/J2uzw",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:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},y={},f=[{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)(c(),{method:"post",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:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)(d.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)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\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:"successful operation"})}),(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:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(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",{})]})]})})})]})}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/a2bc1463.3b0c9239.js b/assets/js/a2bc1463.3b0c9239.js new file mode 100644 index 000000000..29d2a0fe5 --- /dev/null +++ b/assets/js/a2bc1463.3b0c9239.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>v});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),o=a.n(n),r=(a(82723),a(9487)),c=a(41429),d=a(5397),m=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:"eJydVt9v2zgM/lc0Pq2AGydt78U4HNYbiqLYsBZND/eQ5EG2mViNLGmSnB8I/L8PlO3ESdbtekCQOBRJkfz4kd6B5wsHyQQyrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySDpVKZyHCAy3vESPltzsQPESIYHNJTfi0uslKohAkJ8CeY4WIrD4vRIWc0i8rTAC57eSbJwojUSIADdG6hwhmXPpSCErsOSQ7MBvTdD0VqgF1KTKg1FCMSonFmqw2Ww2UM+ae9D5v3W+JVsKG5WnR26MFFnIKH51lOXu/BKdvmIWMrSUvxfo6FSKUviemlAeFyGvubYl943o+gp6wY2GdQRuKcw77YZ1HcGmlGTWFpaqnlJGdQReeHksq8nAojNauSbcq+GQfo4hdVWWoXPzSrI9tBC9u0LcWr4leD2W7veVa8TUQqdA9mqwlxyQNcUoLTZXr4Zy/hbK8D4HrxpZikjmdyUX8n/Yp4ifWsEg0yW5eiq0encoN6Pr0VX4wDm2LbFy9FxI10f49KQB+mZ4c47tMxptPROOKe0ZX3EheSrxAwSDP84NHtSKS5Gz26cH9kKE/RBCc5hVVvhtYHWfzslkRuwq0ReaxoHR7RzwBSQQH08Hh3bVjYbKShoD3huXxDE3ZtBxVvLUUVljbkS8GgX2dvePqeuaBjqK4tCFRnxBasPfjh5Ki5r5+TAY7jpk9sQeDTuqEmmFmutwVwvEo0E1FgsVqrUawemwfCmEo9rTca6zqkTlA4vYXFt2Ys1S7jBnWjFfYDgk+fVgxJzBTMxbAg7YVE3VWJfIKodEWinU0iVTdckmj/O5yASX7F9MnfA4+9gVeL1enxX4ItjcC19UKbNo9EF9EYQBhb7V/s8FRODRlu5xPka7Ehm2YL5xVRyU43as8CyMFWzo14k+nRpRk0qRoXLY48Xt/dNXdj0YQtTrof8Qcvz14fPdt/EdeaUubCAaDYaDIYmocUuuehfdo2dtaKxt4CN4e0uE1mLbgB43PjaSC0VeQ4S7lg6To2U5i6AgsiQT2O0I+3+srGsSf6/QEtNmEay4FUTYwLOoa13iTy4cHeT7vfhmbB+f2xV7wd4Kc4nbM66suKxIE+po1yp8bnxevpCPg8bZejhY3GYZGv9L3f70eHocv0AEabuky7D3wfI1vSjwNSQwhWnzDkIewhwI8h1IrhYVX4QJHfwSv3lFde8Ph2UYDu0D1bE7UttelMeVaFKhb0rspwZ/Ele/4PavvXpz8qbB/v2n0SYYZnVd/wAGFznC",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:"eJydVt9v2zgM/lc0Pq2AGydt78U4HNYbiqLYsBZND/eQ5EG2mViNLGmSnB8I/L8PlO3ESdbtekCQOBRJkfz4kd6B5wsHyQQyrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySDpVKZyHCAy3vESPltzsQPESIYHNJTfi0uslKohAkJ8CeY4WIrD4vRIWc0i8rTAC57eSbJwojUSIADdG6hwhmXPpSCErsOSQ7MBvTdD0VqgF1KTKg1FCMSonFmqw2Ww2UM+ae9D5v3W+JVsKG5WnR26MFFnIKH51lOXu/BKdvmIWMrSUvxfo6FSKUviemlAeFyGvubYl943o+gp6wY2GdQRuKcw77YZ1HcGmlGTWFpaqnlJGdQReeHksq8nAojNauSbcq+GQfo4hdVWWoXPzSrI9tBC9u0LcWr4leD2W7veVa8TUQqdA9mqwlxyQNcUoLTZXr4Zy/hbK8D4HrxpZikjmdyUX8n/Yp4ifWsEg0yW5eiq0encoN6Pr0VX4wDm2LbFy9FxI10f49KQB+mZ4c47tMxptPROOKe0ZX3EheSrxAwSDP84NHtSKS5Gz26cH9kKE/RBCc5hVVvhtYHWfzslkRuwq0ReaxoHR7RzwBSQQH08Hh3bVjYbKShoD3huXxDE3ZtBxVvLUUVljbkS8GgX2dvePqeuaBjqK4tCFRnxBasPfjh5Ki5r5+TAY7jpk9sQeDTuqEmmFmutwVwvEo0E1FgsVqrUawemwfCmEo9rTca6zqkTlA4vYXFt2Ys1S7jBnWjFfYDgk+fVgxJzBTMxbAg7YVE3VWJfIKodEWinU0iVTdckmj/O5yASX7F9MnfA4+9gVeL1enxX4ItjcC19UKbNo9EF9EYQBhb7V/s8FRODRlu5xPka7Ehm2YL5xVRyU43as8CyMFWzo14k+nRpRk0qRoXLY48Xt/dNXdj0YQtTrof8Qcvz14fPdt/EdeaUubCAaDYaDIYmocUuuehfdo2dtaKxt4CN4e0uE1mLbgB43PjaSC0VeQ4S7lg6To2U5i6AgsiQT2O0I+3+srGsSf6/QEtNmEay4FUTYwLOoa13iTy4cHeT7vfhmbB+f2xV7wd4Kc4nbM66suKxIE+po1yp8bnxevpCPg8bZejhY3GYZGv9L3f70eHocv0AEabuky7D3wfI1vSjwNSQwhWnzDkIewhwI8h1IrhYVX4QJHfwSv3lFde8Ph2UYDu0D1bE7UttelMeVaFKhb0rspwZ/Ele/4PavvXpz8qbB/v2n0SYYZnVd/wAGFznC",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:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},f={},v=[{value:"Request",id:"request",level:2}];function b(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)(o(),{method:"post",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:"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)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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)("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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'[\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n]',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,i.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/a88a3db3.4a41b2fc.js b/assets/js/a88a3db3.4a41b2fc.js deleted file mode 100644 index a498a25c0..000000000 --- a/assets/js/a88a3db3.4a41b2fc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>u,contentTitle:()=>m,default:()=>j,frontMatter:()=>o,metadata:()=>c,toc:()=>h});var s=a(85893),l=a(11151),d=a(58219),i=(a(62316),a(51039)),n=a.n(i),r=(a(82723),a(9487),a(41429)),p=(a(5397),a(4667),a(9472),a(85162));const o={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:"eJytVNtu2zAM/RWBTyugxika7MFPK5agCFYsxdJhD21QKBYdE5UlVaLTBoH/fZBzaZqu2AV7sk0f3g4PuQZWiwj5LTDW3ijGCDMJzmNQTM6ONeSg0SDjzRYAErwKqkbGkDzXYFWNkMPzqfJ0yu4BLUggCzlUqDQGkKAxFoF8Cgk5gISAjw0F1JBzaFBC5JVJQSLV3qQc+OyN0wh5qUxMgKLCWkG+Bl75DsmB7ALaVu4r2PVwT3pXgVdcvck/HgpXCq5Q7DwEV4qFRdRRsBNzFJum9X8plSzjouOhdKFWvDF9HEDbzlL86J2NGJPHoN9Pj6N67VIZ0mI8FLHx3hBqaCUM+oO32EnQGIR1LErXWJ34OUIMu85eWp+vxHgIEmrkyr3Mu5szV5BDtoNm6wOGW5AQMSx3KmiCSRNn9jHPMuV9z3m0kRbWqHnsFa7OlKdseQap6YhFE4hX08TVpnXl6f4BVwe8KU9fcAXy9wpLXZItXedM3M1n4tFOaWHFxfVYLM/eqOCmoigodr+1K5oaLXeiF6UL4shbzFVELZztZJN+Jvt570xEjwWVVHSuPXFn7+zU1SiaiGVjhCH7EPM7eypuJ2VJBSkjfuA8EuPsw46tp6enN2yddD6XxFUzFwG9e4EvOmNH6aHX/uMEJDCGOk7KKYYlFbidzDupsg6cgYTCWVYFJxqxVpQmujV9OnZKCjRUoI2Y4NsRXVxeX4nzXh/kgSD+oOTsavx59HU6SlGTpDYjOuv1e/1k8i5yrexBovdU/GrGeyUxPnPmjSKbonWVrbfyfjl9ICE/PCEzCZWLnCDrdZr/92DaNpkfGwwryG9nEpYqkJonwd2uQVNM73p/Co6qSVyiTfv/4dv2qpyIv7tGv2xoty82LctSmQY3V7Zbp1dnsZ21crc0/1zxe2Vs0r3e0n01aev3J2Y4uhrdjKBtfwJ7Szlq",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,c={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:"eJytVNtu2zAM/RWBTyugxika7MFPK5agCFYsxdJhD21QKBYdE5UlVaLTBoH/fZBzaZqu2AV7sk0f3g4PuQZWiwj5LTDW3ijGCDMJzmNQTM6ONeSg0SDjzRYAErwKqkbGkDzXYFWNkMPzqfJ0yu4BLUggCzlUqDQGkKAxFoF8Cgk5gISAjw0F1JBzaFBC5JVJQSLV3qQc+OyN0wh5qUxMgKLCWkG+Bl75DsmB7ALaVu4r2PVwT3pXgVdcvck/HgpXCq5Q7DwEV4qFRdRRsBNzFJum9X8plSzjouOhdKFWvDF9HEDbzlL86J2NGJPHoN9Pj6N67VIZ0mI8FLHx3hBqaCUM+oO32EnQGIR1LErXWJ34OUIMu85eWp+vxHgIEmrkyr3Mu5szV5BDtoNm6wOGW5AQMSx3KmiCSRNn9jHPMuV9z3m0kRbWqHnsFa7OlKdseQap6YhFE4hX08TVpnXl6f4BVwe8KU9fcAXy9wpLXZItXedM3M1n4tFOaWHFxfVYLM/eqOCmoigodr+1K5oaLXeiF6UL4shbzFVELZztZJN+Jvt570xEjwWVVHSuPXFn7+zU1SiaiGVjhCH7EPM7eypuJ2VJBSkjfuA8EuPsw46tp6enN2yddD6XxFUzFwG9e4EvOmNH6aHX/uMEJDCGOk7KKYYlFbidzDupsg6cgYTCWVYFJxqxVpQmujV9OnZKCjRUoI2Y4NsRXVxeX4nzXh/kgSD+oOTsavx59HU6SlGTpDYjOuv1e/1k8i5yrexBovdU/GrGeyUxPnPmjSKbonWVrbfyfjl9ICE/PCEzCZWLnCDrdZr/92DaNpkfGwwryG9nEpYqkJonwd2uQVNM73p/Co6qSVyiTfv/4dv2qpyIv7tGv2xoty82LctSmQY3V7Zbp1dnsZ21crc0/1zxe2Vs0r3e0n01aev3J2Y4uhrdjKBtfwJ7Szlq",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"}},u={},h=[{value:"Request",id:"request",level:2}];function x(e){const t={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=t;return a||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Delete template by ID"})}),"\n",(0,s.jsx)(n(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(t.p,{children:"Delete template by ID"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(r.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"integer",format:"int64"}}})})})]}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(d.Z,{children:[(0,s.jsxs)(p.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid ID supplied"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(p.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Order not found"})}),(0,s.jsx)("div",{})]})]})})})]})}function j(e={}){const{wrapper:t}={...(0,l.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.9de142ad.js b/assets/js/a88a3db3.9de142ad.js new file mode 100644 index 000000000..7c0697aff --- /dev/null +++ b/assets/js/a88a3db3.9de142ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>h,contentTitle:()=>m,default:()=>y,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var s=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),d=a.n(n),r=(a(82723),a(9487),a(41429)),p=(a(5397),a(4667),a(9472),a(85162));const o={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:"eJytVE1v2zAM/SsCTyugxila7ODTiiUYghXrsHTYoQ0GxaJjobKkSnSaIPB/H+jESZau2Ad2sk3zSXx8j9wAqUWC/B4I62AVYYKZBB8wKjLeTTTkoNEi4d0uASQEFVWNhJGRG3CqRshhda6COSf/iA4kGAc5VKg0RpAQ8akxETXkFBuUkGhtGZNMHSwfiatgvUbIS2UTJxQV1gryDdA6dJkUjVtAy6mqA+Vcpktm4Qar1WoFrdyX0pP5bnRfSlBUgQSNqYgmMDfIYTISvhRUoegRgipFwiHqJMiLOYote/1fSBhHuOgaUvpYK9qG3l5B2874/BS8S5gYcTUc8uOkXrdU1mgxGYnUhGANau7I1fDqZe5t1BiF8yRK3zgNbXvKftQxO1Cfr8VkBBJqpMofhO8EpwpyyPrUbHPU4RYkJIzL3g5NtCw9UUh5lqkQBr1OVs3ToPB1poLJlhfApBMWTTS0nnKvttSPjXTonQrmI65B/t5uzNS40ndgQ51GtwHd1CycuP48EcuLF064q0wSJnW/tS+aGh11EyBKH8UJWsxVQi2866zDPzl+ObgQKWBhSlN00IF4cA9u6msUTcKyscIa95jyB3cu7m/L0hRGWfEN58kQzt70HXt+fn7RsbMO88FQ1cxFxOAP6Ysu2LX1GLX/OAMJhLFOt+UU49IUuFPnlauyLjkDCYV3pAriNmKtDKu6C707BbELrSnQJeT0nUTXHz7fiMvBEOSRKf6g5Oxm8n78aTrmU9lWW4kuBsPBkEPBJ6qVO7roNSf/pPHeSYQryoJVxvFpXWWbncUPexAk5MdrZCah8ok4ZbNh/b9G27YcfmowriG/n0lYqmjUnA13vwFtEr/r/To4qYZ7iY53wJsvu81yJv5uI/2SUD8vjodlqWzDXyDhEdcnq7GdtbIfmn+u+LUyttf9PKX7anjy92tmNL4Z342hbX8AD6I+bg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,c={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:"eJytVE1v2zAM/SsCTyugxila7ODTiiUYghXrsHTYoQ0GxaJjobKkSnSaIPB/H+jESZau2Ad2sk3zSXx8j9wAqUWC/B4I62AVYYKZBB8wKjLeTTTkoNEi4d0uASQEFVWNhJGRG3CqRshhda6COSf/iA4kGAc5VKg0RpAQ8akxETXkFBuUkGhtGZNMHSwfiatgvUbIS2UTJxQV1gryDdA6dJkUjVtAy6mqA+Vcpktm4Qar1WoFrdyX0pP5bnRfSlBUgQSNqYgmMDfIYTISvhRUoegRgipFwiHqJMiLOYote/1fSBhHuOgaUvpYK9qG3l5B2874/BS8S5gYcTUc8uOkXrdU1mgxGYnUhGANau7I1fDqZe5t1BiF8yRK3zgNbXvKftQxO1Cfr8VkBBJqpMofhO8EpwpyyPrUbHPU4RYkJIzL3g5NtCw9UUh5lqkQBr1OVs3ToPB1poLJlhfApBMWTTS0nnKvttSPjXTonQrmI65B/t5uzNS40ndgQ51GtwHd1CycuP48EcuLF064q0wSJnW/tS+aGh11EyBKH8UJWsxVQi2866zDPzl+ObgQKWBhSlN00IF4cA9u6msUTcKyscIa95jyB3cu7m/L0hRGWfEN58kQzt70HXt+fn7RsbMO88FQ1cxFxOAP6Ysu2LX1GLX/OAMJhLFOt+UU49IUuFPnlauyLjkDCYV3pAriNmKtDKu6C707BbELrSnQJeT0nUTXHz7fiMvBEOSRKf6g5Oxm8n78aTrmU9lWW4kuBsPBkEPBJ6qVO7roNSf/pPHeSYQryoJVxvFpXWWbncUPexAk5MdrZCah8ok4ZbNh/b9G27YcfmowriG/n0lYqmjUnA13vwFtEr/r/To4qYZ7iY53wJsvu81yJv5uI/2SUD8vjodlqWzDXyDhEdcnq7GdtbIfmn+u+LUyttf9PKX7anjy92tmNL4Z342hbX8AD6I+bg==",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"}},h={},u=[{value:"Request",id:"request",level:2}];function x(e){const t={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=t;return a||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Delete template by ID"})}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(t.p,{children:"Delete template by ID"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(r.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"integer",format:"int64"}}})})})]}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(p.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid ID supplied"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(p.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Order not found"})}),(0,s.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:t}={...(0,l.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.a7aeac43.js b/assets/js/bbdfc22d.a7aeac43.js new file mode 100644 index 000000000..2a1fbb85d --- /dev/null +++ b/assets/js/bbdfc22d.a7aeac43.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:()=>q,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>j});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),c=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktTIzcQ/iva3stCCdvsJpc5LSEURYUCCkPlYHyQZ9oegUYSksaPuPzfU615eGxDAlU5hgse9bvV39daQxAzD8kIAhZWiYAexhwy9KmTNkijIYGHHNlDLWbnDgWds7O7KyaUMgvPSo/Os2BYSkJkaemDKeRfYqKQtY45W+QyzZlHN0cmPJuoEq2TOng2NY7NUKMTQeoZy0xaFkiChQw5sw4znEqNGfPBlWkoHfoee7RGM1+mKXo/LVUbqUpDGs1ZyDEm6jCUTnsmWKnla4ns+LjRvsqOj1nIRWCp0GyCVE1GxdT5YCebiSCZ0dGvt5jKqSTl2lUPOBgbizD6KoMEqoY0cuBghRMFBnTU9DVoUSAksDwRVp4E84IaOEhqeo4iQwccHL6W0mEGSXAlcvBhpcjGy8IqcolLq0yGkEyF8qSQ5lgISNYQVjZqBif1DDakKqJRQmlqL2e6t1wul7AZV3HQh99MtiLb1OiAOtBPYa2SaSyq/+xpJNaHQczkGdNAFTpqQZDoSXoTC9xPhcPUuEKE7sk2Nx9/tF2lxG9M+LSbO4XCI3M4l7hgQmeMCmYhl769UvL9e3fYPxeinbguYDYcHu+vP+sqD8H6pN9fmdLJQsywl5qCfFHScVxaf8I5seoaj+DZ4M9ZIaSKVhyeTa47B2MOy0KRi3rgGqccFk5Y20zXhoMMWPi3kt+mSsHqrzrc2843HIIMaudoQ11QGTqCx+c6tHz2E3F6KZZ30c1uzD2gdULvSzZk7NBbo301o98HA/q3R3o7ZELM0xKNWn0B/l8BJI3QbbWkDjiLuG9bIXX48T1WFFXegHWB3ovZW7KDPn39muFUlCoctqip+L7uTd2qXwa/HnbnSs+Fklnk1geirS8xVoEhN8R71vhYqgg5JNA/oMG4A2oOLJ3qzL+wtteQkxITTxPWF1b256eRpjympZNhNaT+Vi3ssmcHJVb+gQSTf+VYypyu7X7LgBfN1DUMdkBKDSd9jGb2WOZt4qh54x0q6DDBR/C+RdkOcKjyqYltqi//1qIeUsZ0l/NTONz+0jPpo7ipp3oB0NLes97dkCSk8x+902ZbVijpsSf9pIemiNuWdreS+sUnT/qEjW6nU5lKodifOPEy4Phb05DFYnEwG0fR5lKGvJwwh9Zs1WfxMA5Q16r9OAIOAV3hb6dDdHOZNjz8Tqh+VO7X2BdpxD5S0wlD1dHPfSNquZIpEqC2MDy7vLtmP3oD4J3x/0DK/eur84ub4QV5JQBVV3TaG/QGdESwK4TuBDqvXmSdsc12111LY/8/8z7zzKtJJuAy9K0SMq79eJXrmvVG+5tnzCEnWkxGsF5TiEenNhs6fi3RrSAZjTnMhZPUT/ra8IahiCYz6UmQte+8dy/y2339ZDxi72X6gqsDSpwLVZImbPi6VjivfJ48kI+txsG+21qcpSna8I+6486euLsdPgCHSf3oLOIyBCcW9PAVC0jgCZ4gPqvJQ6T7eL4GJfSsjFsPKr/09zcfiHb0",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktTIzcQ/iva3stCCdvsJpc5LSEURYUCCkPlYHyQZ9oegUYSksaPuPzfU615eGxDAlU5hgse9bvV39daQxAzD8kIAhZWiYAexhwy9KmTNkijIYGHHNlDLWbnDgWds7O7KyaUMgvPSo/Os2BYSkJkaemDKeRfYqKQtY45W+QyzZlHN0cmPJuoEq2TOng2NY7NUKMTQeoZy0xaFkiChQw5sw4znEqNGfPBlWkoHfoee7RGM1+mKXo/LVUbqUpDGs1ZyDEm6jCUTnsmWKnla4ns+LjRvsqOj1nIRWCp0GyCVE1GxdT5YCebiSCZ0dGvt5jKqSTl2lUPOBgbizD6KoMEqoY0cuBghRMFBnTU9DVoUSAksDwRVp4E84IaOEhqeo4iQwccHL6W0mEGSXAlcvBhpcjGy8IqcolLq0yGkEyF8qSQ5lgISNYQVjZqBif1DDakKqJRQmlqL2e6t1wul7AZV3HQh99MtiLb1OiAOtBPYa2SaSyq/+xpJNaHQczkGdNAFTpqQZDoSXoTC9xPhcPUuEKE7sk2Nx9/tF2lxG9M+LSbO4XCI3M4l7hgQmeMCmYhl769UvL9e3fYPxeinbguYDYcHu+vP+sqD8H6pN9fmdLJQsywl5qCfFHScVxaf8I5seoaj+DZ4M9ZIaSKVhyeTa47B2MOy0KRi3rgGqccFk5Y20zXhoMMWPi3kt+mSsHqrzrc2843HIIMaudoQ11QGTqCx+c6tHz2E3F6KZZ30c1uzD2gdULvSzZk7NBbo301o98HA/q3R3o7ZELM0xKNWn0B/l8BJI3QbbWkDjiLuG9bIXX48T1WFFXegHWB3ovZW7KDPn39muFUlCoctqip+L7uTd2qXwa/HnbnSs+Fklnk1geirS8xVoEhN8R71vhYqgg5JNA/oMG4A2oOLJ3qzL+wtteQkxITTxPWF1b256eRpjympZNhNaT+Vi3ssmcHJVb+gQSTf+VYypyu7X7LgBfN1DUMdkBKDSd9jGb2WOZt4qh54x0q6DDBR/C+RdkOcKjyqYltqi//1qIeUsZ0l/NTONz+0jPpo7ipp3oB0NLes97dkCSk8x+902ZbVijpsSf9pIemiNuWdreS+sUnT/qEjW6nU5lKodifOPEy4Phb05DFYnEwG0fR5lKGvJwwh9Zs1WfxMA5Q16r9OAIOAV3hb6dDdHOZNjz8Tqh+VO7X2BdpxD5S0wlD1dHPfSNquZIpEqC2MDy7vLtmP3oD4J3x/0DK/eur84ub4QV5JQBVV3TaG/QGdESwK4TuBDqvXmSdsc12111LY/8/8z7zzKtJJuAy9K0SMq79eJXrmvVG+5tnzCEnWkxGsF5TiEenNhs6fi3RrSAZjTnMhZPUT/ra8IahiCYz6UmQte+8dy/y2339ZDxi72X6gqsDSpwLVZImbPi6VjivfJ48kI+txsG+21qcpSna8I+6486euLsdPgCHSf3oLOIyBCcW9PAVC0jgCZ4gPqvJQ6T7eL4GJfSsjFsPKr/09zcfiHb0",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",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},q={},j=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(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)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.bc1aba88.js b/assets/js/bbdfc22d.bc1aba88.js deleted file mode 100644 index eda4bb2db..000000000 --- a/assets/js/bbdfc22d.bc1aba88.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>g,default:()=>T,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var t=s(85893),i=s(11151),r=s(58219),n=(s(62316),s(51039)),l=s.n(n),c=(s(82723),s(9487)),m=s(41429),o=s(5397),p=s(4667),d=s(9472),u=s(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/iuemsuATBKG3UufhmURQosAkaA9hGjldFfSBrdtbHceE/V/X5XTnXQS2AVpj8uFdFX5q4ervvIKgph6SIYQsLBKBPQw4pChT520QRoNCQxyZINazS4cCpKz8/trJpQyc89Kj86zYFhKSmRp6YMp5E8xVsg2wJzNc5nmzKObIROejVWJ1kkdPJsYx6ao0Ykg9ZRlJi0LJMVchpxZhxlOpMaM+eDKNJQOfYc9WqOZL9MUvZ+UauNpHYY0mrOQYwzUYSid9kywUsvXEtnxcWN9nR0fs5CLwFKh2Rgpm4ySqePBVjRjQTqjI663mMqJJOMaqgMcjI1JGH2dQQLrgjR64GCFEwUGdFT0FWhRICSwOBFWngTzgho4SCp6jiJDB/t3ARwcvpbSYQZJcCVy8GGpCMTLwirygQurTIaQTITyZJDmWAhIVhCWNloGJ/UUqmq0RkMffjPZkixSowPqQD+FtUqmMZfusyfvq0MoM37GNFBijjIPEj1pb2Ne+w45TIwrRGhLcCFi2An4+GNTTKg43JrwaZh7hcIjcziTOGdCZ8zLKd2Y9JubJOzf23X9nItNo7XvpuLw+HDzWag8BOuTbndpSicLMcVOagrCoqBjl2zwhHNi2T48hGeDP6aFkCqe4vBsct0SjDgsCkUQdZ81oBzmTljb9FDFQQYs/FvBb0MlZ/VX7e5t8IpDkEHtiCqqgsrQ0VR8rkKLZz8Wp1dicR9hdn3uzVfL9b6mosMOvTXar3v0e69H//a4bodDiHA2/KKWX4D/VwOSxgHdWEkdcBrHfVMKqcPZ95hRNDkYXg4Fei+mb+kO6vT1a4YTUapwWKIm44e6NnWpfun9elidaz0TSmaRUgfEVl+irwJDbojurPExVRFySKB7wH6R+mvqK51q9b+wtmMsauoYJcaeOqwrrOzOToFoymNaOhmWfarvuoTCyr9ecNmeECv/QBqRf6VVipqu7GHLfpdNxzXsdUBIDR99jGL2GOZt0qg54x0aaLHAR2Z9O2E7Q0OZT0wsU33xdxZ1nyKme5ydHiyZASUifVQ3+ayXPu3pvdO7S5GUJD/rnDYLcj0hHfakn3TfFHHB0rpWUr/45EmfsOHdZCJTKRT7E8deBhx9awoyn88P+uIonrmSIS/HzKE1W/NpFMbmaZ/afBwBh4Cu8HeTPrqZTBsOfsdVNxp367kXaZx7pKLT/KxFP/YPUcmVTJGGaTuC51f3N+ys0wPeav0PhNy9ub64vO1fEioNz/qKTju9To9ENHKF0C1HF+tHWKtts91Vt6Gw/192n3nZ1SQTcBG6VgkZV368ylXNeMP9rTPikBMlJkNYrcjFo1NVReLXEt0SkuGIw0w4SfWkr4o3DEUUmUlPimzzknv3Ir891I/CI/ZepJEq9yhxJlRJllDxVW1wscY8GRDG1uJg121PnKcp2vCPtqPWjri/6w+Aw7h+cBZxEYITc3raijkk8ARPEF/ShBCpPspXoISelnHjwRqX/v4GK/dx8A==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={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/iuemsuATBKG3UufhmURQosAkaA9hGjldFfSBrdtbHceE/V/X5XTnXQS2AVpj8uFdFX5q4ervvIKgph6SIYQsLBKBPQw4pChT520QRoNCQxyZINazS4cCpKz8/trJpQyc89Kj86zYFhKSmRp6YMp5E8xVsg2wJzNc5nmzKObIROejVWJ1kkdPJsYx6ao0Ykg9ZRlJi0LJMVchpxZhxlOpMaM+eDKNJQOfYc9WqOZL9MUvZ+UauNpHYY0mrOQYwzUYSid9kywUsvXEtnxcWN9nR0fs5CLwFKh2Rgpm4ySqePBVjRjQTqjI663mMqJJOMaqgMcjI1JGH2dQQLrgjR64GCFEwUGdFT0FWhRICSwOBFWngTzgho4SCp6jiJDB/t3ARwcvpbSYQZJcCVy8GGpCMTLwirygQurTIaQTITyZJDmWAhIVhCWNloGJ/UUqmq0RkMffjPZkixSowPqQD+FtUqmMZfusyfvq0MoM37GNFBijjIPEj1pb2Ne+w45TIwrRGhLcCFi2An4+GNTTKg43JrwaZh7hcIjcziTOGdCZ8zLKd2Y9JubJOzf23X9nItNo7XvpuLw+HDzWag8BOuTbndpSicLMcVOagrCoqBjl2zwhHNi2T48hGeDP6aFkCqe4vBsct0SjDgsCkUQdZ81oBzmTljb9FDFQQYs/FvBb0MlZ/VX7e5t8IpDkEHtiCqqgsrQ0VR8rkKLZz8Wp1dicR9hdn3uzVfL9b6mosMOvTXar3v0e69H//a4bodDiHA2/KKWX4D/VwOSxgHdWEkdcBrHfVMKqcPZ95hRNDkYXg4Fei+mb+kO6vT1a4YTUapwWKIm44e6NnWpfun9elidaz0TSmaRUgfEVl+irwJDbojurPExVRFySKB7wH6R+mvqK51q9b+wtmMsauoYJcaeOqwrrOzOToFoymNaOhmWfarvuoTCyr9ecNmeECv/QBqRf6VVipqu7GHLfpdNxzXsdUBIDR99jGL2GOZt0qg54x0aaLHAR2Z9O2E7Q0OZT0wsU33xdxZ1nyKme5ydHiyZASUifVQ3+ayXPu3pvdO7S5GUJD/rnDYLcj0hHfakn3TfFHHB0rpWUr/45EmfsOHdZCJTKRT7E8deBhx9awoyn88P+uIonrmSIS/HzKE1W/NpFMbmaZ/afBwBh4Cu8HeTPrqZTBsOfsdVNxp367kXaZx7pKLT/KxFP/YPUcmVTJGGaTuC51f3N+ys0wPeav0PhNy9ub64vO1fEioNz/qKTju9To9ENHKF0C1HF+tHWKtts91Vt6Gw/192n3nZ1SQTcBG6VgkZV368ylXNeMP9rTPikBMlJkNYrcjFo1NVReLXEt0SkuGIw0w4SfWkr4o3DEUUmUlPimzzknv3Ir891I/CI/ZepJEq9yhxJlRJllDxVW1wscY8GRDG1uJg121PnKcp2vCPtqPWjri/6w+Aw7h+cBZxEYITc3raijkk8ARPEF/ShBCpPspXoISelnHjwRqX/v4GK/dx8A==",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",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},j={},f=[{value:"Request",id:"request",level:2}];function w(e){const a={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create template"})}),"\n",(0,t.jsx)(l(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(a.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(a.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.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)(a.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)(r.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.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)(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:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function T(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(w,{...e})}):w(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.4d359ed0.js b/assets/js/f0ff4a36.4d359ed0.js new file mode 100644 index 000000000..8cda0f7e8 --- /dev/null +++ b/assets/js/f0ff4a36.4d359ed0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>g,toc:()=>f});var i=a(85893),n=a(11151),t=a(58219),c=(a(62316),a(51039)),r=a.n(c),l=(a(82723),a(9487)),o=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+2YifpPMwfbPN4d3x4Lw+vAMfnFoJbiFWUZyidhakHMdrICO2EkhDABTrGWasAHiiNhtPmOIYA5ug6e5obnqFDQ14LkDxDCGB5yLU4dOoRJXggyGuCPEYDHhj8nguDMQTO5OiBdauUbKzIdIrgAS51qmKEYMZTSwpRghmHoAC30pWmM0LOoSRVXhkFhFFaMZe95XK5hNJbQ2mx3ou4haK5S2D71ip8wMiNY6ZmLFLS8cj9n2A9mCmTcdeVbNDrPwZhEg0THUJZTulYq5W0aMnR0Pfp5zlcm0cRWjvLU7ZOD3hAyCkxQQFc61RE1Ub/wZJRsYuOG8NXFBeHme3I62hQfg25d6KG0gZp3/v9fiEeh6Mw+XZJWftaZWY/D5cK2W+IZH6ecZHua/+gMET82Ah6kcrI1XWi5N5Qjo5PPvw0Gg6GI3JxqcIb4dK9vcS4IPNPKtNcrva1bsu9cpFbpzI0VOEvuNkYRR3F0oNJHq4ryr5i/BYGu21PqcWluw9Fmgo5v4+5wx/X1P19vf8W8jPyVHogrHpbcegPR4cD/9D/cDM4CY5+Do5Per7v/w1l6cEyq8qmJYbGp6uz16x31HKLpqtWr+njwZF/tNuZZw3hMKkcm6lcxu+g0j3e1R3LBU9FzE6vx+yG2PJdhcBilBvhVhWldrk0uJ0SPWToEtVwccXBLoEA+i3V9YsO6ZVA/syiZejcpMTGzmkb9Ptc615bSykPLTVGn2vRXwyATmqRTIg46nw9w7MhEi0+IzHJD18AuqCQszqRTVCvNMqJmMsqEIvBDjnfJMIyYavt9m4Vs7GZMmzLmoXcYsyUZC7BapPko96AWY2RmDWk2GN38k5OVIYst0hEmgr5aIM7echur2YzEQmesr8wtMLh9H0bsaenp52IHVQ2F8IlecgMarVRn1fCKqxdq/XiADxwaDJ7NZugWYgIm+y8clS/Uu43VE+PVFAA1ozYij5uG1H9pSJCabFT2acX11/YqOeD1ymKfwG5/2X86fzr5Jy8UlnVKRr0/J5PIq2sy7jsHEQDRZs1Fq7Y+Gw7wcXm4dodP5oKc7h0fZ1yUZFehbhoSn8zzoAHQffFn3qQKOtIpSioLr6ZtCxJ/D1HQw029WDBjeAhFeJtAbGw9D9ev+ivAn3/ZzMcHLCXh4cXgbf9IqlZFjzNaQUePOJqa1opp6XXNs1/RvYajPq45126RkPjU61wGkWoXWdvZ6p4xkcX5zfgAc8pKV1qeKyooflDd3kxCs/R1ADom+C8aPALNfZnXP26Vq93XjVYD6G1NoViWpblP/6owF8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={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:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+2YifpPMwfbPN4d3x4Lw+vAMfnFoJbiFWUZyidhakHMdrICO2EkhDABTrGWasAHiiNhtPmOIYA5ug6e5obnqFDQ14LkDxDCGB5yLU4dOoRJXggyGuCPEYDHhj8nguDMQTO5OiBdauUbKzIdIrgAS51qmKEYMZTSwpRghmHoAC30pWmM0LOoSRVXhkFhFFaMZe95XK5hNJbQ2mx3ou4haK5S2D71ip8wMiNY6ZmLFLS8cj9n2A9mCmTcdeVbNDrPwZhEg0THUJZTulYq5W0aMnR0Pfp5zlcm0cRWjvLU7ZOD3hAyCkxQQFc61RE1Ub/wZJRsYuOG8NXFBeHme3I62hQfg25d6KG0gZp3/v9fiEeh6Mw+XZJWftaZWY/D5cK2W+IZH6ecZHua/+gMET82Ah6kcrI1XWi5N5Qjo5PPvw0Gg6GI3JxqcIb4dK9vcS4IPNPKtNcrva1bsu9cpFbpzI0VOEvuNkYRR3F0oNJHq4ryr5i/BYGu21PqcWluw9Fmgo5v4+5wx/X1P19vf8W8jPyVHogrHpbcegPR4cD/9D/cDM4CY5+Do5Per7v/w1l6cEyq8qmJYbGp6uz16x31HKLpqtWr+njwZF/tNuZZw3hMKkcm6lcxu+g0j3e1R3LBU9FzE6vx+yG2PJdhcBilBvhVhWldrk0uJ0SPWToEtVwccXBLoEA+i3V9YsO6ZVA/syiZejcpMTGzmkb9Ptc615bSykPLTVGn2vRXwyATmqRTIg46nw9w7MhEi0+IzHJD18AuqCQszqRTVCvNMqJmMsqEIvBDjnfJMIyYavt9m4Vs7GZMmzLmoXcYsyUZC7BapPko96AWY2RmDWk2GN38k5OVIYst0hEmgr5aIM7echur2YzEQmesr8wtMLh9H0bsaenp52IHVQ2F8IlecgMarVRn1fCKqxdq/XiADxwaDJ7NZugWYgIm+y8clS/Uu43VE+PVFAA1ozYij5uG1H9pSJCabFT2acX11/YqOeD1ymKfwG5/2X86fzr5Jy8UlnVKRr0/J5PIq2sy7jsHEQDRZs1Fq7Y+Gw7wcXm4dodP5oKc7h0fZ1yUZFehbhoSn8zzoAHQffFn3qQKOtIpSioLr6ZtCxJ/D1HQw029WDBjeAhFeJtAbGw9D9ev+ivAn3/ZzMcHLCXh4cXgbf9IqlZFjzNaQUePOJqa1opp6XXNs1/RvYajPq45126RkPjU61wGkWoXWdvZ6p4xkcX5zfgAc8pKV1qeKyooflDd3kxCs/R1ADom+C8aPALNfZnXP26Vq93XjVYD6G1NoViWpblP/6owF8=",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:"Get document list",permalink:"/docs/API-docs/getdocumentlist"}},j={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(s.p,{children:"Get a document"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(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,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)(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,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.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)(l.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'[\n {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{})]}),(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",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.64664fbd.js b/assets/js/f0ff4a36.64664fbd.js deleted file mode 100644 index af6ed6877..000000000 --- a/assets/js/f0ff4a36.64664fbd.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:()=>x,default:()=>f,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var i=a(85893),n=a(11151),t=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),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1v2zYQ/ivsfWoAxS9ttg/CMCxogsxosQRLin1IjIKWzhIbiWTJk2ND0H8fjpJsOUqwouuXRCbv5eFzdw9ZA8nMQ3wPqUmqEjV5WEaQok+csqSMhhiukIQUvQFEYCw6yZuLFGLIkAZ7VjpZIqHjqDVoWSLEsD2VVp2SeUQNESiOmqNM0cHzZBCBw2+VcphCTK7CCDztCg7iVWkLhAhwawuTIsRrWXg2SHIsJcQ10M4GS3JKZ9A00R5BD/GLSnsEVlI+ym9WXzGhRSrMWiRGk0zoZ0KKYG1cKWm4glsZosRg/5yv8uRdblfQNEtO663RHj0Hejeb8b9juL5KEvR+XRViXxWIgJFzPeIapLWFSsLG9Ktnp3qMTjond8wLYRmSHQ583zIYgc0Nmc+uCB3S+bVs8abj9KRaqCodxFaaMAuV3h9dafr1bHjy+ayJukqNGTvwk5osUwhNBIkkzIzbDex/GpbvgnJhMs8NBtuyYMuuzfa4mghIUTD9MFg7kDgmv4v05KS1fas1g5o8B3OcuY8MDaNqx/pHU/wvKl+lb8wWyWxI1J1sjTxJql488nHzWyTR2gqlBeUoPBkXxlFXJbeu3EhVyFUYUYs6baN4U6SwHMOxSEM4N/yzCXSezc7Gs3fRSYrQhsTaVDp9A8H2l7HtQm9koVJxfrMQdyyDb9qTYlI5RbugldKqL4/I30se/hIpN53ABmGlHGKY9kI2rQeS1vCp0G162a1cwRJLZH08nUprJ8ai9irThVz5SWLKqbRqupkDZ+pR3LIstKXeYzm0kFUfkXvoPyWdD6b02gTnjstri/pWZToQsJmPSnmXKy+UD9v9uYJmibVx4pm3WEmPqTBtzXmT199P5sJbTNS6k7uJeNAP+taUKCqPLJGF0o8+ftCn4v56vVaJkoX4B1deES7f9mw9PT2N2DoJPleK8molHFpzMM/CYqB06LX/cQIRELrSX69v0W1Ugl1lXkk1DcbTTsT5+olrwFIqrmi39MdzJ+67QiWoPQ76+fzq5pN4P5lBNGiI74A8/bT4cPnX7SVH5ZZqSzSfzCazoGHGUyn1IBG/EPqqidVOLC6eF7g+XEnj90TXYYRbmtpCKs1ZAuK6a/vD+wQiiId3+TKC3Hhik7rmvvjsiqbh5W8VujBMEWykU0EFeDZS5fk73d/VrwJ9+3d3C56Il58FLwLv50XzsGxkUWH7rAnjdPQOaZZN1A/NDyN7DUab7nhK92j4YdQanCcJWhrsjd4LR1p0dXkHEciKizKUhscgDd0Hn+VFFo7RtAD4L8N50eE3HuyPuPt9b97uvOqwf1W21kzFsmmafwFJUbH5",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:"eJytVm1v2zYQ/ivsfWoAxS9ttg/CMCxogsxosQRLin1IjIKWzhIbiWTJk2ND0H8fjpJsOUqwouuXRCbv5eFzdw9ZA8nMQ3wPqUmqEjV5WEaQok+csqSMhhiukIQUvQFEYCw6yZuLFGLIkAZ7VjpZIqHjqDVoWSLEsD2VVp2SeUQNESiOmqNM0cHzZBCBw2+VcphCTK7CCDztCg7iVWkLhAhwawuTIsRrWXg2SHIsJcQ10M4GS3JKZ9A00R5BD/GLSnsEVlI+ym9WXzGhRSrMWiRGk0zoZ0KKYG1cKWm4glsZosRg/5yv8uRdblfQNEtO663RHj0Hejeb8b9juL5KEvR+XRViXxWIgJFzPeIapLWFSsLG9Ktnp3qMTjond8wLYRmSHQ583zIYgc0Nmc+uCB3S+bVs8abj9KRaqCodxFaaMAuV3h9dafr1bHjy+ayJukqNGTvwk5osUwhNBIkkzIzbDex/GpbvgnJhMs8NBtuyYMuuzfa4mghIUTD9MFg7kDgmv4v05KS1fas1g5o8B3OcuY8MDaNqx/pHU/wvKl+lb8wWyWxI1J1sjTxJql488nHzWyTR2gqlBeUoPBkXxlFXJbeu3EhVyFUYUYs6baN4U6SwHMOxSEM4N/yzCXSezc7Gs3fRSYrQhsTaVDp9A8H2l7HtQm9koVJxfrMQdyyDb9qTYlI5RbugldKqL4/I30se/hIpN53ABmGlHGKY9kI2rQeS1vCp0G162a1cwRJLZH08nUprJ8ai9irThVz5SWLKqbRqupkDZ+pR3LIstKXeYzm0kFUfkXvoPyWdD6b02gTnjstri/pWZToQsJmPSnmXKy+UD9v9uYJmibVx4pm3WEmPqTBtzXmT199P5sJbTNS6k7uJeNAP+taUKCqPLJGF0o8+ftCn4v56vVaJkoX4B1deES7f9mw9PT2N2DoJPleK8molHFpzMM/CYqB06LX/cQIRELrSX69v0W1Ugl1lXkk1DcbTTsT5+olrwFIqrmi39MdzJ+67QiWoPQ76+fzq5pN4P5lBNGiI74A8/bT4cPnX7SVH5ZZqSzSfzCazoGHGUyn1IBG/EPqqidVOLC6eF7g+XEnj90TXYYRbmtpCKs1ZAuK6a/vD+wQiiId3+TKC3Hhik7rmvvjsiqbh5W8VujBMEWykU0EFeDZS5fk73d/VrwJ9+3d3C56Il58FLwLv50XzsGxkUWH7rAnjdPQOaZZN1A/NDyN7DUab7nhK92j4YdQanCcJWhrsjd4LR1p0dXkHEciKizKUhscgDd0Hn+VFFo7RtAD4L8N50eE3HuyPuPt9b97uvOqwf1W21kzFsmmafwFJUbH5",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:"Get document list",permalink:"/docs/API-docs/getdocumentlist"}},g={},y=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(s.p,{children:"Get a document"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:10}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"doggie"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"category"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"category"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Dogs"}})]})]})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"photoUrls",required:!0,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",xml:{wrapped:!0},items:{type:"string",xml:{name:"photoUrl"}}}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"tags"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"tag[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"id",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"status",required:!1,schemaName:"string",qualifierMessage:"**Possible values:** [`available`, `pending`, `sold`]",schema:{type:"string",description:"pet status in the store",enum:["available","pending","sold"]}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'[\n {\n "id": 10,\n "name": "doggie",\n "category": {\n "id": 1,\n "name": "Dogs"\n },\n "photoUrls": [\n "string"\n ],\n "tags": [\n {\n "id": 0,\n "name": "string"\n }\n ],\n "status": "available"\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{})]}),(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",{})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.5b0aa367.js b/assets/js/fa40969b.5b0aa367.js new file mode 100644 index 000000000..a737c4762 --- /dev/null +++ b/assets/js/fa40969b.5b0aa367.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>k,frontMatter:()=>h,metadata:()=>j,toc:()=>y});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),d=a.n(n),r=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"getdocumentlist",title:"Get document list",description:"Get document list",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1vGzcQ/SvM5BIDa33E6WVRFHUDwzAS1IblogdLB2p3VpqISzIkV5Yg7H8PhrsrrSy5aYFeJHk+yJk37w29gyAXHtJnyE1WlaiDh1kCOfrMkQ1kNKRwi0F0bqHIB0jAWHSS/Xc5pLDA0AW0fiudLDGg48N3oGWJkMLmUlq6DGaFGhIgPnyJMkcHCTj8XpHDHNLgKkzAh63iHE+lVQgJ4MYqkyOkhVSeA7IllhLSHYStjZHBkV5AzaEyJqVcp/a00IPNZrOBetbcgz78YfIt52ZGB9SBf0prFWWxq+E3z63vTi8x82+YxQ4dYxAIPXsVlRR6YaQDLmJfhXGlDI3p6iP0ihuP6gT8iux/zBvVdQKbUnFaCyyjPueO6gQCBXVsqznBobdG+6bcj6MRfx3P2VdZht4XlRL78ULyfyGUxdn9vFHuIIacmWuJ3svFOd8JIu/f51jISoU+JNeWHlsYWlQ+jT6dAvGI1rggyAttgpBrSUrOFb6DmPDLacKdXktFubh+uBNPzO53sSKPWeUobKME+txPn2dMxRLD0rB+rGlFE5aQwvCVljy6dSekyikWTQjWp8OhtHbQMVzJuR9kphxKS8P1OHK9K2DCM2rGcFTGHkZp6QtuIfm5ULkvHv3jQUY3HTH3MhiPOmIzxUkXJt7VTuHeop7QQke41mN4vW+eluQZfHZ3UETOicI48SpbzKXHXBgtwhKjk+1Xg7HwFjMqWroOxFRP9cSUKCqPTHFFeuXTqb4Uz/dFQRlJJf7GuaeAsw8dwC8vLycAX8ScWwrLai4cWnMIX0RjnEI/a//HBSQQ0JX+vpigW1OG7TDfuGoYg4etCGUWRYilJCZBa/r9dRKzVFGGTPKDHq5vH76Kq8EIkh6H/kXJw693n2/+nNzwqczCZkTjwWgwYhMzt5S6d9G51+Jovr2deza4pWTATRhaJUnzPbHmXauQw2sVU2YJLFlA6TPsdkyHv5yqazZ/r9Cx+mYJrKUjFnHUXtKxmSWVk2dHvn9Y3qz2w2P7Rl2It+pc4fZEPmupKo6EOtm1AZ+bMy+f+IxDxMl+PWRcZxna8I+x/Y3ycD95ggTm7StXxuULTr7wSytfIIUpTCE+5HxCXA3RvgMl9aKKWxaac1nysmLg+/tiFfdF+4Nx7Fx626vyGImmFf7kxs4m/Mry/YLb3/bhjefNhP0/EE00j2FW1/UPz9MDww==",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",description:"Get document list",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",description:"Get document list",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1vGzcQ/SvM5BIDa33E6WVRFHUDwzAS1IblogdLB2p3VpqISzIkV5Yg7H8PhrsrrSy5aYFeJHk+yJk37w29gyAXHtJnyE1WlaiDh1kCOfrMkQ1kNKRwi0F0bqHIB0jAWHSS/Xc5pLDA0AW0fiudLDGg48N3oGWJkMLmUlq6DGaFGhIgPnyJMkcHCTj8XpHDHNLgKkzAh63iHE+lVQgJ4MYqkyOkhVSeA7IllhLSHYStjZHBkV5AzaEyJqVcp/a00IPNZrOBetbcgz78YfIt52ZGB9SBf0prFWWxq+E3z63vTi8x82+YxQ4dYxAIPXsVlRR6YaQDLmJfhXGlDI3p6iP0ihuP6gT8iux/zBvVdQKbUnFaCyyjPueO6gQCBXVsqznBobdG+6bcj6MRfx3P2VdZht4XlRL78ULyfyGUxdn9vFHuIIacmWuJ3svFOd8JIu/f51jISoU+JNeWHlsYWlQ+jT6dAvGI1rggyAttgpBrSUrOFb6DmPDLacKdXktFubh+uBNPzO53sSKPWeUobKME+txPn2dMxRLD0rB+rGlFE5aQwvCVljy6dSekyikWTQjWp8OhtHbQMVzJuR9kphxKS8P1OHK9K2DCM2rGcFTGHkZp6QtuIfm5ULkvHv3jQUY3HTH3MhiPOmIzxUkXJt7VTuHeop7QQke41mN4vW+eluQZfHZ3UETOicI48SpbzKXHXBgtwhKjk+1Xg7HwFjMqWroOxFRP9cSUKCqPTHFFeuXTqb4Uz/dFQRlJJf7GuaeAsw8dwC8vLycAX8ScWwrLai4cWnMIX0RjnEI/a//HBSQQ0JX+vpigW1OG7TDfuGoYg4etCGUWRYilJCZBa/r9dRKzVFGGTPKDHq5vH76Kq8EIkh6H/kXJw693n2/+nNzwqczCZkTjwWgwYhMzt5S6d9G51+Jovr2deza4pWTATRhaJUnzPbHmXauQw2sVU2YJLFlA6TPsdkyHv5yqazZ/r9Cx+mYJrKUjFnHUXtKxmSWVk2dHvn9Y3qz2w2P7Rl2It+pc4fZEPmupKo6EOtm1AZ+bMy+f+IxDxMl+PWRcZxna8I+x/Y3ycD95ggTm7StXxuULTr7wSytfIIUpTCE+5HxCXA3RvgMl9aKKWxaac1nysmLg+/tiFfdF+4Nx7Fx626vyGImmFf7kxs4m/Mry/YLb3/bhjefNhP0/EE00j2FW1/UPz9MDww==",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 by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get document list"})}),"\n",(0,t.jsx)(d(),{method:"post",path:"/documentlist"}),"\n",(0,t.jsx)(s.p,{children:"Get document list"}),"\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)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\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:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(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",{})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e2751700.js b/assets/js/fa40969b.e2751700.js deleted file mode 100644 index a02d3092e..000000000 --- a/assets/js/fa40969b.e2751700.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=i(85893),a=i(11151),n=i(58219),l=(i(62316),i(51039)),d=i.n(l),r=(i(82723),i(9487)),o=i(41429),c=i(5397),m=i(4667),p=i(9472),h=i(85162);const u={id:"getdocumentlist",title:"Get document list",description:"Get document list",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1v2zgQ/Svs9NIAimU33YuwWDRbBEHQYhPEWewhNha0NLKnpkiWpOwYhv77YijJduxk2wK9JArngzNv3htmC0HOPWSPUJi8rlAHD9MECvS5IxvIaMjgGoPozUKRD5CAsegk228KyGCOoXfo7FY6WWFAx8m3oGWFkMHTubR0HswSNSRAnHyBskAHx3dCAg6/1eSwgCy4GhPwYaM4iafKKoQE8MkqUyBkpVSeHfIFVhKyLYSNjZ7BkZ5D00zbbOjDn6bYsEdudEAd+FNaqyiPzaRfPd++PU1lZl8xj405bj0QerYqqigcuJEOOI/tlMZVMrRHF+9jtTLWnY2GTQJ+SfYn44ZNk8BTpTisw5PBnnFHTQKBgnp+1nCAQ2+N9m2574dD/vUcal/nOXpf1krspgrJr0IojxP6fqPcQXQ5mV4CFXov5y/ZThB5+7bAUtYqHEJyaem+g6FD5cPwwykQ92iNC4K80CYIuZKk5EzhG4gBv50G3OiVVFSIy7sb8cCkfhMr8pjXjsImMl9a+neJ/D1lGlYYFoYlY02nk7CADNIj+Xh0q147tVOskxCsz9JUWjswFrWnuVZy5ge5qVJpKV2NgC/oLx/zfNoR7ErYwSctfcYNJN/XJffDI7/fy+eqJ+SO/qNhT2imNunSxLs69G8t6jHNdYRpNTqR+sOCPIPO5h6GyDVRGieOosVMeiyE0SIsMBr5/GIwEt5iTmVH04GY6IkemwpF7ZGprUgvfTbR5+LxtiwpJ6nEPzjzFHD6rgd3vV6fgHsWY64pLOqZcGjN3n0eD+MEDqN2f5xBAgFd5W/LMboV5dgN8pWr0uicduKTeRQfVpKYAN3Rx+MgZqeiHJncex1cXt99EReDISQH/PmBktMvN5+u/hpfcVZmYDui0WA4GPIRs7aS+uCilx6HZ/M92LUvOneUDPgUUqskab4n1rzt1LF/nGLINIEFiyd7hO2W6fC3U03Dx99qdFFpCaykIxZv1F3Ss5nlVJBnQ7F7Nl6t9t199wKdidfqjLI6ks9Kqpo9oUm2ncOnNuf5A+fYe5zs1X3EZZ6jDf/re7hN7m7HD5DArHvdqrh0wck1v6NyDRlMYALx3eYMcS3E8y0oqed13K7Q5mXJy5qBP9wXy7gvug/GsTfpzUGVz5FoW+Gf3NiLAb+zfD/j5o+de2t5NWD3/0LrzWOYNk3zHwb//WU=",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",description:"Get document list",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",description:"Get document list",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1v2zgQ/Svs9NIAimU33YuwWDRbBEHQYhPEWewhNha0NLKnpkiWpOwYhv77YijJduxk2wK9JArngzNv3htmC0HOPWSPUJi8rlAHD9MECvS5IxvIaMjgGoPozUKRD5CAsegk228KyGCOoXfo7FY6WWFAx8m3oGWFkMHTubR0HswSNSRAnHyBskAHx3dCAg6/1eSwgCy4GhPwYaM4iafKKoQE8MkqUyBkpVSeHfIFVhKyLYSNjZ7BkZ5D00zbbOjDn6bYsEdudEAd+FNaqyiPzaRfPd++PU1lZl8xj405bj0QerYqqigcuJEOOI/tlMZVMrRHF+9jtTLWnY2GTQJ+SfYn44ZNk8BTpTisw5PBnnFHTQKBgnp+1nCAQ2+N9m2574dD/vUcal/nOXpf1krspgrJr0IojxP6fqPcQXQ5mV4CFXov5y/ZThB5+7bAUtYqHEJyaem+g6FD5cPwwykQ92iNC4K80CYIuZKk5EzhG4gBv50G3OiVVFSIy7sb8cCkfhMr8pjXjsImMl9a+neJ/D1lGlYYFoYlY02nk7CADNIj+Xh0q147tVOskxCsz9JUWjswFrWnuVZy5ge5qVJpKV2NgC/oLx/zfNoR7ErYwSctfcYNJN/XJffDI7/fy+eqJ+SO/qNhT2imNunSxLs69G8t6jHNdYRpNTqR+sOCPIPO5h6GyDVRGieOosVMeiyE0SIsMBr5/GIwEt5iTmVH04GY6IkemwpF7ZGprUgvfTbR5+LxtiwpJ6nEPzjzFHD6rgd3vV6fgHsWY64pLOqZcGjN3n0eD+MEDqN2f5xBAgFd5W/LMboV5dgN8pWr0uicduKTeRQfVpKYAN3Rx+MgZqeiHJncex1cXt99EReDISQH/PmBktMvN5+u/hpfcVZmYDui0WA4GPIRs7aS+uCilx6HZ/M92LUvOneUDPgUUqskab4n1rzt1LF/nGLINIEFiyd7hO2W6fC3U03Dx99qdFFpCaykIxZv1F3Ss5nlVJBnQ7F7Nl6t9t199wKdidfqjLI6ks9Kqpo9oUm2ncOnNuf5A+fYe5zs1X3EZZ6jDf/re7hN7m7HD5DArHvdqrh0wck1v6NyDRlMYALx3eYMcS3E8y0oqed13K7Q5mXJy5qBP9wXy7gvug/GsTfpzUGVz5FoW+Gf3NiLAb+zfD/j5o+de2t5NWD3/0LrzWOYNk3zHwb//WU=",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 by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},f={},g=[{value:"Request",id:"request",level:2}];function N(e){const s={h2:"h2",p:"p",...(0,a.a)(),...e.components},{Details:i}=s;return i||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 document list"})}),"\n",(0,t.jsx)(d(),{method:"post",path:"/documentlist"}),"\n",(0,t.jsx)(s.p,{children:"Get document list"}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(i,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",description:"",required:!0,style:"simple",explode:!1,schema:{type:"string"}}})})})]}),"\n",(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(i,{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)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\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)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(i,{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:"code",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Report is not available!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,a.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/runtime~main.06c0efe1.js b/assets/js/runtime~main.473a3442.js similarity index 60% rename from assets/js/runtime~main.06c0efe1.js rename to assets/js/runtime~main.473a3442.js index 936be5461..e72c22a0f 100644 --- a/assets/js/runtime~main.06c0efe1.js +++ b/assets/js/runtime~main.473a3442.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,f,b,c={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return c[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=c,r.c=t,e=[],r.O=(a,d,f,b)=>{if(!d){var c=1/0;for(i=0;i=b)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,b0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[d,f,b]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var b=Object.create(null);r.r(b);var c={};a=a||[null,d({}),d([]),d(d)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>c[a]=()=>e[a]));return c.default=()=>e,r.d(b,c),b},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5763:"4eb531f8",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"163ba40c",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"e2751700",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"64664fbd",1359:"49fdcec2",1477:"b31b2642",1520:"8c254a88",1531:"bc1aba88",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"2d551218",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"af8b6278",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"95345333",4682:"18721add",4955:"d23a608f",5507:"36c41078",5763:"2a371478",5900:"8e99cdc5",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"4a41b2fc",7971:"98b57710",8106:"52a2b54f",8140:"901b2f91",8163:"5158ea15",8468:"1e6d4a52",8475:"d27b3009",8489:"f6b0b808",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"bfe72b32",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="OpenSign-Docs:",r.l=(e,a,d,c)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var b=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","4eb531f8":"5763","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)d.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((d,b)=>f=e[a]=[d,b]));d.push(f[2]=b);var c=r.p+r.u(a),t=new Error;r.l(c,(d=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=d&&("load"===d.type?"missing":d.type),c=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+c+")",t.name="ChunkLoadError",t.type=b,t.request=c,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var f,b,c=d[0],t=d[1],o=d[2],n=0;if(c.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,d,c,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,c,f)=>{if(!d){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[d,c,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5763:"4eb531f8",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"163ba40c",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"5b0aa367",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"4d359ed0",1359:"49fdcec2",1477:"b31b2642",1520:"59fcada6",1531:"a7aeac43",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"3b0c9239",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"90d94c1d",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"3868ea9d",4682:"18721add",4955:"d23a608f",5507:"36c41078",5763:"9c40b018",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"9de142ad",7971:"135d9700",8106:"2d0f90d1",8140:"901b2f91",8163:"ee68edbb",8468:"415bedce",8475:"d27b3009",8489:"b9990d5c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"b70fa041",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},f="OpenSign-Docs:",r.l=(e,a,d,b)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","4eb531f8":"5763","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)d.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((d,f)=>c=e[a]=[d,f]));d.push(c[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var c,f,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(d);n Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index e76b41cb8..e35c72df5 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 2f5f7962c..22b897905 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index b8db859b5..d4f10db60 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 72f36d5a5..33761ecb6 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 23ef69fac..002c06642 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 600e807e1..d799be66c 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 22ac44910..7a1449d4c 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index 001d1775b..14941038b 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index a63c75dc6..162d7c40d 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index f7c820ee8..be2ad9bf5 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/add-pet/index.html b/docs/API-docs/add-pet/index.html index 65ba2a247..8b1b121ca 100644 --- a/docs/API-docs/add-pet/index.html +++ b/docs/API-docs/add-pet/index.html @@ -5,7 +5,7 @@ Add a new pet to the store | OpenSign™ - + @@ -13,8 +13,8 @@ 
POST 
/createuser

Add a new pet to the store

Request​

-

Header Parameters

    x-api-token stringrequired
-

Body

required

Create a new pet in the store

    id int64
    name stringrequired

    category

    category

    id int64
    name string
    photoUrls string[]required

    tags

    tag[]

  • Array [

    • id int64
    name string

  • ]

    • status string

    Possible values: [available, pending, sold]

    pet status in the store

-

Responses​

Successful operation

Schema

    id int64
    name stringrequired

    category

    category

    id int64
    name string
    photoUrls string[]required

    tags

    tag[]

  • Array [

    • id int64
    name string

  • ]

    • status string

    Possible values: [available, pending, sold]

    pet status in the store

Loading...
+

Header Parameters

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

Body

required

Create a new pet in the store

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    Customer_id string
    Subscriptions_id string

    Next_billing_date

    date

    __type string
    iso string
+

Responses​

Successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    Customer_id string
    Subscriptions_id string

    Next_billing_date

    date

    __type string
    iso string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 591f5ae19..c72626914 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,15 +5,15 @@ Get contact list | OpenSign™ - +

Get contact list

POST 
/contactlist

Request​

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit int32
    skip int32
-

Responses​

successful operation

Schema

    code int32
    type string
    message string
Loading...
+

Responses​

successful operation

Schema

  • Array [

    • objectId string
    Name string
    Email string
    Phone string

  • ]

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

Create contact

Request​

-

Header Parameters

    x-api-token stringrequired
-

Body

required

provide below parameter to create contact

    Name string
    Email string
    Phone string
+

Header Parameters

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

Body

required

provide below parameter to create contact

    Name stringrequired
    Email stringrequired
    Phone stringrequired

Responses​

successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index a095e05c0..9537e8a0b 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + @@ -13,7 +13,7 @@ 
POST 
/createdocument

Create document

Request​

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Document created successfully!

Schema

    id string
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index c41bdc5a1..05272b047 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create template | OpenSign™ - + @@ -13,7 +13,7 @@ 
POST 
/createtemplate

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

Request​

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

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

Responses​

Template created successfully!

Schema

    code int32
    type string
    message string
Loading...
diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 8c733c102..294956d7b 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete template by ID | OpenSign™ - + @@ -14,7 +14,7 @@

Delete template by ID

Request​

Path Parameters

    template_id int64required

    ID of the template that needs to be deleted

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Invalid ID supplied

Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 12e3e7028..decf49ae1 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Deletes contact | OpenSign™ - + @@ -14,7 +14,7 @@

delete a contact

Request​

Path Parameters

    contact_id stringrequired

    Provide objectId of contact to delete

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Contact deleted successfully!

Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index a5aaef422..08fc49eec 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete document by ID | OpenSign™ - + @@ -14,7 +14,7 @@

delete a document

Request​

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

Contact deleted successfully!

Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 78af54548..948217142 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get template by ID | OpenSign™ - + @@ -13,7 +13,7 @@ 
GET 
/template/:template_id

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

successful operation

Schema

    Name string
    Note string
    Description string
    URL string
    signers signers[]
    folderId string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 712b6ae62..5599c3fa7 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + @@ -13,7 +13,7 @@ 
GET 
/getuser

Get your details

Request​

-

Header Parameters

    x-api-token stringrequired
-

Responses​

Successful operation

Schema

    id int64
    name stringrequired

    category

    category

    id int64
    name string
    photoUrls string[]required

    tags

    tag[]

  • Array [

    • id int64
    name string

  • ]

    • status string

    Possible values: [available, pending, sold]

    pet status in the store

Loading...
+

Header Parameters

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

Responses​

Successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    Customer_id string
    Subscriptions_id string

    Next_billing_date

    date

    __type string
    iso string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 1af633ed8..e85f3d9db 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + @@ -14,7 +14,7 @@

get a contact

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Responses​

successful operation

Schema

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

Get a document

Request​

Path Parameters

    document_id stringrequired

    objectId of contact

-

Header Parameters

    x-api-token stringrequired
-

Responses​

successful operation

Schema

  • Array [

    • id int64
    name stringrequired

    category

    category

    id int64
    name string
    photoUrls string[]required

    tags

    tag[]

  • Array [

    • id int64
    name string

  • ]

    • status string

    Possible values: [available, pending, sold]

    pet status in the store

  • ]

Loading...
+

Header Parameters

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

Responses​

successful operation

Schema

  • Array [

    • objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    Customer_id string
    Subscriptions_id string

    Next_billing_date

    date

    __type string
    iso string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index b29419801..26918e2ed 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get document list | OpenSign™ - + @@ -13,7 +13,7 @@ 
POST 
/documentlist

Get document list

Request​

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit int32
    skip int32

Responses​

successful operation

Schema

    code int32
    type string
    message string
Loading...
diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index c7817326f..2390c4e7a 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + @@ -13,7 +13,7 @@ 
POST 
/templatelist

Get template list

Request​

-

Header Parameters

    x-api-token stringrequired
+

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit int32
    skip int32

Responses​

successful operation

Schema

    id string
    URL string
    Name string
    Note string
    Description string
    Folder string

    Signers

    object[]

  • Array [

    • objectId int64
    Name string

  • ]

    • CreateBy string
Loading...
diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 4497371ed..81e87d030 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index 678ac08e2..2feeebc55 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + @@ -17,7 +17,7 @@
  • Official Website
  • Github repo
    • -

    Authentication

    Security Scheme Type:

    apiKey

    Header parameter name:

    x-api-token

    +

    Authentication

    Security Scheme Type:

    apiKey

    Header parameter name:

    x-api-token

    License

    AGPL 3.0

    diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 16d3c268b..bea96f802 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update template by ID | OpenSign™ - + @@ -14,7 +14,7 @@

    Update template by ID

    Request​

    Path Parameters

      template_id int64required

      ID of the order that needs to be updated

    -

    Header Parameters

      x-api-token stringrequired
    +

    Header Parameters

      x-api-token stringrequired
      Example: opensign.xxxx

    Body

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

      Name string
      Note string
      Description string
      FolderId string

    Responses​

    Invalid ID supplied

    Loading...
    diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index e96eff73b..c9cedf89d 100644 --- a/docs/category/tutorial---basics/index.html +++ b/docs/category/tutorial---basics/index.html @@ -5,7 +5,7 @@ Tutorial - Basics | OpenSign™ - + diff --git a/docs/category/tutorial---extras/index.html b/docs/category/tutorial---extras/index.html index 9c4d33766..ae7c86aad 100644 --- a/docs/category/tutorial---extras/index.html +++ b/docs/category/tutorial---extras/index.html @@ -5,7 +5,7 @@ Tutorial - Extras | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 4e2b96e82..5b482d242 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index 06badc317..edd58e0a4 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ COMMUNITY | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 0a96ca2f8..2d5f8290b 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATION | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index c940bbce6..735568396 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ REPORTING_GUIDELINES | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 5927001b2..1716a2400 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index aebab0c66..4ebc62cf2 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index db64358a8..d385fe3c1 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign yourself | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 76279b693..207090494 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index ce544a5e6..f2a304de5 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 16efa1115..4135fddcb 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/congratulations/index.html b/docs/self-host/tutorial-basics/congratulations/index.html index a61b94b38..fe5223dbb 100644 --- a/docs/self-host/tutorial-basics/congratulations/index.html +++ b/docs/self-host/tutorial-basics/congratulations/index.html @@ -5,7 +5,7 @@ Congratulations! | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-blog-post/index.html b/docs/self-host/tutorial-basics/create-a-blog-post/index.html index a5c7e0f8e..33ac83c01 100644 --- a/docs/self-host/tutorial-basics/create-a-blog-post/index.html +++ b/docs/self-host/tutorial-basics/create-a-blog-post/index.html @@ -5,7 +5,7 @@ Create a Blog Post | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-document/index.html b/docs/self-host/tutorial-basics/create-a-document/index.html index c4478e177..4270245c3 100644 --- a/docs/self-host/tutorial-basics/create-a-document/index.html +++ b/docs/self-host/tutorial-basics/create-a-document/index.html @@ -5,7 +5,7 @@ Create a Document | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-page/index.html b/docs/self-host/tutorial-basics/create-a-page/index.html index 6f5df09b8..d3b6ca7a5 100644 --- a/docs/self-host/tutorial-basics/create-a-page/index.html +++ b/docs/self-host/tutorial-basics/create-a-page/index.html @@ -5,7 +5,7 @@ Create a Page | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/deploy-your-site/index.html b/docs/self-host/tutorial-basics/deploy-your-site/index.html index 3b8bc8359..d250d3f16 100644 --- a/docs/self-host/tutorial-basics/deploy-your-site/index.html +++ b/docs/self-host/tutorial-basics/deploy-your-site/index.html @@ -5,7 +5,7 @@ Deploy your site | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/markdown-features/index.html b/docs/self-host/tutorial-basics/markdown-features/index.html index 67a10dda4..b9d6086a0 100644 --- a/docs/self-host/tutorial-basics/markdown-features/index.html +++ b/docs/self-host/tutorial-basics/markdown-features/index.html @@ -5,7 +5,7 @@ Markdown Features | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/manage-docs-versions/index.html b/docs/self-host/tutorial-extras/manage-docs-versions/index.html index 65bc13299..650f86fa0 100644 --- a/docs/self-host/tutorial-extras/manage-docs-versions/index.html +++ b/docs/self-host/tutorial-extras/manage-docs-versions/index.html @@ -5,7 +5,7 @@ Manage Docs Versions | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/translate-your-site/index.html b/docs/self-host/tutorial-extras/translate-your-site/index.html index ec0298fd8..ec4bbe21f 100644 --- a/docs/self-host/tutorial-extras/translate-your-site/index.html +++ b/docs/self-host/tutorial-extras/translate-your-site/index.html @@ -5,7 +5,7 @@ Translate your site | OpenSign™ - + diff --git a/index.html b/index.html index 346b91fc0..89af8210d 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 5ae285f3d..025073e23 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +