diff --git a/404.html b/404.html index 3a015be50..3e9eea618 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/2c586be5.4815eb75.js b/assets/js/2c586be5.4815eb75.js deleted file mode 100644 index b10c25bec..000000000 --- a/assets/js/2c586be5.4815eb75.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>g,toc:()=>f});var i=s(85893),n=s(11151),l=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGzcS/itTfkkTrCRL1iWBUBTNObme0aIx6gT9IAsCtTu7S2eXZEmu1jph//thuK+SFTsOikNQXD449uzMcOaZ4bxwzxxPLFss2VsVFjlKZ9kqYBHa0AjthJJswT6kCBcGuUNoueDN1SXwLFOlhcKiseAUJCjREJfEEqJWH2x2oI3aikjIBCLuOJTCpbDhFl/OAWWoIowgFhmOb+SN/KgzxSPYqQJ0FIOQoAoDyxcv3uKmSODj5YsXq+9T57RdTCZc67HSKK1IZMY3dhyqfELyeTwhWi5Co7jWk4iEdRQ/hxQNeu0hlxAZXkIpogSdBS4jCJXeQahGyohIcocBaJ4gyCLfoAEVg0sxHwPPrOqUeJnGHRXD1dt/3UgWMKUJDaHkZcQWLPQAtqiwgBn8s0Dr/qmiHVvsWaikow+LPeNaZyL0opNbSyHYMxummHP6jeSEwYiCRqCxgJGnaCwLmBMuQ4qg22lkC6Y2txjSadqQOU6gJR1ebrFvuawzQiYsYLEyOXdswWpvWMDwjueamNlRvHQUs6o98CFVHaVXZf0vXYqQnoOM+yptbwcaqoBJ5b7Wrt9ItOph7bVwY/iOBUw4zIf0z8Bs1NOxCVHR2ZhzkT1V9lbhBvGnmkBXwQPB8ycbcasQNuhB0KmST5afzs6ns+n5dEYamuv19TDWX+9bcFil3lA1wgi2PCvQwggofNwVBgOwjud6/Fj0W37vNk+GZ9b3/96ZVBkP6oOEMhVhSlWiKStgU1VkEXCtkZsxVcu/uKA5BSHPwiKj0ksHewQOvO3M77ydVgG7e9zBu7oWRoJqIXyfYeyg0BoNhMpINM8hNipvnP6mHZ7N51XAdo+7vPvbuPyKglw+7vEfInIpda7am2/G/vPXVcDSx+3/N4okdd+gA/OXVd8ijyaA9UZFu3VbG6vHGNteRHyxyiI0NFUc10RqWiij9XH32CiVIZcn6pewoLnhOTo07UBHc41TYDWGIt5BmaJL0XhyyaUDr91PfBsES9MgcdcGjoFqYoQxLzJXgwTCwg1zpsAbNobLuIevnqcOTBjw+nlMKnjmz1vbwneHZ5Pmb4LlWS9pgRtsbBYYdSZ4ZnCYawqdhVJkGdldWIzG0P3zE1sXODKgbcLtwY93oIvCOpWDP7ARgliZvhFBM/ON4YJLEDLMiqjOplgR9DQgw37fRd4nRFXBfk9RRbOmXl5VQU+gsw4Ivl3XFIMhiu2BVEfCXrCjDUTxTguzW0fcNYRQ5ZrL3dAAkUghk3VhsqoadyOLD8sXQ3UPmSZcpOTvCNLDl7yuAv1832ShQauVtPUsNDs7o/8O0ey2skYp2CIM0dq4yLLddyz48uXi4UGsJp8qPA9PVumtmP3nLtzOrihPCvPkwbYt3IXJRk6NCNZRC1095w6QFTITEtctbOvZ2dl6SthWAZufgu9a5ehSyquSQCyNkkkAOkNuEZzZAU+4kED1w/yFaKIxypxCovf7aZY9BML8AIR/3AfhUm55JiK/2H9Qn1D+bz0dHu/q48nUu9znSr3DMFEz+e/swNkhvXbSYlgY4XZssdyzuxHXYlR/XyxX1SpgBKyixVwr6y3mLmULNrm3p1s0W78FLvd16rIHxwiuxWQ7ZVVwzG0dT4RMRg9KrXrDrwncGr8D8/stSotfkNaoBp0hV8AEBTVFHqHxSFLMfu+fHN61yLePAaf2+x7h4439uJ6f2MHbFfxgqx4s1ct2P/Yrb7fxnlhiOw/btbTbSgeL5mDPXPaJ1q107UY39WvPbD73u8CrqR+Qz1/7OXP+svKp0c9XfaYOxyqqy/eGg0FSD/rgYDATMlY+eg2k7zXKa5FIn/Lb6enZTFj/ucXdXz8/UxxJ++eniPZPapT0kejn42k7EdU3dwz0wkZVheafuMggE/KTXdzIESzfx7EIBc/gD9xY4bCfl8uyvJeyz73Mz8KlxQYMatWzJ57o83oo1f3xnBILTW7fx9dotiJsS/xnjpp45klTj3g9irXp0pB+OhYiyDMRorQ4qCBvfr76FbZwPj5jweB+foHRk18vL979dv2O9FI9qIM0HZ+Nz/x7gbIu53Jw1NGL6XF8By9+/39g/boH1uaSO7xzE51xIQfTRV3Ol8fPrquApVTvF0u235PGjzSZEfnPAg01i1XAttwIvqFLulzRBloXUSorn5Du9EUduNEHOp/Ys6Kux0cdknpALfEmDFG7B3mHLenq/fUHFrB2lM5VRDKGl/RszEu2YDfshvknZtJQvzVyv+lnXCaFr3Ss1ku1nxcuPWwcn3zjaH4ZFEwudwMrDztK7Qr9JMdOCvxAWfsL7n7s2OsvnxVosG25KYSrqqr+C1malXs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,g={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGzcS/itTfkkTrCRL1iWBUBTNObme0aIx6gT9IAsCtTu7S2eXZEmu1jph//thuK+SFTsOikNQXD449uzMcOaZ4bxwzxxPLFss2VsVFjlKZ9kqYBHa0AjthJJswT6kCBcGuUNoueDN1SXwLFOlhcKiseAUJCjREJfEEqJWH2x2oI3aikjIBCLuOJTCpbDhFl/OAWWoIowgFhmOb+SN/KgzxSPYqQJ0FIOQoAoDyxcv3uKmSODj5YsXq+9T57RdTCZc67HSKK1IZMY3dhyqfELyeTwhWi5Co7jWk4iEdRQ/hxQNeu0hlxAZXkIpogSdBS4jCJXeQahGyohIcocBaJ4gyCLfoAEVg0sxHwPPrOqUeJnGHRXD1dt/3UgWMKUJDaHkZcQWLPQAtqiwgBn8s0Dr/qmiHVvsWaikow+LPeNaZyL0opNbSyHYMxummHP6jeSEwYiCRqCxgJGnaCwLmBMuQ4qg22lkC6Y2txjSadqQOU6gJR1ebrFvuawzQiYsYLEyOXdswWpvWMDwjueamNlRvHQUs6o98CFVHaVXZf0vXYqQnoOM+yptbwcaqoBJ5b7Wrt9ItOph7bVwY/iOBUw4zIf0z8Bs1NOxCVHR2ZhzkT1V9lbhBvGnmkBXwQPB8ycbcasQNuhB0KmST5afzs6ns+n5dEYamuv19TDWX+9bcFil3lA1wgi2PCvQwggofNwVBgOwjud6/Fj0W37vNk+GZ9b3/96ZVBkP6oOEMhVhSlWiKStgU1VkEXCtkZsxVcu/uKA5BSHPwiKj0ksHewQOvO3M77ydVgG7e9zBu7oWRoJqIXyfYeyg0BoNhMpINM8hNipvnP6mHZ7N51XAdo+7vPvbuPyKglw+7vEfInIpda7am2/G/vPXVcDSx+3/N4okdd+gA/OXVd8ijyaA9UZFu3VbG6vHGNteRHyxyiI0NFUc10RqWiij9XH32CiVIZcn6pewoLnhOTo07UBHc41TYDWGIt5BmaJL0XhyyaUDr91PfBsES9MgcdcGjoFqYoQxLzJXgwTCwg1zpsAbNobLuIevnqcOTBjw+nlMKnjmz1vbwneHZ5Pmb4LlWS9pgRtsbBYYdSZ4ZnCYawqdhVJkGdldWIzG0P3zE1sXODKgbcLtwY93oIvCOpWDP7ARgliZvhFBM/ON4YJLEDLMiqjOplgR9DQgw37fRd4nRFXBfk9RRbOmXl5VQU+gsw4Ivl3XFIMhiu2BVEfCXrCjDUTxTguzW0fcNYRQ5ZrL3dAAkUghk3VhsqoadyOLD8sXQ3UPmSZcpOTvCNLDl7yuAv1832ShQauVtPUsNDs7o/8O0ey2skYp2CIM0dq4yLLddyz48uXi4UGsJp8qPA9PVumtmP3nLtzOrihPCvPkwbYt3IXJRk6NCNZRC1095w6QFTITEtctbOvZ2dl6SthWAZufgu9a5ehSyquSQCyNkkkAOkNuEZzZAU+4kED1w/yFaKIxypxCovf7aZY9BML8AIR/3AfhUm55JiK/2H9Qn1D+bz0dHu/q48nUu9znSr3DMFEz+e/swNkhvXbSYlgY4XZssdyzuxHXYlR/XyxX1SpgBKyixVwr6y3mLmULNrm3p1s0W78FLvd16rIHxwiuxWQ7ZVVwzG0dT4RMRg9KrXrDrwncGr8D8/stSotfkNaoBp0hV8AEBTVFHqHxSFLMfu+fHN61yLePAaf2+x7h4439uJ6f2MHbFfxgqx4s1ct2P/Yrb7fxnlhiOw/btbTbSgeL5mDPXPaJ1q107UY39WvPbD73u8CrqR+Qz1/7OXP+svKp0c9XfaYOxyqqy/eGg0FSD/rgYDATMlY+eg2k7zXKa5FIn/Lb6enZTFj/ucXdXz8/UxxJ++eniPZPapT0kejn42k7EdU3dwz0wkZVheafuMggE/KTXdzIESzfx7EIBc/gD9xY4bCfl8uyvJeyz73Mz8KlxQYMatWzJ57o83oo1f3xnBILTW7fx9dotiJsS/xnjpp45klTj3g9irXp0pB+OhYiyDMRorQ4qCBvfr76FbZwPj5jweB+foHRk18vL979dv2O9FI9qIM0HZ+Nz/x7gbIu53Jw1NGL6XF8By9+/39g/boH1uaSO7xzE51xIQfTRV3Ol8fPrquApVTvF0u235PGjzSZEfnPAg01i1XAttwIvqFLulzRBloXUSorn5Du9EUduNEHOp/Ys6Kux0cdknpALfEmDFG7B3mHLenq/fUHFrB2lM5VRDKGl/RszEu2YDfshvknZtJQvzVyv+lnXCaFr3Ss1ku1nxcuPWwcn3zjaH4ZFEwudwMrDztK7Qr9JMdOCvxAWfsL7n7s2OsvnxVosG25KYSrqqr+C1malXs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},x={},f=[{value:"Request",id:"request",level:2}];function j(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(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:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(a.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(a.p,{children:["Upload you pdf in our ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(m.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.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(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)(m.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(m.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)(m.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)(m.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(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)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(m.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.695c176b.js b/assets/js/2c586be5.695c176b.js new file mode 100644 index 000000000..20bf657cd --- /dev/null +++ b/assets/js/2c586be5.695c176b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>j});var i=s(85893),r=s(11151),l=s(58219),n=(s(62316),s(51039)),t=s.n(n),o=(s(82723),s(9487)),m=(s(41429),s(5397)),c=s(4667),d=s(9472),p=s(85162);const u={id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGzcS/itTfkkTrCRL1iWBUBTNObme0aIx6gT9IAsCtTu7S2eXZEmu1jph//thuK+SHDsOikNQXD44NneGnHlm+MwM98zxxLLFkr1VYZGjdJatAhahDY3QTijJFuxDinBhkDuEVgreXF0CzzJVWigsGgtOQYISDUlJLCFq94PNDrRRWxEJmUDEHYdSuBQ23OLLOaAMVYQRxCLD8Y28kR91pngEO1WAjmIQElRhYPnixVvcFAl8vHzxYvV96py2i8mEaz1WGqUVicz4xo5DlU9IP48ntJaL0Ciu9SQiZR3FzyFFg373kEuIDC+hFFGCzgKXEYRK7yBUI2VEJLnDADRPEGSRb9CAisGlmI+BZ1Z1m3idxh0Vw9Xbf91IFjClCQ2h5GXEFiz0ALaosIAZ/LNA6/6poh1b7FmopKMPiz3jWmci9KqTW0sh2DMbpphz+o30hMGIgkagsYCRp2gsC5gTLkOKoNtpZAumNrcY0mnakDlOoKU9vN5i30pZZ4RMWMBiZXLu2ILV3rCA4R3PNQmzo3jpKGZVe+BDW3Ur/VbW/9KlCO1zkHFftdvbwQ5VwKRyX2vXb6Ra9bD2u3Bj+I4FTDjMh+ufgdmop2MToqKzMecie6rurcIN4k/1Al0FDwTPn2zErULYoAdBp0o+WX86O5/OpufTGe3QXK+vh7H+emrBIUu9ITbCCLY8K9DCCCh83BUGA7CO53r8WPRbee82T4Zn1vf/5ExixgN+kFCmIkyJJRpaAZuqIouAa43cjIkt/2JCcwpCnoVFRtRLB3sEDrztzO+8nVYBu3vcwbuaCyNBXAjfZxg7KLRGA6EyEs1ziI3KG6e/aYdn83kVsN3jLu/+Ni6/oiCXj3v8h4hcSpWr9uabsf/8dRWw9HH7/40iSd036MD8ZdWXyKMOYL1R0W7dcmP1mGBbi0guVlmEhrqKU07s6cxXMJTR+riUbJTKkMt7yExY0NzwHB2atrujJscpsBpDEe+gTNGlaPxyyaUDv7tv/zYIllpDkq6tHQMRZIQxLzJXIwbCwg1zpsAbNobLuMeybq4OTBjI+uZMKnjmz1vbwpeKZ5Pmb8LoWa9pgRtsbBYYdSZ4YXCYa4qjhVJkGdldWIzG0P3z7VuHJBnQVuT24MfL0UVhncrBH9goQaxMX5WgaQDHcMElCBlmRVSnVqwIeuqWYb/v0sBnR1XBfk9RRbOmwl5VQb9AZx0s+NpdrxgMUWwPtLol7BW7tYEq3mlhduuIu2YhVLnmcjc0QCRSyGRdmKyqxidp2Mfoi3E7gamJHW3yN0Tsketf80Pf+TcpadBqJW3dJc3Ozui/QzS7ea3ZFGwRhmhtXGTZ7jsWfPnY8XCLVi/fT0kP9VzprZj95y7czq4oTwrz5Ja3pfTCZCOnRgTrqIWu7oAHyAqZCYnrFrb17OxsPSVsq4DN74PvWuXoUsqrkkAsjZJJADpDbhGc2QFPuJBAZGL+QjTRGGUeZvenWfYQCPMDEP5xCsKl3PJMRH7k/6A+ofzfejo83tXHk6l3uc+Verphohby39mBs8P12kmLYWGE27HFcs/uRlyLUf19sVxVq4ARsIpGdq2st5i7lC3Y5GSCt2i2fj5c7uvUZQ82GFyLyXbKquBY2jqeCJmMHtRa9YZfE7g1fgfm9/OVFr8gDVgNOkOpgAkKaoo8QuORpJj93j9GvGuRb58J7pv8e4SPZ/ljPr9nOm+H84N5ezBuL9vJ2Q/D3Sx8z3jbedgOrN28OhhBBxPosk+0bthrZ72pH4hm87mfEl5Nfet8/tp3oPOXlU+NvvNi7LC7IkY+6REYO6x9bXpXFIRY+Yg1ML7XKK9FIn2ab6f3N2fC+s8t1v7K+abiSNs/RkU0jVJxpI+0fj6eti1RfVvHQO9txCTUAMVFBpmQn+ziRo5g+T6ORSh4Bn/gxgqHffdcluVJmj73Oj8LlxYbMKhVL574RZ/LQ63uj+eUTGhy+z6+RrMVYUvrnzlq4oUnDQfxuhdrU6RZ+ulYiSDPRIjS4oA13vx89Sts4Xx8xoLBnfwCoye/Xl68++36He1LHFAHaTo+G5/51wNlXc7l4Kij99Pj+A7e//7/3Pp1z63NxXZ45yY640IOOoqawpfHj7CrgKXE8Ysl2+9px4/UjdHynwUaKhCrgG25EXxDl3S5onm0Jk6ikk9Id/qiDtzoA51P4llRc/BRVSTerzXehCFq96DssAxdvb/+wALWts+5ikjH8JIekXnJFuyG3TD/4Ew71C+P3M/9GZdJ4dmN1fsS3/PCpYfF4pMvFs0vA5Lkcjew8rCK1K7QT3LsXoUfKGt/wd2PnXj95bMKDbatNIVwVVXVfwF9cZgB",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create Document",description:"The Create Document API allows users to generate new documents by providing data with base64 encoded file.",sidebar_label:"Create Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1vGzcS/itTfkkTrCRL1iWBUBTNObme0aIx6gT9IAsCtTu7S2eXZEmu1jph//thuK+SHDsOikNQXD44NneGnHlm+MwM98zxxLLFkr1VYZGjdJatAhahDY3QTijJFuxDinBhkDuEVgreXF0CzzJVWigsGgtOQYISDUlJLCFq94PNDrRRWxEJmUDEHYdSuBQ23OLLOaAMVYQRxCLD8Y28kR91pngEO1WAjmIQElRhYPnixVvcFAl8vHzxYvV96py2i8mEaz1WGqUVicz4xo5DlU9IP48ntJaL0Ciu9SQiZR3FzyFFg373kEuIDC+hFFGCzgKXEYRK7yBUI2VEJLnDADRPEGSRb9CAisGlmI+BZ1Z1m3idxh0Vw9Xbf91IFjClCQ2h5GXEFiz0ALaosIAZ/LNA6/6poh1b7FmopKMPiz3jWmci9KqTW0sh2DMbpphz+o30hMGIgkagsYCRp2gsC5gTLkOKoNtpZAumNrcY0mnakDlOoKU9vN5i30pZZ4RMWMBiZXLu2ILV3rCA4R3PNQmzo3jpKGZVe+BDW3Ur/VbW/9KlCO1zkHFftdvbwQ5VwKRyX2vXb6Ra9bD2u3Bj+I4FTDjMh+ufgdmop2MToqKzMecie6rurcIN4k/1Al0FDwTPn2zErULYoAdBp0o+WX86O5/OpufTGe3QXK+vh7H+emrBIUu9ITbCCLY8K9DCCCh83BUGA7CO53r8WPRbee82T4Zn1vf/5ExixgN+kFCmIkyJJRpaAZuqIouAa43cjIkt/2JCcwpCnoVFRtRLB3sEDrztzO+8nVYBu3vcwbuaCyNBXAjfZxg7KLRGA6EyEs1ziI3KG6e/aYdn83kVsN3jLu/+Ni6/oiCXj3v8h4hcSpWr9uabsf/8dRWw9HH7/40iSd036MD8ZdWXyKMOYL1R0W7dcmP1mGBbi0guVlmEhrqKU07s6cxXMJTR+riUbJTKkMt7yExY0NzwHB2atrujJscpsBpDEe+gTNGlaPxyyaUDv7tv/zYIllpDkq6tHQMRZIQxLzJXIwbCwg1zpsAbNobLuMeybq4OTBjI+uZMKnjmz1vbwpeKZ5Pmb8LoWa9pgRtsbBYYdSZ4YXCYa4qjhVJkGdldWIzG0P3z7VuHJBnQVuT24MfL0UVhncrBH9goQaxMX5WgaQDHcMElCBlmRVSnVqwIeuqWYb/v0sBnR1XBfk9RRbOmwl5VQb9AZx0s+NpdrxgMUWwPtLol7BW7tYEq3mlhduuIu2YhVLnmcjc0QCRSyGRdmKyqxidp2Mfoi3E7gamJHW3yN0Tsketf80Pf+TcpadBqJW3dJc3Ozui/QzS7ea3ZFGwRhmhtXGTZ7jsWfPnY8XCLVi/fT0kP9VzprZj95y7czq4oTwrz5Ja3pfTCZCOnRgTrqIWu7oAHyAqZCYnrFrb17OxsPSVsq4DN74PvWuXoUsqrkkAsjZJJADpDbhGc2QFPuJBAZGL+QjTRGGUeZvenWfYQCPMDEP5xCsKl3PJMRH7k/6A+ofzfejo83tXHk6l3uc+Verphohby39mBs8P12kmLYWGE27HFcs/uRlyLUf19sVxVq4ARsIpGdq2st5i7lC3Y5GSCt2i2fj5c7uvUZQ82GFyLyXbKquBY2jqeCJmMHtRa9YZfE7g1fgfm9/OVFr8gDVgNOkOpgAkKaoo8QuORpJj93j9GvGuRb58J7pv8e4SPZ/ljPr9nOm+H84N5ezBuL9vJ2Q/D3Sx8z3jbedgOrN28OhhBBxPosk+0bthrZ72pH4hm87mfEl5Nfet8/tp3oPOXlU+NvvNi7LC7IkY+6REYO6x9bXpXFIRY+Yg1ML7XKK9FIn2ab6f3N2fC+s8t1v7K+abiSNs/RkU0jVJxpI+0fj6eti1RfVvHQO9txCTUAMVFBpmQn+ziRo5g+T6ORSh4Bn/gxgqHffdcluVJmj73Oj8LlxYbMKhVL574RZ/LQ63uj+eUTGhy+z6+RrMVYUvrnzlq4oUnDQfxuhdrU6RZ+ulYiSDPRIjS4oA13vx89Sts4Xx8xoLBnfwCoye/Xl68++36He1LHFAHaTo+G5/51wNlXc7l4Kij99Pj+A7e//7/3Pp1z63NxXZ45yY640IOOoqawpfHj7CrgKXE8Ysl2+9px4/UjdHynwUaKhCrgG25EXxDl3S5onm0Jk6ikk9Id/qiDtzoA51P4llRc/BRVSTerzXehCFq96DssAxdvb/+wALWts+5ikjH8JIekXnJFuyG3TD/4Ew71C+P3M/9GZdJ4dmN1fsS3/PCpYfF4pMvFs0vA5Lkcjew8rCK1K7QT3LsXoUfKGt/wd2PnXj95bMKDbatNIVwVVXVfwF9cZgB",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(a.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(a.p,{children:["Upload you pdf in our ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF"]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.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.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(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)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(c.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)(c.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)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(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)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-sign-document.com"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(c.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.1a624c06.js b/assets/js/5a2de241.1a624c06.js new file mode 100644 index 000000000..068066e3d --- /dev/null +++ b/assets/js/5a2de241.1a624c06.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mLCMCzrijZosRiNgwFLDIOWTjYbimRJyo5h6L8PR0m24jheMnTbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xW/kmQJpNZifc88UYuYo6ik20ZIdi99KYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+V52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5BBKlWHpUnR9wYKdJA8uCrI2/rx6Hr6VdMPTFuKSVeoKO3NeF/D5DI4YGmBFx42MQLVQRK+xebGRJEZBYXApehsJyYKebnwrFMp2VB8KqdlL/MxaYqujYq0pEZWqrI56Q2Ai/8A3uTToFOppTvqiI5i85o5WpqT+L4cRlsrlhTlsyVaYrO5aWUqx++X17r4/0It/xwl518dMOzj4ZYaUI694eVTuKT095x3Ivfjo7fJGc/Jq/f9OM4/hMiuC/ktqgga4qjZa/+3zkQSgqFk5a1yUkcT04bKs/2sdeUjGnu0oJLkbFcoMwY+XTfkUC0Vtt/WNIH4jsEnyC34M8OlI7SnuW6VNn/DXdfRIcBnk3ebiC+fgzxQtWU0fwZ6TtU/wXCLZ6ue1+7p1AfVrWohcJ7eAC2e16DdJiWVvhVmG33PW5Er36f3IxpYhTo55rmoilDwDTjEhi03WWw7vSZCsieXbSjsrQSEph7b1wyGHBj+tqgohYq+dT1U10MuBGDxTFU0a6083wm1Kx3UGu8jf+KOK5pfIBiQyY34hOuIGpJ6ko1A3yOPEMbCKXUfdkOy/dtAjYc706YdsA8b2bsbgl7p0B3CGxaPYWa64CryeqlQXVFLqgmFsePbI/Is3DhdRtAqE+Wa8t2tNmUO8yYVmFloZd0fto/3qxOQbXPbtWtutIFstJhXkomhbpzya3qsZvLPBep4JL9gVMnPI6P2qQul8tHyXwVdD4IPy+nzKLRW/FZOAwZ72pt/tCS4dEW7jK/QrsQKTYF9ISrQRAeNBeWp+HCYsEFFV5z9MuuElEuRYrKddN//mH4mS3YaT+GqFO5zwh68Pni3fvfr96TXbopdZKO+3E/piOjnS+46rja2Xx387vedp9/e1FubpLHez8wkovQXAL4ddMYbqBzIZLujjyOYK6dJ5H1mors2sqqouNvJVpqP+MIFtwKijR0j0w4es42u+6TsI++tFsne9m6vRdQ2y8UNYsFlyX9gwjucLWz91fjKmqbBkVcS7yr4+qNyM7WwqPBQD2v1jhPUzT+oGy3Ew+vRxDBtNnhi/A5AJYv6fuBLyGBW7iF8F1DBkJLDOdrkFzNSj4j+dostTpeUua6ffIu9MnmgYDtpeRhA62R0C/h2qvwE5XiJ1z9vBGv3zyp0FDbSlN6xlVV/QWMVOU/",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mLCMCzrijZosRiNgwFLDIOWTjYbimRJyo5h6L8PR0m24jheMnTbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xW/kmQJpNZifc88UYuYo6ik20ZIdi99KYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+V52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5BBKlWHpUnR9wYKdJA8uCrI2/rx6Hr6VdMPTFuKSVeoKO3NeF/D5DI4YGmBFx42MQLVQRK+xebGRJEZBYXApehsJyYKebnwrFMp2VB8KqdlL/MxaYqujYq0pEZWqrI56Q2Ai/8A3uTToFOppTvqiI5i85o5WpqT+L4cRlsrlhTlsyVaYrO5aWUqx++X17r4/0It/xwl518dMOzj4ZYaUI694eVTuKT095x3Ivfjo7fJGc/Jq/f9OM4/hMiuC/ktqgga4qjZa/+3zkQSgqFk5a1yUkcT04bKs/2sdeUjGnu0oJLkbFcoMwY+XTfkUC0Vtt/WNIH4jsEnyC34M8OlI7SnuW6VNn/DXdfRIcBnk3ebiC+fgzxQtWU0fwZ6TtU/wXCLZ6ue1+7p1AfVrWohcJ7eAC2e16DdJiWVvhVmG33PW5Er36f3IxpYhTo55rmoilDwDTjEhi03WWw7vSZCsieXbSjsrQSEph7b1wyGHBj+tqgohYq+dT1U10MuBGDxTFU0a6083wm1Kx3UGu8jf+KOK5pfIBiQyY34hOuIGpJ6ko1A3yOPEMbCKXUfdkOy/dtAjYc706YdsA8b2bsbgl7p0B3CGxaPYWa64CryeqlQXVFLqgmFsePbI/Is3DhdRtAqE+Wa8t2tNmUO8yYVmFloZd0fto/3qxOQbXPbtWtutIFstJhXkomhbpzya3qsZvLPBep4JL9gVMnPI6P2qQul8tHyXwVdD4IPy+nzKLRW/FZOAwZ72pt/tCS4dEW7jK/QrsQKTYF9ISrQRAeNBeWp+HCYsEFFV5z9MuuElEuRYrKddN//mH4mS3YaT+GqFO5zwh68Pni3fvfr96TXbopdZKO+3E/piOjnS+46rja2Xx387vedp9/e1FubpLHez8wkovQXAL4ddMYbqBzIZLujjyOYK6dJ5H1mors2sqqouNvJVpqP+MIFtwKijR0j0w4es42u+6TsI++tFsne9m6vRdQ2y8UNYsFlyX9gwjucLWz91fjKmqbBkVcS7yr4+qNyM7WwqPBQD2v1jhPUzT+oGy3Ew+vRxDBtNnhi/A5AJYv6fuBLyGBW7iF8F1DBkJLDOdrkFzNSj4j+dostTpeUua6ffIu9MnmgYDtpeRhA62R0C/h2qvwE5XiJ1z9vBGv3zyp0FDbSlN6xlVV/QWMVOU/",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.f6ff51c6.js b/assets/js/5a2de241.f6ff51c6.js deleted file mode 100644 index 2a4486445..000000000 --- a/assets/js/5a2de241.f6ff51c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.70f84e73.js b/assets/js/bbdfc22d.70f84e73.js deleted file mode 100644 index a6f879a65..000000000 --- a/assets/js/bbdfc22d.70f84e73.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=a(85893),t=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),c=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),p=a(9472),d=a(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/is3fmoMxW9xX2AMQ9OXdUGLJVgS9INjBLR0kphIJEtSdjxD/304SrJlJ42XohiKbV8Smbw73h2Pzz3kijmeWDaesAvMdcYdWjYNWIQ2NEI7oSQbs4sUoZmGtwY5jcPx2QnwLFMLC4VFY8EpCGkSISysU7n4k88yBNcYDmCRijAFi2aOwC3MsgK1EdJZiJWBBCUa7oRMIFJhkSNNLIRLQRuMMBYSI7DOFKErDNouXGolwRZhiNbGRbZeqXJDKBmAS9E7atAVRlrgUEjxpUDodBrpaxF1OuBS7iDkEmZI4UQUTe0QttyZcZpT0hu2GkMRCxKubXXhSl7JS50pHsFSFaCjGIQEVRiYdDrvcFYkcHnS6Uyfpc5pO+71uNZdpVFakciMz2w3VHmP9PO4R2O5CI3iWvciUtZRfAApGvTWyd/I8AUsRJSgs8BlBKHSSwjVoTIiktxhAJonCLLIZ2hAxeR63gWeWbU24nUothcjkjh792v3SrKAKe13RMmTiI1ZtbtNrCxgBr8UaN0bFS3ZeMVCJR1KR59c60yEXrV3Y6mKVsyGKeacvtxSIxszNbvB0LGAaUMLOYGWZmORYUvKOiNkwgIWK5Nzx8ascpQFDO94rkm4HgKUoYowAm+iDJgTbo+t9cjGlvUf6z0lO1K5bzXjVcudI/VNltoWyoBRcaCxLWPcGL5kARMOc7s/z0Y9PTchKlobcy6yp+reKJwhvq4GqMx9Znn+ZCduFMIMfVZ1quST9QfDo8FwcDQYkoX66Hx7GqvZ+x5sY+gxISVGMOdZgRYOgbaPE5AFYB3PdXdfETTyPmyetNeszva9NQm3t86+rBGYwKuKG2yqiiwCrjVy0yXo+85gRV2BZ2HhgZkW9hnYinbt/jraQRmwu/0B3lU4FwnCOXiWYeyg0BoNhMpINAcQG5XXQf/QAQ9HozJgy/0hL/81Ib+kTV7sj/iziFxKXamK5ofx/+hVGbB0v/+/oUhS9wMGMHpRblrkTnO/nqloed1gY7lPsOlF+wQrAaINwmDExs4U6AesVtJWeDrs9+nfDpRtUTvigWvaly1/YsH34h7VMLGd+4C+weI36fA3q2UepgTGOVq7jccPqOwJoJ03ITMh8bpJyvWw379+TpkrAzZ6KDnnKkeXEm9eoHSwMEomAegMuUVwZgk84UICLW++Y67QGGUej/ppnj2WhFG/fz1YJ+H5/SScyDnPROTZ/oW6RfnPRtpe3lXLk6t3uadJFcthohLy82wr2PZ4FaTFsDDCLdl4smJ3h1yLw2p+PJmWU6o6lypi5VpZ7zF3KRuz3j2S7q9bxBMnK1aYjI3Zo0DDtejNB6wMdqWt44mQyeGjWtON4+eU3Cp/W+5veJYWH5GIVp2dtlTABG1qijxC4zNJe/bH5r7xvsl8c1948AqwSfEuqW84/RZN34XuB4h3i3dPGgrtWfGaFD/Ac9chNsx1TVxbXLRFRSebSluzvob0DTwzGo5Gni68HPgeevTKt6LRi3JaTktKXqx8puvoTzXKc5FUl/b54AGmKCwI66eby251y6eL+Y729iWYJmn8qDtoLsTVKavuwoQA1PDofp4JeWvHV/IQJqdxLELBM/iMMyscbrrfYrG4V14HXueDcGkxA4NabcQTP+hrsK21/nFANYAmt6fxOZq5CLEu6a8s1fPCvRo7eOixo9nZeuj1rhKd5UyEKC22Tvvxh7NPMIejbp8FrbP0N5zufTp5+/738/dkl85utUmDbr/b9+xfWZdz2VrqbfXucrGp7p3r5hoI/3/M+c8+5tSQ4vDO9XTGhW9Bvi5XdfeY7D7xTAOWUnsZT9hqRSYvTVaWNPylQEO9aRqwOTeCisN3pqDBbAKxW1xScVa1d3hB65N4VlTwv9OQqeVUGsdhiNo9KtvugGen5xcsYLP6GSpXEekYvqAnKr5gY3bFrph/ziIL1eMH91ePjMuk8LjKKrvUanjh0u0+dev7VP3Rgmculy0vtxtYFQr9pcAeVPiZqvkjLn9Zi1czX1Woc9tI0xZOy7L8C61GjrM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v2zYQ/is3fmoMxW9xX2AMQ9OXdUGLJVgS9INjBLR0kphIJEtSdjxD/304SrJlJ42XohiKbV8Smbw73h2Pzz3kijmeWDaesAvMdcYdWjYNWIQ2NEI7oSQbs4sUoZmGtwY5jcPx2QnwLFMLC4VFY8EpCGkSISysU7n4k88yBNcYDmCRijAFi2aOwC3MsgK1EdJZiJWBBCUa7oRMIFJhkSNNLIRLQRuMMBYSI7DOFKErDNouXGolwRZhiNbGRbZeqXJDKBmAS9E7atAVRlrgUEjxpUDodBrpaxF1OuBS7iDkEmZI4UQUTe0QttyZcZpT0hu2GkMRCxKubXXhSl7JS50pHsFSFaCjGIQEVRiYdDrvcFYkcHnS6Uyfpc5pO+71uNZdpVFakciMz2w3VHmP9PO4R2O5CI3iWvciUtZRfAApGvTWyd/I8AUsRJSgs8BlBKHSSwjVoTIiktxhAJonCLLIZ2hAxeR63gWeWbU24nUothcjkjh792v3SrKAKe13RMmTiI1ZtbtNrCxgBr8UaN0bFS3ZeMVCJR1KR59c60yEXrV3Y6mKVsyGKeacvtxSIxszNbvB0LGAaUMLOYGWZmORYUvKOiNkwgIWK5Nzx8ascpQFDO94rkm4HgKUoYowAm+iDJgTbo+t9cjGlvUf6z0lO1K5bzXjVcudI/VNltoWyoBRcaCxLWPcGL5kARMOc7s/z0Y9PTchKlobcy6yp+reKJwhvq4GqMx9Znn+ZCduFMIMfVZ1quST9QfDo8FwcDQYkoX66Hx7GqvZ+x5sY+gxISVGMOdZgRYOgbaPE5AFYB3PdXdfETTyPmyetNeszva9NQm3t86+rBGYwKuKG2yqiiwCrjVy0yXo+85gRV2BZ2HhgZkW9hnYinbt/jraQRmwu/0B3lU4FwnCOXiWYeyg0BoNhMpINAcQG5XXQf/QAQ9HozJgy/0hL/81Ib+kTV7sj/iziFxKXamK5ofx/+hVGbB0v/+/oUhS9wMGMHpRblrkTnO/nqloed1gY7lPsOlF+wQrAaINwmDExs4U6AesVtJWeDrs9+nfDpRtUTvigWvaly1/YsH34h7VMLGd+4C+weI36fA3q2UepgTGOVq7jccPqOwJoJ03ITMh8bpJyvWw379+TpkrAzZ6KDnnKkeXEm9eoHSwMEomAegMuUVwZgk84UICLW++Y67QGGUej/ppnj2WhFG/fz1YJ+H5/SScyDnPROTZ/oW6RfnPRtpe3lXLk6t3uadJFcthohLy82wr2PZ4FaTFsDDCLdl4smJ3h1yLw2p+PJmWU6o6lypi5VpZ7zF3KRuz3j2S7q9bxBMnK1aYjI3Zo0DDtejNB6wMdqWt44mQyeGjWtON4+eU3Cp/W+5veJYWH5GIVp2dtlTABG1qijxC4zNJe/bH5r7xvsl8c1948AqwSfEuqW84/RZN34XuB4h3i3dPGgrtWfGaFD/Ac9chNsx1TVxbXLRFRSebSluzvob0DTwzGo5Gni68HPgeevTKt6LRi3JaTktKXqx8puvoTzXKc5FUl/b54AGmKCwI66eby251y6eL+Y729iWYJmn8qDtoLsTVKavuwoQA1PDofp4JeWvHV/IQJqdxLELBM/iMMyscbrrfYrG4V14HXueDcGkxA4NabcQTP+hrsK21/nFANYAmt6fxOZq5CLEu6a8s1fPCvRo7eOixo9nZeuj1rhKd5UyEKC22Tvvxh7NPMIejbp8FrbP0N5zufTp5+/738/dkl85utUmDbr/b9+xfWZdz2VrqbfXucrGp7p3r5hoI/3/M+c8+5tSQ4vDO9XTGhW9Bvi5XdfeY7D7xTAOWUnsZT9hqRSYvTVaWNPylQEO9aRqwOTeCisN3pqDBbAKxW1xScVa1d3hB65N4VlTwv9OQqeVUGsdhiNo9KtvugGen5xcsYLP6GSpXEekYvqAnKr5gY3bFrph/ziIL1eMH91ePjMuk8LjKKrvUanjh0u0+dev7VP3Rgmculy0vtxtYFQr9pcAeVPiZqvkjLn9Zi1czX1Woc9tI0xZOy7L8C61GjrM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,i.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,i.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,i.jsxs)(s.p,{children:["Upload you pdf in our ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,i.jsx)(s.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(d.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,i.jsx)(d.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(d.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(d.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)(d.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(d.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(d.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(d.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 b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.fadd1beb.js b/assets/js/bbdfc22d.fadd1beb.js new file mode 100644 index 000000000..5bbc4d37f --- /dev/null +++ b/assets/js/bbdfc22d.fadd1beb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var t=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),n=a.n(r),m=(a(82723),a(9487)),c=(a(41429),a(5397)),o=a(4667),d=a(9472),p=a(85162);const h={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/itnfGoM+Za4FxjDsPSyNmixBEuCPjhGQEtHEhuJZEnKjmfovw+HkmzZSeMlKIZi20sik+dO8jsfuWKOJ5aNJ+wCc51xh5ZNAxahDY3QTijJxuwiRWim4Y1BTuNwfHYCPMvUwkJh0VhwCkKaRAgL61Qu/uSzDME1hgNYpCJMwaKZI3ALs6xAbYR0FmJlIEGJhjshE4hUWORIEwvhUtAGI4yFxAisM0XoCoO2B5daSbBFGKK1cZGtPVVhCCUDcCn6QA26wkgLHAopvhYInU4jfS2iTgdcyh2EXMIMKZ2IsqkDwlY4M05zSnrDVmMoYkHCta0eXMkreakzxSNYqgJ0FIOQoAoDk07nLc6KBC5POp3ps9Q5bcf9Pte6pzRKKxKZ8ZnthSrvk34e92ksF6FRXOt+RMo6ig8gRYPeOsUbGb6AhYgSdBa4jCBUegmh6iojIskdBqB5giCLfIYGVEyh5z3gmVVrI16HcnsxIomzt7/1riQLmNJ+RZQ8idiYVavb5MoCZvBrgda9VtGSjVcsVNKhdPTJtc5E6FX7XyztohWzYYo5py+31MjGTM2+YOhYwLQhR06gpdlYZNiSss4ImbCAxcrk3LExqwJlAcNbnmsSrocAZagijMCbKAPmhNtjaz2ysWX9x3pNyY5U7qlmvGq5c6SeZKltoQwYbQ40tmWMG8OXLGDCYW7319mox9cmREW+Mecie6yuLyTPH+2T9HSq5JMU65Px9CpVs3cdb0PkMQEhRjDnWYEWukCrwwmnArCO57q3b40beZ8tT9o+q6N7xyfB8tbRljXAEjZVeYNNVZFFwLVGbnqEbN8Ziwj0eRYWHnfJsa/AVrbr8NfZDsuA3e5P8LaCsUgQjMGzDGMHhdZoIFRGojmA2Ki8TvqHTvhwNCoDttyf8vJfk/JLWuTF/ow/i8il1HSqbH6Y+I9elQFL98f/AUWSuh8wgdGLctMBd3r39UxFy+sGG8t9gk2r2SdYCRArEAYjNnamQD9gtZK2wtPDwYD+7UDZFnMjmrdmddnyJxZ8L2pRDROZuQvoGyx+nR5+sFrmYUpgnKO123h8j8qeBNp1EzITEq+bolwfDgbXz6lyZcBG9xXnXOXoUqLFC5QOFkbJJACdIbcIziyBJ1xIIPfmO9YKjVHm4awfF9lDRRgNBtfDdRGe3y3CiZzzTESezF+oG5T/bKZt965yT6He5p4FVayGiUrIz7OtZNvjVZIWw8IIt2TjyYrddrkW3Wp+PJmWU9p1LlVEurWyPmLuUjZm/Tsc3N+miAZOVqwwGRuzB4GGa9GfD1kZ7EpbxxMhk+6DWtNN4OdU3Kp+W+FveJYWH5GIVl2dtlTABC1qijxC4ytJa/bH5jrxrql8cx24l+FvSrzL2RvKvsXCd6H7Hl7dotWThiF70rvmvGyTEVvzUvpcM83JZiOtSV3D6Yae+ByORp4NvBz6Fnn0ynea0YtyWk5Lqk2sfCHr5E41ynORVFfu+fAeIigsCOunm6tqdUena/WO9vYVliZp/Kg3bK6z1SGqbrJ0wKmf0e06E/LGjq9kFyancSxCwTP4jDMrHG6a22KxuLN7DrzOe+HSYgYGtdqIJ37Qb7G21vrHAS0xmtyexudo5iLEesd+w1XfC/draOChh4Zm4eqhX3eV6KhmIkRpsXWYj9+ffYI5HPUGLGgdlb8RdP/TyZt3v5+/I7t0NKtFGvYGvYEn98q6nMuWqzfVq8nFZvPuXBbXOPf/U8x/9immhhSHt66vMy58h/H7clU3h8nuA800YCl1j/GErVZk8tJkZUnDXws01HqmAZtzI2hz+MYTNJBMIHaDS9qc1d7rXpB/Es+KCt13+i11lErjOAxRuwdl2w3u7PT8ggVsVj8i5SoiHcMX9MDEF2zMrtgV849RZKF6uuD+ZpFxmRQeV1lllzoJL1y63YZufBuqP1rwzOWyFeV2f6pSob+U2L0KP9Nu/ojLX9bi1cw3FeraNtK0hNOyLP8CRxF44w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtv2zYU/itnfGoM+Za4FxjDsPSyNmixBEuCPjhGQEtHEhuJZEnKjmfovw+HkmzZSeMlKIZi20sik+dO8jsfuWKOJ5aNJ+wCc51xh5ZNAxahDY3QTijJxuwiRWim4Y1BTuNwfHYCPMvUwkJh0VhwCkKaRAgL61Qu/uSzDME1hgNYpCJMwaKZI3ALs6xAbYR0FmJlIEGJhjshE4hUWORIEwvhUtAGI4yFxAisM0XoCoO2B5daSbBFGKK1cZGtPVVhCCUDcCn6QA26wkgLHAopvhYInU4jfS2iTgdcyh2EXMIMKZ2IsqkDwlY4M05zSnrDVmMoYkHCta0eXMkreakzxSNYqgJ0FIOQoAoDk07nLc6KBC5POp3ps9Q5bcf9Pte6pzRKKxKZ8ZnthSrvk34e92ksF6FRXOt+RMo6ig8gRYPeOsUbGb6AhYgSdBa4jCBUegmh6iojIskdBqB5giCLfIYGVEyh5z3gmVVrI16HcnsxIomzt7/1riQLmNJ+RZQ8idiYVavb5MoCZvBrgda9VtGSjVcsVNKhdPTJtc5E6FX7XyztohWzYYo5py+31MjGTM2+YOhYwLQhR06gpdlYZNiSss4ImbCAxcrk3LExqwJlAcNbnmsSrocAZagijMCbKAPmhNtjaz2ysWX9x3pNyY5U7qlmvGq5c6SeZKltoQwYbQ40tmWMG8OXLGDCYW7319mox9cmREW+Mecie6yuLyTPH+2T9HSq5JMU65Px9CpVs3cdb0PkMQEhRjDnWYEWukCrwwmnArCO57q3b40beZ8tT9o+q6N7xyfB8tbRljXAEjZVeYNNVZFFwLVGbnqEbN8Ziwj0eRYWHnfJsa/AVrbr8NfZDsuA3e5P8LaCsUgQjMGzDGMHhdZoIFRGojmA2Ki8TvqHTvhwNCoDttyf8vJfk/JLWuTF/ow/i8il1HSqbH6Y+I9elQFL98f/AUWSuh8wgdGLctMBd3r39UxFy+sGG8t9gk2r2SdYCRArEAYjNnamQD9gtZK2wtPDwYD+7UDZFnMjmrdmddnyJxZ8L2pRDROZuQvoGyx+nR5+sFrmYUpgnKO123h8j8qeBNp1EzITEq+bolwfDgbXz6lyZcBG9xXnXOXoUqLFC5QOFkbJJACdIbcIziyBJ1xIIPfmO9YKjVHm4awfF9lDRRgNBtfDdRGe3y3CiZzzTESezF+oG5T/bKZt965yT6He5p4FVayGiUrIz7OtZNvjVZIWw8IIt2TjyYrddrkW3Wp+PJmWU9p1LlVEurWyPmLuUjZm/Tsc3N+miAZOVqwwGRuzB4GGa9GfD1kZ7EpbxxMhk+6DWtNN4OdU3Kp+W+FveJYWH5GIVl2dtlTABC1qijxC4ytJa/bH5jrxrql8cx24l+FvSrzL2RvKvsXCd6H7Hl7dotWThiF70rvmvGyTEVvzUvpcM83JZiOtSV3D6Yae+ByORp4NvBz6Fnn0ynea0YtyWk5Lqk2sfCHr5E41ynORVFfu+fAeIigsCOunm6tqdUena/WO9vYVliZp/Kg3bK6z1SGqbrJ0wKmf0e06E/LGjq9kFyancSxCwTP4jDMrHG6a22KxuLN7DrzOe+HSYgYGtdqIJ37Qb7G21vrHAS0xmtyexudo5iLEesd+w1XfC/draOChh4Zm4eqhX3eV6KhmIkRpsXWYj9+ffYI5HPUGLGgdlb8RdP/TyZt3v5+/I7t0NKtFGvYGvYEn98q6nMuWqzfVq8nFZvPuXBbXOPf/U8x/9immhhSHt66vMy58h/H7clU3h8nuA800YCl1j/GErVZk8tJkZUnDXws01HqmAZtzI2hz+MYTNJBMIHaDS9qc1d7rXpB/Es+KCt13+i11lErjOAxRuwdl2w3u7PT8ggVsVj8i5SoiHcMX9MDEF2zMrtgV849RZKF6uuD+ZpFxmRQeV1lllzoJL1y63YZufBuqP1rwzOWyFeV2f6pSob+U2L0KP9Nu/ojLX9bi1cw3FeraNtK0hNOyLP8CRxF44w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},g={},j=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create Template"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsxs)(s.p,{children:["Upload you pdf in our ",(0,t.jsx)(s.a,{href:"https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf",children:(0,t.jsx)(s.strong,{children:"Debug UI"})})," here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(s.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"widgets"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(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,t.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:1}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:244}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:71}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:38}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/loadmf/signmicroapp/debugpdf) to calculate the value.",format:"number",example:46}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.469f98eb.js b/assets/js/bfe4b778.469f98eb.js new file mode 100644 index 000000000..edf210d38 --- /dev/null +++ b/assets/js/bfe4b778.469f98eb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),d=(s(62316),s(51039)),i=s.n(d),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfUoB2VZe2mLCMCxrgzZo0QRNggFLDIOWTjYbimRJyo5h6L8PR0m27DheMhQbsC+GTN3b89zx7rQEzycOklt4r9OyQOUdDCPI0KVWGC+0ggSup8huTMY9slaKnV6eMy6lnjtWOrSOec0KnYl8wbjKWFmL+ymyDD0X0jGdM86cwVTkImVZY6jPvuggyD3zU+GCYa3korXudWuMsxznzHDLC/RoXcQWumQpV0p7lk65mtQOcyGRaZUiE76OoA1aOJZa5B6zPkSgDVpOEM8zSKB20uKDCNaOILldguIFQgKtrZHIIAJB9Bjup7DN2fl7ArzhPWBUiFkANcYGF9mx+L0UFjNIvC0xAucXkrw5URiJEAE+GKkzhCTn0pFAOsWCQ7IEvzBB0luhJhBBrm3B/fqkqoa1fXT+d50tSGcz1EurZyJDNkapO/x2mPdYGMk9OnbAPZPInWdaYUe2BfAKIki18kRhsgRujBRpIHnwzZG35ePQ9fgbpoFxSynxAh29rQn/e4BEDg80JeDCw4pyqCJQ2r/YzCVBRGZxJnAe6tmJiarrs2t7g8eXuVhVRddGRToyQ0sV+ZzURuCF37A36hToaEz5riqSs+iMVq6m9iiOH5fB6mo3ZclcmaboXF5Kufjpx+W1Pt6NcM0Pd9nRR3d58tEQK01Ip36/0lF8dNw7jHvx2+vDN8nJz8nrN/04jv+ECB4KuS4qIGvQZS/87xwIJYXCUcva6CiOR8cNlSe72GtKxjR3acalyFguUGaMfLofSCBaq+0/LOk98e2DT5Bb8Cd7Soc6ca5Llf3XcHdFtB/gyehkBfH1Y4jnqqaMxtO1vkf1byBc4+m697V7CnWzqkUtFN7DBtjueQ3SYVpa4Rdhtj30uBG9+n1yO6SJUaCfapqLpqyHoZ9CAoO2uwyWnT5TAdmzs3ZUllZCAlPvjUsGA25MXxtU1EIlH7t+qosBN2IwO4Qq2pZ2nk+EmvT2ag3X8V8RxzWNGyhWZHIjPuECopakrlQzwKfIM7SBUErd1/WwPGsTsOJ4e8K0A+Z5M2N7S9g5BbpDYNXqKdRcB1xNVi8MqityQTUxO3xk+5o8NwtV6yfUJ8u1ZVvabMwdZkyrsLLQSzo/7h+uNrag2md36k5d6QJp68tLyaRQ9y65Uz12e5HnIhVcsj9w7ITH4UGb1Pl8/iiZr4LOB+Gn5ZhZNHotPgmHIeNdrdUfWjI82sJd5FdoZyLFpoCecDUIwoPmwvI0XFgsuKDCa45+21YiyqVIUblu+k8/XH5mM3bcjyHqVO4zgh58Pn939uXqjOzSTamTdNiP+zEdGe18wVXH1dbGvZ3f5br7/F8X9OYGe3zwAyO5CE0tkL5sGtItdK5W0t3NhxFMtfMkslxScd9YWVV0/L1ES21vGMGMW8HHdJtul5AJR8/Zasd+ku6Dr+22y1625u8E1PYpRU1qxmVJ/yCCe1xsfW9UwypqmxVFXEu8q+PqXZOdtYVHA4l6ba1xmqZo/F7Z7gS4vLmGCMbNt0MRPkPA8jl9t/A5JHAHdxC+p8hAaMXhfAmSq0nJJyRfm6UWy0vKXLc/34f+3DwQsJ2UbDbuGgn9Eq6dCr9QpX7Cxa8r8frNkwoNta00pWdYVdVfjxs7rw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfUoB2VZe2mLCMCxrgzZo0QRNggFLDIOWTjYbimRJyo5h6L8PR0m27DheMhQbsC+GTN3b89zx7rQEzycOklt4r9OyQOUdDCPI0KVWGC+0ggSup8huTMY9slaKnV6eMy6lnjtWOrSOec0KnYl8wbjKWFmL+ymyDD0X0jGdM86cwVTkImVZY6jPvuggyD3zU+GCYa3korXudWuMsxznzHDLC/RoXcQWumQpV0p7lk65mtQOcyGRaZUiE76OoA1aOJZa5B6zPkSgDVpOEM8zSKB20uKDCNaOILldguIFQgKtrZHIIAJB9Bjup7DN2fl7ArzhPWBUiFkANcYGF9mx+L0UFjNIvC0xAucXkrw5URiJEAE+GKkzhCTn0pFAOsWCQ7IEvzBB0luhJhBBrm3B/fqkqoa1fXT+d50tSGcz1EurZyJDNkapO/x2mPdYGMk9OnbAPZPInWdaYUe2BfAKIki18kRhsgRujBRpIHnwzZG35ePQ9fgbpoFxSynxAh29rQn/e4BEDg80JeDCw4pyqCJQ2r/YzCVBRGZxJnAe6tmJiarrs2t7g8eXuVhVRddGRToyQ0sV+ZzURuCF37A36hToaEz5riqSs+iMVq6m9iiOH5fB6mo3ZclcmaboXF5Kufjpx+W1Pt6NcM0Pd9nRR3d58tEQK01Ip36/0lF8dNw7jHvx2+vDN8nJz8nrN/04jv+ECB4KuS4qIGvQZS/87xwIJYXCUcva6CiOR8cNlSe72GtKxjR3acalyFguUGaMfLofSCBaq+0/LOk98e2DT5Bb8Cd7Soc6ca5Llf3XcHdFtB/gyehkBfH1Y4jnqqaMxtO1vkf1byBc4+m697V7CnWzqkUtFN7DBtjueQ3SYVpa4Rdhtj30uBG9+n1yO6SJUaCfapqLpqyHoZ9CAoO2uwyWnT5TAdmzs3ZUllZCAlPvjUsGA25MXxtU1EIlH7t+qosBN2IwO4Qq2pZ2nk+EmvT2ag3X8V8RxzWNGyhWZHIjPuECopakrlQzwKfIM7SBUErd1/WwPGsTsOJ4e8K0A+Z5M2N7S9g5BbpDYNXqKdRcB1xNVi8MqityQTUxO3xk+5o8NwtV6yfUJ8u1ZVvabMwdZkyrsLLQSzo/7h+uNrag2md36k5d6QJp68tLyaRQ9y65Uz12e5HnIhVcsj9w7ITH4UGb1Pl8/iiZr4LOB+Gn5ZhZNHotPgmHIeNdrdUfWjI82sJd5FdoZyLFpoCecDUIwoPmwvI0XFgsuKDCa45+21YiyqVIUblu+k8/XH5mM3bcjyHqVO4zgh58Pn939uXqjOzSTamTdNiP+zEdGe18wVXH1dbGvZ3f5br7/F8X9OYGe3zwAyO5CE0tkL5sGtItdK5W0t3NhxFMtfMkslxScd9YWVV0/L1ES21vGMGMW8HHdJtul5AJR8/Zasd+ku6Dr+22y1625u8E1PYpRU1qxmVJ/yCCe1xsfW9UwypqmxVFXEu8q+PqXZOdtYVHA4l6ba1xmqZo/F7Z7gS4vLmGCMbNt0MRPkPA8jl9t/A5JHAHdxC+p8hAaMXhfAmSq0nJJyRfm6UWy0vKXLc/34f+3DwQsJ2UbDbuGgn9Eq6dCr9QpX7Cxa8r8frNkwoNta00pWdYVdVfjxs7rw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(i(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.8a6fea27.js b/assets/js/bfe4b778.8a6fea27.js deleted file mode 100644 index a935e7e3e..000000000 --- a/assets/js/bfe4b778.8a6fea27.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.006e5774.js b/assets/js/fa40969b.006e5774.js deleted file mode 100644 index 9422db364..000000000 --- a/assets/js/fa40969b.006e5774.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:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV11v2zYU/Ssc+9IGsi0nTroJw9CgzYKsxVokKQYsMQJaurbYUCRDUk4MQ/99uJRoybGTJkXXp74kFnk/eA4PL3mX1LGZpckFfafSsgDpLB1HNAObGq4dV5Im9MWLFyRMk/OFBptcylNwhsMcCCOCW0fUlGQhBJkwCxlRkriFhkt5KYd9srPzzrCpW0Wyyc7OpSSEkF47RlzOHGEGSFoaA9KJBeGSZN7TOuZK28d4uxjvjM8kc6UBcgo3JdjHQhq4KbkB4nIgC1UaYoOzj7eH8U5k75NRMwPWftMqdePsI44w4ltVaAEOsqfEy9kcyARAElumKVg7LYVYkHQV45a7nDAhApisBVHn3MecR3fazz01IzT2TGYeklREKDkDQ5hfBZ+ImqMDv4eQCi6fCygLXpOF34HSgulfShpRpcEw1NlJRhM6AxdEhKKiEdXMsAIcGBTpkkpWAE1oplJUFo0oR4Fq5nJ6X7XnOXj5rSvTKWIa5dKIBiJp4kwJEbVuITC+5cg5jSjcaaEyoMmUCYsGaQ4Fo8mS+vwJtc5wOUNLWRZ4jrxUV/loRFd7ZGqR+kUHqXQNVxvdGWs2pzMSqGyPa1VFK2IEL7gLtNyUYBZrKAOKBuZUmaILsiFhhbFgd7xAWPtxHAXEsiwmYGiFfszTlAzjzhLsNdffbQUP54yrMca1WkkLFm134xj/raugPUpkJTXPtXQgHdozrQVP/cTgi0Wn5eYC1OQLpF6PBsM4Xqc0YEvhOnbMGIaAuYPCft2/HkbpbwoKqWFuTWIBO/3zmF/v7k3yz38hJ1OOg8+LkDunbTIYNCOlEf1UFRjNcff8cNb/wHOGIaRyz46gBTALvqKtjqsHp0QG5kdRWWv4eRHqFRLvWrUE0oDiqoFQRVTdyjUsT4r/Rfkqiv7Iji+F3yq4h/BtzQYF4+Kr1hOAN81AkJDOlfxKmtH+we5w79fXwzXKHBRaMAdXZw1QnEwNMAfZoXs84m68u9cbxr349fnwIBn9luwf9OM4/pdG9K4QLXiaMQe0u0/Nd6mzH5Cn2jDriP2+dGjVZYdLrPxXoehd7cbx1QhNqoiO4tFm8TsFrYwjUjnC5owLNhHwy/erfmCM2qrmlqztK3gM1CgeXe2vQO1vgjqRcyZ4Rg4/nZBzdQ3yxyLqpnd1+s095bWRn6drYLvjNUgLaWm4W/j3zV2Pad6r55OLMd5xBbhcNY8j/yByOU3ooPtOGiybB1GF7w0w8/BcKo3o1HqmdV9pkFhFBJtYPK4DpvlgPqR4ga9bW8dmXM56j3qN2/WfIcc1jWso2lKl+XvAWtWQ1LVq3gs5MF8pK/yeKu/cUPdRg8Sq4ImfD7c897gl3PrpwI0XAZkqQ+55dxqUHPwkju/1h8RqSPm00U+f4Lv3TBX+xYpvCMHlNXY/PXLxcTrlKWeC/AMTyx2MXwbmbm9vNxh75X2OucvLCTGgVWs+84Oe1q7X6uMVjagDU9iP0zMwc56G+/uBVANvPGhOBUv9qWhqeRh6c98JVSp4CtJCR8eHx58+kDnZ68c06sjjCYsefDh5e/T32RHGRTnWmzTsx/3Y3xDKuoLJTqpjaFvDuqOcGlU0Pd/93V62B/5nd/qzO/3futOmcjm4cwMtGPfF3J+DZVOIL+i9hjUJvek4ormyDk2WS5TcZyOqCofrrgjrc8Yt3ohtX3QNi04XN2eixPy+Oj9g27RbrekYPwxH2+05HjxJL0+bnXtFntI8byUn1Hq56C4qLDZwU42rKBR7XGM9e5imoLu4N67ytfvw+OicRpSVuA3dS+baXzLND4y+dU3rt0+9APyLVG91+B2viPew+GNlXs886NDgC9bIz7iqqv8At5qkpg==",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/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:"eJztV11v2zYU/Ssc+9IGsi0nTroJw9CgzYKsxVokKQYsMQJaurbYUCRDUk4MQ/99uJRoybGTJkXXp74kFnk/eA4PL3mX1LGZpckFfafSsgDpLB1HNAObGq4dV5Im9MWLFyRMk/OFBptcylNwhsMcCCOCW0fUlGQhBJkwCxlRkriFhkt5KYd9srPzzrCpW0Wyyc7OpSSEkF47RlzOHGEGSFoaA9KJBeGSZN7TOuZK28d4uxjvjM8kc6UBcgo3JdjHQhq4KbkB4nIgC1UaYoOzj7eH8U5k75NRMwPWftMqdePsI44w4ltVaAEOsqfEy9kcyARAElumKVg7LYVYkHQV45a7nDAhApisBVHn3MecR3fazz01IzT2TGYeklREKDkDQ5hfBZ+ImqMDv4eQCi6fCygLXpOF34HSgulfShpRpcEw1NlJRhM6AxdEhKKiEdXMsAIcGBTpkkpWAE1oplJUFo0oR4Fq5nJ6X7XnOXj5rSvTKWIa5dKIBiJp4kwJEbVuITC+5cg5jSjcaaEyoMmUCYsGaQ4Fo8mS+vwJtc5wOUNLWRZ4jrxUV/loRFd7ZGqR+kUHqXQNVxvdGWs2pzMSqGyPa1VFK2IEL7gLtNyUYBZrKAOKBuZUmaILsiFhhbFgd7xAWPtxHAXEsiwmYGiFfszTlAzjzhLsNdffbQUP54yrMca1WkkLFm134xj/raugPUpkJTXPtXQgHdozrQVP/cTgi0Wn5eYC1OQLpF6PBsM4Xqc0YEvhOnbMGIaAuYPCft2/HkbpbwoKqWFuTWIBO/3zmF/v7k3yz38hJ1OOg8+LkDunbTIYNCOlEf1UFRjNcff8cNb/wHOGIaRyz46gBTALvqKtjqsHp0QG5kdRWWv4eRHqFRLvWrUE0oDiqoFQRVTdyjUsT4r/Rfkqiv7Iji+F3yq4h/BtzQYF4+Kr1hOAN81AkJDOlfxKmtH+we5w79fXwzXKHBRaMAdXZw1QnEwNMAfZoXs84m68u9cbxr349fnwIBn9luwf9OM4/pdG9K4QLXiaMQe0u0/Nd6mzH5Cn2jDriP2+dGjVZYdLrPxXoehd7cbx1QhNqoiO4tFm8TsFrYwjUjnC5owLNhHwy/erfmCM2qrmlqztK3gM1CgeXe2vQO1vgjqRcyZ4Rg4/nZBzdQ3yxyLqpnd1+s095bWRn6drYLvjNUgLaWm4W/j3zV2Pad6r55OLMd5xBbhcNY8j/yByOU3ooPtOGiybB1GF7w0w8/BcKo3o1HqmdV9pkFhFBJtYPK4DpvlgPqR4ga9bW8dmXM56j3qN2/WfIcc1jWso2lKl+XvAWtWQ1LVq3gs5MF8pK/yeKu/cUPdRg8Sq4ImfD7c897gl3PrpwI0XAZkqQ+55dxqUHPwkju/1h8RqSPm00U+f4Lv3TBX+xYpvCMHlNXY/PXLxcTrlKWeC/AMTyx2MXwbmbm9vNxh75X2OucvLCTGgVWs+84Oe1q7X6uMVjagDU9iP0zMwc56G+/uBVANvPGhOBUv9qWhqeRh6c98JVSp4CtJCR8eHx58+kDnZ68c06sjjCYsefDh5e/T32RHGRTnWmzTsx/3Y3xDKuoLJTqpjaFvDuqOcGlU0Pd/93V62B/5nd/qzO/3futOmcjm4cwMtGPfF3J+DZVOIL+i9hjUJvek4ormyDk2WS5TcZyOqCofrrgjrc8Yt3ohtX3QNi04XN2eixPy+Oj9g27RbrekYPwxH2+05HjxJL0+bnXtFntI8byUn1Hq56C4qLDZwU42rKBR7XGM9e5imoLu4N67ytfvw+OicRpSVuA3dS+baXzLND4y+dU3rt0+9APyLVG91+B2viPew+GNlXs886NDgC9bIz7iqqv8At5qkpg==",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:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},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,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list 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:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,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)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.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)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "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 "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.a3a1a41d.js b/assets/js/fa40969b.a3a1a41d.js new file mode 100644 index 000000000..677358e81 --- /dev/null +++ b/assets/js/fa40969b.a3a1a41d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),m=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:"eJztV21v2zYQ/isc+6UNZFtOnHYThqFBmwVpi7VoUgxYYgS0dLbYUCRLnpwYhv77cJRky7HTJkXRT/2SWMd7ffjwyFtyFDPPkwv+2qRlARo9H0c8A586aVEazRP+5MkT1i6z84UFn1zqj4BOwhyYYEp6ZGbKstYFmwgPGTOa4cLCpb7Uwz7b23vtxBRXnnyyt3epGWOst5YxzAUy4YClpXOgUS2Y1CwLlh4Flr5P/vbJ36nufXBm5sD77/JqG+Pg8YA8vjKFVYCQPcRfLubAJgCa+TJNwftpqdSCpSsfNxJzJpRiDr6U0kHGvJxpgaWDOuaIYh7f2rD20IjQ6AudhZK0YcroGTgmQhZyoiB4PwyYQ6qkfmxBWWs1WTDMgZUeXP9S84gbC04QL04znvAZYLvpRAIecSucKADBEamWXIsCeMIzkxITeMQlEcoKzPldlp3nEOiyySQ0zDVM4xFvgeQJuhIi7nGhyL+XhDmPONxaZTLgyVQoTwppDoXgyZKH+An36KSekaYuC+J9oNYqXsiw5UVXutrVjqzZiY6kxW19lqoqWqGgZCGxxeBLCW6xUVKbclPT1LiiW1FT8aqgQtzKgmo4jOOoLU+XxQQcr8hOBEySYdxJwV9L+8MyuD9mXI3Jr7dGe/Ckux/H9G9zy9fnhq14FbDWCBpJX1irZBoWBp89GS23EzCTz5AG8jlyg7IO6cCXCjt6wjlBBUuEwn/bvhYTz7fZQ9AI3OBTWzv/+0Re7x9M8k9vCJOpJOHjPOSI1ieDQSMpneqnpiBvKPHx7nz4QYeKXGiDj/ZgFQgPoX2tzmYozqgM3M+Csubw4zzUGbJgWq0B5G0VV00JVcTNjd6o5UH+P5vQMsme0Al973sJd199O6NBIaT6pvYE4GUjaClkc6O/EWZ0+Hx/ePD7i+EGZAiFVQLh6qwplBZTBwIhO8Kve9yP9w96w7gXvzgfPk9GfySHz/txHP/HI35bqHXxPBMIvLtPzXdps58Qp9pS65D9LnV41UVHaur8V23Tu9qP46sRqVQRH8Wj7eb3EaxxyLRBJuZCKjFR8NuP637gnNnJ5jVYuzP4WlGjeHR1uCrqcLuoUz0XSmbs6MMpOzfXoH9uRd3wWIff3lNZK4V1vlFsV14X6SEtncRFeMzc9oSVvXo9uRjTHVcA5qZ5CYXXD+Y84YPuo2iwbF4/FSd/bt6+jUqnOr1eWNs3FjR1ESUmno7rQFg5mA85XeCb2h7FTOpZ76tW43X+Z4RxDeNGFetWZeVboF7VgNTVat4LOYjQKSv6nppg3ED33oKmrhCAnw93vO2kZ9KH5RabQAI2NY7dse5MDzmERZIf9IfMW0jltOFPn9Ej98wU4XlKbwgl9TWNJj128X46lakUiv0LEy8Rxk9b5G5ubrYQexZsTiTm5YQ5sGatPgvCAGvXavXxjEccwRX+/fQM3Fym7f19T6hBUB40p0Kk4VQ0vbwVvbxrRCxVMgXtocPjo5MP79icHfRjHnXo8YCkB+9OXx3/c3ZMfomO9SYN+3E/DjeE8VgI3Ql1Auu5rR73ps4UzUB2d7eX6wP/a3T8NTquRsem0yDc4sAqIUPzDbxdNo3zgt+ZJpN2cBxHPDceSWW5JIp8cqqqSFxPMdRPM+npBlvPMdew6Exdc6FKih+66T26zXi0Vh3Th5OkuzvGvcx/+rHZuWfsIZPtTnDa3qwX3aTaZFtsqnEVtc2ZcqxXj9IUbLfurat34/46OT7nERclbUP3UrgOl0Lzg7zvzGnztqgToL8E9U6DP6mlv4XFXyv1euVeg6a+VpvwGVdV9T+5EmW9",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:"eJztV21v2zYQ/isc+6UNZFtOnHYThqFBmwVpi7VoUgxYYgS0dLbYUCRLnpwYhv77cJRky7HTJkXRT/2SWMd7ffjwyFtyFDPPkwv+2qRlARo9H0c8A586aVEazRP+5MkT1i6z84UFn1zqj4BOwhyYYEp6ZGbKstYFmwgPGTOa4cLCpb7Uwz7b23vtxBRXnnyyt3epGWOst5YxzAUy4YClpXOgUS2Y1CwLlh4Flr5P/vbJ36nufXBm5sD77/JqG+Pg8YA8vjKFVYCQPcRfLubAJgCa+TJNwftpqdSCpSsfNxJzJpRiDr6U0kHGvJxpgaWDOuaIYh7f2rD20IjQ6AudhZK0YcroGTgmQhZyoiB4PwyYQ6qkfmxBWWs1WTDMgZUeXP9S84gbC04QL04znvAZYLvpRAIecSucKADBEamWXIsCeMIzkxITeMQlEcoKzPldlp3nEOiyySQ0zDVM4xFvgeQJuhIi7nGhyL+XhDmPONxaZTLgyVQoTwppDoXgyZKH+An36KSekaYuC+J9oNYqXsiw5UVXutrVjqzZiY6kxW19lqoqWqGgZCGxxeBLCW6xUVKbclPT1LiiW1FT8aqgQtzKgmo4jOOoLU+XxQQcr8hOBEySYdxJwV9L+8MyuD9mXI3Jr7dGe/Ckux/H9G9zy9fnhq14FbDWCBpJX1irZBoWBp89GS23EzCTz5AG8jlyg7IO6cCXCjt6wjlBBUuEwn/bvhYTz7fZQ9AI3OBTWzv/+0Re7x9M8k9vCJOpJOHjPOSI1ieDQSMpneqnpiBvKPHx7nz4QYeKXGiDj/ZgFQgPoX2tzmYozqgM3M+Csubw4zzUGbJgWq0B5G0VV00JVcTNjd6o5UH+P5vQMsme0Al973sJd199O6NBIaT6pvYE4GUjaClkc6O/EWZ0+Hx/ePD7i+EGZAiFVQLh6qwplBZTBwIhO8Kve9yP9w96w7gXvzgfPk9GfySHz/txHP/HI35bqHXxPBMIvLtPzXdps58Qp9pS65D9LnV41UVHaur8V23Tu9qP46sRqVQRH8Wj7eb3EaxxyLRBJuZCKjFR8NuP637gnNnJ5jVYuzP4WlGjeHR1uCrqcLuoUz0XSmbs6MMpOzfXoH9uRd3wWIff3lNZK4V1vlFsV14X6SEtncRFeMzc9oSVvXo9uRjTHVcA5qZ5CYXXD+Y84YPuo2iwbF4/FSd/bt6+jUqnOr1eWNs3FjR1ESUmno7rQFg5mA85XeCb2h7FTOpZ76tW43X+Z4RxDeNGFetWZeVboF7VgNTVat4LOYjQKSv6nppg3ED33oKmrhCAnw93vO2kZ9KH5RabQAI2NY7dse5MDzmERZIf9IfMW0jltOFPn9Ej98wU4XlKbwgl9TWNJj128X46lakUiv0LEy8Rxk9b5G5ubrYQexZsTiTm5YQ5sGatPgvCAGvXavXxjEccwRX+/fQM3Fym7f19T6hBUB40p0Kk4VQ0vbwVvbxrRCxVMgXtocPjo5MP79icHfRjHnXo8YCkB+9OXx3/c3ZMfomO9SYN+3E/DjeE8VgI3Ql1Auu5rR73ps4UzUB2d7eX6wP/a3T8NTquRsem0yDc4sAqIUPzDbxdNo3zgt+ZJpN2cBxHPDceSWW5JIp8cqqqSFxPMdRPM+npBlvPMdew6Exdc6FKih+66T26zXi0Vh3Th5OkuzvGvcx/+rHZuWfsIZPtTnDa3qwX3aTaZFtsqnEVtc2ZcqxXj9IUbLfurat34/46OT7nERclbUP3UrgOl0Lzg7zvzGnztqgToL8E9U6DP6mlv4XFXyv1euVeg6a+VpvwGVdV9T+5EmW9",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:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(r(),{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)(m.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)(m.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(m.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)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.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:"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)("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:"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 "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.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)(c.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 y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.3948b808.js b/assets/js/runtime~main.203394b8.js similarity index 95% rename from assets/js/runtime~main.3948b808.js rename to assets/js/runtime~main.203394b8.js index f7a0d87f9..9cb3ba760 100644 --- a/assets/js/runtime~main.3948b808.js +++ b/assets/js/runtime~main.203394b8.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,r,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,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},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,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&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(r,d),r},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",7917:"0028a090",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:"103969af",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"006e5774",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"f33dd953",1477:"b31b2642",1512:"7ddd2ec3",1520:"010e8daa",1531:"70f84e73",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"8a6fea27",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"971ddfe3",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:"bd3f557f",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",7917:"da7ff0bb",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"7a8a462c",8140:"901b2f91",8141:"6478079e",8163:"f6ff51c6",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:"4815eb75",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),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[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 r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.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","0028a090":"7917","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 b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,r,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,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},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,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&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(r,d),r},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",7917:"0028a090",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:"103969af",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"a3a1a41d",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"f33dd953",1477:"b31b2642",1512:"7ddd2ec3",1520:"010e8daa",1531:"fadd1beb",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"469f98eb",2121:"c8df990c",2241:"e6e648f1",2245:"e95152b3",2267:"a4846e2b",2362:"ebdb1814",2403:"971ddfe3",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:"bd3f557f",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",7917:"da7ff0bb",7971:"8323da14",8055:"27482879",8087:"fd9041fd",8106:"7a8a462c",8140:"901b2f91",8141:"6478079e",8163:"1a624c06",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:"695c176b",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),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[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 r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.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","0028a090":"7917","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 b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);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 49ee7ff22..1db285252 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 a5ecd1db1..bfa33f8dd 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 54ffb11ea..7a95dee0f 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 4ce7ffd5a..25b728aa3 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 1729260bc..7ef1f3399 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 f0ee219be..8c057cf85 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 d9aed7401..9aad002f4 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 00f15ddb5..6217edd03 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 a412bc639..03a4273df 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 35ec1ea2c..a9969f414 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 948a1a91d..01bb7b79a 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 bd5c75c03..c838decf3 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 22975c16a..8213c2fb7 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 c81a5bf4d..05f614f60 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 705aa5a37..156962e52 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 65bcc9d74..be86ab28f 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 5b9d8807b..9084da81a 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 fb5ce53ba..707d1163e 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 d89f41ed7..98f1e9497 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 2944d99cd..02aeb2f3a 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/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index bdc970102..caa8c4a1e 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 174e4c750..959778938 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index b1738db66..faabb492c 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 fa5759149..f55e7cc99 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 5db5f6a43..37812857a 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 9f6b77748..f7bcd86c4 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 09a83bac7..2e702fbc3 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™ - + @@ -21,12 +21,6 @@
  • -

    Signature Requests:

    -
      -
    • Documents that require the your signature.
      • -
    -
    • -

  • In-Progress Documents:

    • Documents that are currently in progress.
      • @@ -52,7 +46,7 @@

      Request​

      -

      Path Parameters

        doctype stringrequired

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

        The type of documents to retrieve

      +

      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 [

        • name string
        email string
        phone string

      • ]

        • createdAt date
        updatedAt date

      • ]

      Loading...
      diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index 97fe8ffa2..0de1c04d0 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index a6aac2405..41a5e56db 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 17c1963e8..8e7ae3476 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 550e2717e..65c1b2608 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 20a49356c..0ab5fd3fc 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 65f466c6e..90439084d 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 02d127acf..672301628 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 28727bb5f..ebfcc8066 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 a19e6da92..21203d832 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 6e1c6f957..654fc2cb6 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 d1a9a5912..d712cafa8 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 b105a37f6..b651fce12 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 ee519c308..f89366f26 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 68d90f848..933d00b8b 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 44d3b2cba..be1886e95 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 7b18abf88..f5827a51e 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 ffa20c347..8cd374840 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 e173e35bf..05968f8e5 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 177542390..ce115abdd 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 643ef5326..f9537eb1e 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 93a82484c..0a83f000d 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 918c5feaa..2b0d313c9 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 652b6b516..bd28e59f4 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 3b7d9f30c..f384ae891 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 e5ebad3b0..5b2b8ca1d 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 77937a76d..a5721f633 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 afbafe78c..6ee855c88 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 59077153a..6240f591f 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 eda4b0c68..22110ce39 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 6122d7c32..8ea88905a 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 73279c847..b4cd03cd2 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 16a72f027..048ef86f6 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 8076edfc6..06d089fe7 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 11b803bb7..06e70b837 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 41349ba4d..b88ff97d5 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 3da77da71..180a78e02 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 396080add..3f0f231dc 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 ecde9479a..78de347a9 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 bb6339c43..76d56c3e2 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 76c16f687..eca3959f5 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 7b1734875..9a776c4d5 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 84a2d5347..4a71efd90 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +