From 51dde6cebdaa076e3cb66684b2c6c041006893fa Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 11:15:14 +0000 Subject: [PATCH] deploy: 6e4ed4bc091ec4b9e6e5a115b3fa60a2598a8bbf --- 404.html | 2 +- assets/js/377084eb.015e4a9a.js | 1 + assets/js/377084eb.bdaa43a4.js | 1 - assets/js/770b40a9.2b1a3844.js | 1 - assets/js/770b40a9.cfe051cf.js | 1 + assets/js/f0ff4a36.38cfb709.js | 1 - assets/js/f0ff4a36.bdf7e411.js | 1 + assets/js/fa40969b.4fa1889c.js | 1 - assets/js/fa40969b.fbe110b4.js | 1 + .../js/{runtime~main.89bd2d89.js => runtime~main.91cf2df1.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 2 +- docs/API-docs/createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createtemplate/index.html | 2 +- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/draftedocument/index.html | 2 +- docs/API-docs/get-template/index.html | 4 ++-- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 4 ++-- docs/API-docs/getdocumentlist/index.html | 4 ++-- docs/API-docs/gettemplatelist/index.html | 4 ++-- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 2 +- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/category/create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/manage-docs-using-opensign-drive/index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- docs/help/OpenSign™ Drive/organize-documents/index.html | 2 +- docs/help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Settings/profile/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- docs/self-host/One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 79 files changed, 79 insertions(+), 79 deletions(-) create mode 100644 assets/js/377084eb.015e4a9a.js delete mode 100644 assets/js/377084eb.bdaa43a4.js delete mode 100644 assets/js/770b40a9.2b1a3844.js create mode 100644 assets/js/770b40a9.cfe051cf.js delete mode 100644 assets/js/f0ff4a36.38cfb709.js create mode 100644 assets/js/f0ff4a36.bdf7e411.js delete mode 100644 assets/js/fa40969b.4fa1889c.js create mode 100644 assets/js/fa40969b.fbe110b4.js rename assets/js/{runtime~main.89bd2d89.js => runtime~main.91cf2df1.js} (96%) diff --git a/404.html b/404.html index 255d10dcc..8c9177500 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/377084eb.015e4a9a.js b/assets/js/377084eb.015e4a9a.js new file mode 100644 index 000000000..d1592b05e --- /dev/null +++ b/assets/js/377084eb.015e4a9a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),m=(s(82723),s(9487)),c=s(41429),p=s(5397),o=s(4667),d=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/ivcfWoB+S1x004YhgZbkQUtlmDxMGCpEdDSWWIjkSxJ+QWG/vtw1ItlO7UbbAiwL7ZE3sO7e3Rv3IDjiYXwHiaY64w7tDANIEYbGaGdUBJCmKTIrtCxRoRd3l4znmVqadlaFcwpZtAZgQtkMTouMsv4TBWOcWY1RmIuIuZqcL89xjKLZoGMWzbLCtRGSGfZXBkWGeROyITFKipypOWlcCnTBmOcC4kxs84UkSsM2j4EoDQaTtZexxBCgq7RAQFobniODg25uQHJc4QQGnMeRAwBCHJTc5fCvu/XvzI1b41nLuWOScTYktczZHN0UYp0hsGvhTAYQ+hMgQFYt85IkxW5zsgQXOlMxQjhnGeWBKIUcw7hBtxae0lnhEwggLkyOXfVikygLKd0vNVKWrQEOBsO6W/XVFtEEVo7LzLW8gEBREo6lI7kudaZiPzG4Isl0ObQCjX7gpEj4gwd40Slslomfo/bW63ginuvQ1iNfpvJ3J7dJlAG4ISj1cMjtgDrH1rKCSWVOwFqP5AXLcmkLEbzUm5VQXXMwMoe5gXLLRHbOKwNJtPFKYpS57QNB4MGXFg0/UjlhFZLueP3MbJ8nqnGqgCsSKTPkxbNjeFrShCHuT3NplGnTI9QfR9hXxSyGXqzMOciOyk9Q3xfLzRc6FTJE2rGby7ORufv3o5IfiniBN2/8L/aPdS3m6iXVDoxZgueFWhZjxHvnIpZwKzjue6fCL5WnoxedRTKIp+h6aLblRZ9Nh6XAayfiXo7In6eCTp/VwaQPhM0vqAvxxN8Jm70ZFrdVSH90Hza8piUz0yLMr6WN2a3fMyUypDLrkJfxssAfBZhfOmOR9rZ8Oy8Nxr2hm8no4tw/GP45qI/HA7/hgBWuQ/vujXFddVrrGzeCx2/gJ5yX6xbiPeJIzrLAMZPtaM7laNLqYsvUTq2NEomAdMZcovMmTXjCReS0THmh/+uT6Ex6kT9e55l3YARMhMSH5pe/DAeDh9GLQnjQxImnb7E5qqQ8cu6+pT+4w6NHy5ah94cOnQtFzwTsR8BJ+oR5cv601XvKvWHESsqIb8PO8521ysnLUaFEW7tZ8NVj2vRq/bD+ymNXRQpqh4q/TDpUgih7byDTWeQLIHOM4tm1CxM1mnWXOu+0iipeGd8ZqlJDbgWgwX1nn1p63giZNI7ippu7b8jjisad7zYdjItPiK1spqkrlQ9AKfI/QhS0vtceXBN3Y1GSUXSE78YHbS0SSosE9ZvN0O7DwI/z++h2YxbjJmSzKXoN2n9vD9qbwse2mef5WdJycoKizTWZkI+2vCz7LH7m/lcRIJn7C+cWeFw+qphbrlcHjD22mOuhEuLGTOo1VY88Yue1i6qfXkNATg0ub2Z36FZiKgZwL6hauCFB3VW8MhnRT3BNEvv90EUpZmIUFrsxPHl1e0ntmDn/SEEnfD4DqMHn65/+fD73Qc6l8Kx+kij/rA/9HORsi7nsqOqe73b/7ibbX7/D66Cdbg7XLmBzrjwFcCTt6mz937bvgIIuxfBaQCpso5ENhsK0j9NVpa0/LVAQzViGsCCG8FnlBX3G4iFpee4vdR9k7lXf9T3w9fs+++UTzrTJLSkbPYzJIQAATzieu9iW05p/qqymqytJC6jCLXrYA9q9k7hu/owgQB44dLdavLoq0n9QKc/addumakMoF+qeE8CfqKI+ojrn1vxauebgNq/Rpo4mpZl+Q+LwMM3",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/ivcfWoB+S1x004YhgZbkQUtlmDxMGCpEdDSWWIjkSxJ+QWG/vtw1ItlO7UbbAiwL7ZE3sO7e3Rv3IDjiYXwHiaY64w7tDANIEYbGaGdUBJCmKTIrtCxRoRd3l4znmVqadlaFcwpZtAZgQtkMTouMsv4TBWOcWY1RmIuIuZqcL89xjKLZoGMWzbLCtRGSGfZXBkWGeROyITFKipypOWlcCnTBmOcC4kxs84UkSsM2j4EoDQaTtZexxBCgq7RAQFobniODg25uQHJc4QQGnMeRAwBCHJTc5fCvu/XvzI1b41nLuWOScTYktczZHN0UYp0hsGvhTAYQ+hMgQFYt85IkxW5zsgQXOlMxQjhnGeWBKIUcw7hBtxae0lnhEwggLkyOXfVikygLKd0vNVKWrQEOBsO6W/XVFtEEVo7LzLW8gEBREo6lI7kudaZiPzG4Isl0ObQCjX7gpEj4gwd40Slslomfo/bW63ginuvQ1iNfpvJ3J7dJlAG4ISj1cMjtgDrH1rKCSWVOwFqP5AXLcmkLEbzUm5VQXXMwMoe5gXLLRHbOKwNJtPFKYpS57QNB4MGXFg0/UjlhFZLueP3MbJ8nqnGqgCsSKTPkxbNjeFrShCHuT3NplGnTI9QfR9hXxSyGXqzMOciOyk9Q3xfLzRc6FTJE2rGby7ORufv3o5IfiniBN2/8L/aPdS3m6iXVDoxZgueFWhZjxHvnIpZwKzjue6fCL5WnoxedRTKIp+h6aLblRZ9Nh6XAayfiXo7In6eCTp/VwaQPhM0vqAvxxN8Jm70ZFrdVSH90Hza8piUz0yLMr6WN2a3fMyUypDLrkJfxssAfBZhfOmOR9rZ8Oy8Nxr2hm8no4tw/GP45qI/HA7/hgBWuQ/vujXFddVrrGzeCx2/gJ5yX6xbiPeJIzrLAMZPtaM7laNLqYsvUTq2NEomAdMZcovMmTXjCReS0THmh/+uT6Ex6kT9e55l3YARMhMSH5pe/DAeDh9GLQnjQxImnb7E5qqQ8cu6+pT+4w6NHy5ah94cOnQtFzwTsR8BJ+oR5cv601XvKvWHESsqIb8PO8521ysnLUaFEW7tZ8NVj2vRq/bD+ymNXRQpqh4q/TDpUgih7byDTWeQLIHOM4tm1CxM1mnWXOu+0iipeGd8ZqlJDbgWgwX1nn1p63giZNI7ippu7b8jjisad7zYdjItPiK1spqkrlQ9AKfI/QhS0vtceXBN3Y1GSUXSE78YHbS0SSosE9ZvN0O7DwI/z++h2YxbjJmSzKXoN2n9vD9qbwse2mef5WdJycoKizTWZkI+2vCz7LH7m/lcRIJn7C+cWeFw+qphbrlcHjD22mOuhEuLGTOo1VY88Yue1i6qfXkNATg0ub2Z36FZiKgZwL6hauCFB3VW8MhnRT3BNEvv90EUpZmIUFrsxPHl1e0ntmDn/SEEnfD4DqMHn65/+fD73Qc6l8Kx+kij/rA/9HORsi7nsqOqe73b/7ibbX7/D66Cdbg7XLmBzrjwFcCTt6mz937bvgIIuxfBaQCpso5ENhsK0j9NVpa0/LVAQzViGsCCG8FnlBX3G4iFpee4vdR9k7lXf9T3w9fs+++UTzrTJLSkbPYzJIQAATzieu9iW05p/qqymqytJC6jCLXrYA9q9k7hu/owgQB44dLdavLoq0n9QKc/addumakMoF+qeE8CfqKI+ojrn1vxauebgNq/Rpo4mpZl+Q+LwMM3",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.bdaa43a4.js b/assets/js/377084eb.bdaa43a4.js deleted file mode 100644 index b083b2833..000000000 --- a/assets/js/377084eb.bdaa43a4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),r=(a(62316),a(51039)),n=a.n(r),m=(a(82723),a(9487)),c=a(41429),p=a(5397),o=a(4667),d=a(9472),h=a(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/iscP7WA/Ja4aScMQ4OtyIIWa7F4GLDECGjpLLGRSJY8+QWG/vtw1ItlO7UTbAiwL4lF3sO7e3hv3HAUiePhLZ9AbjKB4Pg04DG4yEqDUise8kkK7AqQNSLs8ss1E1mml46tdcFQMwtoJSyAxYBCZo6JmS6QCeYMRHIuI4Y1uN8e45gDuwAmHJtlBRgrFTo215ZFFgRKlbBYR0UOtLyUmDJjIYa5VBAzh7aIsLDg+jzg2oAVZO11zEOeADY6eMCNsCIHBEtubrgSOfCQN+bcy5gHXJKbRmDK932//pXpeWs8w1QgUwCxI69nwOaAUQp0hoVvhbQQ8xBtAQF3uM5Ik5O5ycgQWJlMx8DDucgcCUQp5IKHG45r4yXRSpXwgM+1zQVWKyrhZTml453RyoEjwNlwSP92TXVFFIFz8yJjLR884JFWCApJXhiTychvDL46Am0OrdCzrxAhEWfpGJSVymqZ+D1ub7UCK+G9Dvlq9NtM5e7sS8LLgKNEWj08Ygtw/kdLOaGUxhOg9oK8aEkmZTHYl3KrCqpjBlb2MC9YbonYxmFtMJkuT1GUIhoXDgYNuHBg+5HOCa2XasfvY2T5PNONVQF3MlE+T1q0sFasKUEQcneaTatPmR6BfhphXzWwGXizIBcyOyk9A3hfLzRcmFSrE2rGby7ORufv3o5IfinjBPBf+F/tHurbTdRLKp0Qs4XICnCsx4h3QcUsYA5Fbvongq+VJ6NXHYWqyGdgu+h2pUWfjcdlwNfPRL0dET/PBJ2/KwOePhM0vqCbEwk8Ezd6NK1uqpC+b662PCblM9MnBcSXeDxwzoZn573RsDd8OxldhOMfwzcX/eFw+DcP+Cr30Vp3mrguYo3S5rsw8QvoKffFunV1nwdipwz4+LHucqNzwJSa8hIUsqXVKgmYyUA4YGjXTCRCKkbH2B/+u7YD1uoT5ex5lnXvX6pMKrhvWuv9eDi8H7UkjA9JmHTaDJvrQsUv6+pj+o87NL6/aB16c+jQtVqITMZ+opvoB1Av609XPVbqDyNWVkJ+n+84212vnHQQFVbi2o96q54wslfth7dTmqIoUnQ9I/rZEFMe8raRDjadubDkdJ5dNJNjYbNO7xXG9LUBRbU4EzNHPWcgjBwsqJXsSzsUiVRJ7yhqurX/hjiuaNzxYtuYjPwI1JlqkrpS9TybgvATRUnfc+3BNXWfDSiqeZ74xeigQ01S6Zh0fruZwX0Q+PF8D81mwkHMtGKYgt+k9fP+qB3+PbTP7tSdomRlhQOaUjOpHlx4p3rs9vN8LiMpMvYXzJxEmL5qmFsulweMvfaYK4lpMWMWjN6KJ37R09pFtR+vecARbO4+z2/ALmTUzFPfUTXwwoM6K0Tks6IeSJql9/sgitJMRqAcdOL48urLJ7Zg5/0hDzrh8QSjB5+uf/nw+80HOpfCsbqkUX/YH/oxRzvMheqo6r7W9i93s83v/8HLrg53hBUOTCakrwCevE2dvbfb9hXwsPuumwY81Q5JZLOhIP3TZmVJy98KsFQjpgFfCCvFjLLidsNj6eh33L7Rvsvcqz/q595r9vQn4qPONAmtKJv9SMhDzgP+AOu9d2o5pXGqymqytpK4jCIw2MEe1Oydwnf1YcIDLgpMd6vJg68m9Q86/VG7dstMZQD9pYr3KOAniqiPsP65Fa92vguo/WukiaNpWZb/ALoTsjM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV21v2zYQ/iscP7WA/Ja4aScMQ4OtyIIWa7F4GLDECGjpLLGRSJY8+QWG/vtw1ItlO7UTbAiwL4lF3sO7e3hv3HAUiePhLZ9AbjKB4Pg04DG4yEqDUise8kkK7AqQNSLs8ss1E1mml46tdcFQMwtoJSyAxYBCZo6JmS6QCeYMRHIuI4Y1uN8e45gDuwAmHJtlBRgrFTo215ZFFgRKlbBYR0UOtLyUmDJjIYa5VBAzh7aIsLDg+jzg2oAVZO11zEOeADY6eMCNsCIHBEtubrgSOfCQN+bcy5gHXJKbRmDK932//pXpeWs8w1QgUwCxI69nwOaAUQp0hoVvhbQQ8xBtAQF3uM5Ik5O5ycgQWJlMx8DDucgcCUQp5IKHG45r4yXRSpXwgM+1zQVWKyrhZTml453RyoEjwNlwSP92TXVFFIFz8yJjLR884JFWCApJXhiTychvDL46Am0OrdCzrxAhEWfpGJSVymqZ+D1ub7UCK+G9Dvlq9NtM5e7sS8LLgKNEWj08Ygtw/kdLOaGUxhOg9oK8aEkmZTHYl3KrCqpjBlb2MC9YbonYxmFtMJkuT1GUIhoXDgYNuHBg+5HOCa2XasfvY2T5PNONVQF3MlE+T1q0sFasKUEQcneaTatPmR6BfhphXzWwGXizIBcyOyk9A3hfLzRcmFSrE2rGby7ORufv3o5IfinjBPBf+F/tHurbTdRLKp0Qs4XICnCsx4h3QcUsYA5Fbvongq+VJ6NXHYWqyGdgu+h2pUWfjcdlwNfPRL0dET/PBJ2/KwOePhM0vqCbEwk8Ezd6NK1uqpC+b662PCblM9MnBcSXeDxwzoZn573RsDd8OxldhOMfwzcX/eFw+DcP+Cr30Vp3mrguYo3S5rsw8QvoKffFunV1nwdipwz4+LHucqNzwJSa8hIUsqXVKgmYyUA4YGjXTCRCKkbH2B/+u7YD1uoT5ex5lnXvX6pMKrhvWuv9eDi8H7UkjA9JmHTaDJvrQsUv6+pj+o87NL6/aB16c+jQtVqITMZ+opvoB1Av609XPVbqDyNWVkJ+n+84212vnHQQFVbi2o96q54wslfth7dTmqIoUnQ9I/rZEFMe8raRDjadubDkdJ5dNJNjYbNO7xXG9LUBRbU4EzNHPWcgjBwsqJXsSzsUiVRJ7yhqurX/hjiuaNzxYtuYjPwI1JlqkrpS9TybgvATRUnfc+3BNXWfDSiqeZ74xeigQ01S6Zh0fruZwX0Q+PF8D81mwkHMtGKYgt+k9fP+qB3+PbTP7tSdomRlhQOaUjOpHlx4p3rs9vN8LiMpMvYXzJxEmL5qmFsulweMvfaYK4lpMWMWjN6KJ37R09pFtR+vecARbO4+z2/ALmTUzFPfUTXwwoM6K0Tks6IeSJql9/sgitJMRqAcdOL48urLJ7Zg5/0hDzrh8QSjB5+uf/nw+80HOpfCsbqkUX/YH/oxRzvMheqo6r7W9i93s83v/8HLrg53hBUOTCakrwCevE2dvbfb9hXwsPuumwY81Q5JZLOhIP3TZmVJy98KsFQjpgFfCCvFjLLidsNj6eh33L7Rvsvcqz/q595r9vQn4qPONAmtKJv9SMhDzgP+AOu9d2o5pXGqymqytpK4jCIw2MEe1Oydwnf1YcIDLgpMd6vJg68m9Q86/VG7dstMZQD9pYr3KOAniqiPsP65Fa92vguo/WukiaNpWZb/ALoTsjM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.2b1a3844.js b/assets/js/770b40a9.2b1a3844.js deleted file mode 100644 index 2787808e0..000000000 --- a/assets/js/770b40a9.2b1a3844.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixo0QSIhwFLjYCWzhYbimRJyi8w9N+HoyRbjpu42Yp+2JfEIp+Hd3x4dzxuwPO5g+QOxlgYyT06mESQoUutMF5oBQmMc2SX6FkLYR+E8+zi5opxKfXSsbUumdfMorcCF8g4k4TQM8YXXEg+lch8u36fjXPh2KxUKa3PpfBrZqxeiAwd44rpBdqFwGXgS7ljRgwVn0qh5qx0aB3ZTHOtHbKZ1QXDlXCeZrcMtsxRsdQiD+OZTssClXd9iEAbtJw8uMoggTn6lkW+QwSGW16gR0vybEDxAiEBKQpBs4KE+VKiXUMEFr+UwmIGyYxLhxE4v5aEnmlbQAS4MlJnCIm3Jc2mORYckg0UfCWKsoDkLI4j8GtDJFUWU7RQEY8XhhYaxlW0dcE9CPPdPHjaZlxNaF1ntHLoCDuKY/q3HxyuTFN0blZKtlUUIki18qg84bkxUqRhYvDZEWlz6ICefsY0yG5pGS9qkxZdKX0Hx63ltGHhsXDH+fUwnfAW6bwVag5RkIb77sh277Aa/jFVhRvdzEkTLzyNHi6xI7jwYxt5xFLaHyG1aBagFbkkM7Q/alt1PD3nYO0PC8BqJ8TW8fvGYXJdHJMo9964ZDBoyZTD/VQXxNZLtbfv58QK6axbryJwYq5Clv7bILH6mOsp6m8T7LNGNsXgFhZcyKPoKeLbZqDVwuRaHTFzenY+Gp68eT0k/FJkc/T/Yf/17KG9/US/oFqPGVtwWaJjPUa6c19ajJjzvDD9I8G3xZPTq8Pi02FvR7bs0elpFcH6hazXQ9LnhaSTN1UE+QtJp+d0cnyOL+QNv5pWt3VI37dHWz2HCpkZkgKzC/984Izi0UlvGPfi1+PheXL6S3J23o/j+G+IYFWEaG0umawpYq3R9rs02Q+wUz2GdevqYx321RFKCoX37cV1P4rj+3OCVBGcxmeHF9iVWnApstDPjPUDqp++3/WF1uojZa1r3tfmD7cvalCYh73NdsfrTTpMSyv8OnQtqx43olfPJ3cTutIL9LluWp7Q5vgcEhg86n4c2kXb+pRWdso3N6avDSpKZ8mnjsrWgBsxWFA1eox2ns+FmveeZU12Xt+SsrV4e77vapsR75GKWyNNF9U0RTnycClV9D3TgdwIdm1QUdoEuRfDgyIXWlPhwnTbLYajZzNt2SM2m3KHGdOK+RzDJI2f9IfMGUzFrImaPvukPqlbXSC1rdQoSaEeXPJJ9djd9WwmUsEl+wunTnic/Nwqt1wuDxR7FTiXwufllFk0egefh8Ega5e1/XgFEXi0hbue3VJ/nbZX8hOmBgE8aHKBpyEXmjutHXr7mESxKUWKymEnei8ubz6wBTvpxxB1wuMbnB58uPr93cfbd7QuhWN9SMN+3I/DTamdL7jqmNp7pjShvHfCm11q/0/fNU2eeFz5gZFchIIRVN80yX4He8k+iSDXztP4ZkMh/aeVVUXD9euCSkAmHO129754wHXnNRR6AkggFIAnsM2zZQed0IcVhA21KWoTlwzWnIs0RdM1cFCM9yra5bsxRMBLn+8XjIdQMJoftHo7pdadtfcrSe0A/aU9fZXwK4XKe1z/toXXM08Smv21aDqaSVVV/wCuNUqM",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixo0QSIhwFLjYCWzhYbimRJyi8w9N+HoyRbjpu42Yp+2JfEIp+Hd3x4dzxuwPO5g+QOxlgYyT06mESQoUutMF5oBQmMc2SX6FkLYR+E8+zi5opxKfXSsbUumdfMorcCF8g4k4TQM8YXXEg+lch8u36fjXPh2KxUKa3PpfBrZqxeiAwd44rpBdqFwGXgS7ljRgwVn0qh5qx0aB3ZTHOtHbKZ1QXDlXCeZrcMtsxRsdQiD+OZTssClXd9iEAbtJw8uMoggTn6lkW+QwSGW16gR0vybEDxAiEBKQpBs4KE+VKiXUMEFr+UwmIGyYxLhxE4v5aEnmlbQAS4MlJnCIm3Jc2mORYckg0UfCWKsoDkLI4j8GtDJFUWU7RQEY8XhhYaxlW0dcE9CPPdPHjaZlxNaF1ntHLoCDuKY/q3HxyuTFN0blZKtlUUIki18qg84bkxUqRhYvDZEWlz6ICefsY0yG5pGS9qkxZdKX0Hx63ltGHhsXDH+fUwnfAW6bwVag5RkIb77sh277Aa/jFVhRvdzEkTLzyNHi6xI7jwYxt5xFLaHyG1aBagFbkkM7Q/alt1PD3nYO0PC8BqJ8TW8fvGYXJdHJMo9964ZDBoyZTD/VQXxNZLtbfv58QK6axbryJwYq5Clv7bILH6mOsp6m8T7LNGNsXgFhZcyKPoKeLbZqDVwuRaHTFzenY+Gp68eT0k/FJkc/T/Yf/17KG9/US/oFqPGVtwWaJjPUa6c19ajJjzvDD9I8G3xZPTq8Pi02FvR7bs0elpFcH6hazXQ9LnhaSTN1UE+QtJp+d0cnyOL+QNv5pWt3VI37dHWz2HCpkZkgKzC/984Izi0UlvGPfi1+PheXL6S3J23o/j+G+IYFWEaG0umawpYq3R9rs02Q+wUz2GdevqYx321RFKCoX37cV1P4rj+3OCVBGcxmeHF9iVWnApstDPjPUDqp++3/WF1uojZa1r3tfmD7cvalCYh73NdsfrTTpMSyv8OnQtqx43olfPJ3cTutIL9LluWp7Q5vgcEhg86n4c2kXb+pRWdso3N6avDSpKZ8mnjsrWgBsxWFA1eox2ns+FmveeZU12Xt+SsrV4e77vapsR75GKWyNNF9U0RTnycClV9D3TgdwIdm1QUdoEuRfDgyIXWlPhwnTbLYajZzNt2SM2m3KHGdOK+RzDJI2f9IfMGUzFrImaPvukPqlbXSC1rdQoSaEeXPJJ9djd9WwmUsEl+wunTnic/Nwqt1wuDxR7FTiXwufllFk0egefh8Ega5e1/XgFEXi0hbue3VJ/nbZX8hOmBgE8aHKBpyEXmjutHXr7mESxKUWKymEnei8ubz6wBTvpxxB1wuMbnB58uPr93cfbd7QuhWN9SMN+3I/DTamdL7jqmNp7pjShvHfCm11q/0/fNU2eeFz5gZFchIIRVN80yX4He8k+iSDXztP4ZkMh/aeVVUXD9euCSkAmHO129754wHXnNRR6AkggFIAnsM2zZQed0IcVhA21KWoTlwzWnIs0RdM1cFCM9yra5bsxRMBLn+8XjIdQMJoftHo7pdadtfcrSe0A/aU9fZXwK4XKe1z/toXXM08Smv21aDqaSVVV/wCuNUqM",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.cfe051cf.js b/assets/js/770b40a9.cfe051cf.js new file mode 100644 index 000000000..d018f091f --- /dev/null +++ b/assets/js/770b40a9.cfe051cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},f={},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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.38cfb709.js b/assets/js/f0ff4a36.38cfb709.js deleted file mode 100644 index f70d8ea24..000000000 --- a/assets/js/f0ff4a36.38cfb709.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),n=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NOmEYGmxdlrZYiyXFgKWGQUtni41EsiRlxzD034ejXiy/JKmxLV8Si7zXh/ccjxtwfGEhvIVfVZRnKJ2FSQAx2sgI7YSSEMJNguwSHatF2MWnK4aSz1K0bK1y5hQz6IzAJbIYHRepZXymcsc4sxojMRcRiyvtLgSgNBpO1q9iCGGBrt6EADQ3PEOHhsLagOQZQgi1wFTEEICgsDR3CezHqmZfMXJXMVPzJl4IwOC3XBiMIXQmxwCsW6dk1opMpwgB4L1OVYwQznlqSSBKMOMQbsCttZd0RsgFBDBXJuOuvYL33FsJQf8+mCXRMNEzKIoJubVaSYuWDA37ffq3G6/Nowitnecpa0CBACIlHUUeboBrnYrIb/S+WlLaHEZXpk3oGTLjROmyRuPUPH67FHfD0Sz5/A6KAOaCFk+zkDinbdjrVSu5SbuRysiaE+50c9b/oBoiE1K5ky3oFLlFZsVCNqXok1NpjOa5oCyr+TQLZYTMqxZbALeUqFIoAlAruZPLd9n/qpDNEEmf0PHEayxwY/iaGOcws0+jZNTxs916i1A9BsTRsDDjIn1Seob4plqoa00nSj7hZvzqbDgYvT4fkPxKxAt0/yL/cvfQ3y7pL9JUrTBmS57maFnHVyV3ucGAWccz3X2KDrU8BX3fcijzbIamrd2sNNrD8bgIYH2i1vmA8DlRafS6CCA5UWl8RifHF3ii3qBNDoeZTrnD6XVZ0tP6aIvHpDy/IoPcYXzhHi+cYX846gz6nf75zeAsHP8Yvjrr9vv9vyGA+8xXa311cYfQ5m31nev4GfwUB2Kt5rffSgidIoDxsZvqWmXoEiEXbEUzwMoouQhY1VadWTO+4EIygtP88N9dYWiMOtrStgidFln7/IVMhcRpfU1Px/3+dNCAMD4EoRmBpHJsrnIZP2+qx/w/ntB4OmoSenWY0JVc8lTEfqS7UXconzeftntXuj+sWFEK+X3YSba9XiZpMcqNcGs/O953uBadcj+8ndBERpWiqqHTD5sugRB6NQF6m9agWQDZM8t6FM1N2ppsuNZdpVFSL075zNKd0+Na9JZ0lexLW8cXQi46j2pNtvFfE8YljDtZbC8mLd4j3UwVSG2pakBOkPu5oKDvufLKFXQfNUrqeR745eDghrpJhGXC+u0aEV8EbK4M29NmM24xZkoyl6DfpPVRd9AM/161y77IL5LIynKLNPGmQt7Z8IvssNuP87mIBE/ZXzizwuHkRY3carU6QOyl17kULslnzKBWW/GFX/SwtrWaj5cQgEOT2Y/zazRLEdXT6gOuel64V7GCR54V1UBSL73ZV6IqTUWE0mKrji8uP31gSzbq9iFolcd3BN37cPXL2z+u35JdKsfykAbdfrfvxxxlXcZly1X7ubZ/uJstv/+Hp11Vng7vXU+nXHjG+mQ3FdtuofXaC9sPu0kAibKORDYbKqrPJi0KWv6WoyFOTwJYciMoPk/JWFj6HTfvtgczffFn9QR8yR54Ix6NvGabJKr5eQ1CgADucL33Ki0mNOuUlKPQSomLKELtWroHDXWnK12+vYEAeO6SXarfeapXP8j60bh2e0AZAP2ldnRU4Sc67ve4/rkRL3ceVKjyq6UJo0lRFP8Af3CHpA==",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",description:"The Get Document API enables you to retrieve details about a specific 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",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NOmEYGmxdlrZYiyXFgKWGQUtni41EsiRlxzD034ejXiy/JKmxLV8Si7zXh/ccjxtwfGEhvIVfVZRnKJ2FSQAx2sgI7YSSEMJNguwSHatF2MWnK4aSz1K0bK1y5hQz6IzAJbIYHRepZXymcsc4sxojMRcRiyvtLgSgNBpO1q9iCGGBrt6EADQ3PEOHhsLagOQZQgi1wFTEEICgsDR3CezHqmZfMXJXMVPzJl4IwOC3XBiMIXQmxwCsW6dk1opMpwgB4L1OVYwQznlqSSBKMOMQbsCttZd0RsgFBDBXJuOuvYL33FsJQf8+mCXRMNEzKIoJubVaSYuWDA37ffq3G6/Nowitnecpa0CBACIlHUUeboBrnYrIb/S+WlLaHEZXpk3oGTLjROmyRuPUPH67FHfD0Sz5/A6KAOaCFk+zkDinbdjrVSu5SbuRysiaE+50c9b/oBoiE1K5ky3oFLlFZsVCNqXok1NpjOa5oCyr+TQLZYTMqxZbALeUqFIoAlAruZPLd9n/qpDNEEmf0PHEayxwY/iaGOcws0+jZNTxs916i1A9BsTRsDDjIn1Seob4plqoa00nSj7hZvzqbDgYvT4fkPxKxAt0/yL/cvfQ3y7pL9JUrTBmS57maFnHVyV3ucGAWccz3X2KDrU8BX3fcijzbIamrd2sNNrD8bgIYH2i1vmA8DlRafS6CCA5UWl8RifHF3ii3qBNDoeZTrnD6XVZ0tP6aIvHpDy/IoPcYXzhHi+cYX846gz6nf75zeAsHP8Yvjrr9vv9vyGA+8xXa311cYfQ5m31nev4GfwUB2Kt5rffSgidIoDxsZvqWmXoEiEXbEUzwMoouQhY1VadWTO+4EIygtP88N9dYWiMOtrStgidFln7/IVMhcRpfU1Px/3+dNCAMD4EoRmBpHJsrnIZP2+qx/w/ntB4OmoSenWY0JVc8lTEfqS7UXconzeftntXuj+sWFEK+X3YSba9XiZpMcqNcGs/O953uBadcj+8ndBERpWiqqHTD5sugRB6NQF6m9agWQDZM8t6FM1N2ppsuNZdpVFSL075zNKd0+Na9JZ0lexLW8cXQi46j2pNtvFfE8YljDtZbC8mLd4j3UwVSG2pakBOkPu5oKDvufLKFXQfNUrqeR745eDghrpJhGXC+u0aEV8EbK4M29NmM24xZkoyl6DfpPVRd9AM/161y77IL5LIynKLNPGmQt7Z8IvssNuP87mIBE/ZXzizwuHkRY3carU6QOyl17kULslnzKBWW/GFX/SwtrWaj5cQgEOT2Y/zazRLEdXT6gOuel64V7GCR54V1UBSL73ZV6IqTUWE0mKrji8uP31gSzbq9iFolcd3BN37cPXL2z+u35JdKsfykAbdfrfvxxxlXcZly1X7ubZ/uJstv/+Hp11Vng7vXU+nXHjG+mQ3FdtuofXaC9sPu0kAibKORDYbKqrPJi0KWv6WoyFOTwJYciMoPk/JWFj6HTfvtgczffFn9QR8yR54Ix6NvGabJKr5eQ1CgADucL33Ki0mNOuUlKPQSomLKELtWroHDXWnK12+vYEAeO6SXarfeapXP8j60bh2e0AZAP2ldnRU4Sc67ve4/rkRL3ceVKjyq6UJo0lRFP8Af3CHpA==",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 from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{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)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{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)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{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)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(a.p,{children:"]"})})})]})]})}),(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)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.bdf7e411.js b/assets/js/f0ff4a36.bdf7e411.js new file mode 100644 index 000000000..041e63cfd --- /dev/null +++ b/assets/js/f0ff4a36.bdf7e411.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",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",description:"The Get Document API enables you to retrieve details about a specific 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",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",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 from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Document"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.4fa1889c.js b/assets/js/fa40969b.4fa1889c.js deleted file mode 100644 index 397347faa..000000000 --- a/assets/js/fa40969b.4fa1889c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/isc+9IGsi07TtoJw9CgzYK0xVo0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEPfqjjPQDpLBwFNwMaGa8eVpBF99uwZqafJ9UKDjW7lZ3CGwxQII4JbR9SYJLUJMmIWEqIkcQsNt/JWdtvk6OitYWO3smSjo6NbSQghrfUYcSlzhBkgcW4MSCcWhEuSeE3rmMttG+310N6lbH0yamLA2u+yqitlb/EYLb5RmRbgIHmKvZRNgYwAJLF5HIO141yIBYlXNmbcpYQJQQx8y7mBhFg+kczlBkqfffR5Ptd+7qkeoZJnMvEpSUWEkhMwhPko+EiAt37iMYdYcHloQkmtNVoQlwLJLZj2raQBVRoMQ15cJjSiE3D1oiMJaEA1MywDBwZJtaSSZUAjmqgYmUADypFQmrmUbrPsOgVPl00mOUVMxTQa0BpIGjmTQ0CtWwi0bzliTgMKcy1UAjQaM2FRIE4hYzRaUu8/otYZLicoKfMMee+ptfLnI6x50RxdrWpjrFqJxkiN23ovFUWwQkHwjLsag285mMVGSnXIVU5jZbJmRlXGq4QyNucZ5nAShkGdnsyzERhaoB7zmETdsBGCveP6h0Vwv8+wGKBdq5W0YFG2F4b4b3PJ1/uGrHjlsZYOpEN5prXgsZ/ofLWotNwNQI2+QuzJZ9CM46VLAzYXriHHjGGYMHeQ2cf1y2Hk+S57EBrmNvhU507/uuB3veNR+uUdYjLmOHiYhdQ5baNOpxrJjWjHKkNrjrvDzVn/AzcVmpDKHWxBC2AWfPla7U2fnBIJmJ8FZcnhwyyUERKvWqwBpHUWwyqFIqBqJjdyeZL9r8qXTNRHdHzd+17CGbV/bdfeYlAPAbE3LMgYF49KjwBeVwM113Sq5CNu+ienve7xq5ddlJ/xZALuf+Rfzu762ywaZ0KoGSRkykQOlrTWh2qAHUKm249th1oeg57vFrKG9mpkpd3r94uALg7UetlFfA5UOn5VBDQ9UKl/iivHJnCgXre5ORxkWjAHw6uS0sN6aYuHpPz+ig0wB8mZe5g4vbB33OqGrfDldfc06v8enZy2wzD8lwZ0nnm21p0Dc0Cb+7b6znXyE/wUO2KN4rddSjbR4RI7gWF9CA57YTjso0gR0H7Y3z0MP4NWxhGpHGFTxgUbCfjtx52GYIzaW93WYO2P4KGk+mF/eLJK6mQ3qUs5ZYIn5OzTJblWdyB/bkZN9650v7umvBTy83Qj2eZ4maSFODfcLXxzO28xzVvlfHQzwJ4nA5eqqjP23bBLaUQ7zSa5s6y64YKiPTOte+XciMbZz7RuKw0Sq5VgI4tVucM070yx2G5LW8cmXE5aD2oN1vFfIcYljBtZrEu35u8Ba3cFUlOq6h9TYP7kLPB7rLxyBd1HDRKrggd+2t3T63NLuPXTNTaeBGSsDNnSbtwmU/CTOH7c7hKrIebjij9tgpeeK5X56wr2lILLO7yqtsjNx/GYx5wJ8g+MLHcweF4jN5vNdhB74XUuuEvzETGg1Vp84gc9rE2t1ccLGlAHJrMfx1dgpjyu+7l7XHW8cKfaFSz2u6I6suuh19tKyFLBY5AWGjw+u/j0gUzJcTukQYMeTwi68+HyzfnfV+doF+lYLlK3HbZD3wgo6zImG64uYH2PL6//Y6Oy6oK+vdrL9Yb/9ZTw6ylh9ZRQVRoHc9fRgnFffD1vl1XhvKFbrwtR/ZAwCGiqrEOR5RIp8sWIosDh8laL9TThFk+w9b32DhaNW7jvH2lEfTW9R7a6Lq9FB/hhOMru93Ev859/rlbuBXnKS8decOraLBfNoOpga2yKAfaNZXHGGMvZszgG3cx75+jdOL8uzq9pQFnu0s1D4c4fCtUPtL43ps3TogwA/yLUexX+wJL+HhZ/rsTLmXsVqvxqacRnUBTFf1U3FvU=",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/getdocumentlist",title:"Get Document list from status",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 from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/isc+9IGsi07TtoJw9CgzYK0xVo0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEPfqjjPQDpLBwFNwMaGa8eVpBF99uwZqafJ9UKDjW7lZ3CGwxQII4JbR9SYJLUJMmIWEqIkcQsNt/JWdtvk6OitYWO3smSjo6NbSQghrfUYcSlzhBkgcW4MSCcWhEuSeE3rmMttG+310N6lbH0yamLA2u+yqitlb/EYLb5RmRbgIHmKvZRNgYwAJLF5HIO141yIBYlXNmbcpYQJQQx8y7mBhFg+kczlBkqfffR5Ptd+7qkeoZJnMvEpSUWEkhMwhPko+EiAt37iMYdYcHloQkmtNVoQlwLJLZj2raQBVRoMQ15cJjSiE3D1oiMJaEA1MywDBwZJtaSSZUAjmqgYmUADypFQmrmUbrPsOgVPl00mOUVMxTQa0BpIGjmTQ0CtWwi0bzliTgMKcy1UAjQaM2FRIE4hYzRaUu8/otYZLicoKfMMee+ptfLnI6x50RxdrWpjrFqJxkiN23ovFUWwQkHwjLsag285mMVGSnXIVU5jZbJmRlXGq4QyNucZ5nAShkGdnsyzERhaoB7zmETdsBGCveP6h0Vwv8+wGKBdq5W0YFG2F4b4b3PJ1/uGrHjlsZYOpEN5prXgsZ/ofLWotNwNQI2+QuzJZ9CM46VLAzYXriHHjGGYMHeQ2cf1y2Hk+S57EBrmNvhU507/uuB3veNR+uUdYjLmOHiYhdQ5baNOpxrJjWjHKkNrjrvDzVn/AzcVmpDKHWxBC2AWfPla7U2fnBIJmJ8FZcnhwyyUERKvWqwBpHUWwyqFIqBqJjdyeZL9r8qXTNRHdHzd+17CGbV/bdfeYlAPAbE3LMgYF49KjwBeVwM113Sq5CNu+ienve7xq5ddlJ/xZALuf+Rfzu762ywaZ0KoGSRkykQOlrTWh2qAHUKm249th1oeg57vFrKG9mpkpd3r94uALg7UetlFfA5UOn5VBDQ9UKl/iivHJnCgXre5ORxkWjAHw6uS0sN6aYuHpPz+ig0wB8mZe5g4vbB33OqGrfDldfc06v8enZy2wzD8lwZ0nnm21p0Dc0Cb+7b6znXyE/wUO2KN4rddSjbR4RI7gWF9CA57YTjso0gR0H7Y3z0MP4NWxhGpHGFTxgUbCfjtx52GYIzaW93WYO2P4KGk+mF/eLJK6mQ3qUs5ZYIn5OzTJblWdyB/bkZN9650v7umvBTy83Qj2eZ4maSFODfcLXxzO28xzVvlfHQzwJ4nA5eqqjP23bBLaUQ7zSa5s6y64YKiPTOte+XciMbZz7RuKw0Sq5VgI4tVucM070yx2G5LW8cmXE5aD2oN1vFfIcYljBtZrEu35u8Ba3cFUlOq6h9TYP7kLPB7rLxyBd1HDRKrggd+2t3T63NLuPXTNTaeBGSsDNnSbtwmU/CTOH7c7hKrIebjij9tgpeeK5X56wr2lILLO7yqtsjNx/GYx5wJ8g+MLHcweF4jN5vNdhB74XUuuEvzETGg1Vp84gc9rE2t1ccLGlAHJrMfx1dgpjyu+7l7XHW8cKfaFSz2u6I6suuh19tKyFLBY5AWGjw+u/j0gUzJcTukQYMeTwi68+HyzfnfV+doF+lYLlK3HbZD3wgo6zImG64uYH2PL6//Y6Oy6oK+vdrL9Yb/9ZTw6ylh9ZRQVRoHc9fRgnFffD1vl1XhvKFbrwtR/ZAwCGiqrEOR5RIp8sWIosDh8laL9TThFk+w9b32DhaNW7jvH2lEfTW9R7a6Lq9FB/hhOMru93Ev859/rlbuBXnKS8decOraLBfNoOpga2yKAfaNZXHGGMvZszgG3cx75+jdOL8uzq9pQFnu0s1D4c4fCtUPtL43ps3TogwA/yLUexX+wJL+HhZ/rsTLmXsVqvxqacRnUBTFf1U3FvU=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",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,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(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","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"document[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.fbe110b4.js b/assets/js/fa40969b.fbe110b4.js new file mode 100644 index 000000000..90c08d5f9 --- /dev/null +++ b/assets/js/fa40969b.fbe110b4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/isc+9IGsi07TtoJw9Cgy4KsxVI0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEv/UHGegXSWDgKagI0N144rSSP64sULUk+Tm4UGG93JT+AMhykQRgS3jqgxSWoTZMQsJERJ4hYa7uSd7LbJ0dEfho3dypKNjo7uJCGEtNZjxKXMEWaAxLkxIJ1YEC5J4jWtYy63bbTXQ3uXsvXRqIkBa7/Jqq6UvcVjtPhOZVqAg+Q59lI2BTICkMTmcQzWjnMhFiRe2ZhxlxImBDHwNecGEmL5RDKXGyh99tHn+Vz7ued6hEqeycSnJBURSk7AEOaj4CMB3vqJxxxiweWhCSW11mhBXAokt2Dad5IGVGkwDHlxmdCITsDVi44koAHVzLAMHBgk1ZJKlgGNaKJiZAINKEdCaeZSus2ymxQ8XTaZ5BQxFdNoQGsgaeRMDgG1biHQvuWIOQ0ozLVQCdBozIRFgTiFjNFoSb3/iFpnuJygpMwz5L2n1sqfj7DmRXN0taqNsWolGiM1buu9VBTBCgXBM+5qDL7mYBYbKdUhVzmNlcmaGVUZrxLK2JxnmMNJGAZ1ejLPRmBogXrMYxJ1w0YI9p7r7xbBwz7DYoB2rVbSgkXZXhjiv80lX+8bsuKVx1o6kA7lmdaCx36i88Wi0nI3ADX6ArEnn0EzjpcuDdhcuIYcM4ZhwtxBZp/WL4eR57vsQWiY2+BTnTv984Lf945H6ee/EJMxx8HDLKTOaRt1OtVIbkQ7Vhlac9wdbs76H7ip0IRU7mALWgCz4MvXam/65JRIwPwoKEsOH2ahjJB41WINIK2zGFYpFAFVM7mRy7Psf1G+ZKI+ouPr3rcSzqj9a7v2FoN6DIi9YUHGuHhSegTwthqouaZTJZ9w0z857XWP37zuovyMJxNw/yP/cnbX32bROBNCzSAhUyZysKS1PlQD7BAy3X5qO9TyGPR8t5A1tFcjK+1ev18EdHGg1usu4nOg0vGbIqDpgUr9U1w5NoED9brNzeEg04I5GF6XlB7WS1s8JuX3lwWZXMors1kWRkoJYLLp0J81RUBjA8xBcuYeZ1ov7B23umErfH3TPY36v0Ynp+0wDP+lAZ1nnt51q8Ec0OZGr75znfwAP8WOWKNabteeTTi5xNZhWJ+aw14YDvsoUgS0H/Z3T89PoJVxRCpH2JRxwUYCfvl+xycYo/aWwzVY+yN4LKl+2B+erJI62U3qUk6Z4Ak5+3hJbtQ9yB+bUdO9K93vrikvhfw83Ui2OV4maSHODXcL3w3PW0zzVjkf3Q6wScrApapqpX377FIa0U6zq+4sq/a5oGjPTOvmOjei0SwwrdtKg8TyJtjIYhnvMM07U6zO29LWsQmXk9ajWoN1/NeIcQnjRhbrWq/5e8BiX4HUlKoazhSYP2oL/B4rr1xBd6VBYhnxwE+7ey4H3BJu/XSNjScBGStDtrQb188U/CSOH7e7xGqI+bjiT5vgLelaZf5+g02o4PIe77Ytcns1HvOYM0H+gZHlDgYva+Rms9kOYq+8zgV3aT4iBrRai0/8oIe1qbX6eEUD6sBk9mp8DWbK47oBfMBVxwt3ql3BYr8rqjO+Hnq7rYQsFTwGaaHB47OLjx/IlBy3Qxo06PGMoDsfLt+d/319jnaRjuUiddthO/Sdg7IuY7Lh6gLWF//yvWBsVFbd6LdXe7ne8D/fHn6+PazeHqpK42DuOlow7ouv5+2yKpy3dOs5IqpfHgYBTZV1KLJcIkU+G1EUOFxeg7GeJtziCba+CN/DonFt9w0njaivpg/IVvfrtegAPwxH2f0+HmT+y0/Vyr0iz3ka2QtOXZvlohlUHWyNTTHARrMszhhjOXsWx6Cbee8cvRvn18X5DQ0oy126eSjc+0Oh+oHW98a0eVqUAeBfhHqvwm9Y0t/D4veVeDnzoEKVXy2N+AyKovgPdJgn+Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",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 from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/isc+9IGsi07TtoJw9Cgy4KsxVI0KQYsMQxaOrbYUCRLUr7A0H8fDiXZ8iUXd0Wf+pJY5Ll+/Hh4yCV1bGJpdEv/UHGegXSWDgKagI0N144rSSP64sULUk+Tm4UGG93JT+AMhykQRgS3jqgxSWoTZMQsJERJ4hYa7uSd7LbJ0dEfho3dypKNjo7uJCGEtNZjxKXMEWaAxLkxIJ1YEC5J4jWtYy63bbTXQ3uXsvXRqIkBa7/Jqq6UvcVjtPhOZVqAg+Q59lI2BTICkMTmcQzWjnMhFiRe2ZhxlxImBDHwNecGEmL5RDKXGyh99tHn+Vz7ued6hEqeycSnJBURSk7AEOaj4CMB3vqJxxxiweWhCSW11mhBXAokt2Dad5IGVGkwDHlxmdCITsDVi44koAHVzLAMHBgk1ZJKlgGNaKJiZAINKEdCaeZSus2ymxQ8XTaZ5BQxFdNoQGsgaeRMDgG1biHQvuWIOQ0ozLVQCdBozIRFgTiFjNFoSb3/iFpnuJygpMwz5L2n1sqfj7DmRXN0taqNsWolGiM1buu9VBTBCgXBM+5qDL7mYBYbKdUhVzmNlcmaGVUZrxLK2JxnmMNJGAZ1ejLPRmBogXrMYxJ1w0YI9p7r7xbBwz7DYoB2rVbSgkXZXhjiv80lX+8bsuKVx1o6kA7lmdaCx36i88Wi0nI3ADX6ArEnn0EzjpcuDdhcuIYcM4ZhwtxBZp/WL4eR57vsQWiY2+BTnTv984Lf945H6ee/EJMxx8HDLKTOaRt1OtVIbkQ7Vhlac9wdbs76H7ip0IRU7mALWgCz4MvXam/65JRIwPwoKEsOH2ahjJB41WINIK2zGFYpFAFVM7mRy7Psf1G+ZKI+ouPr3rcSzqj9a7v2FoN6DIi9YUHGuHhSegTwthqouaZTJZ9w0z857XWP37zuovyMJxNw/yP/cnbX32bROBNCzSAhUyZysKS1PlQD7BAy3X5qO9TyGPR8t5A1tFcjK+1ev18EdHGg1usu4nOg0vGbIqDpgUr9U1w5NoED9brNzeEg04I5GF6XlB7WS1s8JuX3lwWZXMors1kWRkoJYLLp0J81RUBjA8xBcuYeZ1ov7B23umErfH3TPY36v0Ynp+0wDP+lAZ1nnt51q8Ec0OZGr75znfwAP8WOWKNabteeTTi5xNZhWJ+aw14YDvsoUgS0H/Z3T89PoJVxRCpH2JRxwUYCfvl+xycYo/aWwzVY+yN4LKl+2B+erJI62U3qUk6Z4Ak5+3hJbtQ9yB+bUdO9K93vrikvhfw83Ui2OV4maSHODXcL3w3PW0zzVjkf3Q6wScrApapqpX377FIa0U6zq+4sq/a5oGjPTOvmOjei0SwwrdtKg8TyJtjIYhnvMM07U6zO29LWsQmXk9ajWoN1/NeIcQnjRhbrWq/5e8BiX4HUlKoazhSYP2oL/B4rr1xBd6VBYhnxwE+7ey4H3BJu/XSNjScBGStDtrQb188U/CSOH7e7xGqI+bjiT5vgLelaZf5+g02o4PIe77Ytcns1HvOYM0H+gZHlDgYva+Rms9kOYq+8zgV3aT4iBrRai0/8oIe1qbX6eEUD6sBk9mp8DWbK47oBfMBVxwt3ql3BYr8rqjO+Hnq7rYQsFTwGaaHB47OLjx/IlBy3Qxo06PGMoDsfLt+d/319jnaRjuUiddthO/Sdg7IuY7Lh6gLWF//yvWBsVFbd6LdXe7ne8D/fHn6+PazeHqpK42DuOlow7ouv5+2yKpy3dOs5IqpfHgYBTZV1KLJcIkU+G1EUOFxeg7GeJtziCba+CN/DonFt9w0njaivpg/IVvfrtegAPwxH2f0+HmT+y0/Vyr0iz3ka2QtOXZvlohlUHWyNTTHARrMszhhjOXsWx6Cbee8cvRvn18X5DQ0oy126eSjc+0Oh+oHW98a0eVqUAeBfhHqvwm9Y0t/D4veVeDnzoEKVXy2N+AyKovgPdJgn+Q==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",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,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 list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(d.Z,{collapsible:!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:"folder"})}),(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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"widgets"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,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 "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.89bd2d89.js b/assets/js/runtime~main.91cf2df1.js similarity index 96% rename from assets/js/runtime~main.89bd2d89.js rename to assets/js/runtime~main.91cf2df1.js index 90fd17180..9ab3645f7 100644 --- a/assets/js/runtime~main.89bd2d89.js +++ b/assets/js/runtime~main.91cf2df1.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,r,b,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,r,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,r,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&r&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"46be1b2a",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"4fa1889c",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"38cfb709",1477:"b31b2642",1512:"7ddd2ec3",1520:"2b1a3844",1531:"298e9aa8",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"9ac115fd",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"98102502",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"450477a3",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"8efd80de",6103:"ebc8482f",6113:"8e8c149c",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"f9046360",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"bdaa43a4",8140:"901b2f91",8141:"6478079e",8163:"7d7e666b",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5e09231a",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(r[e])r[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var b=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var r=t.o(e,a)?e[a]:void 0;if(0!==r)if(r)c.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>r=e[a]=[c,b]));c.push(r[2]=b);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",f.name="ChunkLoadError",f.type=b,f.request=d,r[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var r,b,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(r in f)t.o(f,r)&&(t.m[r]=f[r]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,r,b,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,r,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,r,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&r&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"46be1b2a",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"fbe110b4",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"bdf7e411",1477:"b31b2642",1512:"7ddd2ec3",1520:"cfe051cf",1531:"298e9aa8",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"9ac115fd",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"98102502",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"450477a3",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"804248b0",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"395b3964",6011:"6de743c9",6033:"8efd80de",6103:"ebc8482f",6113:"8e8c149c",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"f9046360",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"015e4a9a",8140:"901b2f91",8141:"6478079e",8163:"7d7e666b",8468:"4f2bfead",8474:"f58804a4",8475:"d27b3009",8489:"40a02a7c",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"d6b7d755",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"3b8abbdf",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5e09231a",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(r[e])r[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var b=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var r=t.o(e,a)?e[a]:void 0;if(0!==r)if(r)c.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>r=e[a]=[c,b]));c.push(r[2]=b);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",f.name="ChunkLoadError",f.type=b,f.request=d,r[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var r,b,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(r in f)t.o(f,r)&&(t.m[r]=f[r]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 04162dbaa..fbf623e53 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 64cb2ed69..4a52009cc 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 28ce1d4f8..e1cd21e70 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 c3cd2c0fb..aff8da95d 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 9828e19b9..8113ceed8 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 644c32d22..f8b0c003a 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 fb8572887..298eded9a 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 f98e1aa3e..1d678771b 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 b5dc00dac..9702f12ef 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 13986648e..8d10934ba 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 7bcac0433..8c20dbf76 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 2ecbb7096..965dc86be 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 917f9a0d3..9cf5e26dd 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 173df2ef9..f601a6ffb 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 7133d8816..54bcb2bed 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 9cd723e32..0763b76e3 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index a5bad9b88..e50fe607d 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 8145f499e..850d5ba04 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 5e1e8d6ff..13483af69 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index b8d93c5af..7ad8b221f 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index feea1d03e..5de0a9b7e 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index decc9968d..4dfc00c82 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index eb9c275ef..2fdad7402 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 33c661118..78eee5397 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 3d53d2051..ceb24a919 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Document API enables you to retrieve details about a specific document.

Request​

Path Parameters

    document_id stringrequired

    objectId of Document

-

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 21432e52f..8886b89bc 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + @@ -48,6 +48,6 @@

Request​

Path Parameters

    doctype stringrequired

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

    The type of documents to retrieve

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 795ec4bfd..a9209b5be 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.

Request​

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • role string
    name string
    email string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    x number
    y number
    w number
    h number
    page number

  • ]

  • ]

    • sendInOrder boolean
    createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index eeb052d1d..07026bdf7 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 a5a8b15d7..00e0b0820 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/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 184a62e1e..f85c13d78 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index c3f9a3511..de18312bf 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 42ad3cb33..5f5f47b2e 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 4e8260daa..e1e9498b9 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index 7658dbcad..a74ffc753 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 8a1ac4ea5..b9674a715 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 677409b06..5db7eb7c9 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index 157888792..5555e2b3a 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index 69b0cf2a0..41dec9410 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index f48146271..b12160438 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 9859fb722..19adccf81 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index c11c6108b..e05ba604b 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATON INSTRUCTIONS | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 9e1021436..c5b672c61 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 310ab8560..1633b8824 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 2ebe1d47c..57a0380a5 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 4bf6f6e79..a40f5c6c2 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/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 0ebc17481..d1019fb9e 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index 79ca28391..198c63a88 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index 31d59466f..6effcbc52 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 54fea7f61..b4a82cb61 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index a7c710e9a..18b7d0c1b 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index 3a4a7030e..334cc2e5a 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index e30f072a2..d048a1de0 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index f9b0b3cd4..03e7552b7 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index 324eab40f..3f9918347 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index d9eafd249..884182e34 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index ea0a5b6ac..61b68ec20 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index f93f166c3..af64da91c 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Settings/profile/index.html b/docs/help/Settings/profile/index.html index 477781f23..0a07fa681 100644 --- a/docs/help/Settings/profile/index.html +++ b/docs/help/Settings/profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index aef696bdd..0355a6ebc 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index 41d1dc098..eb8c7dbee 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send template to a signer | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index f3eefacdf..bbc727e59 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index a586b050d..802c8a2ef 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 120d83c32..d6a701046 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 03636956e..ea5caa91e 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 14659b568..788d627c5 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost Setup with Docker | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index a7c074adb..5cef1adc7 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index eecb508a8..f6c1e520e 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 b4c2a411b..19518362b 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +