diff --git a/404.html b/404.html index 99b9ed39c..8a9d475d1 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/1f73ca32.3205b4fb.js b/assets/js/1f73ca32.3205b4fb.js deleted file mode 100644 index dd82915b0..000000000 --- a/assets/js/1f73ca32.3205b4fb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=a(85893),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:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJyVVm1v2kgQ/ivb+dRIDjaQpHfW6dRcL4eSVk1UElUqQdHaHmCDvbvdXRMQ8n+vZm2IA0l6+QJ45nlmZ+flMWtwfGohHsGNRQPjAJRGw51Q8jyDGKbovCMAzQ0v0KEh9BokLxBiWB5yLQ6dmqOEAISEGGbIM88w+LMUBjOInSkxAOtWOXGsKHSOEAAuda4yhHjCc0uAdIYFh3gNbqU90hkhp1ARlHtSTPlJK6ays1wul1CN6RyrlbRoidmLIvrK0KZGaLoHxDAs0xStnZQ5214PAkiVdCgd4bnWuUi9I7y3RFrvp6OSe0wd1cJQGCfqI2szlWs38QAmyhTctS2PN/lvIOa9fjK7uaAbfvUFfVuEC4XsH0SinxVc5G/l3ytMED82hk6qCgp1NVPyzakcHZ98+KPf6/b6FOJCJdfC5W+OkuGC6J9UoblcvZW9GQ0forROFWjuxLN9eSSlLWAVwLBMtpNjXyC/loPd5VNrcenuEpHnQk7vMu7w9zN1d1f7X8v8X4pUBSCseh3Yi3r9w250GH247p7ER3/GxyedKIp+QFUFsCz82DT7nDUxXd295nkPVpImtGD1c0XAo+hofwG/YapMxqRybKJKmb0DjzzeR57LBc9Fxk6vztk1yco7f7zFtDTCrbz2tEUnHo1JA54GGaBjK1UalqHjIrcQQIFuphpF82rmZhBDOEVX1vpm0Sw24laanITMOW3jMORadzajlfPE0p6EXItw0fX6s8ltSHpRt+9JhtvWcC0+4wqC34snXVnISd3XpsaXGuVQTKUvzaILu5e+ngnLhPXuTKVlgdJ5QWMTZdgOmyXcYsaUZG6G3kn2fqfLrMZUTBot7LBbeSuHqkBWWiT9zIWc2/hWHrLR5WQiUsFz9h0TKxyO328q9vDwsFexA88ZCDcrE2ZQq0f41Bt9Wdus7cMBBODQFPZyMkSzECk23XnhqNCDw0bheeoVHmuB3Jg+7pJoInORorTYGvTTwdUX1u9EELSG4n+kHH45/3T2dXhGUWms6hZ1O1EnIpNW1hVctg56ZmSftHc7RA6XLtQ5F17mfFLrZpxHsBnncQAzZR2Z1mtq9Y3Jq4rMP0s0tEXjABbcCJ7QbI3GVbAZPZr/TFhyZNs3804q2xcnvP/WvOQPGDXpuRTnuNqb9QXPS0JCFawbwGmaonYt394rmXZtu8aDs2sIgJd07/aCzf2CNT/oLhuXXLViP82mToA+KZ1nCX/RenzG1d9beO15kbD9F1SjqRTjqqp+AU1xLxs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-user",title:"Get your details",description:"Get your details",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJyVVm1v2kgQ/ivb+dRIDjaQpHfW6dRcL4eSVk1UElUqQdHaHmCDvbvdXRMQ8n+vZm2IA0l6+QJ45nlmZ+flMWtwfGohHsGNRQPjAJRGw51Q8jyDGKbovCMAzQ0v0KEh9BokLxBiWB5yLQ6dmqOEAISEGGbIM88w+LMUBjOInSkxAOtWOXGsKHSOEAAuda4yhHjCc0uAdIYFh3gNbqU90hkhp1ARlHtSTPlJK6ays1wul1CN6RyrlbRoidmLIvrK0KZGaLoHxDAs0xStnZQ5214PAkiVdCgd4bnWuUi9I7y3RFrvp6OSe0wd1cJQGCfqI2szlWs38QAmyhTctS2PN/lvIOa9fjK7uaAbfvUFfVuEC4XsH0SinxVc5G/l3ytMED82hk6qCgp1NVPyzakcHZ98+KPf6/b6FOJCJdfC5W+OkuGC6J9UoblcvZW9GQ0forROFWjuxLN9eSSlLWAVwLBMtpNjXyC/loPd5VNrcenuEpHnQk7vMu7w9zN1d1f7X8v8X4pUBSCseh3Yi3r9w250GH247p7ER3/GxyedKIp+QFUFsCz82DT7nDUxXd295nkPVpImtGD1c0XAo+hofwG/YapMxqRybKJKmb0DjzzeR57LBc9Fxk6vztk1yco7f7zFtDTCrbz2tEUnHo1JA54GGaBjK1UalqHjIrcQQIFuphpF82rmZhBDOEVX1vpm0Sw24laanITMOW3jMORadzajlfPE0p6EXItw0fX6s8ltSHpRt+9JhtvWcC0+4wqC34snXVnISd3XpsaXGuVQTKUvzaILu5e+ngnLhPXuTKVlgdJ5QWMTZdgOmyXcYsaUZG6G3kn2fqfLrMZUTBot7LBbeSuHqkBWWiT9zIWc2/hWHrLR5WQiUsFz9h0TKxyO328q9vDwsFexA88ZCDcrE2ZQq0f41Bt9Wdus7cMBBODQFPZyMkSzECk23XnhqNCDw0bheeoVHmuB3Jg+7pJoInORorTYGvTTwdUX1u9EELSG4n+kHH45/3T2dXhGUWms6hZ1O1EnIpNW1hVctg56ZmSftHc7RA6XLtQ5F17mfFLrZpxHsBnncQAzZR2Z1mtq9Y3Jq4rMP0s0tEXjABbcCJ7QbI3GVbAZPZr/TFhyZNs3804q2xcnvP/WvOQPGDXpuRTnuNqb9QXPS0JCFawbwGmaonYt394rmXZtu8aDs2sIgJd07/aCzf2CNT/oLhuXXLViP82mToA+KZ1nCX/RenzG1d9beO15kbD9F1SjqRTjqqp+AU1xLxs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create contact",permalink:"/docs/API-docs/createcontact"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,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 your details"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"Get your details"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(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:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Record not found!"})}),(0,i.jsx)("div",{})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.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/1f73ca32.4e7c2112.js b/assets/js/1f73ca32.4e7c2112.js new file mode 100644 index 000000000..94d3819cb --- /dev/null +++ b/assets/js/1f73ca32.4e7c2112.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:()=>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/52d5c0f9.e5b15fa2.js b/assets/js/52d5c0f9.8e44167e.js similarity index 54% rename from assets/js/52d5c0f9.e5b15fa2.js rename to assets/js/52d5c0f9.8e44167e.js index 386809a2f..3f9a09807 100644 --- a/assets/js/52d5c0f9.e5b15fa2.js +++ b/assets/js/52d5c0f9.8e44167e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,t,d)=>{d.r(t),d.d(t,{assets:()=>p,contentTitle:()=>m,default:()=>j,frontMatter:()=>c,metadata:()=>h,toc:()=>u});var s=d(85893),n=d(11151),a=d(58219),l=(d(62316),d(51039)),o=d.n(l),i=(d(82723),d(9487),d(41429)),r=(d(5397),d(4667),d(9472),d(85162));const c={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/Jj3QNXmwcxEu40UlVovIOVhxSdImVxkutIIYUC/TIBEs7DHDQBq2g83k6IEbHRlhRokdLd9egRIkQw+5CGHnh9RMq4CDp7hxFihY4WPxeSYspxN5WyMH5fUE+TpamQOCAO1PoFCHOROEIkORYCohr8HsTkN5KtYGGoCI4xURTOblRk91ut4OGD1R6rt9k2lMxwudwnPu91VuZItPr/zDx85TpbCgD85q1mf9O/hwybUvhx5aXhEx+tc6vhEuhaVYU1RmtHDq652o6pb/DBK618iLxHdGUuSpJ0LmsKor9GRXrw/TDaS+lPct0pdIO+sdr6FxtRSFT9vl+zh6otWfQNBwcJpWVfh/6P258vFwR8xJ9rl+0EzTjc4gh6ssb1aMmNUBX2m2vqMoWpB7vjYujSBgz6VtdiLWbJLqMhJHR9hIoWE9mQTVvi3VAaeiBMPIr7oH/WLGUo1SZDs7Sh+bcGVQLuVGhFtvLV2J6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBLvunAgVBXAEHJJWaVRGLIWkrnamT8dOJMFCJqgcErxr0ecv97fs/WQKfCSKn6Ac3c6vZ38tZnQryapt0eVkOpmSyWjnS6FGgW7aNThM/3rP5jfHPa4De1qCb+/NTmcedz4yhZCKYgXedTcASxjB4/GeWnHItfMEqWtSxz+2aBoyf6/Q0qStOGyFlWJNclzWkEpHz+mwdE5yffd3t7/O2U+vvDdz6QdJ0RRtRVHRG3B4wv3R2m1WDe+n6ZfJnqLRhjsc34HNwf65md3OHmbAQVRU/vEqeAqroHsgim8mdxikDUy/9LV50+FPGuSvuP84wNuTkw7DR7JFU4arpmn+B3rIo2M=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,h={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/Jj3QNXmwcxEu40UlVovIOVhxSdImVxkutIIYUC/TIBEs7DHDQBq2g83k6IEbHRlhRokdLd9egRIkQw+5CGHnh9RMq4CDp7hxFihY4WPxeSYspxN5WyMH5fUE+TpamQOCAO1PoFCHOROEIkORYCohr8HsTkN5KtYGGoCI4xURTOblRk91ut4OGD1R6rt9k2lMxwudwnPu91VuZItPr/zDx85TpbCgD85q1mf9O/hwybUvhx5aXhEx+tc6vhEuhaVYU1RmtHDq652o6pb/DBK618iLxHdGUuSpJ0LmsKor9GRXrw/TDaS+lPct0pdIO+sdr6FxtRSFT9vl+zh6otWfQNBwcJpWVfh/6P258vFwR8xJ9rl+0EzTjc4gh6ssb1aMmNUBX2m2vqMoWpB7vjYujSBgz6VtdiLWbJLqMhJHR9hIoWE9mQTVvi3VAaeiBMPIr7oH/WLGUo1SZDs7Sh+bcGVQLuVGhFtvLV2J6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBLvunAgVBXAEHJJWaVRGLIWkrnamT8dOJMFCJqgcErxr0ecv97fs/WQKfCSKn6Ac3c6vZ38tZnQryapt0eVkOpmSyWjnS6FGgW7aNThM/3rP5jfHPa4De1qCb+/NTmcedz4yhZCKYgXedTcASxjB4/GeWnHItfMEqWtSxz+2aBoyf6/Q0qStOGyFlWJNclzWkEpHz+mwdE5yffd3t7/O2U+vvDdz6QdJ0RRtRVHRG3B4wv3R2m1WDe+n6ZfJnqLRhjsc34HNwf65md3OHmbAQVRU/vEqeAqroHsgim8mdxikDUy/9LV50+FPGuSvuP84wNuTkw7DR7JFU4arpmn+B3rIo2M=",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",permalink:"/docs/API-docs/getdocumentlist"}},p={},u=[{value:"Request",id:"request",level:2}];function x(e){const t={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:d}=t;return d||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Delete document by ID"})}),"\n",(0,s.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,s.jsx)(t.p,{children:"delete a document"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(i.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(i.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)(r.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(r.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Contact not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(r.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function j(e={}){const{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,t,d)=>{d.r(t),d.d(t,{assets:()=>p,contentTitle:()=>m,default:()=>j,frontMatter:()=>r,metadata:()=>h,toc:()=>u});var s=d(85893),n=d(11151),a=d(58219),l=(d(62316),d(51039)),o=d.n(l),i=(d(82723),d(9487),d(41429)),c=(d(5397),d(4667),d(9472),d(85162));const r={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/Jj3QNXmwcxEu40UlVovIOVhxSdImVxkutIIYUC/TIBEs7DHDQBq2g83k6IEbHRlhRokdLd9egRIkQw+5CGHnh9RMq4CDp7hxFihY4WPxeSYspxN5WyMH5fUE+TpamQOCAO1PoFCHOROEIkORYCohr8HsTkN5KtYGGoCI4xURTOblRk91ut4OGD1R6rt9k2lMxwudwnPu91VuZItPr/zDx85TpbCgD85q1mf9O/hwybUvhx5aXhEx+tc6vhEuhaVYU1RmtHDq652o6pb/DBK618iLxHdGUuSpJ0LmsKor9GRXrw/TDaS+lPct0pdIO+sdr6FxtRSFT9vl+zh6otWfQNBwcJpWVfh/6P258vFwR8xJ9rl+0EzTjc4gh6ssb1aMmNUBX2m2vqMoWpB7vjYujSBgz6VtdiLWbJLqMhJHR9hIoWE9mQTVvi3VAaeiBMPIr7oH/WLGUo1SZDs7Sh+bcGVQLuVGhFtvLV2J6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBLvunAgVBXAEHJJWaVRGLIWkrnamT8dOJMFCJqgcErxr0ecv97fs/WQKfCSKn6Ac3c6vZ38tZnQryapt0eVkOpmSyWjnS6FGgW7aNThM/3rP5jfHPa4De1qCb+/NTmcedz4yhZCKYgXedTcASxjB4/GeWnHItfMEqWtSxz+2aBoyf6/Q0qStOGyFlWJNclzWkEpHz+mwdE5yffd3t7/O2U+vvDdz6QdJ0RRtRVHRG3B4wv3R2m1WDe+n6ZfJnqLRhjsc34HNwf65md3OHmbAQVRU/vEqeAqroHsgim8mdxikDUy/9LV50+FPGuSvuP84wNuTkw7DR7JFU4arpmn+B3rIo2M=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},m=void 0,h={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVd9v2zgM/ldUPq2AGqfd7sU4DBvaYAhWXItLD/eQBoNi07GutqRJcprA8P9+oPyjTtpgw7CXxKY+ih/Jj3QNXmwcxEu40UlVovIOVhxSdImVxkutIIYUC/TIBEs7DHDQBq2g83k6IEbHRlhRokdLd9egRIkQw+5CGHnh9RMq4CDp7hxFihY4WPxeSYspxN5WyMH5fUE+TpamQOCAO1PoFCHOROEIkORYCohr8HsTkN5KtYGGoCI4xURTOblRk91ut4OGD1R6rt9k2lMxwudwnPu91VuZItPr/zDx85TpbCgD85q1mf9O/hwybUvhx5aXhEx+tc6vhEuhaVYU1RmtHDq652o6pb/DBK618iLxHdGUuSpJ0LmsKor9GRXrw/TDaS+lPct0pdIO+sdr6FxtRSFT9vl+zh6otWfQNBwcJpWVfh/6P258vFwR8xJ9rl+0EzTjc4gh6ssb1aMmNUBX2m2vqMoWpB7vjYujSBgz6VtdiLWbJLqMhJHR9hIoWE9mQTVvi3VAaeiBMPIr7oH/WLGUo1SZDs7Sh+bcGVQLuVGhFtvLV2J6yKVj0oXjPrcwRCzTlh15s7VwmDKtmM8xHJL9/eSSOYOJzGQSXCfsUT2qhS6RVQ6zqmCFVE8uflQXbHmXZTKRomD/4tpJj6t3fcWen59fVew8+HyRPq/WzKLRL/BNMIayjr2Gl3Pg4NGW7i5boN3KBLvunAgVBXAEHJJWaVRGLIWkrnamT8dOJMFCJqgcErxr0ecv97fs/WQKfCSKn6Ac3c6vZ38tZnQryapt0eVkOpmSyWjnS6FGgW7aNThM/3rP5jfHPa4De1qCb+/NTmcedz4yhZCKYgXedTcASxjB4/GeWnHItfMEqWtSxz+2aBoyf6/Q0qStOGyFlWJNclzWkEpHz+mwdE5yffd3t7/O2U+vvDdz6QdJ0RRtRVHRG3B4wv3R2m1WDe+n6ZfJnqLRhjsc34HNwf65md3OHmbAQVRU/vEqeAqroHsgim8mdxikDUy/9LV50+FPGuSvuP84wNuTkw7DR7JFU4arpmn+B3rIo2M=",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={},u=[{value:"Request",id:"request",level:2}];function x(e){const t={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:d}=t;return d||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(t.p,{children:"Delete document by ID"})}),"\n",(0,s.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,s.jsx)(t.p,{children:"delete a document"}),"\n",(0,s.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(i.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,s.jsxs)(d,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(t.p,{children:"Header Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(i.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)(t.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(c.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Contact not found!"})}),(0,s.jsx)("div",{})]}),(0,s.jsxs)(c.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(t.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{})]})]})})})]})}function j(e={}){const{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.710d8a00.js b/assets/js/935f2afb.710d8a00.js deleted file mode 100644 index 7dcb7dc79..000000000 --- a/assets/js/935f2afb.710d8a00.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"New-Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}]}],"selfhostSidebar":[{"type":"link","label":"Tutorial Intro","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/self-host/tutorial-basics/create-a-page","docId":"self-host/tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/self-host/tutorial-basics/create-a-document","docId":"self-host/tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/self-host/tutorial-basics/create-a-blog-post","docId":"self-host/tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/self-host/tutorial-basics/markdown-features","docId":"self-host/tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/self-host/tutorial-basics/deploy-your-site","docId":"self-host/tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/self-host/tutorial-basics/congratulations","docId":"self-host/tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/self-host/tutorial-extras/manage-docs-versions","docId":"self-host/tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/self-host/tutorial-extras/translate-your-site","docId":"self-host/tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"COMMUNITY","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATION","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"REPORTING_GUIDELINES","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Deletes contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get contact list","href":"/docs/API-docs/contactlist","className":"api-method post","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Create document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Get document by ID","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Delete document by ID","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get document list","href":"/docs/API-docs/getdocumentlist","className":"api-method post","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get template by ID","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update template by ID","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete template by ID","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get template list","href":"/docs/API-docs/gettemplatelist","className":"api-method post","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get contact list","description":"","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create contact","description":"Create contact","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create document","description":"Create document","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete template by ID","description":"Delete template by ID","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Deletes contact","description":"delete a contact","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete document by ID","description":"delete a document","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get template by ID","description":"","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"Get your details","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get contact","description":"get a contact","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get document by ID","description":"Get a document","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get document list","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get template list","description":"Get template list","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update template by ID","description":"Update template by ID","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"COMMUNITY","description":"","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATION","description":"","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"REPORTING_GUIDELINES","description":"","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/intro":{"id":"self-host/intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/congratulations":{"id":"self-host/tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-blog-post":{"id":"self-host/tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-document":{"id":"self-host/tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-page":{"id":"self-host/tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/deploy-your-site":{"id":"self-host/tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/markdown-features":{"id":"self-host/tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/manage-docs-versions":{"id":"self-host/tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/translate-your-site":{"id":"self-host/tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.d8fb2ce8.js b/assets/js/935f2afb.d8fb2ce8.js new file mode 100644 index 000000000..b9b740892 --- /dev/null +++ b/assets/js/935f2afb.d8fb2ce8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"New-Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}]}],"selfhostSidebar":[{"type":"link","label":"Tutorial Intro","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/self-host/tutorial-basics/create-a-page","docId":"self-host/tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/self-host/tutorial-basics/create-a-document","docId":"self-host/tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/self-host/tutorial-basics/create-a-blog-post","docId":"self-host/tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/self-host/tutorial-basics/markdown-features","docId":"self-host/tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/self-host/tutorial-basics/deploy-your-site","docId":"self-host/tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/self-host/tutorial-basics/congratulations","docId":"self-host/tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/self-host/tutorial-extras/manage-docs-versions","docId":"self-host/tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/self-host/tutorial-extras/translate-your-site","docId":"self-host/tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"COMMUNITY","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATION","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"REPORTING_GUIDELINES","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Deletes contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get contact list","href":"/docs/API-docs/contactlist","className":"api-method post","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Create document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Get document by ID","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Delete document by ID","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get document list by doctype","href":"/docs/API-docs/getdocumentlist","className":"api-method post","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Create template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Get template by ID","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update template by ID","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete template by ID","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get template list","href":"/docs/API-docs/gettemplatelist","className":"api-method post","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"id":"API-docs/contactlist","title":"Get contact list","description":"","sidebar":"apiSidebar"},"API-docs/createcontact":{"id":"API-docs/createcontact","title":"Create contact","description":"Create contact","sidebar":"apiSidebar"},"API-docs/createdocument":{"id":"API-docs/createdocument","title":"Create document","description":"Create document","sidebar":"apiSidebar"},"API-docs/createtemplate":{"id":"API-docs/createtemplate","title":"Create template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/delete-template":{"id":"API-docs/delete-template","title":"Delete template by ID","description":"Delete template by ID","sidebar":"apiSidebar"},"API-docs/deletecontact":{"id":"API-docs/deletecontact","title":"Deletes contact","description":"delete a contact","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete document by ID","description":"delete a document","sidebar":"apiSidebar"},"API-docs/get-template":{"id":"API-docs/get-template","title":"Get template by ID","description":"","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"Get your details","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get contact","description":"get a contact","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get document by ID","description":"Get a document","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get document list by doctype","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"id":"API-docs/gettemplatelist","title":"Get template list","description":"Get template list","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/update-template":{"id":"API-docs/update-template","title":"Update template by ID","description":"Update template by ID","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"COMMUNITY","description":"","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATION","description":"","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"REPORTING_GUIDELINES","description":"","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/intro":{"id":"self-host/intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/congratulations":{"id":"self-host/tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-blog-post":{"id":"self-host/tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-document":{"id":"self-host/tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/create-a-page":{"id":"self-host/tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/deploy-your-site":{"id":"self-host/tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"selfhostSidebar"},"self-host/tutorial-basics/markdown-features":{"id":"self-host/tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/manage-docs-versions":{"id":"self-host/tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"selfhostSidebar"},"self-host/tutorial-extras/translate-your-site":{"id":"self-host/tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.7a142a0b.js b/assets/js/bbdfc22d.5761ff15.js similarity index 50% rename from assets/js/bbdfc22d.7a142a0b.js rename to assets/js/bbdfc22d.5761ff15.js index e2fb4d9c4..81280069a 100644 --- a/assets/js/bbdfc22d.7a142a0b.js +++ b/assets/js/bbdfc22d.5761ff15.js @@ -1 +1 @@ -"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",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 +"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/f0ff4a36.7753345a.js b/assets/js/f0ff4a36.7753345a.js new file mode 100644 index 000000000..2884d36ef --- /dev/null +++ b/assets/js/f0ff4a36.7753345a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var n=a(85893),i=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),d=(a(82723),a(9487)),c=a(41429),o=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2WgV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfouPG8DXlxWFpB/I2G1RfQ+6daKH0STr2fh9uxNP5RZx//Z2qdi8cSY9zYf0DtSW5uFXuaA+6QG6RUZdsu7sJ4IMqqDOP9HanUU7FQn7/6292ZcQSvStx/MVy57SNwrCTVKYYJaokb3fP8nhcjwpZjB4NwfOD+aPlvvUjdBh/Jxo0TQCuLel22vrYDZ2uyoLc7E0kvGBH+mTxbvzusOd7zmJSOZapSqZvwOv+dKg7kUteiJRdfp6we+KhNx6nxaQywq09WQ1ZKprNafBKdLnqWM6zm8shgrCHF9YDOmmA/Jllz32VKQbl5FqPelIqeGypqCHXIlyeAUXqkUxpJNt07+DZ1kyLj0hF+1dupQsKmSlv3CW2b1OfiOXZAe3d58IyYf1xfzfPGSxThu1Zs5hbTJmSzOXoD0l+MTpjVmMiso5uRuxBPsipKpFVFomiCiGfbPQgT9nsLstEInjB/sDYCofzt33Gnp+fDzJ24m1uhMurmBnUaqu+8EKf1qHV5uUEAnBoSnuXTdEsRdIP2yuhQq8cdiRK9B/VgCUXVNVO9Mu+EfVfIRKUFgcdfnnz+RO7GI0hGDTFf4Acfpr8en07vSav1FZtic5G49GYRFpZV3I5CESruq8ai9dscrVf4Hq7Eg4Xe9dhDlcu1AUXkqJ4xHXX+jMYqEfDXToPIFfWkUpdU198NUXTkPhbhYYGbB7AkhvBY2rEWQ2psPScbnblq0DffunW7gl7eS2/CLyfF0nDsuRFRW8QwBOu974DmnkT9EPzw8heg9GG253SDRr6MGkVLpMEtRucHezrHT66ub6HAHhFRRlSw5Onhu6B7vJiFnbRtADol+C8aPCeBvsjrn/eqLcnrxpsPu9abUrFvGmafwAgCI4b",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2WgV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfouPG8DXlxWFpB/I2G1RfQ+6daKH0STr2fh9uxNP5RZx//Z2qdi8cSY9zYf0DtSW5uFXuaA+6QG6RUZdsu7sJ4IMqqDOP9HanUU7FQn7/6292ZcQSvStx/MVy57SNwrCTVKYYJaokb3fP8nhcjwpZjB4NwfOD+aPlvvUjdBh/Jxo0TQCuLel22vrYDZ2uyoLc7E0kvGBH+mTxbvzusOd7zmJSOZapSqZvwOv+dKg7kUteiJRdfp6we+KhNx6nxaQywq09WQ1ZKprNafBKdLnqWM6zm8shgrCHF9YDOmmA/Jllz32VKQbl5FqPelIqeGypqCHXIlyeAUXqkUxpJNt07+DZ1kyLj0hF+1dupQsKmSlv3CW2b1OfiOXZAe3d58IyYf1xfzfPGSxThu1Zs5hbTJmSzOXoD0l+MTpjVmMiso5uRuxBPsipKpFVFomiCiGfbPQgT9nsLstEInjB/sDYCofzt33Gnp+fDzJ24m1uhMurmBnUaqu+8EKf1qHV5uUEAnBoSnuXTdEsRdIP2yuhQq8cdiRK9B/VgCUXVNVO9Mu+EfVfIRKUFgcdfnnz+RO7GI0hGDTFf4Acfpr8en07vSav1FZtic5G49GYRFpZV3I5CESruq8ai9dscrVf4Hq7Eg4Xe9dhDlcu1AUXkqJ4xHXX+jMYqEfDXToPIFfWkUpdU198NUXTkPhbhYYGbB7AkhvBY2rEWQ2psPScbnblq0DffunW7gl7eS2/CLyfF0nDsuRFRW8QwBOu974DmnkT9EPzw8heg9GG253SDRr6MGkVLpMEtRucHezrHT66ub6HAHhFRRlSw5Onhu6B7vJiFnbRtADol+C8aPCeBvsjrn/eqLcnrxpsPu9abUrFvGmafwAgCI4b",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"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(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)(t.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(m.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)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.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,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",{})]}),(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",{})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.86ea4c77.js b/assets/js/f0ff4a36.86ea4c77.js deleted file mode 100644 index 84e7300fe..000000000 --- a/assets/js/f0ff4a36.86ea4c77.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:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=a(85893),n=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),o=(a(82723),a(9487)),d=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:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+ObCfpPMwfbJN87vjwXh6yAMfnFoJbOFNRnqF0FqYexGgjI7QTSkIAF+gYZ3EDAA+URsNpcRxDAHN0nTXNDc/QoSGvBUieIQSwPORaHDr1iBI8EOQ1QR6jAQ8Mfs+FwRgCZ3L0wLpVSjZWZDpF8ACXOlUxQjDjqSVAlGDGISjArXSFdEbIOZQE5ZVRQBylFXPZWy6XSyi9NZWW672IWyqauwS2T63CB4zcOGZqxiIlHY/c/0nWg5kyGXfdmWf2+o9BmETDRIdQllPa1molLVpyNPR9+tmka/MoQmtnecrW6QEPiDklJiiAa52KqFroP1gyKnbZcWP4iuLiMLOd+ToalF9D7p2oqbRB2vd8v1+Ix+EoTL5dUta+VpnZz8OlQvYbIpmfZ1yk+9o/KAwRPzYTvUhl5Oo6UXJvKkfHJx9+Gg0HwxG5uFThjXDp3l5iXJD5J5VpLlf7WrflXrnIrVMZGqrwF9w8G0UdYOnBJA/XFWVfMX6Lg922p9Ti0t2HIk2FnN/H3OGPa+r+vl5/i/kZeSo9EFa9DRz6w9HhwD/0P9wMToKjn4Pjk57v+39DWXqwzKqyaYWh8enq7DXjHVhu0XRh9Zg+Hhz5R7ud2Sork8qxmcpl/A4q7PEudiwXPBUxO70esxtSy3cVA4tRboRbVZLa1dLgdkrykKFLVKPFlQa7BALot1LXLzqiVwL5M4tWoXOTkho7p23Q73Ote20tpTy01Bh9rkV/MQDaqWUyIeGo87XB51lItPiMpCQ/vAHogELO6kQ2Qb3SKCdiLqtALAY74nyTCMuErZbbs1XKxmbKsC1rFnKLMVOSuQSrRZof9QbMaozErBHFHruTd3KiMmS5RRLSVMhHG9zJQ3Z7NZuJSPCU/YWhFQ6n79uIPT097UTsoLK5EC7JQ2ZQq2f4vJqswtq1Wg8OwAOHJrNXswmahYiwyc4rW/UrcL+RerqkggKwVsR26uO2EdVfKiKUFjuVfXpx/YWNej54naL4F5T7X8afzr9OzskrlVWdokHP7/k0pZV1GZedjehB0WaNhSs2PttOcPF8ce0+P5oKc7h0fZ1yUYlexbhoSv8WOvCge+NPPUiUdQQpCqqLbyYtS5r+nqOhBpt6sOBG8JAK8baAWFj6H69v9FeJvv+zeRwcsJcfDy8Sb/tFUrMseJrTCDx4xNXWa6Wcll7bNP+Z2Ws06u02u3TNhp5PNeA0ilC7ztrOq2JDjy7Ob8ADnlNSutLwWElD84fO8mIUNtnUBOib6Lxo8As19mdc/bqG1yuvGqwfoTWaQjEty/IfnPnAPw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get document by ID",description:"Get a document",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+ObCfpPMwfbJN87vjwXh6yAMfnFoJbOFNRnqF0FqYexGgjI7QTSkIAF+gYZ3EDAA+URsNpcRxDAHN0nTXNDc/QoSGvBUieIQSwPORaHDr1iBI8EOQ1QR6jAQ8Mfs+FwRgCZ3L0wLpVSjZWZDpF8ACXOlUxQjDjqSVAlGDGISjArXSFdEbIOZQE5ZVRQBylFXPZWy6XSyi9NZWW672IWyqauwS2T63CB4zcOGZqxiIlHY/c/0nWg5kyGXfdmWf2+o9BmETDRIdQllPa1molLVpyNPR9+tmka/MoQmtnecrW6QEPiDklJiiAa52KqFroP1gyKnbZcWP4iuLiMLOd+ToalF9D7p2oqbRB2vd8v1+Ix+EoTL5dUta+VpnZz8OlQvYbIpmfZ1yk+9o/KAwRPzYTvUhl5Oo6UXJvKkfHJx9+Gg0HwxG5uFThjXDp3l5iXJD5J5VpLlf7WrflXrnIrVMZGqrwF9w8G0UdYOnBJA/XFWVfMX6Lg922p9Ti0t2HIk2FnN/H3OGPa+r+vl5/i/kZeSo9EFa9DRz6w9HhwD/0P9wMToKjn4Pjk57v+39DWXqwzKqyaYWh8enq7DXjHVhu0XRh9Zg+Hhz5R7ud2Sork8qxmcpl/A4q7PEudiwXPBUxO70esxtSy3cVA4tRboRbVZLa1dLgdkrykKFLVKPFlQa7BALot1LXLzqiVwL5M4tWoXOTkho7p23Q73Ote20tpTy01Bh9rkV/MQDaqWUyIeGo87XB51lItPiMpCQ/vAHogELO6kQ2Qb3SKCdiLqtALAY74nyTCMuErZbbs1XKxmbKsC1rFnKLMVOSuQSrRZof9QbMaozErBHFHruTd3KiMmS5RRLSVMhHG9zJQ3Z7NZuJSPCU/YWhFQ6n79uIPT097UTsoLK5EC7JQ2ZQq2f4vJqswtq1Wg8OwAOHJrNXswmahYiwyc4rW/UrcL+RerqkggKwVsR26uO2EdVfKiKUFjuVfXpx/YWNej54naL4F5T7X8afzr9OzskrlVWdokHP7/k0pZV1GZedjehB0WaNhSs2PttOcPF8ce0+P5oKc7h0fZ1yUYlexbhoSv8WOvCge+NPPUiUdQQpCqqLbyYtS5r+nqOhBpt6sOBG8JAK8baAWFj6H69v9FeJvv+zeRwcsJcfDy8Sb/tFUrMseJrTCDx4xNXWa6Wcll7bNP+Z2Ws06u02u3TNhp5PNeA0ilC7ztrOq2JDjy7Ob8ADnlNSutLwWElD84fO8mIUNtnUBOib6Lxo8As19mdc/bqG1yuvGqwfoTWaQjEty/IfnPnAPw==",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={},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,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)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,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)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("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:"FGik23bhUJ"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})}),(0,i.jsx)("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 {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.220ffc26.js b/assets/js/fa40969b.220ffc26.js deleted file mode 100644 index 285bab871..000000000 --- a/assets/js/fa40969b.220ffc26.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:()=>f});var i=n(85893),t=n(11151),l=n(58219),a=(n(62316),n(51039)),r=n.n(a),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",description:"### Document Types:",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktvGzkM/isqc2mCiR9tuofBYrHZNAiCFk2QZLGH2Ad5hvao0UiKpLE9MOa/L6h5eBwn3bTo3npJxhRJkfw+kdyA5wsH8T181EmRo/IOphGk6BIrjBdaQQwHBwesPWZ3pUEXT9QNeitwiYwzKZxnes7S1gWbcYcp04r50uBETdR4wI6OPlo+950nFx8dTRRjjB1vZcxn3DNukSWFtai8LJlQLA2WznNfuAH5e0f+bsVCcV9YZDf4WKD7lkuLj4WwyHyGrNSFZa41Dv7ek79LdXxt9cKicz8UpWmMg8cT8nimcyPRY/oafxlfIpshKuaKJEHn5oWUJUs6HyvhM8albJNJt0nUd36gO8/XJpy99kZs9LlKQ0pKM6nVAi3jIQoxk3WNfgsYYiKF+t6E0tZqVgYECod2MFEQgTZoOfHsMoUYFuhbEhGpIALDLc/RoyWSbkDxHCGGVCfELIhAEEEN9xk8Ze1dhoF+u8z0mtmGuRBBW0iIvS0wAudLSf6doJpDBLg2UqcI8ZxLRwpJhjmHeAPh/hict0ItSFMVOb2jQNXuPoigw8jWJA1Bt1TpK3ZA92QNOD1JW8rtc62qqCvM+pgbcez1A6q2OBnyFO3PTLYiVR6MYgJQUYqD9Xq9hmpa34PO/6XTkmwTrTwqT5/cGCmSAPfwqyOUNvuX6NlXTAL0lsjhBTo6lSIXvqeminwW0pprm3Pfl3TBjUdVBO5BmO+0G1VVBOtckllTWKLjjDKqIvDCy11ZRQYWndHK1eG+G43o3y4lt++adbwPwP+UCiUBu6eJUrxB8AyKOTrHF8+d7eV/cJDinBfS9wtwasRNk3RTg5PRyX7aN2i09Uw4prRnfMmF5DOJbyAYfNg3uFRLLkXKTq8v2R1x+U2IyGFSWOHL0An6TI/vp0S8HH2mqY0Y3fQOn0EMw35LGW6a3lHR00S7bDtLYSU9Fu+Ni4dDbsygZbbkMzdIdD7kRgyX48DxNpRbwqYu/05AXUG5EZ+whOi/HyhlSJDfbJ/PeUvIjv7jUUtoorZQcx3uavC4MqhoKIbCLcfPtEThCAY6bosSuMbm2rIn1r0hnmE4JPn7wZg5g4mYNzQdMJoNtzoPXZ2oLYV6oA3hmN1fzeciEVyyf3DmhMfp27bAq9Vqr8CHweZC+KyYMYtGb9UXQRhQ6Ft1Pw4hAo82d1fzW7RLkWAD5gtXDYPysHl8PAmPD3MuiASN6M+nRsRXKRIkum9fxunF9Wf2fjCCqMehV4Q8/Hx5dv7l9py8EgtriMaD0WBEIuJwzlXvogv0HWqsGY87+PZ67a+d7dfO9r/tbE1r87j2QyO5UMTXwP1N03Pv4ckaF7cb2zSCjLpzfA+bDVHubyurisSPBVpq7dMIltwKmhChMafC0XfarSUvcv7tTVPjQ/aa5e/ZNNq2rahnL7ks6BdE8IBlb++splXU9u0fjvGlEOqrdgdFFwnterXCWe3z+K5ehFuNvQ1ia3GaJGj8N3X7U/T66vYOIpg1e1we1guwfEW7JF9BDBOYQNjhyUMYgkG+AcnVogibBdR+abjxgqjRn4wPYTI2H1THZ6u/W4k6FfpLiT1r8DsNqk9Y/tGp1ycvGnQrcq1NMEyrqvoX08Azgg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list",description:"### 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",description:"### Document Types:",sidebar_label:"Get document list",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktvGzkM/isqc2mCiR9tuofBYrHZNAiCFk2QZLGH2Ad5hvao0UiKpLE9MOa/L6h5eBwn3bTo3npJxhRJkfw+kdyA5wsH8T181EmRo/IOphGk6BIrjBdaQQwHBwesPWZ3pUEXT9QNeitwiYwzKZxnes7S1gWbcYcp04r50uBETdR4wI6OPlo+950nFx8dTRRjjB1vZcxn3DNukSWFtai8LJlQLA2WznNfuAH5e0f+bsVCcV9YZDf4WKD7lkuLj4WwyHyGrNSFZa41Dv7ek79LdXxt9cKicz8UpWmMg8cT8nimcyPRY/oafxlfIpshKuaKJEHn5oWUJUs6HyvhM8albJNJt0nUd36gO8/XJpy99kZs9LlKQ0pKM6nVAi3jIQoxk3WNfgsYYiKF+t6E0tZqVgYECod2MFEQgTZoOfHsMoUYFuhbEhGpIALDLc/RoyWSbkDxHCGGVCfELIhAEEEN9xk8Ze1dhoF+u8z0mtmGuRBBW0iIvS0wAudLSf6doJpDBLg2UqcI8ZxLRwpJhjmHeAPh/hict0ItSFMVOb2jQNXuPoigw8jWJA1Bt1TpK3ZA92QNOD1JW8rtc62qqCvM+pgbcez1A6q2OBnyFO3PTLYiVR6MYgJQUYqD9Xq9hmpa34PO/6XTkmwTrTwqT5/cGCmSAPfwqyOUNvuX6NlXTAL0lsjhBTo6lSIXvqeminwW0pprm3Pfl3TBjUdVBO5BmO+0G1VVBOtckllTWKLjjDKqIvDCy11ZRQYWndHK1eG+G43o3y4lt++adbwPwP+UCiUBu6eJUrxB8AyKOTrHF8+d7eV/cJDinBfS9wtwasRNk3RTg5PRyX7aN2i09Uw4prRnfMmF5DOJbyAYfNg3uFRLLkXKTq8v2R1x+U2IyGFSWOHL0An6TI/vp0S8HH2mqY0Y3fQOn0EMw35LGW6a3lHR00S7bDtLYSU9Fu+Ni4dDbsygZbbkMzdIdD7kRgyX48DxNpRbwqYu/05AXUG5EZ+whOi/HyhlSJDfbJ/PeUvIjv7jUUtoorZQcx3uavC4MqhoKIbCLcfPtEThCAY6bosSuMbm2rIn1r0hnmE4JPn7wZg5g4mYNzQdMJoNtzoPXZ2oLYV6oA3hmN1fzeciEVyyf3DmhMfp27bAq9Vqr8CHweZC+KyYMYtGb9UXQRhQ6Ft1Pw4hAo82d1fzW7RLkWAD5gtXDYPysHl8PAmPD3MuiASN6M+nRsRXKRIkum9fxunF9Wf2fjCCqMehV4Q8/Hx5dv7l9py8EgtriMaD0WBEIuJwzlXvogv0HWqsGY87+PZ67a+d7dfO9r/tbE1r87j2QyO5UMTXwP1N03Pv4ckaF7cb2zSCjLpzfA+bDVHubyurisSPBVpq7dMIltwKmhChMafC0XfarSUvcv7tTVPjQ/aa5e/ZNNq2rahnL7ks6BdE8IBlb++splXU9u0fjvGlEOqrdgdFFwnterXCWe3z+K5ehFuNvQ1ia3GaJGj8N3X7U/T66vYOIpg1e1we1guwfEW7JF9BDBOYQNjhyUMYgkG+AcnVogibBdR+abjxgqjRn4wPYTI2H1THZ6u/W4k6FfpLiT1r8DsNqk9Y/tGp1ycvGnQrcq1NMEyrqvoX08Azgg==",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 y(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"})}),"\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)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "code": 0,\n "type": "string",\n "message": "string"\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)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.e2316308.js b/assets/js/fa40969b.e2316308.js new file mode 100644 index 000000000..a732afba1 --- /dev/null +++ b/assets/js/fa40969b.e2316308.js @@ -0,0 +1 @@ +"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.7b73134f.js b/assets/js/runtime~main.46bc4aec.js similarity index 92% rename from assets/js/runtime~main.7b73134f.js rename to assets/js/runtime~main.46bc4aec.js index f5d4fdf90..23033ea60 100644 --- a/assets/js/runtime~main.7b73134f.js +++ b/assets/js/runtime~main.46bc4aec.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,f,c,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,f,c)=>{if(!d){var b=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(c,b),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",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:"710d8a00",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"220ffc26",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"86ea4c77",1359:"49fdcec2",1477:"b31b2642",1520:"cf3449cd",1531:"7a142a0b",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"0722cf48",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"3205b4fb",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:"e5b15fa2",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:"46034b3d",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="OpenSign-Docs:",r.l=(e,a,d,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)d.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>f=e[a]=[d,c]));d.push(f[2]=c);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+b+")",t.name="ChunkLoadError",t.type=c,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var f,c,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,d,f,c,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,f,c)=>{if(!d){var b=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(c,b),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",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:"7753345a",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:"8e44167e",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:"46034b3d",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="OpenSign-Docs:",r.l=(e,a,d,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)d.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>f=e[a]=[d,c]));d.push(f[2]=c);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+b+")",t.name="ChunkLoadError",t.type=c,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var f,c,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(d);n Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 59130a420..7dc7b5343 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 832ee0b4b..0cd32e99a 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 4003f1c73..eaf449045 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 16256085c..6f960bdb2 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 b97e19574..c8d206da4 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 21f5cd76c..8fe1e7b05 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 0b1591da0..0eaa97426 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 2a480d8ad..3aa6cb176 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 5c7fae8bf..31629cdc3 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 650520716..d1cf5dded 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 e019a2284..3088ca5e4 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 8d594a181..483331de2 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index c285ce855..017ffac33 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,11 +5,11 @@ Create document | OpenSign™ - + -

Create document

+

Create document

POST 
/createdocument

Create document

Request​

diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index bc00816b7..573247cca 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
    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 335396457..cf0ba5ad6 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete template by ID | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 6ed33fcee..d1a55cd8b 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Deletes contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index e9e550ba5..9b0028f57 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,16 +5,16 @@ Delete document by ID | OpenSign™ - + -

Delete document by ID

+

Delete document by ID

DELETE 
/document/:document_id

delete a document

Request​

Path Parameters

    document_id stringrequired

    Provide objectId of document to delete

Header Parameters

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

Responses​

Contact deleted successfully!

Loading...
+

Responses​

Contact deleted successfully!

Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index a9e2aa304..288149be5 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get template by ID | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 3448c0329..2e193e5f2 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
    Customer_id string
    Subscriptions_id string

    Next_billing_date

    date

    __type string
    iso string
Loading...
+

Responses​

Successful operation

Schema

    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 a7f7d2403..9c5bf33bb 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index c59d01b1c..257252fed 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,16 +5,16 @@ Get document by ID | OpenSign™ - + -

Get document by ID

+

Get document by ID

GET 
/document/:document_id

Get a document

Request​

Path Parameters

    document_id stringrequired

    objectId of contact

Header Parameters

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

Responses​

successful operation

Schema

  • Array [

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

    Next_billing_date

    date

    __type string
    iso string

  • ]

Loading...
+

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/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 0247e0b15..d82bf4d53 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -3,13 +3,13 @@ -Get document list | OpenSign™ +Get document list by doctype | OpenSign™ - + -

Get document list

+

Get document list by doctype

POST 
/documentlist/:doctype

Document Types:​

Retrieve a list of documents based on type

@@ -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

    code number
    type string
    message string
Loading...
+

Responses​

successful operation

Schema

    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 aec4525c5..461736bd1 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 3d2ead577..a15c00aa4 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 8e26fc9ac..592db1d03 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 b6590701c..7347b2b90 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update template by ID | OpenSign™ - + diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index 4df845163..4ca22e52d 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 f1e9814aa..b4c8ee5eb 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 584cf43e9..dfbda4a57 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 a6c472070..09af57dcd 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 cd9029082..e86812e67 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 ab373befe..a9b2ab07a 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 75b3f6a83..dec3b52f6 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 ab33252fc..e92700272 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 e7736564e..517a311be 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 5342ee5d9..840312431 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 faa5c7ce6..5fc600d13 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 f1662f824..17486928d 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 a56b62e1b..09ed46477 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 5f79400fd..8e1422fe5 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 c821b2ecd..610b3b1f4 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 65f7288b3..a6058c1ac 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 b97331ea4..aead92b08 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 41a6c9fa7..2c4f6dbd9 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 7a5cffd35..a92e3828a 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 ddff0f99e..cd0e4fd29 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 c4da371e5..33d18fed3 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 b42b9c50f..9c84f7886 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +