diff --git a/404.html b/404.html index ddf5f760a..22f97eb87 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.7ccc6dd5.js b/assets/js/05632a52.7ccc6dd5.js deleted file mode 100644 index d3c6f3aeb..000000000 --- a/assets/js/05632a52.7ccc6dd5.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:()=>b,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1r4zgQ/iva+bQFN07a3hdzLFuW0gu7bMulx31IwyLb41itLWklOXUw/u/HyHbiNCl3XQ5CYs+bnnl5RmnA8bWFaAlflHQ8cRZWAaRoEyO0E0pCBGt0jLOk00MASqPhpJunnXav0tzwEh0aCtmA5CVCBPU51+LcqWeUEICgmDnyFA0EYPBnJQymEDlTYQDWbQvysaLUBUIAWOtCpQhRxgtLBkmOJYeoAbfV3tIZIdfQkin3ThFBlFas5aSu6xraYAelh/pDpAMSzV0Or1NW8RMmbp4ylY0S/9+wBpApU3I3luzB6z9mcZ5c5DqGtl3RsVYradFSoIvplH4O4doqSdDarCrYrjkQ+GRROrLnWhci8YrwyZJTc4yuy5raaCiME92RQzHenUc+i/P64klTb777+r8vwJNCFiOS+03JRfEL/jHi514wSVRJoe5zJd8N5Wp2ObvwH2jbAOrSgzkcqhQdF4WlM5xwxSlNS85X06vjFvb0Y1I5lqlKph/Am/52bDqXG16IlF3fz9kDkeqDx2QxqYxwW8+8MeWi5YrGqESXq56xnqouhwjCHmLY7KnRAkUzm4HGlSmIss5pG4Uh13oy8KvgsaW6hlyLcDMDOmfAsaDx6iboAM2u8FyLr7iF4N/XBKUnZKa8c1/aO41yIdbSl2EzO6LwQy4sE9arU5VUJUrn559lyrBX3izmFlOmJHM5eiXJLyczZjUmIuupM2GP8lEuVImsskh0K4R8ttGjPGfLuywTieAF+xtjKxyuPg4Ve3l5OarYmfe5FS6vYmZQq7352gt9Wcdeu5czCMChKe1dtkCzEQn23XnjqNAbh/1CoFUWNYAdoQbR59dONH2FSFBaHE369e39N3Y5mUIwGor/ADn8Nv9y831xQ1FprLoWzSbTyZREWllXcjk66BbdaPEedLbZ77Wjq6mfLIe1C3XBhaToHmnTD/wS9tbR6DZYBZAr68igaWga/jJF25L4Z4WGSLUKYMON4DGN37KBVFh6Tnfb/k2UH//sL44zdvpiOQl7YIkkimx4UdEbBPCM28OLrF21wcCUXwb2ForutENq7sDQxdoZXCcJajfSHV04Byvo9uYBAuAVdWS8D579PugfKJeTRThE0wGgb4Jz0uF3YvNX3H7amXeaNx12f086ayrFqm3bfwClgx2J",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get contact",description:"get a contact",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1r4zgQ/iva+bQFN07a3hdzLFuW0gu7bMulx31IwyLb41itLWklOXUw/u/HyHbiNCl3XQ5CYs+bnnl5RmnA8bWFaAlflHQ8cRZWAaRoEyO0E0pCBGt0jLOk00MASqPhpJunnXav0tzwEh0aCtmA5CVCBPU51+LcqWeUEICgmDnyFA0EYPBnJQymEDlTYQDWbQvysaLUBUIAWOtCpQhRxgtLBkmOJYeoAbfV3tIZIdfQkin3ThFBlFas5aSu6xraYAelh/pDpAMSzV0Or1NW8RMmbp4ylY0S/9+wBpApU3I3luzB6z9mcZ5c5DqGtl3RsVYradFSoIvplH4O4doqSdDarCrYrjkQ+GRROrLnWhci8YrwyZJTc4yuy5raaCiME92RQzHenUc+i/P64klTb777+r8vwJNCFiOS+03JRfEL/jHi514wSVRJoe5zJd8N5Wp2ObvwH2jbAOrSgzkcqhQdF4WlM5xwxSlNS85X06vjFvb0Y1I5lqlKph/Am/52bDqXG16IlF3fz9kDkeqDx2QxqYxwW8+8MeWi5YrGqESXq56xnqouhwjCHmLY7KnRAkUzm4HGlSmIss5pG4Uh13oy8KvgsaW6hlyLcDMDOmfAsaDx6iboAM2u8FyLr7iF4N/XBKUnZKa8c1/aO41yIdbSl2EzO6LwQy4sE9arU5VUJUrn559lyrBX3izmFlOmJHM5eiXJLyczZjUmIuupM2GP8lEuVImsskh0K4R8ttGjPGfLuywTieAF+xtjKxyuPg4Ve3l5OarYmfe5FS6vYmZQq7352gt9Wcdeu5czCMChKe1dtkCzEQn23XnjqNAbh/1CoFUWNYAdoQbR59dONH2FSFBaHE369e39N3Y5mUIwGor/ADn8Nv9y831xQ1FprLoWzSbTyZREWllXcjk66BbdaPEedLbZ77Wjq6mfLIe1C3XBhaToHmnTD/wS9tbR6DZYBZAr68igaWga/jJF25L4Z4WGSLUKYMON4DGN37KBVFh6Tnfb/k2UH//sL44zdvpiOQl7YIkkimx4UdEbBPCM28OLrF21wcCUXwb2ForutENq7sDQxdoZXCcJajfSHV04Byvo9uYBAuAVdWS8D579PugfKJeTRThE0wGgb4Jz0uF3YvNX3H7amXeaNx12f086ayrFqm3bfwClgx2J",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"}},b={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"get a contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})}),(0,t.jsx)(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 f(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.dbc22dee.js b/assets/js/05632a52.dbc22dee.js new file mode 100644 index 000000000..657f20441 --- /dev/null +++ b/assets/js/05632a52.dbc22dee.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),n=s(11151),t=s(58219),i=(s(62316),s(51039)),c=s.n(i),r=(s(82723),s(9487)),d=s(41429),m=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zgM/isaP62Amzhp9sU4HFYMRa/YsBaXHu5DGxSyTcdqbUmT5DSB4f8+ULYTp0lv63AYUKSJ+KKH5ENSNTi+tBDdwSclHU+chUUAKdrECO2EkhDBEh3jLGnlEIDSaDjJrtJWuhNpbniJDg25rEHyEiGC9SnX4tSpJ5QQgCCfOfIUDQRg8FslDKYQOVNhANZtCrKxotQFQgC41oVKEaKMF5YUkhxLDlENbqO9pjNCLqEhVe6NIoIorVjK0Xq9XkMTbKF0UB9E2iPR3OXwMmQVP2LirlKmskHg/xvWADJlSu6GJzvw+q9JnCfTXMfQNAu61molLVpyNA1D+rcP11ZJgtZmVcG2xYHAB4vSkT7XuhCJF4wfLRnVh+jaqKmMhtw40V6Z+JC2WrIqY1+6LeJpGDYBlGgtX+KxaHexdSxjiUHuMGU75MXmHdXQoK0K92NQfYXenNx8Eufr6aOmy756UrzNwaNCFiOS+UXJRfEL9jHix+5glKiSXN3kSr4ZymxyNpn6P2iaANalB7PP9BQdF4WlO5xwxTHJQCRkISQ+9Ix7mIbhAzknnVk4O2ReX0+pHMtUJdN3v5F3s3D2Vt4NcP5X3LNw9jDdxv3hMO4rueKFSNn5zRW7pcH2e+P+8LNxD3G6FuchVUSr1A7ovawMz9tsWEwqI9zGz/fhYI/uFjSsSnS56vaCXwguhwjGHefG9W4AN0DezKpfFpUpaDE4p200HnOtR/0UL3hsqVHGXIvxagJ0T49jTklt87aHZpsUrsVn3EDw42VE4QmZKW/cpeBao5yLpfQJXE0OFsVtLiwT1otTlVQlSuerzjJl2AtrFnOLKVOSuRy9kM7PRhNmNSYi6wgzYvfyXs5ViayySEO9EPLJRvfylN1dZ5lIBC/Yvxhb4XDxvs/Y8/PzQcZOvM2lcHkVM4Na7dSX/tCndWi1/XECATg0pb3O5mhWIsGuOq9cNfbK464NaGFGNWA7Ifujjy+NiG2FSFBaHPDx/PLmCzsbhRAMSPETkMdfrj5dfJ1fkFeiVVuiySgchXSklXUll4OLLtEN1vteZetdNx88gDpmOVy7sS648E3jkdYd4e9gpx0N3hyLAHJlHSnUNbHhH1M0DR1/q9BQUy0CWHEjeEz0u6shFZa+p9s3xaso3//dPU9O2PHny1HYfZdIapEVLyr6BQE84Wb/udQsmqDvlF8G9hqK9rb91tyCoedbq3CeJKjdQHYwZvdG0OXFLQTAK6rIcB48+XnQfaFYjiZhH00LgD4JzlGDP6ibP+Pmz616K3nVYPsIbrUpFYumab4D91nw6Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get contact",description:"get a contact",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get contact",description:"get a contact",sidebar_label:"Get contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zgM/isaP62Amzhp9sU4HFYMRa/YsBaXHu5DGxSyTcdqbUmT5DSB4f8+ULYTp0lv63AYUKSJ+KKH5ENSNTi+tBDdwSclHU+chUUAKdrECO2EkhDBEh3jLGnlEIDSaDjJrtJWuhNpbniJDg25rEHyEiGC9SnX4tSpJ5QQgCCfOfIUDQRg8FslDKYQOVNhANZtCrKxotQFQgC41oVKEaKMF5YUkhxLDlENbqO9pjNCLqEhVe6NIoIorVjK0Xq9XkMTbKF0UB9E2iPR3OXwMmQVP2LirlKmskHg/xvWADJlSu6GJzvw+q9JnCfTXMfQNAu61molLVpyNA1D+rcP11ZJgtZmVcG2xYHAB4vSkT7XuhCJF4wfLRnVh+jaqKmMhtw40V6Z+JC2WrIqY1+6LeJpGDYBlGgtX+KxaHexdSxjiUHuMGU75MXmHdXQoK0K92NQfYXenNx8Eufr6aOmy756UrzNwaNCFiOS+UXJRfEL9jHix+5glKiSXN3kSr4ZymxyNpn6P2iaANalB7PP9BQdF4WlO5xwxTHJQCRkISQ+9Ix7mIbhAzknnVk4O2ReX0+pHMtUJdN3v5F3s3D2Vt4NcP5X3LNw9jDdxv3hMO4rueKFSNn5zRW7pcH2e+P+8LNxD3G6FuchVUSr1A7ovawMz9tsWEwqI9zGz/fhYI/uFjSsSnS56vaCXwguhwjGHefG9W4AN0DezKpfFpUpaDE4p200HnOtR/0UL3hsqVHGXIvxagJ0T49jTklt87aHZpsUrsVn3EDw42VE4QmZKW/cpeBao5yLpfQJXE0OFsVtLiwT1otTlVQlSuerzjJl2AtrFnOLKVOSuRy9kM7PRhNmNSYi6wgzYvfyXs5ViayySEO9EPLJRvfylN1dZ5lIBC/Yvxhb4XDxvs/Y8/PzQcZOvM2lcHkVM4Na7dSX/tCndWi1/XECATg0pb3O5mhWIsGuOq9cNfbK464NaGFGNWA7Ifujjy+NiG2FSFBaHPDx/PLmCzsbhRAMSPETkMdfrj5dfJ1fkFeiVVuiySgchXSklXUll4OLLtEN1vteZetdNx88gDpmOVy7sS648E3jkdYd4e9gpx0N3hyLAHJlHSnUNbHhH1M0DR1/q9BQUy0CWHEjeEz0u6shFZa+p9s3xaso3//dPU9O2PHny1HYfZdIapEVLyr6BQE84Wb/udQsmqDvlF8G9hqK9rb91tyCoedbq3CeJKjdQHYwZvdG0OXFLQTAK6rIcB48+XnQfaFYjiZhH00LgD4JzlGDP6ibP+Pmz616K3nVYPsIbrUpFYumab4D91nw6Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function N(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get contact"})}),"\n",(0,l.jsx)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"get a contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(N,{...e})}):N(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.4e7c2112.js b/assets/js/1f73ca32.4e7c2112.js deleted file mode 100644 index 94d3819cb..000000000 --- a/assets/js/1f73ca32.4e7c2112.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:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>g,toc:()=>v});var i=a(85893),l=a(11151),t=a(58219),r=(a(62316),a(51039)),n=a.n(r),o=(a(82723),a(9487)),d=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={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:"eJyVVU1v2zgQ/SvsnBpAsew47S6ExaLZImskLZqgTrAHxwdKGlmMJZIlKceCof++GEpyFTvFri/+mHlvODN8T9qB4ysL0QIeLRpYBqA0Gu6EkjcpRLBC5xMBaG54iQ4NoXcgeYkQwfaca3Hu1BolBCAkRJAjTz3D4I9KGEwhcqbCAKyrC+JYUeoCIQDc6kKlCFHGC0uAJMeSQ7QDV2uPdEbIFTQE5Z4UUX/SipUcbbfbLTRLOsdqJS1aYl6Mx/SVok2M0DQHRDCvkgStzaqC7ceDABIlHUpHeK51IRKfCJ8tkXbH7aj4GRNHuzBUxon2yDZM6zpsPIBMmZK7YeTnJH/PxPpiGuePtzThN7/Q0yrcKmR/IRL9uuSiOJX/rDBG/NQFRokqqdR9ruTJrVx++Pjb79OLycWUStyq+EG44uQqKW6I/lmVmsv6VHYvDWiaALalX0en04pE3ATg2q66/w0BL8eXx4r5jokyKZPKsUxVMn0HHvnhGHkjN7wQKbu6v2EP5IN3/niLSWWEq71Zhi6JFksS7esiM3SsVpVhKTouCgsBlOhy1VnQ28/lEEG4Qle1hrRoNr0bK1OQ85zTNgpDrvWo30XBY0sXG3Itws3EG6bvbU4CbzX8qsP91rkWX7CG4L/dTiMLmSlP7nZ8p1HOxUr61WwmcDj0Qy4sE9anU5VUJUrnHcgyZdgBm8XcYsqUZC5Hn6T4dDRhVmMiss68I/Ykn+Rclcgqi2T4Qsi1jZ7kOVvcZZlIBC/YPxhb4XD5vt/Yy8vL0cbOPGcmXF7FzKBWP+ErH/RrHbL2f84gAIemtHfZHM1GJNjdzi+OCj047B5JPPGPJGwd3Yc+HZJIkYVIUFocCP1qdv+VTUdjCAai+B8th19vPl9/m19TVZJVe0WT0Xg0ppBW1pVcDg56Q7KvrncvIodbF+qCC0mFfFO7Ts4L6OW8DCBX1lFot6OrfjRF01D4R4WGXLQMYMON4DFpa7Fsgl56pP9UWEqk+1fJQSv7Jz28/969lc4YXdJbLa6xPtL6hhcVIaEJdh3gKklQu0Hu6B1CXtvbeHb9AAHwiuYeGmztDdb9oFn6lKwHtV930zZAn9TOm4Q/yB5fsP5zD28zvyTsX9stmlaxbJrmX+yJvu8=",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-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:"eJyVVU1v2zgQ/SvsnBpAsew47S6ExaLZImskLZqgTrAHxwdKGlmMJZIlKceCof++GEpyFTvFri/+mHlvODN8T9qB4ysL0QIeLRpYBqA0Gu6EkjcpRLBC5xMBaG54iQ4NoXcgeYkQwfaca3Hu1BolBCAkRJAjTz3D4I9KGEwhcqbCAKyrC+JYUeoCIQDc6kKlCFHGC0uAJMeSQ7QDV2uPdEbIFTQE5Z4UUX/SipUcbbfbLTRLOsdqJS1aYl6Mx/SVok2M0DQHRDCvkgStzaqC7ceDABIlHUpHeK51IRKfCJ8tkXbH7aj4GRNHuzBUxon2yDZM6zpsPIBMmZK7YeTnJH/PxPpiGuePtzThN7/Q0yrcKmR/IRL9uuSiOJX/rDBG/NQFRokqqdR9ruTJrVx++Pjb79OLycWUStyq+EG44uQqKW6I/lmVmsv6VHYvDWiaALalX0en04pE3ATg2q66/w0BL8eXx4r5jokyKZPKsUxVMn0HHvnhGHkjN7wQKbu6v2EP5IN3/niLSWWEq71Zhi6JFksS7esiM3SsVpVhKTouCgsBlOhy1VnQ28/lEEG4Qle1hrRoNr0bK1OQ85zTNgpDrvWo30XBY0sXG3Itws3EG6bvbU4CbzX8qsP91rkWX7CG4L/dTiMLmSlP7nZ8p1HOxUr61WwmcDj0Qy4sE9anU5VUJUrnHcgyZdgBm8XcYsqUZC5Hn6T4dDRhVmMiss68I/Ykn+Rclcgqi2T4Qsi1jZ7kOVvcZZlIBC/YPxhb4XD5vt/Yy8vL0cbOPGcmXF7FzKBWP+ErH/RrHbL2f84gAIemtHfZHM1GJNjdzi+OCj047B5JPPGPJGwd3Yc+HZJIkYVIUFocCP1qdv+VTUdjCAai+B8th19vPl9/m19TVZJVe0WT0Xg0ppBW1pVcDg56Q7KvrncvIodbF+qCC0mFfFO7Ts4L6OW8DCBX1lFot6OrfjRF01D4R4WGXLQMYMON4DFpa7Fsgl56pP9UWEqk+1fJQSv7Jz28/969lc4YXdJbLa6xPtL6hhcVIaEJdh3gKklQu0Hu6B1CXtvbeHb9AAHwiuYeGmztDdb9oFn6lKwHtV930zZAn9TOm4Q/yB5fsP5zD28zvyTsX9stmlaxbJrmX+yJvu8=",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"}},j={},v=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,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)(n(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"Get your details"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"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)(u.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}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.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)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.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/1f73ca32.b4037d80.js b/assets/js/1f73ca32.b4037d80.js new file mode 100644 index 000000000..152a6d268 --- /dev/null +++ b/assets/js/1f73ca32.b4037d80.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-user",title:"Get your details",description:"Get your details",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"Get your details"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"user"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.ab8f63df.js b/assets/js/2c586be5.ab8f63df.js deleted file mode 100644 index 206ed6832..000000000 --- a/assets/js/2c586be5.ab8f63df.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>k,frontMatter:()=>h,metadata:()=>g,toc:()=>v});var t=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),d=a.n(r),c=(a(82723),a(9487)),l=a(41429),o=a(5397),p=a(4667),m=a(9472),u=a(85162);const h={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJyVVU1v2zgQ/SvsnBqAsZy0exEWiw26RRG0aIJ1ij04RkFTI4sJRbIk5dg19N+LoT6q2C3avTjOzDxy3ps39AGi2ATIl/CPlU2NJgZYcbAOvYjKmusCcpAeRcSiLwAOTnhRY0RPyAMYUSPksDsXTp1H+4gGOCgDOVQoCvTAweOXRnksII++QQ4h7jVhgqqdRuCAO6dtgZCXQgcqkBXWAvIDxL1LldErs4GWSkUC5dSmCWpjZrvdbgftiu4JzpqAgZCX8zn9KTBIrxzRgXzkyXpWLDRSYghlo/X+BXCQ1kSimR9AOKeVTEJkD4Hgh9PG7PoBZVLFk2xRdZd3YdLvmAKH0vpaxGnkO6fqQV1+3cnt5S1xbbz+3wfE6EKeZX1kJm0Nbcshqpjyymhl8POg1GdSqW2p4vX8j1O9rs1WaFWwq9trdkezfZFOCygbr+I+GWA6+Xy5okE8P+RN0ppNLFRjrCyZy9nQWSpWkEN24rWAfjsYLakxEhTOzQYHaLEOxDQTTmXbi+SFocUFTawbyrNGR1mFU+9xD/zXRibmypQ2gXs9bxyahdqYpND2Ao6531UqMBVSeuCVLMVK69kRmq1FwIJZw2KFKUnxV7MLFhxKVfZunLF7c28WtkbWBCwbzbQyjyG/N+dseVOWSiqh2X+4Diri6uWg2NPT04liZwnzTsWqWTOPzn4v36RgknWKGv85Aw4RfR1uygX6rZKD/X5yVZaKs37HhEw7hrVQNNU+9PcxiLZAK4kmIJX3I7p6d/uBvZrNgU9M8RstZx+u37z9uHhLp5KtuhFdzOazOYXIjLUwk4tOnftsuqOHIu5i5rRQZrK2namXxw/oikNFrs+XcDjQwD953bYU/tKgp5VacdgKr8SaHLZctXwwIG1BoQIlivGtPOpofMDg5b/9s3vGaFQ/6vQR9yeO3wrdUCW0/NAXXEmJLk5yJ08jbdy41Lc3izvgIBriP92zx7Rn/RciM6TMfnL483a6DuiT+vkh4E/akve4/2ss7zI/BYw/TF01abFq2/Yb4IBpTg==",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/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:"eJyVVU1v2zgQ/SvsnBqAsZy0exEWiw26RRG0aIJ1ij04RkFTI4sJRbIk5dg19N+LoT6q2C3avTjOzDxy3ps39AGi2ATIl/CPlU2NJgZYcbAOvYjKmusCcpAeRcSiLwAOTnhRY0RPyAMYUSPksDsXTp1H+4gGOCgDOVQoCvTAweOXRnksII++QQ4h7jVhgqqdRuCAO6dtgZCXQgcqkBXWAvIDxL1LldErs4GWSkUC5dSmCWpjZrvdbgftiu4JzpqAgZCX8zn9KTBIrxzRgXzkyXpWLDRSYghlo/X+BXCQ1kSimR9AOKeVTEJkD4Hgh9PG7PoBZVLFk2xRdZd3YdLvmAKH0vpaxGnkO6fqQV1+3cnt5S1xbbz+3wfE6EKeZX1kJm0Nbcshqpjyymhl8POg1GdSqW2p4vX8j1O9rs1WaFWwq9trdkezfZFOCygbr+I+GWA6+Xy5okE8P+RN0ppNLFRjrCyZy9nQWSpWkEN24rWAfjsYLakxEhTOzQYHaLEOxDQTTmXbi+SFocUFTawbyrNGR1mFU+9xD/zXRibmypQ2gXs9bxyahdqYpND2Ao6531UqMBVSeuCVLMVK69kRmq1FwIJZw2KFKUnxV7MLFhxKVfZunLF7c28WtkbWBCwbzbQyjyG/N+dseVOWSiqh2X+4Diri6uWg2NPT04liZwnzTsWqWTOPzn4v36RgknWKGv85Aw4RfR1uygX6rZKD/X5yVZaKs37HhEw7hrVQNNU+9PcxiLZAK4kmIJX3I7p6d/uBvZrNgU9M8RstZx+u37z9uHhLp5KtuhFdzOazOYXIjLUwk4tOnftsuqOHIu5i5rRQZrK2namXxw/oikNFrs+XcDjQwD953bYU/tKgp5VacdgKr8SaHLZctXwwIG1BoQIlivGtPOpofMDg5b/9s3vGaFQ/6vQR9yeO3wrdUCW0/NAXXEmJLk5yJ08jbdy41Lc3izvgIBriP92zx7Rn/RciM6TMfnL483a6DuiT+vkh4E/akve4/2ss7zI/BYw/TF01abFq2/Yb4IBpTg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},j={},v=[{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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create document"})}),"\n",(0,t.jsx)(d(),{method:"post",path:"/createdocument"}),"\n",(0,t.jsx)(s.p,{children:"Create document"}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(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,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Document created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,n.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/2c586be5.ddf96f1e.js b/assets/js/2c586be5.ddf96f1e.js new file mode 100644 index 000000000..fab023b72 --- /dev/null +++ b/assets/js/2c586be5.ddf96f1e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>v});var l=a(85893),n=a(11151),i=a(58219),c=(a(62316),a(51039)),t=a.n(c),r=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVKc9kUohgVZUQQtlmDOsAfHCGjqymJCUSxJOfYM/ffhUh+VrRTpXvbiOPdDPPfccygfwPONg3QJv1eiLlF7B6sIKoOWe1npmwxSEBa5x6wrgAgMt7xEj5Y6D6B5iZDC7pwbee6rZ9QQgdSQQoE8QwsRWPxWS4sZpN7WGIHze0U9TpZGIUSAO6OqDCHNuXJUIAosOaQH8HsTKr2VegMNlfLQlBJM7eRGz3a73Q6aFZ3jTKUdOuqcJwn9ydAJKw2NA+kwJ+umYq4WAp3La6X2v0AEotKexkwPwI1RUgQi4idH7YcpsGr9hCKwYok2L9vDRZhmqNJ1uQ5MDOjnSdJEUKJzfIPTQcdzXlfac+FZhgqnkJswdq3826DaMC11elxe2ZL71wEUT3L+z05s53d0Wm3Vf36A98alcdxFZqIqoWki8NKHvNRKanzs1/c4T5LHy8durDcLoWmo5n3yYbrvG73lSmbs6u6G3ZM2/88dv08+/OyOxzh9i5Nm2pWB685isi1qPXbEyjjesuFQ1Fb6fbDo2JvpckVWOabpOriBjUxeoi8qsr+pXGt6X0AK8eQ2cGi3/VUQpDFsmxsz6z2q+NrR2mNuZLy9CG7tIS6I75bSI6ADX9zIL7iH6O2rhiaXOq9Cc8fOrUG9kBsduN1ewOns94V0TLqQ7ucKgmB5ZdlJN1tzhxmrNPMFhiTFL2cXzBkUMu+0NGMP+kEvqhJZ7TCvFVNSP7v0QZ+z5W2eSyG5Yn/j2kmPq3c9Yy8vLxPGzkLPZ+mLes0smup7+SYEA63jruGfM4jAoy3dbb5Au5Wi9+IPjopDcdw5hIvgECy5pK12od9Om0iISgrUDkdSvfp895VdzhKIRqL4Ccjx15vrT38sPtFTSVbtii5mySyhEImx5Hp00FS5R9sdNORx52OjuNSjO6wV9fL0FbeKoCDVp0s4HGjhf1nVNBT+VqMlS60i2HIr+ZoUtlw1US9AckEmHSWy4W12gmi4fuDdn92L8YzRql5D+oz7ieK3XNVUCU106AquhEDjR7nJxUaOG0x9d7u4hwh4TfOPffYcfNZ9oWH6lN6PHn4Mp0VAn4Tn1YaP5JIvuP91KG8zP2wYfjq01cTFqmmafwHUdfmX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocument",title:"Create document",description:"Create document",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVKc9kUohgVZUQQtlmDOsAfHCGjqymJCUSxJOfYM/ffhUh+VrRTpXvbiOPdDPPfccygfwPONg3QJv1eiLlF7B6sIKoOWe1npmwxSEBa5x6wrgAgMt7xEj5Y6D6B5iZDC7pwbee6rZ9QQgdSQQoE8QwsRWPxWS4sZpN7WGIHze0U9TpZGIUSAO6OqDCHNuXJUIAosOaQH8HsTKr2VegMNlfLQlBJM7eRGz3a73Q6aFZ3jTKUdOuqcJwn9ydAJKw2NA+kwJ+umYq4WAp3La6X2v0AEotKexkwPwI1RUgQi4idH7YcpsGr9hCKwYok2L9vDRZhmqNJ1uQ5MDOjnSdJEUKJzfIPTQcdzXlfac+FZhgqnkJswdq3826DaMC11elxe2ZL71wEUT3L+z05s53d0Wm3Vf36A98alcdxFZqIqoWki8NKHvNRKanzs1/c4T5LHy8durDcLoWmo5n3yYbrvG73lSmbs6u6G3ZM2/88dv08+/OyOxzh9i5Nm2pWB685isi1qPXbEyjjesuFQ1Fb6fbDo2JvpckVWOabpOriBjUxeoi8qsr+pXGt6X0AK8eQ2cGi3/VUQpDFsmxsz6z2q+NrR2mNuZLy9CG7tIS6I75bSI6ADX9zIL7iH6O2rhiaXOq9Cc8fOrUG9kBsduN1ewOns94V0TLqQ7ucKgmB5ZdlJN1tzhxmrNPMFhiTFL2cXzBkUMu+0NGMP+kEvqhJZ7TCvFVNSP7v0QZ+z5W2eSyG5Yn/j2kmPq3c9Yy8vLxPGzkLPZ+mLes0smup7+SYEA63jruGfM4jAoy3dbb5Au5Wi9+IPjopDcdw5hIvgECy5pK12od9Om0iISgrUDkdSvfp895VdzhKIRqL4Ccjx15vrT38sPtFTSVbtii5mySyhEImx5Hp00FS5R9sdNORx52OjuNSjO6wV9fL0FbeKoCDVp0s4HGjhf1nVNBT+VqMlS60i2HIr+ZoUtlw1US9AckEmHSWy4W12gmi4fuDdn92L8YzRql5D+oz7ieK3XNVUCU106AquhEDjR7nJxUaOG0x9d7u4hwh4TfOPffYcfNZ9oWH6lN6PHn4Mp0VAn4Tn1YaP5JIvuP91KG8zP2wYfjq01cTFqmmafwHUdfmX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},v=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create document"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,l.jsx)(s.p,{children:"Create document"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!",\n "result": {\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.2df63b7b.js b/assets/js/377084eb.2df63b7b.js deleted file mode 100644 index 425dc1e4a..000000000 --- a/assets/js/377084eb.2df63b7b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),o=a(5397),p=a(4667),c=a(9472),h=a(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:"eJytVt9v2zgM/lc0vmwF1Di97V78tOJaFMEVbbF2uIc0OCg2Hau1JU2i0wSB//cDFTt1k3a3Hu7JNsUfHynyozdAahEgncId1q5ShAFmEnIMmdeOtDWQAkiwDr3iz0kOKSyQenWQ4JRXNRJ69rMBo2qEFFbHyuljso9oQIJmPyWqHD1I8Pij0R5zSMk3KCHQumKboGtXsUtcucrmCGmhqsAKWYm1gnQDtHZRk7w2C2hZVUWjlDGaoBdmtFqtVtDKHRTqsP6t8x6KU1TCfp6TM2EL0WsLKhUJg5gHQVbMURRIWYn5/5mAhML6WtFWwhm1M3YfnDUBAxv8Nh7z4yXU0GQZhlA0ldhdDUjIrCE0xPrKuUpn8SB5CGy0OURh5w+YEd+hZzektyGvYt1+jnUrea5+iC+76vHVXFl6t5ubClVA4XGp8Ukokwu+UkGlDiK3WVNzeq2Es2E53hdid8HDkrYSvn+7fK+rksiFNEnWtvG6VgscZbZmXww6DsTOn/JerYfGU3iw+HVRK11FKwkPtjQDwUzCqq7YRdfHvVMJT14517dfK0ET1uE18M9QOVj31YV73XkrgTRVL0QtV6HK0fP0v69Cq4cwVycXanUT3byMmXlUhMOW6UPvn7Rs/GX85XASeiISxpIobGPyDxB1fz/UnZilqnQuTm8m4o6Z6cPHiKpGKm1HbJHQqIQUkj58shkwSAsSAvplT3eNrwaNoJwb9TxUqXngUifK6WR5AjzZAbPGa1rf8iRuh21IlIN2cfpP5H75VzrlBLQpbDTuynft0Nzy3HCmy5MDprvjcdIhHvdTFalCFNaLPWsxVwFzYXkKMR6y/PPoRASHmS46lhmJe3Nvbm2NognIzFRp8xjSe3MsptdFoTOtKvEXzoMmnH3qK/b09HRQsaNoc6GpbObCo7PP6osojGUdWu0+jkACoa/DdXGLfqmzfkzfCJVE5aTjTpVF7kSeQe7CrejrvhE3WKUzNAEH3Xx6cXMpPo/GIAdN8QuQk8vJH+dXt+fsldtqe0Uno/FozCJnA9XKDAJdID1vqflaTM72L3jzvAl4e3c9RbiixFVKR7qLGDdds093rAgS0uHCnEkobSBW2Wy4E777qm1Z/KNBv4Z0OpOwVF6reWS1DeQ68Hu+W35vQvv0rdujR+LXd++ryfRTY3hklqpqcJv5I673fgDaWSv70fnPaN+CsQ33clZ3aPiPZKtwmmXoaHB2sKyZK3asdHF+B237D1VpT+0=",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-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:"eJytVt9v2zgM/lc0vmwF1Di97V78tOJaFMEVbbF2uIc0OCg2Hau1JU2i0wSB//cDFTt1k3a3Hu7JNsUfHynyozdAahEgncId1q5ShAFmEnIMmdeOtDWQAkiwDr3iz0kOKSyQenWQ4JRXNRJ69rMBo2qEFFbHyuljso9oQIJmPyWqHD1I8Pij0R5zSMk3KCHQumKboGtXsUtcucrmCGmhqsAKWYm1gnQDtHZRk7w2C2hZVUWjlDGaoBdmtFqtVtDKHRTqsP6t8x6KU1TCfp6TM2EL0WsLKhUJg5gHQVbMURRIWYn5/5mAhML6WtFWwhm1M3YfnDUBAxv8Nh7z4yXU0GQZhlA0ldhdDUjIrCE0xPrKuUpn8SB5CGy0OURh5w+YEd+hZzektyGvYt1+jnUrea5+iC+76vHVXFl6t5ubClVA4XGp8Ukokwu+UkGlDiK3WVNzeq2Es2E53hdid8HDkrYSvn+7fK+rksiFNEnWtvG6VgscZbZmXww6DsTOn/JerYfGU3iw+HVRK11FKwkPtjQDwUzCqq7YRdfHvVMJT14517dfK0ET1uE18M9QOVj31YV73XkrgTRVL0QtV6HK0fP0v69Cq4cwVycXanUT3byMmXlUhMOW6UPvn7Rs/GX85XASeiISxpIobGPyDxB1fz/UnZilqnQuTm8m4o6Z6cPHiKpGKm1HbJHQqIQUkj58shkwSAsSAvplT3eNrwaNoJwb9TxUqXngUifK6WR5AjzZAbPGa1rf8iRuh21IlIN2cfpP5H75VzrlBLQpbDTuynft0Nzy3HCmy5MDprvjcdIhHvdTFalCFNaLPWsxVwFzYXkKMR6y/PPoRASHmS46lhmJe3Nvbm2NognIzFRp8xjSe3MsptdFoTOtKvEXzoMmnH3qK/b09HRQsaNoc6GpbObCo7PP6osojGUdWu0+jkACoa/DdXGLfqmzfkzfCJVE5aTjTpVF7kSeQe7CrejrvhE3WKUzNAEH3Xx6cXMpPo/GIAdN8QuQk8vJH+dXt+fsldtqe0Uno/FozCJnA9XKDAJdID1vqflaTM72L3jzvAl4e3c9RbiixFVKR7qLGDdds093rAgS0uHCnEkobSBW2Wy4E777qm1Z/KNBv4Z0OpOwVF6reWS1DeQ68Hu+W35vQvv0rdujR+LXd++ryfRTY3hklqpqcJv5I673fgDaWSv70fnPaN+CsQ33clZ3aPiPZKtwmmXoaHB2sKyZK3asdHF+B237D1VpT+0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template by ID"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\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:"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)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.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"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.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,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.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)(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)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.f92effd7.js b/assets/js/377084eb.f92effd7.js new file mode 100644 index 000000000..c8e00d480 --- /dev/null +++ b/assets/js/377084eb.f92effd7.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:()=>g,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1P4zgQ/1d887RI3jawRSfladGBUHUI0MLqHqBCbjJpDInttZ3Sqsr/fhrno6GFXTid9qnNeD5+8z0b8GLhIL6DWyxNITw6mHFI0SVWGi+1ghiAgzZoBX1OU4hhgb5jBw5GWFGiR0t6NqBEiRDD6rMw8rPXT6iAgyQ9OYoULXCw+KOSFlOIva2Qg/PrgmScLE1BKnFlCp0ixJkoHDEkOZYC4g34tQmc3kq1gJpYRRCKCaNycqFGq9VqBTXvofgW64NMOyhG+Bx2/ZyeMp2xjpv5XHimEFPHvGZzZBn6JMf0/3SAQ6ZtKXxDIY/qGal3RiuHjgSOooh+XkJ1VZKgc1lVsD41wCHRyqPyxC+MKWQSHsaPjoQ2+yj0/BETTzm0pMbLxmQSoPdcqirnIW99rI+iqA4wq8L/Wt1lSMPPXW8o22S68KdPBmX6UvsPq7kuUDhkFpcSn5lQKaMKYT6XjqU6qUqKVs3hdBjdj5no62WYoZrD928XH1WVe29cPB6vdWVlKRY4SnRJugh06K9en7BWrIfCd/Co8euiFLIIUhweda4GhBmHVVmQirYtOqUcnq0wpqvmmoP0WLrXwG+hkrH2qzX3uvKag5e+eEGqKQpFipaGyccitHp0c3F4LlbXQc1Lm4lF4XFYMp3p3ZfBk1SFVPjQtdzDURQ9/Al1TTyTaLLfet3kY0p7lulKpX/8xs6bRJOaQ4nOicWr3bCN1WtAf+b5JJo8HPeeH+97PlVLUciUnVxP2S0N9t/r+PF7HR/i9A3O/WKRDVOzoF5EZUhvolGiz3W7+MLC8znEMO7qabwZbJgaODi0y24dVrYYdLYwZtTtqULMHfXOWBg5Xh4CTX6HSWWlX99Q2JrIDBfpoP+N/BtpAPxy3ZIDUmU6CLdOXhlUNzQIKUTLw71NeEvzUbrw3I3JkFeWact2pNlcOEyZprGK4ZHoX0aHzBlMZNaWxIjdq3t1o0tklUPaXIVUTy6+V5/Z3VWWyUSKgv2Dcyc9zj51EXt+ft6L2EGQOZc+r+bMotFb9kUghrAOpfqPA+Dg0ZbuKrtBu5RJN3ffMDUOzOO20EUSCh1pqNJYaUhfd4WongqZoHI4qLiT8+sL9mUUAR8UxTsgjy+mf51d3pyRViqrJkWHo2gUEclo50uhBobO0W+vmPmaTU93E7zZti1dd21NeVz5sSmEDA0RMG7aYr/r1xxwiIcH1YxDrp0nls2GKuG7LeqayD8qtGuI72YclsJKMQ9ragOpdPQ/7Y+jN6F9+tbeWQfs/bfZq850XaOoZZaiqLDx/AnXOwdiPat51zr/Ge1bMBpzL3u1R0MXa8NwkiRo/OBtb7LSrOin0vnZLdT1v4mSCwg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,u={id:"API-docs/get-template",title:"Get template by ID",description:"",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vt1P4zgQ/1d887RI3jawRSfladGBUHUI0MLqHqBCbjJpDInttZ3Sqsr/fhrno6GFXTid9qnNeD5+8z0b8GLhIL6DWyxNITw6mHFI0SVWGi+1ghiAgzZoBX1OU4hhgb5jBw5GWFGiR0t6NqBEiRDD6rMw8rPXT6iAgyQ9OYoULXCw+KOSFlOIva2Qg/PrgmScLE1BKnFlCp0ixJkoHDEkOZYC4g34tQmc3kq1gJpYRRCKCaNycqFGq9VqBTXvofgW64NMOyhG+Bx2/ZyeMp2xjpv5XHimEFPHvGZzZBn6JMf0/3SAQ6ZtKXxDIY/qGal3RiuHjgSOooh+XkJ1VZKgc1lVsD41wCHRyqPyxC+MKWQSHsaPjoQ2+yj0/BETTzm0pMbLxmQSoPdcqirnIW99rI+iqA4wq8L/Wt1lSMPPXW8o22S68KdPBmX6UvsPq7kuUDhkFpcSn5lQKaMKYT6XjqU6qUqKVs3hdBjdj5no62WYoZrD928XH1WVe29cPB6vdWVlKRY4SnRJugh06K9en7BWrIfCd/Co8euiFLIIUhweda4GhBmHVVmQirYtOqUcnq0wpqvmmoP0WLrXwG+hkrH2qzX3uvKag5e+eEGqKQpFipaGyccitHp0c3F4LlbXQc1Lm4lF4XFYMp3p3ZfBk1SFVPjQtdzDURQ9/Al1TTyTaLLfet3kY0p7lulKpX/8xs6bRJOaQ4nOicWr3bCN1WtAf+b5JJo8HPeeH+97PlVLUciUnVxP2S0N9t/r+PF7HR/i9A3O/WKRDVOzoF5EZUhvolGiz3W7+MLC8znEMO7qabwZbJgaODi0y24dVrYYdLYwZtTtqULMHfXOWBg5Xh4CTX6HSWWlX99Q2JrIDBfpoP+N/BtpAPxy3ZIDUmU6CLdOXhlUNzQIKUTLw71NeEvzUbrw3I3JkFeWact2pNlcOEyZprGK4ZHoX0aHzBlMZNaWxIjdq3t1o0tklUPaXIVUTy6+V5/Z3VWWyUSKgv2Dcyc9zj51EXt+ft6L2EGQOZc+r+bMotFb9kUghrAOpfqPA+Dg0ZbuKrtBu5RJN3ffMDUOzOO20EUSCh1pqNJYaUhfd4WongqZoHI4qLiT8+sL9mUUAR8UxTsgjy+mf51d3pyRViqrJkWHo2gUEclo50uhBobO0W+vmPmaTU93E7zZti1dd21NeVz5sSmEDA0RMG7aYr/r1xxwiIcH1YxDrp0nls2GKuG7LeqayD8qtGuI72YclsJKMQ9ragOpdPQ/7Y+jN6F9+tbeWQfs/bfZq850XaOoZZaiqLDx/AnXOwdiPat51zr/Ge1bMBpzL3u1R0MXa8NwkiRo/OBtb7LSrOin0vnZLdT1v4mSCwg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},j={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"createtemplate"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "result": {\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.1bf4c76e.js b/assets/js/52d5c0f9.1bf4c76e.js new file mode 100644 index 000000000..4533951c1 --- /dev/null +++ b/assets/js/52d5c0f9.1bf4c76e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>y,contentTitle:()=>x,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),d=a(58219),t=(a(62316),a(51039)),i=a.n(t),r=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1P4zgU/Sve+zRIoQlQXqLVatCCRtWgBW1Z7QNUyE1uGg+J7bGd0irKfx9d54O0hRlmtZqXNrHvtc859ys1OL6yEN/DpUqqEqWzsAggRZsYoZ1QEmJIsUCHjLO0s4EAlEbDaX+WDhajbc0NL9GhobNrkLxEiGFzzLU4duoJJQQg6OwceYoGAjD4tRIGU4idqTAA67YF+VhR6gIhANzoQqUIccYLSwZJjiWHuAa31d7SGSFX0JAp904xwZRWrORks9lsoAkGKD3WR5H2UDR3OexzvzVqLVJkavkFEzdLmcoGGZhTrGX+f+IPIFOm5G688kJI56fL/JTbFJpmQbdaraRFS+ecRhH97RLo49ohTZmtkgStzaqi2P4GASRKOgpaXAPXuhCJD2v4xZJ7fQizVYJibCgJnGgvTzy3wUpW5dLHdYB+GkVNACVay1f4Gu0Xkj/A3DQBOOG8qZCFkPjY6/B4GkWP59A0ZDONpt/RQyrHMlXJ9FeKMI2mPy3CCOj3mE+j6ePZwPz8kPlMrnkhUnZxO2N3VIO/lvj5e4mPcboWJ3HalAX5dfUrWqO2l+yoMl5v1bCYVEa4rW9F4x4U3y+oiEp0uXppY759uRxiCPtKD+tRv2iAjjTrvrlVpqBG5py2cRhyrSd91yn40k4SVYZci3B9AnRZD2ZOyrbi7UAalOFafMYtBD9unsRRyEx5506HG41yLlbSq7g+Oehrd7mwTFi/3XPzoWeZMmzPmy25xZQpyVyOfpPWzyYnzGpMRNZlzYQ9yAc5VyWyymJWFawQ8snGD/KY3d9kmUgEL9i/uLTC4eJDr9jz8/OBYkfe55NwebVkBrV6MV/5RS/r2Gt4OYIAHJrS3mRzNGuRYBedN64KvXHY1QJPfC1gyQVFtVv6uO9EKVeIBKXFUVJefLq9ZmeTCIJRUrwDcng9+/Pqr/kVnUpp1YboZBJNIlrSyrqSy9FFl+1EHgbRcstml/sxrl+K+9UR3uWZw40LdcGFryOPu+4K4B5G5vF4ZC4CyJV1ZFLXlB3/mKJpaPlrhYYqbRHAmhvBl5SO9zWkwtJzOsy/N7F++LsbpUfs3dP3VS59IUmqojUvKnqDAJ5wu/cF0CyaoK+m/wz2LRjtdbvlO6ChT5LW4CJJULvR3kE/3ulVl1fXV3dXEACvKFTjtvHk20b3QHReFWIXUIuBfgnRqw6/U9F/xu0fg3m786bD8G3XWpMai6ZpvgGx3JPf",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1P4zgU/Sve+zRIoQlQXqLVatCCRtWgBW1Z7QNUyE1uGg+J7bGd0irKfx9d54O0hRlmtZqXNrHvtc859ys1OL6yEN/DpUqqEqWzsAggRZsYoZ1QEmJIsUCHjLO0s4EAlEbDaX+WDhajbc0NL9GhobNrkLxEiGFzzLU4duoJJQQg6OwceYoGAjD4tRIGU4idqTAA67YF+VhR6gIhANzoQqUIccYLSwZJjiWHuAa31d7SGSFX0JAp904xwZRWrORks9lsoAkGKD3WR5H2UDR3OexzvzVqLVJkavkFEzdLmcoGGZhTrGX+f+IPIFOm5G688kJI56fL/JTbFJpmQbdaraRFS+ecRhH97RLo49ohTZmtkgStzaqi2P4GASRKOgpaXAPXuhCJD2v4xZJ7fQizVYJibCgJnGgvTzy3wUpW5dLHdYB+GkVNACVay1f4Gu0Xkj/A3DQBOOG8qZCFkPjY6/B4GkWP59A0ZDONpt/RQyrHMlXJ9FeKMI2mPy3CCOj3mE+j6ePZwPz8kPlMrnkhUnZxO2N3VIO/lvj5e4mPcboWJ3HalAX5dfUrWqO2l+yoMl5v1bCYVEa4rW9F4x4U3y+oiEp0uXppY759uRxiCPtKD+tRv2iAjjTrvrlVpqBG5py2cRhyrSd91yn40k4SVYZci3B9AnRZD2ZOyrbi7UAalOFafMYtBD9unsRRyEx5506HG41yLlbSq7g+Oehrd7mwTFi/3XPzoWeZMmzPmy25xZQpyVyOfpPWzyYnzGpMRNZlzYQ9yAc5VyWyymJWFawQ8snGD/KY3d9kmUgEL9i/uLTC4eJDr9jz8/OBYkfe55NwebVkBrV6MV/5RS/r2Gt4OYIAHJrS3mRzNGuRYBedN64KvXHY1QJPfC1gyQVFtVv6uO9EKVeIBKXFUVJefLq9ZmeTCIJRUrwDcng9+/Pqr/kVnUpp1YboZBJNIlrSyrqSy9FFl+1EHgbRcstml/sxrl+K+9UR3uWZw40LdcGFryOPu+4K4B5G5vF4ZC4CyJV1ZFLXlB3/mKJpaPlrhYYqbRHAmhvBl5SO9zWkwtJzOsy/N7F++LsbpUfs3dP3VS59IUmqojUvKnqDAJ5wu/cF0CyaoK+m/wz2LRjtdbvlO6ChT5LW4CJJULvR3kE/3ulVl1fXV3dXEACvKFTjtvHk20b3QHReFWIXUIuBfgnRqw6/U9F/xu0fg3m786bD8G3XWpMai6ZpvgGx3JPf",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},y={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete document by ID"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a document"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(d.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document deleted successfully!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Document deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.ae8aa607.js b/assets/js/52d5c0f9.ae8aa607.js deleted file mode 100644 index cb1a6a3b1..000000000 --- a/assets/js/52d5c0f9.ae8aa607.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,d,t)=>{t.r(d),t.d(d,{assets:()=>p,contentTitle:()=>m,default:()=>j,frontMatter:()=>o,metadata:()=>u,toc:()=>h});var s=t(85893),n=t(11151),a=t(58219),i=(t(62316),t(51039)),l=t.n(i),r=(t(82723),t(9487),t(41429)),c=(t(5397),t(4667),t(9472),t(85162));const o={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:"eJytVVFv2zgM/isan1ZAjdNu92IMww3XYAhWrMWlhz2kwaDYdKxVljRJThMY/u8HKrbrpO3dcLiXxKY+ih/Jj3QDQWw8pEu4MlldoQ4eVhxy9JmTNkijIYUcFQZkguUdBjgYi07Q+TwfEKNjK5yoMKCjuxvQokJIYXcurDwP5gE1cJB0d4kiRwccHP6spcMc0uBq5ODDXpGPl5VVCBxwZ5XJEdJCKE+ArMRKQNpA2NuIDE7qDbQEFdEpJZray42e7Ha7HbR8oNJz/S7znooVoYTT3G+d2cocmVn/wCzMc2aKoQwsGHbI/P/kz6EwrhJhbHlKyJaX6/JS+BzadkVRvTXao6d7LqdT+jtOoO9rxzRnvs4y9L6oldq/oWq9n77/BzdtAitMrfMO+9tz7FxvhZI5+3Q7Z3fU3DfQthw8ZrWTYR8VMG59ulwR9wpDaZ7UE1UTSkgh6QucNKM2tUBXum2vqdop0k8I1qdJIqyd9M1WYu0nmakSYWWyvQAK1pNZUNUP5TqiNHRBWPkF98D/XbOUo9SFic4yxPbcWNQLudGxFtuLZ3K6K6Vn0sfjPrc4Rqwwjp14s7XwmDOjWSgxHpL93eSCeYuZLGQWXSfsXt/rhamQ1R6LWjEl9YNP7/U5W94UhcykUOwbrr0MuHrbV+zx8fFZxc6iz2cZynrNHFrzBN9EYyzr2Gt4OQMOAV3lb4oFuq3MsOvOK6GSCE6AQ2Z0EFmgMmIlJHW1M/1+6kQSVDJD7ZHgXYs+fb69Zu8mU+AjUfwC5eR6/sfs62JGt5KsDi26mEwnUzJZ40Ml9CjQ1WERDvO/3rP51WmPm8ie1uDLm7PTWcBdSKwSUlOsyLvpBmAJI3g63lQrDqXxgSBNQ+r4y6m2JfPPGh1N2orDVjgp1iTHZQO59PScD2vnVa5v/+w22Bn75aX3Yi79IGmaoq1QNb0BhwfcnyzedtXyfpr+M9nXaBzCHY/vwOZo/1zNrmd3M+Agair/eBU8xFXQPRDFF5M7DnIITL/0vXnR4QMN8hfcfxzgh5NXHYbP5AFNGa7atv0bBQGkSQ==",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:"eJytVVFv2zgM/isan1ZAjdNu92IMww3XYAhWrMWlhz2kwaDYdKxVljRJThMY/u8HKrbrpO3dcLiXxKY+ih/Jj3QDQWw8pEu4MlldoQ4eVhxy9JmTNkijIYUcFQZkguUdBjgYi07Q+TwfEKNjK5yoMKCjuxvQokJIYXcurDwP5gE1cJB0d4kiRwccHP6spcMc0uBq5ODDXpGPl5VVCBxwZ5XJEdJCKE+ArMRKQNpA2NuIDE7qDbQEFdEpJZray42e7Ha7HbR8oNJz/S7znooVoYTT3G+d2cocmVn/wCzMc2aKoQwsGHbI/P/kz6EwrhJhbHlKyJaX6/JS+BzadkVRvTXao6d7LqdT+jtOoO9rxzRnvs4y9L6oldq/oWq9n77/BzdtAitMrfMO+9tz7FxvhZI5+3Q7Z3fU3DfQthw8ZrWTYR8VMG59ulwR9wpDaZ7UE1UTSkgh6QucNKM2tUBXum2vqdop0k8I1qdJIqyd9M1WYu0nmakSYWWyvQAK1pNZUNUP5TqiNHRBWPkF98D/XbOUo9SFic4yxPbcWNQLudGxFtuLZ3K6K6Vn0sfjPrc4Rqwwjp14s7XwmDOjWSgxHpL93eSCeYuZLGQWXSfsXt/rhamQ1R6LWjEl9YNP7/U5W94UhcykUOwbrr0MuHrbV+zx8fFZxc6iz2cZynrNHFrzBN9EYyzr2Gt4OQMOAV3lb4oFuq3MsOvOK6GSCE6AQ2Z0EFmgMmIlJHW1M/1+6kQSVDJD7ZHgXYs+fb69Zu8mU+AjUfwC5eR6/sfs62JGt5KsDi26mEwnUzJZ40Ml9CjQ1WERDvO/3rP51WmPm8ie1uDLm7PTWcBdSKwSUlOsyLvpBmAJI3g63lQrDqXxgSBNQ+r4y6m2JfPPGh1N2orDVjgp1iTHZQO59PScD2vnVa5v/+w22Bn75aX3Yi79IGmaoq1QNb0BhwfcnyzedtXyfpr+M9nXaBzCHY/vwOZo/1zNrmd3M+Agair/eBU8xFXQPRDFF5M7DnIITL/0vXnR4QMN8hfcfxzgh5NXHYbP5AFNGa7atv0bBQGkSQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},p={},h=[{value:"Request",id:"request",level:2}];function x(e){const d={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:t}=d;return t||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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(d.p,{children:"Delete document by ID"})}),"\n",(0,s.jsx)(l(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,s.jsx)(d.p,{children:"delete a document"}),"\n",(0,s.jsx)(d.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)(d.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,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)(d.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)(a.Z,{children:[(0,s.jsxs)(c.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(d.p,{children:"Document deleted successfully!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(c.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(d.p,{children:"Document not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(c.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(d.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function j(e={}){const{wrapper:d}={...(0,n.a)(),...e.components};return d?(0,s.jsx)(d,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.81ba9e18.js b/assets/js/5a2de241.81ba9e18.js deleted file mode 100644 index 81c46c1f1..000000000 --- a/assets/js/5a2de241.81ba9e18.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>u,contentTitle:()=>h,default:()=>j,frontMatter:()=>c,metadata:()=>b,toc:()=>x});var s=t(85893),l=t(11151),i=t(58219),n=(t(62316),t(51039)),d=t.n(n),r=(t(82723),t(9487)),p=t(41429),m=(t(5397),t(4667)),o=(t(9472),t(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:"eJytVk1v2zgQ/SvEnFKAsWw0J52226SBsUVi1An2YBsBJY5sJhLJkpQ/YOi/L4a2HNlO0GZRn2RqPt5w3rzRFoKYe0gn8ICVLUVADzMOxqITQRk9lJBCbaUI2BoAByucqDCgI88taFEhpLC+FFZdBvOCGjgoDSksUEh0wMHhz1o5lJAGVyMHHzYl+XhV2ZJC4tqWRiKkhSg9GeQLrASkWwgbGy2DU3oODZmK6JQSTO3VXPfW6/UaGn6AEvZYn5RsoVgRFsBBos+dslQbpDC8ZqZgYYHMOImOhYUITCNKz4JhGbJd6fJPVsChMK4SoVNTM9vFRx/+NnJDPsc4rTNLJZFlWJoVO1w/gdwhZG3Fnl2IwEoUPjCjsWPbFvAJOORGB9SBEglrS5XHZifPnrJtz6Gb7BnzQJ13RI2g0NPbu3jbvy6w2zMfHw54qaF3Jnw4zIhKROZwqXDFhJaMiMDCQnkmTV5XVF7D4bp7jx9L0UJk3V40HL6ZUqKjyfhYvPWzz8TgVqxH0DQcggpHaZ46pH3KiAZNQ3YOvTXa7278qt8/Z8dQL0WpJBteM19TO1ESzqv+1bntfeS5NoEVptYyIjm2eDwmFMs2bHgNHCoMC0NyYOvIBJqnFJLWLtl28DfAwaNbtgpRu5LUIATr0yQR1vba0S1F5nu5qRJhVbIcAI2Cx7x2KmzGRMNd3V1teb12YdU/uAH+awWiMondP16n7KZtTMvjM2q2zPw9sp1w7W36dNlzRAiCW5hY254X9xb1mNJ8GQ3ZcnCmXQ+UXfn4ugURx5gVxrETb5YJj5IZHcWOXtL5596AeYu5KvYK0GNTPdVjUyGrPRZ1yUqlX3w61Zdscl8UKleiZP9i5lXA2UXb0NVqddbQT9HnVoVFnTGH1ryaz+Nh7HrX6/CHFCqgq/x9MUa3VDnuyfNOqiQaJ3tdE3nUNayEItLtj/46daIrL1WO2kcK7Bn05Xb0nX3u9YF3OPsbkJPvw683d+Mbikqs37Vo0Ov3+nRkjQ+V0J1E702ZfFOvAq5DYkuhogBFZNv9BE6gw9e0u/hmHBbGBzLZbqn/j65sGjr+WaPbQDqZcVgKp0RGhJtsQSpPz/Kww07QHNYGXPxotwn7wA59s5p2ljUN8lKUNf0DDi+4Odnkzazh7UD/b7jvwdilO1aQAxr6tNgZfN3FvHygGK8WZ1uUdOygmKPHB+CQ7Vd7Fb8SwIkVfVaIFaQwhSmVbCL0KHjxfAul0PNazMl+F5Z+/wGCblmK",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,b={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:"eJytVk1v2zgQ/SvEnFKAsWw0J52226SBsUVi1An2YBsBJY5sJhLJkpQ/YOi/L4a2HNlO0GZRn2RqPt5w3rzRFoKYe0gn8ICVLUVADzMOxqITQRk9lJBCbaUI2BoAByucqDCgI88taFEhpLC+FFZdBvOCGjgoDSksUEh0wMHhz1o5lJAGVyMHHzYl+XhV2ZJC4tqWRiKkhSg9GeQLrASkWwgbGy2DU3oODZmK6JQSTO3VXPfW6/UaGn6AEvZYn5RsoVgRFsBBos+dslQbpDC8ZqZgYYHMOImOhYUITCNKz4JhGbJd6fJPVsChMK4SoVNTM9vFRx/+NnJDPsc4rTNLJZFlWJoVO1w/gdwhZG3Fnl2IwEoUPjCjsWPbFvAJOORGB9SBEglrS5XHZifPnrJtz6Gb7BnzQJ13RI2g0NPbu3jbvy6w2zMfHw54qaF3Jnw4zIhKROZwqXDFhJaMiMDCQnkmTV5XVF7D4bp7jx9L0UJk3V40HL6ZUqKjyfhYvPWzz8TgVqxH0DQcggpHaZ46pH3KiAZNQ3YOvTXa7278qt8/Z8dQL0WpJBteM19TO1ESzqv+1bntfeS5NoEVptYyIjm2eDwmFMs2bHgNHCoMC0NyYOvIBJqnFJLWLtl28DfAwaNbtgpRu5LUIATr0yQR1vba0S1F5nu5qRJhVbIcAI2Cx7x2KmzGRMNd3V1teb12YdU/uAH+awWiMondP16n7KZtTMvjM2q2zPw9sp1w7W36dNlzRAiCW5hY254X9xb1mNJ8GQ3ZcnCmXQ+UXfn4ugURx5gVxrETb5YJj5IZHcWOXtL5596AeYu5KvYK0GNTPdVjUyGrPRZ1yUqlX3w61Zdscl8UKleiZP9i5lXA2UXb0NVqddbQT9HnVoVFnTGH1ryaz+Nh7HrX6/CHFCqgq/x9MUa3VDnuyfNOqiQaJ3tdE3nUNayEItLtj/46daIrL1WO2kcK7Bn05Xb0nX3u9YF3OPsbkJPvw683d+Mbikqs37Vo0Ov3+nRkjQ+V0J1E702ZfFOvAq5DYkuhogBFZNv9BE6gw9e0u/hmHBbGBzLZbqn/j65sGjr+WaPbQDqZcVgKp0RGhJtsQSpPz/Kww07QHNYGXPxotwn7wA59s5p2ljUN8lKUNf0DDi+4Odnkzazh7UD/b7jvwdilO1aQAxr6tNgZfN3FvHygGK8WZ1uUdOygmKPHB+CQ7Vd7Fb8SwIkVfVaIFaQwhSmVbCL0KHjxfAul0PNazMl+F5Z+/wGCblmK",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={},x=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,s.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"Update template by 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)(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:"string",format:"string"}}})})})]}),"\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)(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,s.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,s.jsx)(o.default,{label:"application/json",value:"application/json-schema",children:(0,s.jsxs)(t,{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)(a.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)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,s.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,s.jsx)(m.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,s.jsx)(m.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)(o.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid ID supplied"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(o.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Order not found"})}),(0,s.jsx)("div",{})]})]})})})]})}function j(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.e12965bb.js b/assets/js/5a2de241.e12965bb.js new file mode 100644 index 000000000..0aeb7bb37 --- /dev/null +++ b/assets/js/5a2de241.e12965bb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>b});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),m=s.n(t),r=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const x={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu4zYQ/RV2nrKAYjtZb1HoqekmzRpdJMYmQR8Sw6Ckkc2EIrkk5QsM/XsxulmOc9m0QddPMjVDzjlnhjPagOczB+EtXGNmJPfoYBKANmi5F1qNEgghNwn32BhAAIZbnqFHS54bUDxDCGF1yI049PoBFQQgFIQwR56ghQAsfs+FxQRCb3MMwPm1JB8nMiNpS1wZqROEMOXSkUE8x4xDuAG/NqWlt0LNoCBTXjqFFKZyYqZ6q9VqBUXQhuLrWKciaUIx3M8hgARdbIUhbBDC6JTplPk5ssaD+Tn3TCEmjnnNImQV+uQ9QQSQaptx34FVTKr90fk/dLImn91QjdULkSCLUOolaxWgIKsIWwiOHXDPJHLnmVbYsW0AfIAAYq08Kk8HcWOkiEu9+/eOTtvsh66je4w9iW8pO7xAR28vSsJfB9iVzZUPbbyk6YX2b95mTBCRWVwIXDKuEka5wPxcOJboOM8IXhHAaZfHtx3RZkVXiyKAP7VM0FJxvG2/1b2L+NE5X42hKALwwu8cM+3k7TSiNCgKsrPojFauYvx4MNjPjqY4m2xlLo9jdC7NpVz/8n5yx2V6t1Yqz6KyvlvQ7UoL+ngwKALI0Dk+e7PGHVwNrAYVVMTk0r8edrX8tF7bw7hLjr+48fCL2VFHKCkUThsRpseDwfS3aX30q4a1hMOnVKszuCntBZciYalAmTC6yNzPFW74X4R7HdpLzBFbDW/DF7Jdac9SnavkZzM1fIcU74B5mZvh9NeWnU/77IxUxfbJeMSuqRv/D+R0qPj0MhVb4N04fRUnYVplkvzqTi4qo2qq2GGlu16xsUvDzW5XZNGajU6BYvNzTWONyUt8NBeE0G/s+pvOJVxAAA7topl0citpqvHeuLDf58b0mhFE8sj1Yp31uRH9xRFQP3cY51b49RWRW/HXnZG25HAj/sI1BK9PUgSTNPu2HRXOGkKbZrzXX5v2+mMd81HDfLoHdlvgTlejcFNdYquVujSorugY0nlxtDeDXdPpwpWvmyDK5GSptuyRN4u4w4RpVQ5t9JLWP/aOmDMYi7TO6x67U3fqSmfIcodpLpkU6sGFd+qQ3V6mqYgFl+xvjJzwODloBF0ul3uCfih9zoWf5xGzaPTWfFYulqp3vdo/NGZ5tJm7TK/QLkSMdfI8c1S/NO7X1crjslox44KSrl76/bETUS5FjMphp2xOzsdf2cfeAIJOzv5AyP2vo89nF1dntCtlfSXRUW/QG9CS0c5nXHUOeq7KkieHLo8r3zeSi7KWy8g2dQXeQidfw+4APwlgrp0nk82G9L+xsiho+XuOdg3h7SSABbeCR5RwtxtIhKPnpB3EH0XTXoZw8K0ZidnbvgWeBNSUs6JaXnCZ0z8I4AHXjz5KikkRNDX9ryN+LozquN1LpI2GvpIqg8/VnofXtMfWYq89bD1O4hiNf9F20rlgxzfXEEBUf85kZesAy5f0KcWXEMId3BE9uoRZ3o/l+gYkV7O8bCBQbUu/fwB7wA/6",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/update-template",title:"Update template by ID",description:"Update template by ID",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu4zYQ/RV2nrKAYjtZb1HoqekmzRpdJMYmQR8Sw6Ckkc2EIrkk5QsM/XsxulmOc9m0QddPMjVDzjlnhjPagOczB+EtXGNmJPfoYBKANmi5F1qNEgghNwn32BhAAIZbnqFHS54bUDxDCGF1yI049PoBFQQgFIQwR56ghQAsfs+FxQRCb3MMwPm1JB8nMiNpS1wZqROEMOXSkUE8x4xDuAG/NqWlt0LNoCBTXjqFFKZyYqZ6q9VqBUXQhuLrWKciaUIx3M8hgARdbIUhbBDC6JTplPk5ssaD+Tn3TCEmjnnNImQV+uQ9QQSQaptx34FVTKr90fk/dLImn91QjdULkSCLUOolaxWgIKsIWwiOHXDPJHLnmVbYsW0AfIAAYq08Kk8HcWOkiEu9+/eOTtvsh66je4w9iW8pO7xAR28vSsJfB9iVzZUPbbyk6YX2b95mTBCRWVwIXDKuEka5wPxcOJboOM8IXhHAaZfHtx3RZkVXiyKAP7VM0FJxvG2/1b2L+NE5X42hKALwwu8cM+3k7TSiNCgKsrPojFauYvx4MNjPjqY4m2xlLo9jdC7NpVz/8n5yx2V6t1Yqz6KyvlvQ7UoL+ngwKALI0Dk+e7PGHVwNrAYVVMTk0r8edrX8tF7bw7hLjr+48fCL2VFHKCkUThsRpseDwfS3aX30q4a1hMOnVKszuCntBZciYalAmTC6yNzPFW74X4R7HdpLzBFbDW/DF7Jdac9SnavkZzM1fIcU74B5mZvh9NeWnU/77IxUxfbJeMSuqRv/D+R0qPj0MhVb4N04fRUnYVplkvzqTi4qo2qq2GGlu16xsUvDzW5XZNGajU6BYvNzTWONyUt8NBeE0G/s+pvOJVxAAA7topl0citpqvHeuLDf58b0mhFE8sj1Yp31uRH9xRFQP3cY51b49RWRW/HXnZG25HAj/sI1BK9PUgSTNPu2HRXOGkKbZrzXX5v2+mMd81HDfLoHdlvgTlejcFNdYquVujSorugY0nlxtDeDXdPpwpWvmyDK5GSptuyRN4u4w4RpVQ5t9JLWP/aOmDMYi7TO6x67U3fqSmfIcodpLpkU6sGFd+qQ3V6mqYgFl+xvjJzwODloBF0ul3uCfih9zoWf5xGzaPTWfFYulqp3vdo/NGZ5tJm7TK/QLkSMdfI8c1S/NO7X1crjslox44KSrl76/bETUS5FjMphp2xOzsdf2cfeAIJOzv5AyP2vo89nF1dntCtlfSXRUW/QG9CS0c5nXHUOeq7KkieHLo8r3zeSi7KWy8g2dQXeQidfw+4APwlgrp0nk82G9L+xsiho+XuOdg3h7SSABbeCR5RwtxtIhKPnpB3EH0XTXoZw8K0ZidnbvgWeBNSUs6JaXnCZ0z8I4AHXjz5KikkRNDX9ryN+LozquN1LpI2GvpIqg8/VnofXtMfWYq89bD1O4hiNf9F20rlgxzfXEEBUf85kZesAy5f0KcWXEMId3BE9uoRZ3o/l+gYkV7O8bCBQbUu/fwB7wA/6",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update template by ID"})}),"\n",(0,l.jsx)(m(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:200}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template upated sucessfully"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}})})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template upated sucessfully",\n "result": {\n "objectId": "asd2HsP4Hp"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:400}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 400,\n "message": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:404}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.c77fc495.js b/assets/js/770b40a9.c77fc495.js new file mode 100644 index 000000000..ad40e1979 --- /dev/null +++ b/assets/js/770b40a9.c77fc495.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),d=s(5397),p=s(4667),o=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnZ3YtOzaZpGnSxCdYuerCNgJJGNhOK5JKUY8PQfy+G+rBip3FaFPXF9nAeOfPmzZA7cGxpIZnBFEstmEMLixCURsMcV/I2hwSW6Fy7Krh1EIJmhpXo0BB0B5KVCAlszpnm5049oYQQuIQEVshyNBCCwR8VN5hD4kyFIVi3FYSxvNQCIQTcaKFyhKRgwpJDtsKSQbIDt9Xe0xkul1CTK/OghOKUli/laLPZbKBeNOegdV9UviVspqRD6egn01rwzGcVPVolyXZ0iEofMfMZGuLAcbS0KnjJ3cBNVmXq0yqUKZkbWvrgxnEdgn3i+h/i4roOYVMKgrXEEuspZVSH4LgTL201AQxaraRtwr2IY/rK0WaGa8qY+KuyDK0tKhH05YXwv2Io87U7TrRP6yKOmzArMWSSGcO2pBaHpT19TGMmVR7qYsBpb9kLZTP+LZWlvbj3AvqVC3xth73/yjltkyjqdF9ZNKNMlYT+5ovyFtr6H0EH9iDlToA670CqBvLLsHzvQ1JklJ8S1HVvggrv00MmfCl9O//bypxm5VEh1AMFd2E/dGfT4pVB5vDL9p0ZZ+SuujSOGmdYgcNjoR4Gw6XgEh+6Nnq4iOOHcdw216f483E/3co1EzwPLu9vgynNvJ/+x276FH+uQyjRWrY8QfswTtfEeUwUb5ya2f2ClqG9YeMlDTfoeqEH7fVQolspujm0aq8Lt4IEooNbxKJZd1dIZcSg7ZjWo262C5Zaar2IaR6tx37KW8wqw912Qnw2lA0vn4GINf8dScUnryjKjMr0fX+BXHcc9hfAOO5GOg0zLgvlz2rJutMoScue6vUYDqmarrgNuPXLucqqEqXz+ggKZYIDdJAyi3mgZOBW6BfJ/nE0DqzGjBettEbBXM7lRJUYVBZpuAsun2wyl+fB7K4oeMaZCP7E1HKHiw8dwc/Pz0cEn3nMDXerKg0MarV3X3qjr8IQ1f85gxAcmtLeFRM0a551M/Rvjoq8c9Q2DMt8w2DJOImgNf18CCJdCp6htDhQ7uXN/dfg4yiGcKChd4Qcfb29uv42uaZdSYVNicajeBSTiZRbMjk46DWh56+OaIcbF2nBuG8lH9Wu7YEZvOiBRQgrapFkBrsdFfwPI+qazD8qNFtIZosQ1sxwlpLCZos67PRKTZNzSwt5/2g6iKefRvDhe/v+OguoVK/F+YTbowZZM1GRJ9ThrnW4avY8n9Iee4+jabdHXGYZavem72IwM+7vJlMIIW1fcKUfhWDYM70i2TMkMIc5AD1SaQff/N6+A8HksvIDEZp96fMXx6q8PA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get template list",description:"Get template list",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvqnDaAYsnZ3YtOzaZpGnSxCdYuerCNgJJGNhOK5JKUY8PQfy+G+rBip3FaFPXF9nAeOfPmzZA7cGxpIZnBFEstmEMLixCURsMcV/I2hwSW6Fy7Krh1EIJmhpXo0BB0B5KVCAlszpnm5049oYQQuIQEVshyNBCCwR8VN5hD4kyFIVi3FYSxvNQCIQTcaKFyhKRgwpJDtsKSQbIDt9Xe0xkul1CTK/OghOKUli/laLPZbKBeNOegdV9UviVspqRD6egn01rwzGcVPVolyXZ0iEofMfMZGuLAcbS0KnjJ3cBNVmXq0yqUKZkbWvrgxnEdgn3i+h/i4roOYVMKgrXEEuspZVSH4LgTL201AQxaraRtwr2IY/rK0WaGa8qY+KuyDK0tKhH05YXwv2Io87U7TrRP6yKOmzArMWSSGcO2pBaHpT19TGMmVR7qYsBpb9kLZTP+LZWlvbj3AvqVC3xth73/yjltkyjqdF9ZNKNMlYT+5ovyFtr6H0EH9iDlToA670CqBvLLsHzvQ1JklJ8S1HVvggrv00MmfCl9O//bypxm5VEh1AMFd2E/dGfT4pVB5vDL9p0ZZ+SuujSOGmdYgcNjoR4Gw6XgEh+6Nnq4iOOHcdw216f483E/3co1EzwPLu9vgynNvJ/+x276FH+uQyjRWrY8QfswTtfEeUwUb5ya2f2ClqG9YeMlDTfoeqEH7fVQolspujm0aq8Lt4IEooNbxKJZd1dIZcSg7ZjWo262C5Zaar2IaR6tx37KW8wqw912Qnw2lA0vn4GINf8dScUnryjKjMr0fX+BXHcc9hfAOO5GOg0zLgvlz2rJutMoScue6vUYDqmarrgNuPXLucqqEqXz+ggKZYIDdJAyi3mgZOBW6BfJ/nE0DqzGjBettEbBXM7lRJUYVBZpuAsun2wyl+fB7K4oeMaZCP7E1HKHiw8dwc/Pz0cEn3nMDXerKg0MarV3X3qjr8IQ1f85gxAcmtLeFRM0a551M/Rvjoq8c9Q2DMt8w2DJOImgNf18CCJdCp6htDhQ7uXN/dfg4yiGcKChd4Qcfb29uv42uaZdSYVNicajeBSTiZRbMjk46DWh56+OaIcbF2nBuG8lH9Wu7YEZvOiBRQgrapFkBrsdFfwPI+qazD8qNFtIZosQ1sxwlpLCZos67PRKTZNzSwt5/2g6iKefRvDhe/v+OguoVK/F+YTbowZZM1GRJ9ThrnW4avY8n9Iee4+jabdHXGYZavem72IwM+7vJlMIIW1fcKUfhWDYM70i2TMkMIc5AD1SaQff/N6+A8HksvIDEZp96fMXx6q8PA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,l.jsx)(a.p,{children:"Get template list"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "File": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.cf3449cd.js b/assets/js/770b40a9.cf3449cd.js deleted file mode 100644 index fa5bb6679..000000000 --- a/assets/js/770b40a9.cf3449cd.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 l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),p=a(5397),d=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:"eJytVk1v4zYQ/SvsnDaA4o9se9Gp2TTNGg02QexFD7ZRUNLIZkKRXJJy5Br678XQkqzYaZICzSX2cN5wPt48cweerxzEc5hhYST36GAZgTZouRdaTTKIYYXeN6dSOA8RGG55gR4tQXegeIEQQ3XOjTj3+gkVRCAUxLBGnqGFCCz+KIXFDGJvS4zA+a0kjBOFkQgRYGWkzhDinEtHDukaCw7xDvzWBE9vhVpBTa48gGLKUzmxUoOqqiqol/t70PkvOtsSNtXKo/L0kRsjRRqqGj46rch2colOHjENFVrqgRfo6FSKQviemyqLJJSVa1tw37d0yY1HdQTuSZj/iBvVdQRVIQnWNJa6nlBFdQReePnSVhPAojNauX26F6MR/cvQpVYYqpj6V6YpOpeXknXjhej/6pDITkfVK7OzHGZXjb8mqnAX92Gm3x9uXwtwcF97b1w8HLZMLB3aQaoLAn8LbXoL7cIH1oIDSPt3QK03U3oP+a3f0I8hKbM6gt+1pD14E5QHnw4yFSsVFqzDcGv5ljbLY+HeH8nePHlvMMdp/F2lRpcXXxP3sdY+aoS6R8y29r/aAujwyiL3+GX7wbal5K7bXpzsQ3+Mx9c2+/Dz6JfTFZioDZciY5f3EzYjmfopBH/pdIO+4wlr9K5Av9YkhUY3+ufXEMPwSBYd2k2riaWVPdZyYwatWEmeOGLukBsx3IyDbDlMSyv8dkrrth9fX017HDDiDyQSvKu5VBlt8cNBEa/bTneKNh61GkVqJVSuw11NT+8MKppiaNhmDMetmq2FY8KF40ynZYHKB/lgubbsCM0S7jBjWjG/xnBI9s+DMXMGU5E3yjNgC7VQU10gKx2SWkmhnly8UOdsfpfnIhVcsj8xccLj8lPb4Ofn55MGnwXMjfDrMmEWjT64r4IxTKGP6r6cQQQebeHu8inajUhbCfqXq4bBedjoKU+DnmLBBZGgMf16DCL6SpGictgj9+XN/S37PBhB1OPQB1Ie3k6urr9NrykqsXA/ovFgNBiRiZhbcNW76DWiZ68qnMfKD43kQlGkkNWu2YE5vNiBZQRrWpF4DrsdDfy7lXVN5h8l2i3E82UEG24FT4hh82UdtXylpcmEo4OsewUc5dP9WMGnh+ZBccZoVK/l+YTbkwXZcFmSJ9TRrnG42sc8n1GMg8fJj+EBcZmmaPybvsueZtzfTWcQQdI8SYrwygHLn+lZxJ8hhgUsAOjVRRHC8gf7DiRXq5KvgsyGuPT3D3l1U/4=",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:"eJytVk1v4zYQ/SvsnDaA4o9se9Gp2TTNGg02QexFD7ZRUNLIZkKRXJJy5Br678XQkqzYaZICzSX2cN5wPt48cweerxzEc5hhYST36GAZgTZouRdaTTKIYYXeN6dSOA8RGG55gR4tQXegeIEQQ3XOjTj3+gkVRCAUxLBGnqGFCCz+KIXFDGJvS4zA+a0kjBOFkQgRYGWkzhDinEtHDukaCw7xDvzWBE9vhVpBTa48gGLKUzmxUoOqqiqol/t70PkvOtsSNtXKo/L0kRsjRRqqGj46rch2colOHjENFVrqgRfo6FSKQviemyqLJJSVa1tw37d0yY1HdQTuSZj/iBvVdQRVIQnWNJa6nlBFdQReePnSVhPAojNauX26F6MR/cvQpVYYqpj6V6YpOpeXknXjhej/6pDITkfVK7OzHGZXjb8mqnAX92Gm3x9uXwtwcF97b1w8HLZMLB3aQaoLAn8LbXoL7cIH1oIDSPt3QK03U3oP+a3f0I8hKbM6gt+1pD14E5QHnw4yFSsVFqzDcGv5ljbLY+HeH8nePHlvMMdp/F2lRpcXXxP3sdY+aoS6R8y29r/aAujwyiL3+GX7wbal5K7bXpzsQ3+Mx9c2+/Dz6JfTFZioDZciY5f3EzYjmfopBH/pdIO+4wlr9K5Av9YkhUY3+ufXEMPwSBYd2k2riaWVPdZyYwatWEmeOGLukBsx3IyDbDlMSyv8dkrrth9fX017HDDiDyQSvKu5VBlt8cNBEa/bTneKNh61GkVqJVSuw11NT+8MKppiaNhmDMetmq2FY8KF40ynZYHKB/lgubbsCM0S7jBjWjG/xnBI9s+DMXMGU5E3yjNgC7VQU10gKx2SWkmhnly8UOdsfpfnIhVcsj8xccLj8lPb4Ofn55MGnwXMjfDrMmEWjT64r4IxTKGP6r6cQQQebeHu8inajUhbCfqXq4bBedjoKU+DnmLBBZGgMf16DCL6SpGictgj9+XN/S37PBhB1OPQB1Ie3k6urr9NrykqsXA/ovFgNBiRiZhbcNW76DWiZ68qnMfKD43kQlGkkNWu2YE5vNiBZQRrWpF4DrsdDfy7lXVN5h8l2i3E82UEG24FT4hh82UdtXylpcmEo4OsewUc5dP9WMGnh+ZBccZoVK/l+YTbkwXZcFmSJ9TRrnG42sc8n1GMg8fJj+EBcZmmaPybvsueZtzfTWcQQdI8SYrwygHLn+lZxJ8hhgUsAOjVRRHC8gf7DiRXq5KvgsyGuPT3D3l1U/4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"Get template list"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"sting",qualifierMessage:void 0,schema:{type:"string",format:"sting",example:"zxcpou2Hbs"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.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": "zxcpou2Hbs",\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.58479125.js b/assets/js/7b076186.58479125.js deleted file mode 100644 index 1cc7ec226..000000000 --- a/assets/js/7b076186.58479125.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:()=>m,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>h,toc:()=>x});var a=s(85893),d=s(11151),n=s(58219),c=(s(62316),s(51039)),i=s.n(c),l=(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:"eJytVd9v2zgM/lc0Pq2AGqfd9mIcDjdswRCsWIulh3tIg4Ni0bFWWdIkOU1g+H8/ULHzo21ww+FeElv6SH4kP9ItRLEKkM/hkzVRFDHAgoPEUHjlorIGcpCoMSITrNhBgIN16AVdT+UecLh1wosaI3py3IIRNUIOm0vh1GW0j2iAgyLPFQqJHjh4/NkojxLy6BvkEOJWk01QtdMIHHDjtJUIeSl0IEBRYS0gbyFuXUJGr8wKOoKKZJQTSxPUyow2m80GOr6n0lP9W8mBiROxgueJ33m7VhKZXf7AIk4ls+VQAxYt26X9f7LnUFpfi3h8ckjHVdfL6loECV23oKjBWRMwkJ/r8Zj+Tvn3Le2JShaaosAQykbr7Rsq1fvx+/NWxkZW2sbIHvrhJXRq1kIryT7eTdk9NfYNdB2HgEXjVdym7h+3PZ8viHmNsbIH4STFxApyyPrqZu2hQx2QQ78e1NR4TcqJ0YU8y4Rzo6HNWizDqLB1JpzK1ldAoQYqM6r4rlQnhPYdEE59xS3wf1crZahMaZOxiqk1tw7NTK1MqsT66oWS7isVmArpWtqiqdHEND+stJ49s2ZLEVAya1isMF3S+bvRFQsOC1WqIpmO2IN5MDNbI2sClo1mWpnHkD+YSza/LUtVKKHZX7gMKuLi7VCxp6enFxW7SDZfVKyaJfPo7AG+SoeprMdW+5cL4BDR1+G2nKFfqwL77pwJlSVwBnwYQioj1kLpw1z+8dyIBKhVgSYgwfsWffxyd8PejcbAj0TxC5Szm+mnybfZhLySrHYtuhqNR2M6cjbEWpijQJ+TTMPR/jvpbpt4o4mv78peYBE3MXNaKENBEuG21/0cDuj8aDctOFQ2RAK0LYniT6+7jo5/NuhpvBYc1sIrsSQVzluQKtCz3G+as0Tffu+X1gX71TX3aiLD+BianbXQDb0Bh0fcni7abtHxYYT+M9VzLHbRTmd2T+Zk5Xye3EzuJ8BBNFT64/l/TPPfPxDFV3M7DbILTL/0eXnV4Dea3q+4/X0P392cNdh/FXdoynDRdd0/71qcVw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},p=void 0,h={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:"eJytVd9v2zgM/lc0Pq2AGqfd9mIcDjdswRCsWIulh3tIg4Ni0bFWWdIkOU1g+H8/ULHzo21ww+FeElv6SH4kP9ItRLEKkM/hkzVRFDHAgoPEUHjlorIGcpCoMSITrNhBgIN16AVdT+UecLh1wosaI3py3IIRNUIOm0vh1GW0j2iAgyLPFQqJHjh4/NkojxLy6BvkEOJWk01QtdMIHHDjtJUIeSl0IEBRYS0gbyFuXUJGr8wKOoKKZJQTSxPUyow2m80GOr6n0lP9W8mBiROxgueJ33m7VhKZXf7AIk4ls+VQAxYt26X9f7LnUFpfi3h8ckjHVdfL6loECV23oKjBWRMwkJ/r8Zj+Tvn3Le2JShaaosAQykbr7Rsq1fvx+/NWxkZW2sbIHvrhJXRq1kIryT7eTdk9NfYNdB2HgEXjVdym7h+3PZ8viHmNsbIH4STFxApyyPrqZu2hQx2QQ78e1NR4TcqJ0YU8y4Rzo6HNWizDqLB1JpzK1ldAoQYqM6r4rlQnhPYdEE59xS3wf1crZahMaZOxiqk1tw7NTK1MqsT66oWS7isVmArpWtqiqdHEND+stJ49s2ZLEVAya1isMF3S+bvRFQsOC1WqIpmO2IN5MDNbI2sClo1mWpnHkD+YSza/LUtVKKHZX7gMKuLi7VCxp6enFxW7SDZfVKyaJfPo7AG+SoeprMdW+5cL4BDR1+G2nKFfqwL77pwJlSVwBnwYQioj1kLpw1z+8dyIBKhVgSYgwfsWffxyd8PejcbAj0TxC5Szm+mnybfZhLySrHYtuhqNR2M6cjbEWpijQJ+TTMPR/jvpbpt4o4mv78peYBE3MXNaKENBEuG21/0cDuj8aDctOFQ2RAK0LYniT6+7jo5/NuhpvBYc1sIrsSQVzluQKtCz3G+as0Tffu+X1gX71TX3aiLD+BianbXQDb0Bh0fcni7abtHxYYT+M9VzLHbRTmd2T+Zk5Xye3EzuJ8BBNFT64/l/TPPfPxDFV3M7DbILTL/0eXnV4Dea3q+4/X0P392cNdh/FXdoynDRdd0/71qcVw==",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"}},m={},x=[{value:"Request",id:"request",level:2}];function j(e){const t={h2:"h2",p:"p",...(0,d.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)(i(),{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)(l.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)(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,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(n.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,d.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/7b076186.621d99d2.js b/assets/js/7b076186.621d99d2.js new file mode 100644 index 000000000..45eb4c686 --- /dev/null +++ b/assets/js/7b076186.621d99d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var l=a(85893),t=a(11151),n=a(58219),c=(a(62316),a(51039)),i=a.n(c),r=(a(82723),a(9487)),d=a(41429),o=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVJc90UYhgVtUAQNlmDOsAfHCGjpymJDkSxJOTYE/ffiUrIs56PLhqEvtkSeS5577pca8HztIF3AR608z7yDZQQ5uswK44VWkEKOEj0yzrIOAhFog5bT9mU+AA67hlteoUdLBzegeIWQwvaUG3Hq9QMqiEDQySXyHC1EYPFbLSzmkHpbYwTO7yTZOFEZiRABbo3UOUJacOkIkJVYcUgb8DsTkN4KtYaWoDwYpcRSObFWk+12u4U2Gqj0VO9FvmdiuC/hqeM3Vm9EjkyvvmLmL3Omi70GzGvWuf1/so+g0LbifrxycMeU01U55S6Htl3Src5o5dDROdMkob9j/n1Ie6I5c3WWoXNFLeXuF4iCDKg8GXJjpMhCSOOvjqyb5yw7HSjAlhLAi+7uLLg2oFRdrUJQB+bTJGkjqNA5vsaXvD74+GPKbRuBFz4ghZJC4f1ehftpktxPoW0JM0tmr6uhtGeFrlX+MyWYJbN/K8GI54/8niWzkd8fnvt9qTZcipyd31yyW6q+n+v3h7f6PebpO57k07aSZNdXruhAXRc5UmW83qnhMKut8LvQhMbdJ10sqYAq9KU+9K/QuHwJKcR9kcfNoVG0QAfazb6p1VZSA/PeuDSOuTGTfbeRfOUmma5ibkS8OQO6ak9lTrp20h0RGnThRnzBHUT/3DTJQ6EKHYx7Fa4NqrlYq6Dh5uxZQ7sthWPChe1cZ3WFyofAs0Jb9sSarbjDnGnFfIlhk9bfT86YM5iJos+ZCbtTd2quK2S1w6KWTAr14NI7dcoW10UhMsEl+xtXTnhcvtsr9vj4+Eyxk2DzWfiyXjGLRh/g67AYZB1bDS8nEIFHW7nrYo52IzLso/PKVXEAx30l0NhKG8CKC3kYD78/NaKEkyJD5XCUkuefb67Y+0kC0Sgp3kA5vrr8ePHH/IJOpbTqQnQ2SSYJLRntfMXV6KJPIU3daAwfRbc5FPVLI7tPMI9bHxvJRSifQLjp834BB3Q6GpHLCErtPAGahpLiLyvblpa/1WipvJYRbLgVfEVZuGggF46e82HgvUr03Z/97Dxhb522LzqyLx9FtbPhsqY3iOABd8fzvl220b6E/jPV11h0tx3X7ECGvj86wHmWofGjvWct+Kg9fbq4uri9gAh4TWEa94qH0Cv6B3LnRR2OCXUc6JcYvWjwK1X6F9z9NsC7nVcNhg+5Dk1qLNu2/Q4qVosD",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"Deletes contact",description:"delete a contact",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Deletes contact",description:"delete a contact",sidebar_label:"Deletes contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vl1v2zYU/SvcfWoAxVJc90UYhgVtUAQNlmDOsAfHCGjpymJDkSxJOTYE/ffiUrIs56PLhqEvtkSeS5577pca8HztIF3AR608z7yDZQQ5uswK44VWkEKOEj0yzrIOAhFog5bT9mU+AA67hlteoUdLBzegeIWQwvaUG3Hq9QMqiEDQySXyHC1EYPFbLSzmkHpbYwTO7yTZOFEZiRABbo3UOUJacOkIkJVYcUgb8DsTkN4KtYaWoDwYpcRSObFWk+12u4U2Gqj0VO9FvmdiuC/hqeM3Vm9EjkyvvmLmL3Omi70GzGvWuf1/so+g0LbifrxycMeU01U55S6Htl3Src5o5dDROdMkob9j/n1Ie6I5c3WWoXNFLeXuF4iCDKg8GXJjpMhCSOOvjqyb5yw7HSjAlhLAi+7uLLg2oFRdrUJQB+bTJGkjqNA5vsaXvD74+GPKbRuBFz4ghZJC4f1ehftpktxPoW0JM0tmr6uhtGeFrlX+MyWYJbN/K8GI54/8niWzkd8fnvt9qTZcipyd31yyW6q+n+v3h7f6PebpO57k07aSZNdXruhAXRc5UmW83qnhMKut8LvQhMbdJ10sqYAq9KU+9K/QuHwJKcR9kcfNoVG0QAfazb6p1VZSA/PeuDSOuTGTfbeRfOUmma5ibkS8OQO6ak9lTrp20h0RGnThRnzBHUT/3DTJQ6EKHYx7Fa4NqrlYq6Dh5uxZQ7sthWPChe1cZ3WFyofAs0Jb9sSarbjDnGnFfIlhk9bfT86YM5iJos+ZCbtTd2quK2S1w6KWTAr14NI7dcoW10UhMsEl+xtXTnhcvtsr9vj4+Eyxk2DzWfiyXjGLRh/g67AYZB1bDS8nEIFHW7nrYo52IzLso/PKVXEAx30l0NhKG8CKC3kYD78/NaKEkyJD5XCUkuefb67Y+0kC0Sgp3kA5vrr8ePHH/IJOpbTqQnQ2SSYJLRntfMXV6KJPIU3daAwfRbc5FPVLI7tPMI9bHxvJRSifQLjp834BB3Q6GpHLCErtPAGahpLiLyvblpa/1WipvJYRbLgVfEVZuGggF46e82HgvUr03Z/97Dxhb522LzqyLx9FtbPhsqY3iOABd8fzvl220b6E/jPV11h0tx3X7ECGvj86wHmWofGjvWct+Kg9fbq4uri9gAh4TWEa94qH0Cv6B3LnRR2OCXUc6JcYvWjwK1X6F9z9NsC7nVcNhg+5Dk1qLNu2/Q4qVosD",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"}},f={},b=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Deletes contact"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a contact"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.16260b16.js b/assets/js/8a725248.16260b16.js deleted file mode 100644 index f45738eb6..000000000 --- a/assets/js/8a725248.16260b16.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),l=s.n(r),c=(s(82723),s(9487)),o=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"createcontact",title:"Create contact",description:"Create contact",sidebar_label:"Create contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVt9v2zgM/ldUPq2Am8RJ78U4HNYriqHYsBZLD/eQBgfZZmK1sqRJcn4g8P8+UHYcJ+l218cDiiKhSIrk9/GLduD50kEyg1utPM+8g3kE2qDlXmh1n0MCmUXuMWvOIQLDLS/Ro6W4HSheIiSwueJGXHn9igoiEAoSKJDnaCECi98rYTGHxNsKI3B+KynGidJIhAhwY6TOEZIFl44csgJLDskO/NYET2+FWkJNrjwEJVSlcmKpBpvNZgP1vLkHnf9T51uKzdFlVhhqBBIwVq9EjixFqdesa4J5zZoO2aFF+oTKUxJujBRZmMbwxVGmXa+8Q2czuCu5kBDBVxpIBI+FVkjTbFvQ6Qs287M0Xy/QUYbgfdZoBAttS+77lkPnL5raQBpHc+n741PEj61hkOmSUjUFvzNVPJ6M40k8GcdQ1xF44YP5iDP/pARITefHTAgGZ7RyzSzGo9E5bi0xW5By5qosQ+cWlZTbi/dg9WscGjMR/n0DMEWcFpvxi6ER/s/BvI4n8Tj8BTA3ZSimXfAWzBw9F9JBH+yTk4D09ej6HMupLtEXQi3ZGpVna6vVMmJGInfIvN0yvuRCMck92gsIWX47z3KvVlyKnN083rMnEpyLUK7DrLLCb4Mq9eUomc1JHU5odbrzVJkmvTPaNTLnC0hgeCp/Du1qr32VlaRz3huXDIfcmMFelCRPHWEx5EYMV3GQp32BU6Jkw7qjMjuwuBGfcQvRv2sr9U1M/3ZQvrs9nHtt6RjWEewtznSUOVppum2hQ2kt2A8G1VQsVZj+KobTuT4VwjHhwnGus6pE5cNGsoW27CSapdxhzrRivsBwSPbJIGbOYCYW7TIP2LN6VkQeVjlcVJJJoV5d8qyu2OxhsRCZ4JL9jakTHucf9nis1+szPC5DzCfhiyplFo0+uC+DMYDWj+q+XEIEHm3pHhZTtCuRYYv9T64aBudhK1FEnmQH2CLQmj6eBtHIpchQOezt3s2nxy9sMhhB1KPcfyh5+OX+9u7r9I6yEmkbiOLBaDAiEzG95Kp30dlWHIHbEdTjxg+N5EJRmlDSrl2Y2cl7YR5BQQuVzGC3I7j/srKuyfy9QkvLOo9gxa3gKfFrNq+jPblpw3Lh6CDvngYnBXXqDx++tb8tlwyitwt9xe3ZNq24rMgT6mjXOtw2Oa+eKMfB4+zX5RBxk2Vo/C995z2FeXyYPkEEaftOKcPTByxf01uJryGBZ3gGoIcYZQhKEew7kFwtK74Max3ykgLwiibfl4/XIB/tB5rj/khte1UeT6Jphf5TY28G/E7r+Rm3f3TuzclPA7onYONNMMzruv4BSYqNUg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createcontact",title:"Create contact",description:"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/ldUPq2Am8RJ78U4HNYriqHYsBZLD/eQBgfZZmK1sqRJcn4g8P8+UHYcJ+l218cDiiKhSIrk9/GLduD50kEyg1utPM+8g3kE2qDlXmh1n0MCmUXuMWvOIQLDLS/Ro6W4HSheIiSwueJGXHn9igoiEAoSKJDnaCECi98rYTGHxNsKI3B+KynGidJIhAhwY6TOEZIFl44csgJLDskO/NYET2+FWkJNrjwEJVSlcmKpBpvNZgP1vLkHnf9T51uKzdFlVhhqBBIwVq9EjixFqdesa4J5zZoO2aFF+oTKUxJujBRZmMbwxVGmXa+8Q2czuCu5kBDBVxpIBI+FVkjTbFvQ6Qs287M0Xy/QUYbgfdZoBAttS+77lkPnL5raQBpHc+n741PEj61hkOmSUjUFvzNVPJ6M40k8GcdQ1xF44YP5iDP/pARITefHTAgGZ7RyzSzGo9E5bi0xW5By5qosQ+cWlZTbi/dg9WscGjMR/n0DMEWcFpvxi6ER/s/BvI4n8Tj8BTA3ZSimXfAWzBw9F9JBH+yTk4D09ej6HMupLtEXQi3ZGpVna6vVMmJGInfIvN0yvuRCMck92gsIWX47z3KvVlyKnN083rMnEpyLUK7DrLLCb4Mq9eUomc1JHU5odbrzVJkmvTPaNTLnC0hgeCp/Du1qr32VlaRz3huXDIfcmMFelCRPHWEx5EYMV3GQp32BU6Jkw7qjMjuwuBGfcQvRv2sr9U1M/3ZQvrs9nHtt6RjWEewtznSUOVppum2hQ2kt2A8G1VQsVZj+KobTuT4VwjHhwnGus6pE5cNGsoW27CSapdxhzrRivsBwSPbJIGbOYCYW7TIP2LN6VkQeVjlcVJJJoV5d8qyu2OxhsRCZ4JL9jakTHucf9nis1+szPC5DzCfhiyplFo0+uC+DMYDWj+q+XEIEHm3pHhZTtCuRYYv9T64aBudhK1FEnmQH2CLQmj6eBtHIpchQOezt3s2nxy9sMhhB1KPcfyh5+OX+9u7r9I6yEmkbiOLBaDAiEzG95Kp30dlWHIHbEdTjxg+N5EJRmlDSrl2Y2cl7YR5BQQuVzGC3I7j/srKuyfy9QkvLOo9gxa3gKfFrNq+jPblpw3Lh6CDvngYnBXXqDx++tb8tlwyitwt9xe3ZNq24rMgT6mjXOtw2Oa+eKMfB4+zX5RBxk2Vo/C995z2FeXyYPkEEaftOKcPTByxf01uJryGBZ3gGoIcYZQhKEew7kFwtK74Max3ykgLwiibfl4/XIB/tB5rj/khte1UeT6Jphf5TY28G/E7r+Rm3f3TuzclPA7onYONNMMzruv4BSYqNUg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create contact"})}),"\n",(0,t.jsx)(l(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"Create contact"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{})]}),(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 y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.ba909b7d.js b/assets/js/8a725248.ba909b7d.js new file mode 100644 index 000000000..e6ed6e58a --- /dev/null +++ b/assets/js/8a725248.ba909b7d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),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:"eJzVV99v2zgM/ld0fFoBN3HS7MU4HNYriqHYsBZLD/eQBoVsM4laWdIkOT8Q+H8/UHYcJ+m69mXAAUWRUCRFfvxIKlvwfO4gmcCVVp5n3sE0Am3Qci+0uskhgcwi95jV5xCB4ZYX6NGS3RYULxASWJ9zI869fkYFEQgFCSyQ52ghAos/SmExh8TbEiNwfiPJxonCSIQIcG2kzhGSGZeOFLIFFhySLfiNCZreCjWHilR5MEooSuXEXPXW6/Uaqml9Dzr/t843ZJujy6wwlAgkYKxeihxZilKvWJsE85rVGbJ9ivQJlScn3BgpsoBG/8mRp20nvH1mE7guuJAQwTcCJIK7hVZIaDYp6PQJa/ws4esFOvIQtE8SjWCmbcF9V7LP/ElTGkhw1Je+3z5F/NQIepkuyFUd8DtdDYYXw8HF4GI4gKqKwAsfxAeceUypIBWdHzIhCJzRytVYDOP4tG4NMZsi5cyVWYbOzUopN3+8p1av1yEL/Gu1VFmkgbttqsM4riIo0Dk+fxGmPSivh1xnXUr/66BqMXXh+6piFoN0sR4+Gbrsf86w0eBiMAx/gWHrIgTTTJ2GYTl6LqSDLgOPTjpHQkmh8HFHvcdhHD+Sc9IZxaNTCo51gX4h1JytUHm2slrNI2YkcofM2w3jcy4Uk9yj/Z2UHMWjt1LyfSm8htYoHnXQ+niK1o1acilydnl3w+5pH/xeSD6+FZJunL6O85Rgolaq99oBKl15jYbDrLTCb8Ja7O7DZDKl9XQ0146XDhVI08I12tV71i8ggf7x/nVol7vlW1pJi9Z745J+nxvT221FyVNHfdfnRvSXg7AfdwGOCe0a0IMwW7S4EV9wA9GvlzvlTUX8vl+91zuEd8utnSbtMHlpPrTj4WCn0G0zHUJrkL81qMZirkLdlgM4xvV+IRwTLhznOisLVD6Qjc20ZUfWLOUOc6YV8wsMhyS/6A2YM5iJWcPTHntQD4p6iJUOZ6VkUqhnlzyocza5nc1EJrhk/2LqhMfph109VqvVST3Ogs1n4RdlyiwavVefB2EoWteq/XIGEXi0hbudjdEuRYZN7X9yVT8o95vuI/IkW8CmAo3o07ERQS5Fhsphpw0uP999ZRe9GKIO5d4Qcv/rzdX1t/E1eSXS1iUa9OJeTCJiesFV56KTrjgobktQj2vfN5KL0JQhpG3TMJOjB+s0ggU1VDKB7ZbK/Y+VVUXiHyVaatZpBEtuBU+JX5NpFe3ITR2WC0cHefs2PQqoHWzw4XvzuDljEL0c6DNuTrppyWVJmlBF20bhqvZ5fk8+9hong3NvcZllaPyrutPOhLm7Hd9DBGnzUC7CVAXLV/RY5ytI4AEeAOiXAHkIkyLItyC5mpdhtkLtlyYALwn57vh4DuOj+UA47o7UphPlIRJ1KvSfEnvR4E9qzy+4+atVr09+atD+Bqm1qQzTqqr+A0fWar0=",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:"eJzVV99v2zgM/ld0fFoBN3HS7MU4HNYriqHYsBZLD/eQBoVsM4laWdIkOT8Q+H8/UHYcJ+m69mXAAUWRUCRFfvxIKlvwfO4gmcCVVp5n3sE0Am3Qci+0uskhgcwi95jV5xCB4ZYX6NGS3RYULxASWJ9zI869fkYFEQgFCSyQ52ghAos/SmExh8TbEiNwfiPJxonCSIQIcG2kzhGSGZeOFLIFFhySLfiNCZreCjWHilR5MEooSuXEXPXW6/Uaqml9Dzr/t843ZJujy6wwlAgkYKxeihxZilKvWJsE85rVGbJ9ivQJlScn3BgpsoBG/8mRp20nvH1mE7guuJAQwTcCJIK7hVZIaDYp6PQJa/ws4esFOvIQtE8SjWCmbcF9V7LP/ElTGkhw1Je+3z5F/NQIepkuyFUd8DtdDYYXw8HF4GI4gKqKwAsfxAeceUypIBWdHzIhCJzRytVYDOP4tG4NMZsi5cyVWYbOzUopN3+8p1av1yEL/Gu1VFmkgbttqsM4riIo0Dk+fxGmPSivh1xnXUr/66BqMXXh+6piFoN0sR4+Gbrsf86w0eBiMAx/gWHrIgTTTJ2GYTl6LqSDLgOPTjpHQkmh8HFHvcdhHD+Sc9IZxaNTCo51gX4h1JytUHm2slrNI2YkcofM2w3jcy4Uk9yj/Z2UHMWjt1LyfSm8htYoHnXQ+niK1o1acilydnl3w+5pH/xeSD6+FZJunL6O85Rgolaq99oBKl15jYbDrLTCb8Ja7O7DZDKl9XQ0146XDhVI08I12tV71i8ggf7x/nVol7vlW1pJi9Z745J+nxvT221FyVNHfdfnRvSXg7AfdwGOCe0a0IMwW7S4EV9wA9GvlzvlTUX8vl+91zuEd8utnSbtMHlpPrTj4WCn0G0zHUJrkL81qMZirkLdlgM4xvV+IRwTLhznOisLVD6Qjc20ZUfWLOUOc6YV8wsMhyS/6A2YM5iJWcPTHntQD4p6iJUOZ6VkUqhnlzyocza5nc1EJrhk/2LqhMfph109VqvVST3Ogs1n4RdlyiwavVefB2EoWteq/XIGEXi0hbudjdEuRYZN7X9yVT8o95vuI/IkW8CmAo3o07ERQS5Fhsphpw0uP999ZRe9GKIO5d4Qcv/rzdX1t/E1eSXS1iUa9OJeTCJiesFV56KTrjgobktQj2vfN5KL0JQhpG3TMJOjB+s0ggU1VDKB7ZbK/Y+VVUXiHyVaatZpBEtuBU+JX5NpFe3ITR2WC0cHefs2PQqoHWzw4XvzuDljEL0c6DNuTrppyWVJmlBF20bhqvZ5fk8+9hong3NvcZllaPyrutPOhLm7Hd9DBGnzUC7CVAXLV/RY5ytI4AEeAOiXAHkIkyLItyC5mpdhtkLtlyYALwn57vh4DuOj+UA47o7UphPlIRJ1KvSfEnvR4E9qzy+4+atVr09+atD+Bqm1qQzTqqr+A0fWar0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your details",permalink:"/docs/API-docs/get-user"},next:{title:"Get contact",permalink:"/docs/API-docs/getcontact"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create contact"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"Create contact"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.0722cf48.js b/assets/js/a2bc1463.0722cf48.js deleted file mode 100644 index 89bcf1865..000000000 --- a/assets/js/a2bc1463.0722cf48.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var i=a(85893),t=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),o=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/lc0Pq2AGyft9mIchnVFURQb1mLp4R6SPMg2E6uRJU2S8wOB//cDZTtxkvV2HRAkDkVSJD9+pHfg+cJBMoFbrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySCBrVKVwHiIw3PISPVpyswPFS4QENpfciEuvl6ggAkF+CuQ5WojA4s9KWMwh8bbCCJzfSrJxojQSIQLcGKlzhGTOpSOFrMCSQ7IDvzVB01uhFlCTKg9GCcWonFiowWaz2UA9a+5B57/ofEu2FDYqT4/cGCmykFH84ijL3fklOn3BLGRoKX8v0NGpFKXwPTVVlWlIa65tyX1fsg9uNKwjcEth3mg3rOsINqUks7awVPWUMqoj8MLLY1lNBhad0co14V4Nh/RzDKmrsgydm1eS7aGF6M0V4tbyLcHrsXS/r1wjphY6BbJXhL3kgKwpRmmxuXoxlPP3UIa3OXjRyFJEMr8ruZB/YJ8ifm4Fg0yX5Oqp0OrNoXwYXY+uwgfOsW2JlaPnQro+wqcnDdAfhh/PsX1QKy5Fzm6eHtgz8e9duMlhVlnht4GkfXYmkxmRpURfaGK30S2tfQEJxMdkd2hXHdMrK4nV3huXxDE3ZtBRUPLUUZVibkS8GgUydvePqYmafjiK4tBURnxF6qrfThJKi3rzx4Hnd12h9zwdDTvmEQeFmutwV1vXR4NqLBYqVGs1gtPZ91wIx4QLx7nOqhKVD6Rgc23ZiTVLucOcacV8geGQ5NeDEXMGMzFv+TRgUzVVY10iqxwSB6VQS5dM1SWbPM7nIhNcsn8wdcLj7H1X4PV6fVbgi2BzL3xRpcyi0Qf1RRAGFPpW+z8XEIFHW7rH+RjtSmTYgvnKVXFQjtspwbMwJbBhUyf6fGpELSxFhsphr81v7p++sevBEKJeD/2PkONvD7d338d35JW6sIFoNBgOhiSixi256l10j561obG2gY/g7e0E2nJtA3rc+NhILhR5DRHuWjpMjnbfLIKCyJJMYLcj7P+2sq5J/LNCS0ybRbDiVvCUmm0yq6OudYk/uXB0kO/X3Kuxvf/RbswL9lqYS9yecWXFZUWaUEe7VuG28Xn5TD4OGmfT/mBxk2Vo/H/q9qfH0+P4GSJI251bhjUOlq9p7/M1JDCFafNKQR7CHAjyHUiuFhVfhIEb/BK/eUV17w+HZRgO7QPVsTtS216Ux5VoUqFvSuyXBn8RV7/i9tNevTl51WD/OtNoEwyzuq7/BUJfKh8=",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/lc0Pq2AGyft9mIchnVFURQb1mLp4R6SPMg2E6uRJU2S8wOB//cDZTtxkvV2HRAkDkVSJD9+pHfg+cJBMoFbrTzPvINZBDm6zArjhVaQAESgDVpOfx9ySCBrVKVwHiIw3PISPVpyswPFS4QENpfciEuvl6ggAkF+CuQ5WojA4s9KWMwh8bbCCJzfSrJxojQSIQLcGKlzhGTOpSOFrMCSQ7IDvzVB01uhFlCTKg9GCcWonFiowWaz2UA9a+5B57/ofEu2FDYqT4/cGCmykFH84ijL3fklOn3BLGRoKX8v0NGpFKXwPTVVlWlIa65tyX1fsg9uNKwjcEth3mg3rOsINqUks7awVPWUMqoj8MLLY1lNBhad0co14V4Nh/RzDKmrsgydm1eS7aGF6M0V4tbyLcHrsXS/r1wjphY6BbJXhL3kgKwpRmmxuXoxlPP3UIa3OXjRyFJEMr8ruZB/YJ8ifm4Fg0yX5Oqp0OrNoXwYXY+uwgfOsW2JlaPnQro+wqcnDdAfhh/PsX1QKy5Fzm6eHtgz8e9duMlhVlnht4GkfXYmkxmRpURfaGK30S2tfQEJxMdkd2hXHdMrK4nV3huXxDE3ZtBRUPLUUZVibkS8GgUydvePqYmafjiK4tBURnxF6qrfThJKi3rzx4Hnd12h9zwdDTvmEQeFmutwV1vXR4NqLBYqVGs1gtPZ91wIx4QLx7nOqhKVD6Rgc23ZiTVLucOcacV8geGQ5NeDEXMGMzFv+TRgUzVVY10iqxwSB6VQS5dM1SWbPM7nIhNcsn8wdcLj7H1X4PV6fVbgi2BzL3xRpcyi0Qf1RRAGFPpW+z8XEIFHW7rH+RjtSmTYgvnKVXFQjtspwbMwJbBhUyf6fGpELSxFhsphr81v7p++sevBEKJeD/2PkONvD7d338d35JW6sIFoNBgOhiSixi256l10j561obG2gY/g7e0E2nJtA3rc+NhILhR5DRHuWjpMjnbfLIKCyJJMYLcj7P+2sq5J/LNCS0ybRbDiVvCUmm0yq6OudYk/uXB0kO/X3Kuxvf/RbswL9lqYS9yecWXFZUWaUEe7VuG28Xn5TD4OGmfT/mBxk2Vo/H/q9qfH0+P4GSJI251bhjUOlq9p7/M1JDCFafNKQR7CHAjyHUiuFhVfhIEb/BK/eUV17w+HZRgO7QPVsTtS216Ux5VoUqFvSuyXBn8RV7/i9tNevTl51WD/OtNoEwyzuq7/BUJfKh8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/contactlist"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(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)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(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)(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)("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:"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)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'[\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.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/a2bc1463.d45861d2.js b/assets/js/a2bc1463.d45861d2.js new file mode 100644 index 000000000..1d6e44226 --- /dev/null +++ b/assets/js/a2bc1463.d45861d2.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:()=>b,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const j={id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVlFv4jgQ/iu+edpKKQlt9yU6nbZXVVW1q2219HQPwIOTDMTFsb22Q0Eo/301ToAAy+11JQRhPGPPfN/MF2/A87mDdAx3WnmeewfTCAp0uRXGC60gBYhAG7Sc/j4WkELeukrhPERguOUVerS0zQYUrxBSWF1yIy69XqCCCATtUyIv0EIEFr/XwmIBqbc1RuD8WlKME5WRCBHgykhdIKQzLh055CVWHNIN+LUJnt4KNYeGXHkISilH5cRcDVar1QqaaXsOOv+3LtYUS2mj8vTIjZEiDxXFr46q3JweorNXzEOFlur3Ah2tSlEJ33NTdZWFsmbaVtz3LbvkhkkTgVsI8864pGkiWFWSwjpgCfWMKmoi8MLLQ1tDARad0cq16V4lCf0cUurqPEfnZrVkO2ohejdC3Fq+Jno9Vu7XyLVmaqFjInsg7Cx7Zk05zMrV1auhmr8GGN63watGliFS+H3FhfyN+AzxU2cY5LqirZ5Lrd6dys3wengVPnDKbTdYBXoupOszfLzSEn2TfDzl9lEtuRQFu31+ZC80f3/8BrNnGMzDVJ628K6+m+RjE0GFzvH5T7HZI9HP07d5niIiWqdWR3p4HNpbNBzmtRV+HWSorz/peEpyUKEvNemX0Z1w+RJSiA/lzKFdbrWstpJ0y3vj0jjmxgy2IiN55qgPYm5EvBwGudmePyIwW7wOstiPjRGfkebml1pJZRFH3/ZKdr8FcKdEw2SrLaQyQs10OKtD6smgGom5Cjgvh3Cs7i+lcEy4sFzovK5Q+dAcbKYtO4pmGXdYMK2YLzEskv16MGTOYC5mXV8N2ERN1EhXyGqHpDJSqIVLJ+qSjZ9mM5ELLtm/mDnhcfphC/Db29sJwBch5kH4ss6YRaP37vNgDCz0o3Z/LiACj7ZyT7MR2qXIsSPzzFFxcI67aeF5mBZs9WJr+nQcRE0pRY7KYa9tbx+ev7DrQQJRr4f+R8rxl8e7+6+je9qVurClaDhIBgmZqHErrnoHPaBnXWqsa+ADentvPXqPdw3oceVjI7kIMxUy3HTjMD54u08jKGlY0jFsNsT9P1Y2DZm/12hp0qYRLLkVPKNmG0+baNu6ND+FcLRQ7F7kZ3P78K27E1ywc2kucH0yK0sua/KEJtp0DnftnpcvtMfe40T19hG3eY7G/6dvXz2en0YvEEHW3SqqIIlg+RvdbPgbpDCBSXtpoh2CDgT7BiRX8zoII7T70nzzmnDvi8MiiEP3QDhul9S6l+UhEm0p9E2F/TTgT5rVz7j+a+ferpwN2F3YWm+iYdo0zQ/AjXfi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/contactlist",title:"Get contact list",description:"",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get contact list",description:"",sidebar_label:"Get contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJydVlFv4jgQ/iu+edpKKQlt9yU6nbZXVVW1q2219HQPwIOTDMTFsb22Q0Eo/301ToAAy+11JQRhPGPPfN/MF2/A87mDdAx3WnmeewfTCAp0uRXGC60gBYhAG7Sc/j4WkELeukrhPERguOUVerS0zQYUrxBSWF1yIy69XqCCCATtUyIv0EIEFr/XwmIBqbc1RuD8WlKME5WRCBHgykhdIKQzLh055CVWHNIN+LUJnt4KNYeGXHkISilH5cRcDVar1QqaaXsOOv+3LtYUS2mj8vTIjZEiDxXFr46q3JweorNXzEOFlur3Ah2tSlEJ33NTdZWFsmbaVtz3LbvkhkkTgVsI8864pGkiWFWSwjpgCfWMKmoi8MLLQ1tDARad0cq16V4lCf0cUurqPEfnZrVkO2ohejdC3Fq+Jno9Vu7XyLVmaqFjInsg7Cx7Zk05zMrV1auhmr8GGN63watGliFS+H3FhfyN+AzxU2cY5LqirZ5Lrd6dys3wengVPnDKbTdYBXoupOszfLzSEn2TfDzl9lEtuRQFu31+ZC80f3/8BrNnGMzDVJ628K6+m+RjE0GFzvH5T7HZI9HP07d5niIiWqdWR3p4HNpbNBzmtRV+HWSorz/peEpyUKEvNemX0Z1w+RJSiA/lzKFdbrWstpJ0y3vj0jjmxgy2IiN55qgPYm5EvBwGudmePyIwW7wOstiPjRGfkebml1pJZRFH3/ZKdr8FcKdEw2SrLaQyQs10OKtD6smgGom5Cjgvh3Cs7i+lcEy4sFzovK5Q+dAcbKYtO4pmGXdYMK2YLzEskv16MGTOYC5mXV8N2ERN1EhXyGqHpDJSqIVLJ+qSjZ9mM5ELLtm/mDnhcfphC/Db29sJwBch5kH4ss6YRaP37vNgDCz0o3Z/LiACj7ZyT7MR2qXIsSPzzFFxcI67aeF5mBZs9WJr+nQcRE0pRY7KYa9tbx+ev7DrQQJRr4f+R8rxl8e7+6+je9qVurClaDhIBgmZqHErrnoHPaBnXWqsa+ADentvPXqPdw3oceVjI7kIMxUy3HTjMD54u08jKGlY0jFsNsT9P1Y2DZm/12hp0qYRLLkVPKNmG0+baNu6ND+FcLRQ7F7kZ3P78K27E1ywc2kucH0yK0sua/KEJtp0DnftnpcvtMfe40T19hG3eY7G/6dvXz2en0YvEEHW3SqqIIlg+RvdbPgbpDCBSXtpoh2CDgT7BiRX8zoII7T70nzzmnDvi8MiiEP3QDhul9S6l+UhEm0p9E2F/TTgT5rVz7j+a+ferpwN2F3YWm+iYdo0zQ/AjXfi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Deletes contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Create document",permalink:"/docs/API-docs/createdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get contact list"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/contactlist"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'[\n {\n "objectId": "ph1bhx2jp",\n "Name": "joe bee",\n "Email": "joebee@example.com",\n "Phone": "4131231231"\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.7f9061ab.js b/assets/js/a88a3db3.7f9061ab.js deleted file mode 100644 index 3f16cdd0c..000000000 --- a/assets/js/a88a3db3.7f9061ab.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,t,l)=>{l.r(t),l.d(t,{assets:()=>h,contentTitle:()=>m,default:()=>j,frontMatter:()=>p,metadata:()=>c,toc:()=>y});var s=l(85893),a=l(11151),d=l(58219),i=(l(62316),l(51039)),n=l.n(i),r=(l(82723),l(9487),l(41429)),o=(l(5397),l(4667),l(9472),l(85162));const p={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:"eJytVMtu2zAQ/BViTw3AWA6Sk04NaiMwGjRBnaIHxyhocWURoUiGXDk2DP17sYrlOE6DPtCTLWqHmtmZ3S2QWibIZ3CHdbCKMMFcgg8YFRnvJhpy0GiRsC8ACUFFVSNhZOQWnKoRclifqmBOyT+gAwnGQQ4VKo0RJER8bExEDTnFBiUk2ljGJFMHy1fiOlivEfJS2cQFRYW1gnwLtAldJUXjltByqepAOdN0ySzdYL1er6GVeyq04/rD6J5KUFSBBI2piCawNshhMhK+FFSh6BGCKkXCIeokyIsFimf1+n+KkFD6WCs6kNXO+f4UvEuYGHExHPLPEV+3UtZoMRmJ1IRgDWruyMXw4m3tTdQYhfMkSt84DW17rH7UKXuRvtiIyQgk1EiVfzG+M5wqyCHrS7PtQYdbkJAwrvo4NNGy9UQh5VmmQhj0Plm1SIPC15kKJludAYtOWDTR0GbKvXqWfhikl96pYD7jBuTv48ZKjSt9BzbUeXQT0E3N0onL24lYnb1Jwl1lkjCpe6190dToqJsAUfoojtBioRJq4V0XHX7J5+eDM5ECFqY0RQcdiHt376a+RtEkLBsrrHEPKb93p2J2U5amMMqK77hIhnD+oe/Y09PTm46ddJgrQ1WzEBGDfylfdoddWw9R+4cTkEAY63RTTjGuTIE7d975VNYVZyCh8I5UQdxGrJVhV3dHH49BnEJrCnQJuXxn0eXV7bU4HwxBHoTiDyhn15NP4y/TMd/KsXq26GwwHAz5KPhEtXIHH3ovya883ieJcE1ZsMo4vq1jtt1FfLZfHSAhP1wjcwmVT8Ql2y37/y3atuXjxwbjBvLZXMJKRaMWHLjZFrRJ/F/v18ERG+4lOl4CH77uNsuJ+LuN9EtB/bw4HpaVsg0/gYQH3Bytxnbeyn5o/pnxezSeP/d6SvdsePL3a2Y0vh7fjaFtfwL7QD7Z",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:"eJytVMtu2zAQ/BViTw3AWA6Sk04NaiMwGjRBnaIHxyhocWURoUiGXDk2DP17sYrlOE6DPtCTLWqHmtmZ3S2QWibIZ3CHdbCKMMFcgg8YFRnvJhpy0GiRsC8ACUFFVSNhZOQWnKoRclifqmBOyT+gAwnGQQ4VKo0RJER8bExEDTnFBiUk2ljGJFMHy1fiOlivEfJS2cQFRYW1gnwLtAldJUXjltByqepAOdN0ySzdYL1er6GVeyq04/rD6J5KUFSBBI2piCawNshhMhK+FFSh6BGCKkXCIeokyIsFimf1+n+KkFD6WCs6kNXO+f4UvEuYGHExHPLPEV+3UtZoMRmJ1IRgDWruyMXw4m3tTdQYhfMkSt84DW17rH7UKXuRvtiIyQgk1EiVfzG+M5wqyCHrS7PtQYdbkJAwrvo4NNGy9UQh5VmmQhj0Plm1SIPC15kKJludAYtOWDTR0GbKvXqWfhikl96pYD7jBuTv48ZKjSt9BzbUeXQT0E3N0onL24lYnb1Jwl1lkjCpe6190dToqJsAUfoojtBioRJq4V0XHX7J5+eDM5ECFqY0RQcdiHt376a+RtEkLBsrrHEPKb93p2J2U5amMMqK77hIhnD+oe/Y09PTm46ddJgrQ1WzEBGDfylfdoddWw9R+4cTkEAY63RTTjGuTIE7d975VNYVZyCh8I5UQdxGrJVhV3dHH49BnEJrCnQJuXxn0eXV7bU4HwxBHoTiDyhn15NP4y/TMd/KsXq26GwwHAz5KPhEtXIHH3ovya883ieJcE1ZsMo4vq1jtt1FfLZfHSAhP1wjcwmVT8Ql2y37/y3atuXjxwbjBvLZXMJKRaMWHLjZFrRJ/F/v18ERG+4lOl4CH77uNsuJ+LuN9EtB/bw4HpaVsg0/gYQH3Bytxnbeyn5o/pnxezSeP/d6SvdsePL3a2Y0vh7fjaFtfwL7QD7Z",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={},y=[{value:"Request",id:"request",level:2}];function u(e){const t={h2:"h2",p:"p",...(0,a.a)(),...e.components},{Details:l}=t;return l||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)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(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:"string",format:"string"}}})})})]}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(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)(d.Z,{children:[(0,s.jsxs)(o.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)(o.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,a.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.cbedd512.js b/assets/js/a88a3db3.cbedd512.js new file mode 100644 index 000000000..1bc27a644 --- /dev/null +++ b/assets/js/a88a3db3.cbedd512.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),m=s.n(n),d=(s(82723),s(9487)),r=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const x={id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYilZ51CdGjTGwmjQLOoUPTiGQUsjixuK5JIjx4ah/16QsmQ53uxHUezJFjVDvvdm5lF7IL52kM7hESsjOaGDRQTaoOUktJrmkEKOEgm7AIjAcMsrJLQ+cw+KVwgpbC+5EZekn1FBBEJBCiXyHC1EYPFzLSzmkJKtMQJHO+lznKiM9Fvi1kidI6QFl84HZCVWHNI90M6ESLJCraHxoTwkpR6mcmKtRtvtdgtN1EOhA9alyDsohlMJEeToMiuM5wYpTO+YLhiVyLoMRiUnphBzx0izFbKWff5/koig0LbiNKDVLPz+zmjl0PmM6yTxP6d4uxp0oJirswydK2opd79ABJlWhIp8JjdGiixUMf7kfPr+HJBefcKMfEmtrzmJ9vAssOijVF2tQhl76a+TpImgQuf4Gr9E8Fikb2BumghIUAgVSgqFy06H5XWSLH+FpvEx42T8FT2UJlboWuU/U4RxMv5hEQZAv8Z8nIyXNz3zm3PmU7XhUuTs9uOUPfqR+7nEb76X+BAntTg9p20lfd5hXEUb1FrHiSrD9VaNUxnuQk8dp3e1Y9M78Nio1EfvCp5FJaQQd6HxfmASDUTg0G46R6ut9O5FZFwax9yYUWc1kq/cKNNVzI2IN1fg59ZhVltBu5nXt5Vw6IVHfbgRf+AOom87pmcqVKFD8kGNB4NqJtYqaLm5OjOzx1I4Jlx4neusrlBRaABWaMteZbMVd5gzrYL7+Zd+/f3oijmDmSgOvTNiT+pJzXSFrHZY1JJJoZ5d+qQu2fyhKEQmuGT/4MoJwsW7TrGXl5czxS5CzgdBZb1iFo0+hq/DYpB1mNU/XEAEhLZyD8UM7UZkeKjOG0fFITg+TATPwkRgxYWv6mHpt9dJvvGkyFA5HLTm7YeP9+z9KIFo0BTfATm+n/4++XM28bv6tmpLdDVKRolfMtpRxdXgoLc6+aTGfScRbik2koswLwHZ/tDi8/72gwjS4U24iKDUjnzIfu/r/7eVTeOXP9dod5DOFxFsuBV85RtuvodcOP8/72+0V2h6w4F3fx0uxwv2Y5fqFwl186L8sGy4rP0TRPCMu1e3e7Noom5o/jPit2C0x51OaY/Gf260AbdZhoYG787M17tEb0l3k/vJ4wSa5l+DqUIR",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete template by ID",description:"Delete template by ID",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYilZ51CdGjTGwmjQLOoUPTiGQUsjixuK5JIjx4ah/16QsmQ53uxHUezJFjVDvvdm5lF7IL52kM7hESsjOaGDRQTaoOUktJrmkEKOEgm7AIjAcMsrJLQ+cw+KVwgpbC+5EZekn1FBBEJBCiXyHC1EYPFzLSzmkJKtMQJHO+lznKiM9Fvi1kidI6QFl84HZCVWHNI90M6ESLJCraHxoTwkpR6mcmKtRtvtdgtN1EOhA9alyDsohlMJEeToMiuM5wYpTO+YLhiVyLoMRiUnphBzx0izFbKWff5/koig0LbiNKDVLPz+zmjl0PmM6yTxP6d4uxp0oJirswydK2opd79ABJlWhIp8JjdGiixUMf7kfPr+HJBefcKMfEmtrzmJ9vAssOijVF2tQhl76a+TpImgQuf4Gr9E8Fikb2BumghIUAgVSgqFy06H5XWSLH+FpvEx42T8FT2UJlboWuU/U4RxMv5hEQZAv8Z8nIyXNz3zm3PmU7XhUuTs9uOUPfqR+7nEb76X+BAntTg9p20lfd5hXEUb1FrHiSrD9VaNUxnuQk8dp3e1Y9M78Nio1EfvCp5FJaQQd6HxfmASDUTg0G46R6ut9O5FZFwax9yYUWc1kq/cKNNVzI2IN1fg59ZhVltBu5nXt5Vw6IVHfbgRf+AOom87pmcqVKFD8kGNB4NqJtYqaLm5OjOzx1I4Jlx4neusrlBRaABWaMteZbMVd5gzrYL7+Zd+/f3oijmDmSgOvTNiT+pJzXSFrHZY1JJJoZ5d+qQu2fyhKEQmuGT/4MoJwsW7TrGXl5czxS5CzgdBZb1iFo0+hq/DYpB1mNU/XEAEhLZyD8UM7UZkeKjOG0fFITg+TATPwkRgxYWv6mHpt9dJvvGkyFA5HLTm7YeP9+z9KIFo0BTfATm+n/4++XM28bv6tmpLdDVKRolfMtpRxdXgoLc6+aTGfScRbik2koswLwHZ/tDi8/72gwjS4U24iKDUjnzIfu/r/7eVTeOXP9dod5DOFxFsuBV85RtuvodcOP8/72+0V2h6w4F3fx0uxwv2Y5fqFwl186L8sGy4rP0TRPCMu1e3e7Noom5o/jPit2C0x51OaY/Gf260AbdZhoYG787M17tEb0l3k/vJ4wSa5l+DqUIR",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,l.jsx)(m(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Delete template by ID"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Template deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.5761ff15.js b/assets/js/bbdfc22d.5761ff15.js deleted file mode 100644 index 81280069a..000000000 --- a/assets/js/bbdfc22d.5761ff15.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>j,contentTitle:()=>g,default:()=>Z,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var a=t(85893),l=t(11151),i=t(58219),r=(t(62316),t(51039)),n=t.n(r),o=(t(82723),t(9487)),c=t(41429),m=t(5397),d=t(4667),p=t(9472),u=t(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:"eJztVs1T6zYQ/1f09l0ejElCX3vx6VHKMEwZYAhMDyEHRd7EAlkSkpyPl/H/3lnZTpwEWpjpsVyI93tXu7/dNQQ+85CO4AELq3hAD+MEMvTCSRuk0ZDCQ46sZbNzh5zo7OzuinGlzMKz0qPzLBgmiIlMlD6YQv7kE4UstIYTtsilyJlHN0fGPZuoEq2TOng2NY7NUKPjQeoZy4woCyTGQoacWYcZTqXGjPngShFKh77HHq3RzJdCoPfTUm081WFIoxMWcoyBOgyl055xVmr5WiI7Pm6lr7LjYxZyHpjgmk2QsskomSYe7EQz4cQzOtr1FoWcShJuTPUgAWNjEkZfZZBCXZCWDwlY7niBAR0VfQ2aFwgpLE+4lSfBvKCGBCQVPUeeoYMEHL6W0mEGaXAlJuDDSpGOl4VVZBKXVpkMIZ1y5UlA5FhwSNcQVjZKBif1DCoS5VEppTC1lzPdWy6XS6jGtR/04XeTrUhXGB1QB/rJrVVSxKT6z55aYn3oxEyeUQTK0FEJgkRP3JuY4H4oCUyNK3joUrax+fhjU1UK/MaET5u5U8g9ModziQvGdcYoYRZy6TdPSrb/6Db751xsOq47MFUCj/fXnzWVh2B92u+vTOlkwWfYE6YgWxR0bJeNPe4cX3WVR/Bs8Mes4FJFrQSeTa47hHECy0KRiabhWqMJLBy3tu2uKgEZsPBvBb8NlZw1X427t41XCQQZ1A6poiqoDB2Nx+cqtHz2E356yZd30cyuz71B67je51Sk7NBbo33do78MBvRvD/R2wISQZwM0avUFkv9qQEQc3Y2ULotJHPtNJRoKZRRF3hjrAr3ns7d4B3X6+jXDKS9VOCxRm/F9U5umVL8OfjuszpWecyWziK0PBFtfoq8CQ24I96zxMVUeckihfwCDcQc0GFg61el/bm2vBSfFJ546rM+t7M9PI0x5FKWTYTWk+tYl7KJnZ0qs/BNpTP4VYylyerb7LQJetF3XItgBKLWY9DGY2UOZt4GjwY13oKCDBB+Z9+2U7QwOZT41sUzN499a1EOKmN5yfgqH2196Jn1kt/nUFwAt7T3t3Q1JTKJ/752227Kekh570k96aIq4bWl3K6lffPqkT9jodjqVQnLF/sKJlwHH39qCLBaLg944ijqXMuTlhDm0Zis+i8TYQF2tzccRJBDQFf52OkQ3l6LF4Xdc9aNwv5l9LuLsIxWdZqgm/dhXopIrKZAGajuGZ5d31+x7bwBJp/0/EHL/+ur84mZ4QVZpgOonOu0NegMi0dgVXHccndcXWadts911t4Gx/8+8z5x5DcgEXIa+VVzGtR+fct2g3mh/84wTyAkW0xGs1+Ti0amqIvJriW4F6WicwJw7SfWkryppEYpgMpOeGNnmznv3Ib/dNyfjEXsv0hdcHUDinKuSJKFK1o3AeW3z5IFsbCUO9t1W40wItOEfZcedPXF3O3yABCbN0VnEZQiOL+jw5QtI4QmeIJ7VZCHCfaSvQXE9K+PWg9ou/f0NxD93SA==",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:"eJztVs1T6zYQ/1f09l0ejElCX3vx6VHKMEwZYAhMDyEHRd7EAlkSkpyPl/H/3lnZTpwEWpjpsVyI93tXu7/dNQQ+85CO4AELq3hAD+MEMvTCSRuk0ZDCQ46sZbNzh5zo7OzuinGlzMKz0qPzLBgmiIlMlD6YQv7kE4UstIYTtsilyJlHN0fGPZuoEq2TOng2NY7NUKPjQeoZy4woCyTGQoacWYcZTqXGjPngShFKh77HHq3RzJdCoPfTUm081WFIoxMWcoyBOgyl055xVmr5WiI7Pm6lr7LjYxZyHpjgmk2QsskomSYe7EQz4cQzOtr1FoWcShJuTPUgAWNjEkZfZZBCXZCWDwlY7niBAR0VfQ2aFwgpLE+4lSfBvKCGBCQVPUeeoYMEHL6W0mEGaXAlJuDDSpGOl4VVZBKXVpkMIZ1y5UlA5FhwSNcQVjZKBif1DCoS5VEppTC1lzPdWy6XS6jGtR/04XeTrUhXGB1QB/rJrVVSxKT6z55aYn3oxEyeUQTK0FEJgkRP3JuY4H4oCUyNK3joUrax+fhjU1UK/MaET5u5U8g9ModziQvGdcYoYRZy6TdPSrb/6Db751xsOq47MFUCj/fXnzWVh2B92u+vTOlkwWfYE6YgWxR0bJeNPe4cX3WVR/Bs8Mes4FJFrQSeTa47hHECy0KRiabhWqMJLBy3tu2uKgEZsPBvBb8NlZw1X427t41XCQQZ1A6poiqoDB2Nx+cqtHz2E356yZd30cyuz71B67je51Sk7NBbo33do78MBvRvD/R2wISQZwM0avUFkv9qQEQc3Y2ULotJHPtNJRoKZRRF3hjrAr3ns7d4B3X6+jXDKS9VOCxRm/F9U5umVL8OfjuszpWecyWziK0PBFtfoq8CQ24I96zxMVUeckihfwCDcQc0GFg61el/bm2vBSfFJ546rM+t7M9PI0x5FKWTYTWk+tYl7KJnZ0qs/BNpTP4VYylyerb7LQJetF3XItgBKLWY9DGY2UOZt4GjwY13oKCDBB+Z9+2U7QwOZT41sUzN499a1EOKmN5yfgqH2196Jn1kt/nUFwAt7T3t3Q1JTKJ/752227Kekh570k96aIq4bWl3K6lffPqkT9jodjqVQnLF/sKJlwHH39qCLBaLg944ijqXMuTlhDm0Zis+i8TYQF2tzccRJBDQFf52OkQ3l6LF4Xdc9aNwv5l9LuLsIxWdZqgm/dhXopIrKZAGajuGZ5d31+x7bwBJp/0/EHL/+ur84mZ4QVZpgOonOu0NegMi0dgVXHccndcXWadts911t4Gx/8+8z5x5DcgEXIa+VVzGtR+fct2g3mh/84wTyAkW0xGs1+Ti0amqIvJriW4F6WicwJw7SfWkryppEYpgMpOeGNnmznv3Ib/dNyfjEXsv0hdcHUDinKuSJKFK1o3AeW3z5IFsbCUO9t1W40wItOEfZcedPXF3O3yABCbN0VnEZQiOL+jw5QtI4QmeIJ7VZCHCfaSvQXE9K+PWg9ou/f0NxD93SA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},j={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:t}=s;return t||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create template"})}),"\n",(0,a.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\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",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.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,a.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,a.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,a.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(u.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,a.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,a.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(u.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 Z(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.e44fb86a.js b/assets/js/bbdfc22d.e44fb86a.js new file mode 100644 index 000000000..b8fc94810 --- /dev/null +++ b/assets/js/bbdfc22d.e44fb86a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),o=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tTIzcQ/iva3stCDbZhkxzmtIRQFBVqoTBUDsZFyTNtj0AjCUnjx7rmv6da8/DYhiykcgwX7Fa/H1+31+D5zEE8gjvMjeQeHYwjSNElVhgvtIIY7jJkzTM7s8iJzk5vLhmXUi8cKxxax7xmCT0iSwrndS5+8IlE5hvFEVtkIsmYQztHxh2byAKNFco7NtWWzVCh5V6oGUt1UuRIDwvhM2YspjgVClPmvC0SX1h0PXZvtGKuSBJ0blrI1lLlhtAqYj7D4KhFX1jlGGeFEi8FssPDhvsyPTxkPuOeJVyxCVI0KQVT+4Mdbyac3rQKep3BREwFMdeqehCBNiEIrS5TiKFKSPMOERhueY4eLSV9DYrnCDEsj7gRR14/o4IIBCU9Q56ihQgsvhTCYgqxtwVG4PxKkowTuZGkEpdG6hQhnnLpiCHJMOcQr8GvTOD0VqgZlMTKg1BMbionZqq3XC6XUI4rO+j87zpdkWyilUfl6SM3RookBNV/ctQS630jevKEiacILaXAC3T0+j0EuOtKBFNtc+67lI1vLnxos0qOf9f+w2puJHKHzOJc4IJxlTIKmPlMuLakpPuPbrN/zETbcd2BKSO4v736qKrMe+Pifn+lCytyPsNeonPSRU6Hdmn1cWv5qis8gieN32Y5FzJIRfCkM9UhjCNY5pJU1A3XKI1gYbkxTXeVEQiPuXvN+Y2rZKz+Vpt7XXkZgRdebpFKyoJM0dJ4fCxDyyc34ccXfHkT1Gzb3Bm0jundl5KELTqjlat69GQwoH87oLcFJoQ8LdDI1SeI/qsBScLotlyqyCdh7Nu4TwaDMoIcneOzV2dgk6Gf+FzFXUj/771q61NTKM+B5RWwedPl/ep9/pzilJNne4VrYrqtKxakGxahpFD42FTz8WQwePytLvEvg1/3q3qp5lyKNOyEO4LbT0Ffjj7ThNdGu5AM7jOIob8H32F31dhdWNmZW25MrwFVySeOJqPPjejPjwO8OkwKK/xqSH1RJbmL+p3pNuJPpPH+6W4gz6ndbjfIfd70QoO8e2DaYOn74HEHHV8HvBrv3oCwDoK9B6c26LA18BT5VIc01bW/NqiG5DHVcn4M+1eLcEy48NzEU10udGzsSG9vdnok+tfecbPlq+nusQf1oIY6D1cC3RxSqGcXP6gjNrqeTkUiuGR/4cQJj+MvTUIWi8VebxwEmQvhs2LCLBq9YZ8FYmigrlT75QAi8Ghzdz0dop2LpNkfb5jqB+Z+jVk8CfOPlHSasor0bVeIUi5FgjRym0E9vbi5Yl97A4g67f8Ol/tXl2fn34fnpJUGqCrRcW/QGxCJxi7nqmPorLokO22bbq/pFn7/P08/cp7WIONx6ftGchHOlVDKdY16o92NOY4gI1iMR7Bek4l7K8uSyC8F2hXEo3EEc24F5ZO+lVGDUASTqXD0kLb36ZuF/HJbn7oH7C1Pn3G1B4lzLgvihDJa1wxnlc6jO9Kx4djb0xuJ0yRB4/+Rd9zZEzfXwzuIYFIfy3lYl2D5gg52voAYHuABws8B0hDgPtDXILmaFWEvQqWX/v4GeJa2sg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tTIzcQ/iva3stCDbZhkxzmtIRQFBVqoTBUDsZFyTNtj0AjCUnjx7rmv6da8/DYhiykcgwX7Fa/H1+31+D5zEE8gjvMjeQeHYwjSNElVhgvtIIY7jJkzTM7s8iJzk5vLhmXUi8cKxxax7xmCT0iSwrndS5+8IlE5hvFEVtkIsmYQztHxh2byAKNFco7NtWWzVCh5V6oGUt1UuRIDwvhM2YspjgVClPmvC0SX1h0PXZvtGKuSBJ0blrI1lLlhtAqYj7D4KhFX1jlGGeFEi8FssPDhvsyPTxkPuOeJVyxCVI0KQVT+4Mdbyac3rQKep3BREwFMdeqehCBNiEIrS5TiKFKSPMOERhueY4eLSV9DYrnCDEsj7gRR14/o4IIBCU9Q56ihQgsvhTCYgqxtwVG4PxKkowTuZGkEpdG6hQhnnLpiCHJMOcQr8GvTOD0VqgZlMTKg1BMbionZqq3XC6XUI4rO+j87zpdkWyilUfl6SM3RookBNV/ctQS630jevKEiacILaXAC3T0+j0EuOtKBFNtc+67lI1vLnxos0qOf9f+w2puJHKHzOJc4IJxlTIKmPlMuLakpPuPbrN/zETbcd2BKSO4v736qKrMe+Pifn+lCytyPsNeonPSRU6Hdmn1cWv5qis8gieN32Y5FzJIRfCkM9UhjCNY5pJU1A3XKI1gYbkxTXeVEQiPuXvN+Y2rZKz+Vpt7XXkZgRdebpFKyoJM0dJ4fCxDyyc34ccXfHkT1Gzb3Bm0jundl5KELTqjlat69GQwoH87oLcFJoQ8LdDI1SeI/qsBScLotlyqyCdh7Nu4TwaDMoIcneOzV2dgk6Gf+FzFXUj/771q61NTKM+B5RWwedPl/ep9/pzilJNne4VrYrqtKxakGxahpFD42FTz8WQwePytLvEvg1/3q3qp5lyKNOyEO4LbT0Ffjj7ThNdGu5AM7jOIob8H32F31dhdWNmZW25MrwFVySeOJqPPjejPjwO8OkwKK/xqSH1RJbmL+p3pNuJPpPH+6W4gz6ndbjfIfd70QoO8e2DaYOn74HEHHV8HvBrv3oCwDoK9B6c26LA18BT5VIc01bW/NqiG5DHVcn4M+1eLcEy48NzEU10udGzsSG9vdnok+tfecbPlq+nusQf1oIY6D1cC3RxSqGcXP6gjNrqeTkUiuGR/4cQJj+MvTUIWi8VebxwEmQvhs2LCLBq9YZ8FYmigrlT75QAi8Ghzdz0dop2LpNkfb5jqB+Z+jVk8CfOPlHSasor0bVeIUi5FgjRym0E9vbi5Yl97A4g67f8Ol/tXl2fn34fnpJUGqCrRcW/QGxCJxi7nqmPorLokO22bbq/pFn7/P08/cp7WIONx6ftGchHOlVDKdY16o92NOY4gI1iMR7Bek4l7K8uSyC8F2hXEo3EEc24F5ZO+lVGDUASTqXD0kLb36ZuF/HJbn7oH7C1Pn3G1B4lzLgvihDJa1wxnlc6jO9Kx4djb0xuJ0yRB4/+Rd9zZEzfXwzuIYFIfy3lYl2D5gg52voAYHuABws8B0hDgPtDXILmaFWEvQqWX/v4GeJa2sg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"##default"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "message": "Template created successfully!",\n "result": {\n "code": 0,\n "type": "string",\n "message": "string"\n }\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.415bb7e5.js b/assets/js/f0ff4a36.415bb7e5.js new file mode 100644 index 000000000..4b467330e --- /dev/null +++ b/assets/js/f0ff4a36.415bb7e5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu2zgQ/RV2nhpAsZXEfREWiw2aNOttkRRNin1IDIOSxhYTimRJyrEh6G2/ZD9tv2QxkmXLl9wWi74k9nBmeOZyZugSPJ86iG7hTCdFjso7GAWQokusMF5oBRFcoGecpUsFCEAbtJwOhylEMEXfOTPc8hw9WvJaguI5QgTzQ27EodcPqCAAQV4z5ClaCMDij0JYTCHytsAAnF9IsnEiNxIhAJwbqVOEaMKlI4Ukw5xDVIJfmFrTW6GmUJEqr40iwqicmKrefD6fQxWsoLRYxyJtoRjuM9iOWsf3mPhhyvSEJVp5nvj/E2wAE21z7ruSNXrz+1GcJceZiaGqRnStM1o5dOToOAzp3yZcVyQJOjcpJFuVBwIg5FSYqARujBRJfdC/d2RU7qJroqY6WnLjRXNlUoe00lJFHte1WyE+DsMqgByd41PcF+06to9NMllikXtM2Rq5XLyjIlp0hfQvg2or9NbkfroQD8cncfb9D7rtRni5F/FzLlz9gThBLi61f7MHI5E7ZNSia2pVAXzSkmjxRm9XBtW1mKp//vqbnVkxw9qVeHtgmffGRf3+UlJY2Ut0Tt6uHtXbcd1rZDHWaAhePRVWHri1fEEc9Ji7l8t9WfP3uc661whVFYBvSgoecyO5x3F7d0Wn81ySm61xAB27tawjFEoKheOWiePjMBwPyGMVwCAc7DKynahMac8mulDpu59IyEE4eC0h9wF9LvJBOBifrCL/sBv5UM24FCk7/TpkNzTzf27gH14beBenb3DuNoholJrdtZGVrrzJhsOksMIv6tXX3XnR7YjGeI4+08udWe9Kn0EE/bbf+mVnOVVA/uys3aSFlR1+cmN67YqTPHbE0j43oj87ArqpRXJNaW0yt4FnTUIjPiOx8MVNTQEKNdG18TIJ7dypUzg72lmiN5lwTLj6uI2trjubaMu2rFnMHaZMK+YzrA9JftI7Ys5gIibLlumxO3WnrnWOrHBIC08K9eCiO3XIbq8mE5EILtmfGDvhcfS+zdjj4+NOxg5qmwvhsyJmFo1eq09rYZ3WrtXqywEE4NHm7mpyjXYmknZ6PnFVv1buL4lAj4moBMy5oKouRb9tG1G/SZGgctjpyNOLr1/YSS+EoNMUr4Dc/zL8eH55fU5eqa2aEh31wl5IIqOdz7nqXEQPv7ZqLF6w4dl2gcs1rXeficsO8zj3fSO5qOlTIy6XrX8LHfWo+zIbBZBp50mlLKkvvltZVST+UaAlgo0CmHEreEyNeFtCKhx9TlcvryeBvv+2fMQdsP2PvL3AW74oIsuMy4K+QQAPuNh6VVajKmhJ85+RPQWjuW6TpSs09MxtFE6TBI3vnO3M3I15dHF+AwHwgorSHQ0P9WhYfqBY9mZhE00DgP4SnL0GvxCxP+Pi15V6c/KkwerHQqNNqRhVVfUvqnRZlw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get document by ID",description:"Get a document",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu2zgQ/RV2nhpAsZXEfREWiw2aNOttkRRNin1IDIOSxhYTimRJyrEh6G2/ZD9tv2QxkmXLl9wWi74k9nBmeOZyZugSPJ86iG7hTCdFjso7GAWQokusMF5oBRFcoGecpUsFCEAbtJwOhylEMEXfOTPc8hw9WvJaguI5QgTzQ27EodcPqCAAQV4z5ClaCMDij0JYTCHytsAAnF9IsnEiNxIhAJwbqVOEaMKlI4Ukw5xDVIJfmFrTW6GmUJEqr40iwqicmKrefD6fQxWsoLRYxyJtoRjuM9iOWsf3mPhhyvSEJVp5nvj/E2wAE21z7ruSNXrz+1GcJceZiaGqRnStM1o5dOToOAzp3yZcVyQJOjcpJFuVBwIg5FSYqARujBRJfdC/d2RU7qJroqY6WnLjRXNlUoe00lJFHte1WyE+DsMqgByd41PcF+06to9NMllikXtM2Rq5XLyjIlp0hfQvg2or9NbkfroQD8cncfb9D7rtRni5F/FzLlz9gThBLi61f7MHI5E7ZNSia2pVAXzSkmjxRm9XBtW1mKp//vqbnVkxw9qVeHtgmffGRf3+UlJY2Ut0Tt6uHtXbcd1rZDHWaAhePRVWHri1fEEc9Ji7l8t9WfP3uc661whVFYBvSgoecyO5x3F7d0Wn81ySm61xAB27tawjFEoKheOWiePjMBwPyGMVwCAc7DKynahMac8mulDpu59IyEE4eC0h9wF9LvJBOBifrCL/sBv5UM24FCk7/TpkNzTzf27gH14beBenb3DuNoholJrdtZGVrrzJhsOksMIv6tXX3XnR7YjGeI4+08udWe9Kn0EE/bbf+mVnOVVA/uys3aSFlR1+cmN67YqTPHbE0j43oj87ArqpRXJNaW0yt4FnTUIjPiOx8MVNTQEKNdG18TIJ7dypUzg72lmiN5lwTLj6uI2trjubaMu2rFnMHaZMK+YzrA9JftI7Ys5gIibLlumxO3WnrnWOrHBIC08K9eCiO3XIbq8mE5EILtmfGDvhcfS+zdjj4+NOxg5qmwvhsyJmFo1eq09rYZ3WrtXqywEE4NHm7mpyjXYmknZ6PnFVv1buL4lAj4moBMy5oKouRb9tG1G/SZGgctjpyNOLr1/YSS+EoNMUr4Dc/zL8eH55fU5eqa2aEh31wl5IIqOdz7nqXEQPv7ZqLF6w4dl2gcs1rXeficsO8zj3fSO5qOlTIy6XrX8LHfWo+zIbBZBp50mlLKkvvltZVST+UaAlgo0CmHEreEyNeFtCKhx9TlcvryeBvv+2fMQdsP2PvL3AW74oIsuMy4K+QQAPuNh6VVajKmhJ85+RPQWjuW6TpSs09MxtFE6TBI3vnO3M3I15dHF+AwHwgorSHQ0P9WhYfqBY9mZhE00DgP4SnL0GvxCxP+Pi15V6c/KkwerHQqNNqRhVVfUvqnRZlw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact created successfully!"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Contact created successfully!",\n "result": {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.cf1cb739.js b/assets/js/f0ff4a36.cf1cb739.js deleted file mode 100644 index ff1b46909..000000000 --- a/assets/js/f0ff4a36.cf1cb739.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:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var i=a(85893),n=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),d=(a(82723),a(9487)),o=a(41429),c=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:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2UhV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfomtvTXU05MaJNmSfjGPv8eFGPJ1fxPnX36k698KR9DgX1j9Q+5GLW+WO9qAL5BYZdcO2i5sAPqiCOvBIb3ca5VQs5Pe//mZXRizRuxLHXyx3TtsoDDtJZYpRokrydvcsj8f1qJDF6NEQPD+AGw/cGL6mdndY2h+X+9aPymH8nWjQNAG4tqTbqepjN3S6Kgtyszd58IId6TcBvBu/O2ztnpqYVI5lqpLpG/C6Px3qTuSSFyJll58n7J7o5o2HaTGpjHBrz0lDMopmc5qvEl2uOjLzJOZyiCDs0YX1gDUaIH9m2VNcZYpBNbnWo557Ch5bqmnItQiXZ0CReiRTmrw22zt4tiXT4iNSzX5IoXRBITPljbu89l3qE7E8O2C3+1xYJqw/7u/mqYFlyrA9axZziylTkrkc/SHJL0ZnzGpMRNaxyog9yAc5VSWyyiIxUSHkk40e5Cmb3WWZSAQv2B8YW+Fw/rbP2PPz80HGTrzNjXB5FTODWm3VF17o0zq02rycQAAOTWnvsimapUj6WXslVOiVw44rieWjGrDkgqraiX7ZN6L+K0SC0uKgwS9vPn9iF6MxBIOm+BeQw0+TX69vp9fkldqqLdHZaDwak0gr60ouB4FoI/dVY/GaTa72C1xvmf9wf3cd5nDlQl1wISmKR1x3rT+DgXo0XJnzAHJlHanUNfXFV1M0DYm/VWhowOYBLLkRPKZGnNWQCkvP6WYlvgr07Zduu56wl7fvi8D7eZE0LEteVPQGATzhem/dN/Mm6IfmPyN7DUYbbndKN2jo+6NVuEwS1G5wdrCWd/jo5voeAuAVFWVIDU+eGroHusuLWdhF0wKgX4LzosF7GuyPuP55o96evGqw+YprtSkV86Zp/gGquIW0",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:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2UhV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfomtvTXU05MaJNmSfjGPv8eFGPJ1fxPnX36k698KR9DgX1j9Q+5GLW+WO9qAL5BYZdcO2i5sAPqiCOvBIb3ca5VQs5Pe//mZXRizRuxLHXyx3TtsoDDtJZYpRokrydvcsj8f1qJDF6NEQPD+AGw/cGL6mdndY2h+X+9aPymH8nWjQNAG4tqTbqepjN3S6Kgtyszd58IId6TcBvBu/O2ztnpqYVI5lqpLpG/C6Px3qTuSSFyJll58n7J7o5o2HaTGpjHBrz0lDMopmc5qvEl2uOjLzJOZyiCDs0YX1gDUaIH9m2VNcZYpBNbnWo557Ch5bqmnItQiXZ0CReiRTmrw22zt4tiXT4iNSzX5IoXRBITPljbu89l3qE7E8O2C3+1xYJqw/7u/mqYFlyrA9axZziylTkrkc/SHJL0ZnzGpMRNaxyog9yAc5VSWyyiIxUSHkk40e5Cmb3WWZSAQv2B8YW+Fw/rbP2PPz80HGTrzNjXB5FTODWm3VF17o0zq02rycQAAOTWnvsimapUj6WXslVOiVw44rieWjGrDkgqraiX7ZN6L+K0SC0uKgwS9vPn9iF6MxBIOm+BeQw0+TX69vp9fkldqqLdHZaDwak0gr60ouB4FoI/dVY/GaTa72C1xvmf9wf3cd5nDlQl1wISmKR1x3rT+DgXo0XJnzAHJlHanUNfXFV1M0DYm/VWhowOYBLLkRPKZGnNWQCkvP6WYlvgr07Zduu56wl7fvi8D7eZE0LEteVPQGATzhem/dN/Mm6IfmPyN7DUYbbndKN2jo+6NVuEwS1G5wdrCWd/jo5voeAuAVFWVIDU+eGroHusuLWdhF0wKgX4LzosF7GuyPuP55o96evGqw+YprtSkV86Zp/gGquIW0",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,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)(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:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(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:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n}',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 v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.ae0bc259.js b/assets/js/fa40969b.ae0bc259.js new file mode 100644 index 000000000..9f47465e2 --- /dev/null +++ b/assets/js/fa40969b.ae0bc259.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtSTHSg+LomiaOIabIDZsBz3YgkHtjrSMuSRDcvUDYW95kj5an6QY7o9Wlp1YRttTLvZqODOcn29mOCvwfOogvoK3OilyVN7BKIIUXWKF8UIriOHZs2esOWaXS4Muvlbn6K3AGTLOpHCe6QlLGxVszB2mTCvmlwav1bU66LG9vbeWT3yrycV7e9eKMcb21zTmM+4Zt8iSwlpUXi6ZUCwNks5zX7ge6XtJ+i7EVHFfWGTn+KVA9y2VFr8UwiLzGbKlLixzjXDQd0j6TtT+mdVTi849yUpTCweNQ9L4RudGosf0MfoyPkM2RlTMFUmCzk0KKZcsaXXMhc8Yl7JxJl07Ud35iu48Wphw9tgbsebnKg0uKc2kVlO0jAcrxFhWMfo55BATKdSuDqWN1HgZMlA4tL1rBRFog5YTzk5SiGGKvgERgQoiMNzyHD1aAukKFM8RYkh1QsiCCAQB1HCfwV3UXmYY4LeJTK+ZrZELETSBhNjbAiNwfilJvxMUc4gAF0bqFCGecOmIIckw5xCvINwfg/NWqClxqiKnOgpQbe+DCNoc2QqkwegGKl3GNtEdWp2cDqUJ5bpcyzJqA7PY50bse32LqglOhjxF+286WxIrD0IxJVCRi73FYrGAclTdg87/rtMlySZaeVSePrkxUiQh3f3PjrK02r5Ejz9jElJvCRxeoKNTKXLhO2yqyMfBrYm2OfddSmvcwaCMwN0Ks6PcoCwjWOSSxOrAEhzH5FEZgRdebtJKErDojFauMvflYED/NiG5rmvW4j4kfrcIcWv5ktLrMXffj1xFpvraRm0bhDWO28y+Oxa3Lw/H2ac/yOnLyundVLjwQeVHKj5qv7MGI5E7DI2urWLS9U5LQvWO2k4NKpoaf3/9i721YoZBldjdscx74+J+v6YUVvYSnZO207na3a7POjRKkifzQrd7aro/BsDe06C6t0HZwbHH3Eju8aa5u9zGfzf2jdyaVhXAcDDcxvw5Gm09U9ozPuNC8rHEn54A+ge8TULD2q7u1tvhYFhGkKNzfPqduNxvajdSQlHvvWkq/WY4GN4MofH+1bb3J2rGpUjZ67MTdkld+f91/dVjXe/a6Ss7tzEgKqZqumxEpUuvouEwKazwyzC1u1MpvhrRkMjRZ5pGvtH1nPcZxNDvjv/+qp7zJY1RtLPmFVBY2alBbkyvmUKSjx1VYp8b0Z8dhHnUmHJBca1Ct2HQutCMeI9Uad8dpuQhpet8PeqOmli2o+pg0AwfGkNCTXS4qw5a04pCyGcH9zxfhGPCheMmKAEnbKItuyPdeXBnGA6Jftg7YM5gIiY1xHqM3nEXOg8vMBpDUqhbes3vs6vTyUQkgkv2J46d8Dh63gR4Pp9vBfhFkDkWPivGzKLRa/ZpIIYsdKXaHy8gAo82d6eTC7QzkTQN9YGr+oG5XxcOT0LhYM4FgaAm/XZXiPApRYLKYQfBr4/PPrDD3gCiDoYeYXL/w8mbo48XR6SVUFil6KA36A2IRBjOuepcdIy+zVq1H42XbP1q3Uh154n0Y9X6sWr9Z6tW3eU8LnzfSC5CDw9lsKrb7xXc2b7iBrKjCDJq1PEVrFYEuU9WliWRvxRoqcuPIphxK2hmhh6dCkffabtNPIj55+d1jF+wx+xs97rRdHBF7XvGZUG/IIJbXHbWxXJURk0Lf7KND5lQXbU5M1pLaEWrGN5UOvcvq07QcGw9BNYSr5MEjf8mb3egnp1eXEIE43r9ysMrASyf0wrI5xDDNVxDWL1JQ5iHgb4CydW0CG8FqPTSnOMFQaM7JG/DkKw/KI73Rn8zEpUr9Jccu1fgF5pZ73H5a8tenTwo0G62FTelYVSW5T9fr3mm",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtSTHSg+LomiaOIabIDZsBz3YgkHtjrSMuSRDcvUDYW95kj5an6QY7o9Wlp1YRttTLvZqODOcn29mOCvwfOogvoK3OilyVN7BKIIUXWKF8UIriOHZs2esOWaXS4Muvlbn6K3AGTLOpHCe6QlLGxVszB2mTCvmlwav1bU66LG9vbeWT3yrycV7e9eKMcb21zTmM+4Zt8iSwlpUXi6ZUCwNks5zX7ge6XtJ+i7EVHFfWGTn+KVA9y2VFr8UwiLzGbKlLixzjXDQd0j6TtT+mdVTi849yUpTCweNQ9L4RudGosf0MfoyPkM2RlTMFUmCzk0KKZcsaXXMhc8Yl7JxJl07Ud35iu48Wphw9tgbsebnKg0uKc2kVlO0jAcrxFhWMfo55BATKdSuDqWN1HgZMlA4tL1rBRFog5YTzk5SiGGKvgERgQoiMNzyHD1aAukKFM8RYkh1QsiCCAQB1HCfwV3UXmYY4LeJTK+ZrZELETSBhNjbAiNwfilJvxMUc4gAF0bqFCGecOmIIckw5xCvINwfg/NWqClxqiKnOgpQbe+DCNoc2QqkwegGKl3GNtEdWp2cDqUJ5bpcyzJqA7PY50bse32LqglOhjxF+286WxIrD0IxJVCRi73FYrGAclTdg87/rtMlySZaeVSePrkxUiQh3f3PjrK02r5Ejz9jElJvCRxeoKNTKXLhO2yqyMfBrYm2OfddSmvcwaCMwN0Ks6PcoCwjWOSSxOrAEhzH5FEZgRdebtJKErDojFauMvflYED/NiG5rmvW4j4kfrcIcWv5ktLrMXffj1xFpvraRm0bhDWO28y+Oxa3Lw/H2ac/yOnLyundVLjwQeVHKj5qv7MGI5E7DI2urWLS9U5LQvWO2k4NKpoaf3/9i721YoZBldjdscx74+J+v6YUVvYSnZO207na3a7POjRKkifzQrd7aro/BsDe06C6t0HZwbHH3Eju8aa5u9zGfzf2jdyaVhXAcDDcxvw5Gm09U9ozPuNC8rHEn54A+ge8TULD2q7u1tvhYFhGkKNzfPqduNxvajdSQlHvvWkq/WY4GN4MofH+1bb3J2rGpUjZ67MTdkld+f91/dVjXe/a6Ss7tzEgKqZqumxEpUuvouEwKazwyzC1u1MpvhrRkMjRZ5pGvtH1nPcZxNDvjv/+qp7zJY1RtLPmFVBY2alBbkyvmUKSjx1VYp8b0Z8dhHnUmHJBca1Ct2HQutCMeI9Uad8dpuQhpet8PeqOmli2o+pg0AwfGkNCTXS4qw5a04pCyGcH9zxfhGPCheMmKAEnbKItuyPdeXBnGA6Jftg7YM5gIiY1xHqM3nEXOg8vMBpDUqhbes3vs6vTyUQkgkv2J46d8Dh63gR4Pp9vBfhFkDkWPivGzKLRa/ZpIIYsdKXaHy8gAo82d6eTC7QzkTQN9YGr+oG5XxcOT0LhYM4FgaAm/XZXiPApRYLKYQfBr4/PPrDD3gCiDoYeYXL/w8mbo48XR6SVUFil6KA36A2IRBjOuepcdIy+zVq1H42XbP1q3Uh154n0Y9X6sWr9Z6tW3eU8LnzfSC5CDw9lsKrb7xXc2b7iBrKjCDJq1PEVrFYEuU9WliWRvxRoqcuPIphxK2hmhh6dCkffabtNPIj55+d1jF+wx+xs97rRdHBF7XvGZUG/IIJbXHbWxXJURk0Lf7KND5lQXbU5M1pLaEWrGN5UOvcvq07QcGw9BNYSr5MEjf8mb3egnp1eXEIE43r9ysMrASyf0wrI5xDDNVxDWL1JQ5iHgb4CydW0CG8FqPTSnOMFQaM7JG/DkKw/KI73Rn8zEpUr9Jccu1fgF5pZ73H5a8tenTwo0G62FTelYVSW5T9fr3mm",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'[\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n]',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e2316308.js b/assets/js/fa40969b.e2316308.js deleted file mode 100644 index a732afba1..000000000 --- a/assets/js/fa40969b.e2316308.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var i=n(85893),t=n(11151),a=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=n(41429),o=n(5397),m=n(4667),p=n(9472),h=n(85162);const u={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tu3DYQ/RVm8pIY8l7ipA9CUTRNXMNNEBu2gz54FwUlza4YUyRDUnvBQm/9kn5av6QY6rKy1068QfqWF1s74twPz4w24PncQXwNb3VaFqi8g2kEGbrUCuOFVhDD06dPWfuaXa0NuniiLtBbgQtknEnhPNMzlrUmWMIdZkwr5tcGJ2qixgN2cPDW8pnvLLn44GCiGGPscCtjPueecYssLa1F5eWaCcWyoOk896UbkL0XZO9SzBX3pUV2gZ9LdF8yafFzKSwynyNb69Iy1yoHe0dk71Qdnls9t+jcN0VpGuVg8SVZfKMLI9Fj9hh7OV8gSxAVc2WaonOzUso1SzsbS+FzxqVsk8m2SdQ+X5HP45UJ7x7rEZvzXGUhJaWZ1GqOlvEQhUhkXaOfQg8xlULtm1DWaiXr0IHSoR1MFESgDVpOODvNIIY5+hZEBCqIwHDLC/RoCaQbULxAiCHTKSELIhAEUMN9DndRe5VjgN9tZHrNbINciKAtJMTelhiB82tJ9p2gmkMEuDJSZwjxjEtHB9IcCw7xBoL/GJy3Qs3ppCoLukcBqp0/iKDrka1BGoJuodI/2DW6J2ua05O0pdxe16qKusKsDrkRh17foGqLkyPP0H7PZCs6yoNSTA1UlOJgtVqtoJrWftD533S2Jt1UK4/K0yM3Roo0tHv4yVGXNrtOdPIJ09B6S+DwAh29laIQvndMlUUS0pppW3Dfl3TBjUdVBO5GmD31RlUVwaqQpNYUluCYUEZVBF54eVtWkYJFZ7RydbgvRiP6dxuS23vNOtyHxn+XCtViuke76OyS3eK16+DvJ+LmxVGSf/yDkruqk9vPhAsPdM3IxAft97ZgJHKHgdC620q2fteS0LuntTODiqbDv3//w95ascBgSuyfWO69cfFw2EhKKwepLsja2VLtH9cnHQiR9Cm8wGqdBW4tX9Ot9Vi4r7f7QwDmPUTU9wZVD69tXf9qfVe7OO/X/q5eg/OXo5e70L5Ao61nwjGlPeMLLiRPJD6BoPBqV+FULbgUGXt9fsquiK+ehFgdpqUVfh3Yvs9m8fWUyKVAn2saFUY388HnEMOwPzaGm2Y+VES/aBft9Cit7PWUGzNo2UvyxFFnh9yI4WIceKwN5ZLuX13zWwFtG2fEO6TOfZWEKUO61hdbijxu29VR3HjUkhbRl1AzHXw1zWihHQq3GN8z9oSjNtDrtiiBT9hMW3ZHu7eo5RhekvxoMGbOYCpmDRUNGM3/S12EyU30JYW6oS3wkF2fzWYiFVyyPzFxwuP0WVvg5XK5U+DnQedE+LxMmEWjt8fnQRi60NfqfjyHCDzawp3NLtEuRNpe0AdcDcPhYUOwPA0EiwUXBIJG9OtdJcKrFCkqh71b8frk/D07Gowg6mHoESEP35++Of5weUxWCYV1i8aD0WBEIsJwwVXP0Qn6rmv1Xp2s2XbbudXq3mj9saL/WNH/txW9YTmPKz80kgtF0A3XYNPQ7zXc2drjFrLTCHIi6vgaNhuC3Ecrq4rEn0u0xPLTCBbcChoWgaMz4eg567bQBzH/7KKp8XP2mF3/3jRaBldE3wsuS/oFEdzguveZUU2rqKXwb47xoRBqV7dnRhcJrfb1gTe1zcOrmgnaEzsL41bjdZqi8V882x+o52eXVxBB0qztRfgSAMuX9OnAlxDDBCYQPtnIQpiHQb4BydW85POwcwS7NOd4SdDoD8mbMCSbB6rjvdW/XYk6FfpLid2r8DPNrHe4/qU7Xr95UKH7IqpPUxumVVX9B5ho3I0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tu3DYQ/RVm8pIY8l7ipA9CUTRNXMNNEBu2gz54FwUlza4YUyRDUnvBQm/9kn5av6QY6rKy1068QfqWF1s74twPz4w24PncQXwNb3VaFqi8g2kEGbrUCuOFVhDD06dPWfuaXa0NuniiLtBbgQtknEnhPNMzlrUmWMIdZkwr5tcGJ2qixgN2cPDW8pnvLLn44GCiGGPscCtjPueecYssLa1F5eWaCcWyoOk896UbkL0XZO9SzBX3pUV2gZ9LdF8yafFzKSwynyNb69Iy1yoHe0dk71Qdnls9t+jcN0VpGuVg8SVZfKMLI9Fj9hh7OV8gSxAVc2WaonOzUso1SzsbS+FzxqVsk8m2SdQ+X5HP45UJ7x7rEZvzXGUhJaWZ1GqOlvEQhUhkXaOfQg8xlULtm1DWaiXr0IHSoR1MFESgDVpOODvNIIY5+hZEBCqIwHDLC/RoCaQbULxAiCHTKSELIhAEUMN9DndRe5VjgN9tZHrNbINciKAtJMTelhiB82tJ9p2gmkMEuDJSZwjxjEtHB9IcCw7xBoL/GJy3Qs3ppCoLukcBqp0/iKDrka1BGoJuodI/2DW6J2ua05O0pdxe16qKusKsDrkRh17foGqLkyPP0H7PZCs6yoNSTA1UlOJgtVqtoJrWftD533S2Jt1UK4/K0yM3Roo0tHv4yVGXNrtOdPIJ09B6S+DwAh29laIQvndMlUUS0pppW3Dfl3TBjUdVBO5GmD31RlUVwaqQpNYUluCYUEZVBF54eVtWkYJFZ7RydbgvRiP6dxuS23vNOtyHxn+XCtViuke76OyS3eK16+DvJ+LmxVGSf/yDkruqk9vPhAsPdM3IxAft97ZgJHKHgdC620q2fteS0LuntTODiqbDv3//w95ascBgSuyfWO69cfFw2EhKKwepLsja2VLtH9cnHQiR9Cm8wGqdBW4tX9Ot9Vi4r7f7QwDmPUTU9wZVD69tXf9qfVe7OO/X/q5eg/OXo5e70L5Ao61nwjGlPeMLLiRPJD6BoPBqV+FULbgUGXt9fsquiK+ehFgdpqUVfh3Yvs9m8fWUyKVAn2saFUY388HnEMOwPzaGm2Y+VES/aBft9Cit7PWUGzNo2UvyxFFnh9yI4WIceKwN5ZLuX13zWwFtG2fEO6TOfZWEKUO61hdbijxu29VR3HjUkhbRl1AzHXw1zWihHQq3GN8z9oSjNtDrtiiBT9hMW3ZHu7eo5RhekvxoMGbOYCpmDRUNGM3/S12EyU30JYW6oS3wkF2fzWYiFVyyPzFxwuP0WVvg5XK5U+DnQedE+LxMmEWjt8fnQRi60NfqfjyHCDzawp3NLtEuRNpe0AdcDcPhYUOwPA0EiwUXBIJG9OtdJcKrFCkqh71b8frk/D07Gowg6mHoESEP35++Of5weUxWCYV1i8aD0WBEIsJwwVXP0Qn6rmv1Xp2s2XbbudXq3mj9saL/WNH/txW9YTmPKz80kgtF0A3XYNPQ7zXc2drjFrLTCHIi6vgaNhuC3Ecrq4rEn0u0xPLTCBbcChoWgaMz4eg567bQBzH/7KKp8XP2mF3/3jRaBldE3wsuS/oFEdzguveZUU2rqKXwb47xoRBqV7dnRhcJrfb1gTe1zcOrmgnaEzsL41bjdZqi8V882x+o52eXVxBB0qztRfgSAMuX9OnAlxDDBCYQPtnIQpiHQb4BydW85POwcwS7NOd4SdDoD8mbMCSbB6rjvdW/XYk6FfpLid2r8DPNrHe4/qU7Xr95UKH7IqpPUxumVVX9B5ho3I0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(n,{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:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,i.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.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)(n,{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:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(n,{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:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report is not available!"})}),(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/runtime~main.2b1716a3.js b/assets/js/runtime~main.b70a4847.js similarity index 66% rename from assets/js/runtime~main.2b1716a3.js rename to assets/js/runtime~main.b70a4847.js index ce6d104e3..529a23e34 100644 --- a/assets/js/runtime~main.2b1716a3.js +++ b/assets/js/runtime~main.b70a4847.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,r.c=t,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"e2316308",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"cf1cb739",1359:"49fdcec2",1477:"b31b2642",1520:"cf3449cd",1531:"5761ff15",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"0722cf48",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"4e7c2112",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:"7ccc6dd5",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"7f9061ab",7971:"16260b16",8106:"2df63b7b",8140:"901b2f91",8163:"81ba9e18",8468:"ae8aa607",8475:"d27b3009",8489:"58479125",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"ab8f63df",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="OpenSign-Docs:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n{"use strict";var e,a,c,d,b,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=f,r.c=t,e=[],r.O=(a,c,d,b)=>{if(!c){var f=1/0;for(i=0;i=b)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,b0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[c,d,b]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var b=Object.create(null);r.r(b);var f={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(b,f),b},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"ae0bc259",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"415bb7e5",1359:"49fdcec2",1477:"b31b2642",1520:"c77fc495",1531:"e44fb86a",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"d45861d2",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"b4037d80",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"dbc22dee",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"cbedd512",7971:"ba909b7d",8106:"f92effd7",8140:"901b2f91",8163:"e12965bb",8468:"1bf4c76e",8475:"d27b3009",8489:"621d99d2",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"ddf96f1e",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},b="OpenSign-Docs:",r.l=(e,a,c,f)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var b=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>d=e[a]=[c,b]));c.push(d[2]=b);var f=r.p+r.u(a),t=new Error;r.l(f,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var b=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+f+")",t.name="ChunkLoadError",t.type=b,t.request=f,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,b,f=c[0],t=c[1],o=c[2],n=0;if(f.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index b34547ecd..c7630febf 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 89b9af143..e6815f813 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 3549cb38d..d84fa2059 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 3f7ebcf18..faa6ba480 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 9b569ab85..128e96fc8 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 68bee0bec..d2129b542 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 832c43c89..677cd166b 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 47c8dfc92..a6576fffd 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 80dbc20f5..48a985b8f 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 4193cb040..16e10eb9d 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 6110d264c..874fb0e9f 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + @@ -14,6 +14,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

  • Array [

    • objectId string
    Name string
    Email string
    Phone string

  • ]

Loading...
+

Responses​

successful operation

Schema

  • 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 7769a6086..1b888a103 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create contact | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

required

provide below parameter to create contact

    Name stringrequired
    Email stringrequired
    Phone stringrequired
-

Responses​

Contact created successfully!

Schema

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

Responses​

Contact created successfully!

Schema

    code number
    message string

    result

    contactdetails

    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 7cf0ff9bc..824720c61 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + @@ -14,6 +14,6 @@

Create document

Request​

Header Parameters

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

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
+

Responses​

Document created successfully!

Schema

    code number
    message string

    result

    object

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

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

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

Responses​

Template created successfully!

Schema

    code number
    type string
    message string
Loading...
+

Responses​

Template created successfully!

Schema

    code number
    message string

    result

    ##default

    code number
    type string
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 5b08a6786..90b761947 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™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    template_id stringrequired

    ID of the template that needs to be deleted

Header Parameters

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

Responses​

Invalid ID supplied

Loading...
+

Responses​

Template deleted successfully!

Schema

    code number
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index a57d9fc76..38d709a50 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Deletes contact | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    contact_id stringrequired

    Provide objectId of contact to delete

Header Parameters

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

Responses​

Contact deleted successfully!

Loading...
+

Responses​

Contact deleted successfully!

Schema

    code number
    message string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index eda1449d1..9e4a20e92 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete document by ID | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

Header Parameters

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

Responses​

Document deleted successfully!

Loading...
+

Responses​

Document deleted successfully!

Schema

    code number
    message string
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 2d71a6d14..18ac5d9c6 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get template by ID | OpenSign™ - + @@ -14,6 +14,6 @@

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

Header Parameters

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

Responses​

successful operation

Schema

    Name string
    Note string
    Description string
    URL string
    signers signers[]
    folderId string
Loading...
+

Responses​

successful operation

Schema

    code number

    result

    createtemplate

    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 6552ba9a2..5f6b074a6 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™ - + @@ -14,6 +14,6 @@

Get your details

Request​

Header Parameters

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

Responses​

Successful operation

Schema

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

Responses​

Successful operation

Schema

    code number

    result

    user

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company 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 1628ab24f..b6a854979 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

Header Parameters

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

Responses​

successful operation

Schema

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

Responses​

successful operation

Schema

    code number
    message string

    result

    contactdetails

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

Request​

Path Parameters

    document_id stringrequired

    objectId of contact

Header Parameters

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

Responses​

successful operation

Schema

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
+

Responses​

successful operation

Schema

    code number
    message string

    result

    document

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 1caec1d93..bf85fba25 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get document list by doctype | OpenSign™ - + @@ -55,6 +55,6 @@

Path Parameters

    doctype stringrequired

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

    The type of documents to retrieve

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
+

Responses​

successful operation

Schema

  • Array [

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index ba72c9d8d..92ce5da1d 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

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

    Signers

    object[]

  • Array [

    • objectId sting
    Name string

  • ]

    • CreateBy string
Loading...
+

Responses​

successful operation

Schema

    code number

    result

    template[]

  • Array [

    • objectId string
    File string
    Name string
    Note string
    Description string
    Folder string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • CreateBy string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index bf1cd25ef..fab3c5988 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 8be47ca0a..b01b1ff90 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 4af9037a9..dd46017cc 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™ - + @@ -13,9 +13,9 @@ 
PUT 
/template/:template_id

Update template by ID

Request​

-

Path Parameters

    template_id stringrequired

    ID of the order that needs to be updated

+

Path Parameters

    template_id stringrequired

    ID of the template that needs to be updated

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

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

    Name string
    Note string
    Description string
    FolderId string
-

Responses​

Invalid ID supplied

Loading...
+

Responses​

Template updated successfully!

Schema

    code number
    message string

    result

    object

    objectId string
Loading...
\ No newline at end of file diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index 2bc181a72..313814189 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 612e7b767..f9a64eec0 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 fdf40d061..cc218888d 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 10b37fc5f..26d0dd1ec 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 2a96e56de..613b771b7 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 b612888cd..fd8d780c2 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 8115c2213..dc5e59b93 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 f8af765df..b88c181ea 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 dbf9fc468..02471f659 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 2a8408faa..b2a2b74fe 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 6ed07da90..7ccdd9060 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 ab34f58a2..ff165ffc2 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 8825bc11d..d4351c509 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 5e23cb370..fc4427034 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 b0ad4decc..0ad1b7538 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 c36fda055..20f0a3dcd 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 d198aeab5..ad0768169 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 a9d1e0534..a699ba90c 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 fb1d7821d..d3911374d 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 1357ea7a5..ccec467d5 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 61a59d52a..f181062df 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 de85d4281..9a84f4100 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +