diff --git a/404.html b/404.html index 77c913738..a8fc6e09d 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.8bacc2bc.js b/assets/js/05632a52.8bacc2bc.js new file mode 100644 index 000000000..efd82a62a --- /dev/null +++ b/assets/js/05632a52.8bacc2bc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu20YQ/ZXJvjQBaN3ipChRFDHSwDUSJEHtIkAdwViSI3Ht5e5md6gLBL71S/pp/ZJieJEoSw7qIgggWOLu3M5w5sx4I0jOg4ivxWtrSKYUxDQSGYbUK0fKGhGLqxzhHAlaCTj7eAFSa7sMsLYlkAWP5BUuEDIkqXQAmdiSQEJwmKqZSiFtdAciEtahl2z6IhOxmCO1dyISTnpZIKHniDbCyAJFLNr7G5WJSCiOyEnKxf0wbXKLKV1kYGewM+nxS6k8ZiImX2IkAq01Gw2qcBpFJHDltM1QxDOpAwukORZSxBtBa1dLkldmLiIxs76Q1D/BlaytxML9Nk7ydJK7RFTVlN0GZ03AwIYmoxF/7YcbyjTFEGalhm1GRFSDRUMsL53TKq0vhreBlTaH0TWoOXeezZBqXHbJeDSOfJzkq8mtE1XU5v9xBm4tQoLI6lhIpf+HfoL4qj0YpLZgUy635tGhnI6fjyf1h02kHiVhdkbHzOyUJqPJ85Px6GT049X4ZXz6U/zi5WA0Gv0pIrEqajRtVWaSapSkSPefS5d9Bz/VfbG24tsG7Ct0vVBVrHV6rBYvbYGUKzOHJRqCpbdmHoHTKAMC+TXIuVQGtCT0T75dkaL31n89TY+LrOrBVkYrgzddI96cjkY3420STg+T0NGbsQQzW5rs+yI94v7rcE5vJls4Lw7hXJiF1Cqr2frK3qH5vnD67qlxf1i0qhGq78Ue2P55AzJgWnpF63oyrE6kUyfNfXw9ZcblOrHtRKlHCeUiFsO2+oeb3RSpBFvzi27MlF6LWORELsTDoXRuYB2aoOZGyyQwBQ2lU8MF08h96SBNltjVwxrTXeSXnN0mgXvxb9MonXqLa9ER755UO/lylBn6OpXKzGyt3Cbtg0NzqeamTvlifDAfP6FObYE8rylH6MT/+evvWiOzaVmgoboinsCH0oOzS/Q8oKTJYKZxpRKNR8Z/QFloDEGvQRnCuZeEkKm5IqmBs8L9m0onE6UV1xCLWdb20CvDMIBPOVKOnq9+8AgSMlyg5tIDbe0d2yELsiRb1D7amGFp/d2MQ4pAQlIGZTAECIidCppcmhShexcRWA/SABpC77wKCFIVLDyzHnA2U6liw1w1ntuykEbOkZ1FwHFzFpy3C5VhAG+TMhAEq8saCHssEKmBaBCzMIBf1QIb4HzYEDVmMC/ZRASpzRDa/mEYJoMEA4Fj9yrF2mgg6Qk0LtDLeQ0tR5iVWoOz3NhKal5/+u+WDZGXJvCobALqXs02fc5b3kVqH5lcD+Cz+WyYeqEMyAWglbkL8WdzAtfbMvuESVCE06ddLyyXy4M+eLavc64oLxPw6OxOb14f1l3TV98+PBORIPRF+DC7RL9QKbYN+IDPYS08bOmORx9TVrOMcI+9uq/A1KNViiZgj5zOzj++gwU8H4xE1Ov6/xDw8N3F6zfvL9+wXWaZpv/Gg9FgVC8zNlAhTc9Vb7u+37abHWd/60W8ZR3CFQ2dlqqm4BropqXPa7FbpOPeGj6NRG4DscBmk8iAf3hdVXz8pUTPFD2NxEJ6JROmpuuNyFTg39l2zX4Q5NPf2439GRzf6I+G3TGoYfpcSF3yk4jEHa73/4OoplXUsSgH1gicpSk66qkeTMe9EXP+5kpEQpacoz5739Xs3f5g60fD2qf1JgD+y9PlqMLP/KLf4vqXrXhz86BCi6+T5hRNq6r6F9iGzi0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu20YQ/ZXJvjQBaN3ipChRFDHSwDUSJEHtIkAdwViSI3Ht5e5md6gLBL71S/pp/ZJieJEoSw7qIgggWOLu3M5w5sx4I0jOg4ivxWtrSKYUxDQSGYbUK0fKGhGLqxzhHAlaCTj7eAFSa7sMsLYlkAWP5BUuEDIkqXQAmdiSQEJwmKqZSiFtdAciEtahl2z6IhOxmCO1dyISTnpZIKHniDbCyAJFLNr7G5WJSCiOyEnKxf0wbXKLKV1kYGewM+nxS6k8ZiImX2IkAq01Gw2qcBpFJHDltM1QxDOpAwukORZSxBtBa1dLkldmLiIxs76Q1D/BlaytxML9Nk7ydJK7RFTVlN0GZ03AwIYmoxF/7YcbyjTFEGalhm1GRFSDRUMsL53TKq0vhreBlTaH0TWoOXeezZBqXHbJeDSOfJzkq8mtE1XU5v9xBm4tQoLI6lhIpf+HfoL4qj0YpLZgUy635tGhnI6fjyf1h02kHiVhdkbHzOyUJqPJ85Px6GT049X4ZXz6U/zi5WA0Gv0pIrEqajRtVWaSapSkSPefS5d9Bz/VfbG24tsG7Ct0vVBVrHV6rBYvbYGUKzOHJRqCpbdmHoHTKAMC+TXIuVQGtCT0T75dkaL31n89TY+LrOrBVkYrgzddI96cjkY3420STg+T0NGbsQQzW5rs+yI94v7rcE5vJls4Lw7hXJiF1Cqr2frK3qH5vnD67qlxf1i0qhGq78Ue2P55AzJgWnpF63oyrE6kUyfNfXw9ZcblOrHtRKlHCeUiFsO2+oeb3RSpBFvzi27MlF6LWORELsTDoXRuYB2aoOZGyyQwBQ2lU8MF08h96SBNltjVwxrTXeSXnN0mgXvxb9MonXqLa9ER755UO/lylBn6OpXKzGyt3Cbtg0NzqeamTvlifDAfP6FObYE8rylH6MT/+evvWiOzaVmgoboinsCH0oOzS/Q8oKTJYKZxpRKNR8Z/QFloDEGvQRnCuZeEkKm5IqmBs8L9m0onE6UV1xCLWdb20CvDMIBPOVKOnq9+8AgSMlyg5tIDbe0d2yELsiRb1D7amGFp/d2MQ4pAQlIGZTAECIidCppcmhShexcRWA/SABpC77wKCFIVLDyzHnA2U6liw1w1ntuykEbOkZ1FwHFzFpy3C5VhAG+TMhAEq8saCHssEKmBaBCzMIBf1QIb4HzYEDVmMC/ZRASpzRDa/mEYJoMEA4Fj9yrF2mgg6Qk0LtDLeQ0tR5iVWoOz3NhKal5/+u+WDZGXJvCobALqXs02fc5b3kVqH5lcD+Cz+WyYeqEMyAWglbkL8WdzAtfbMvuESVCE06ddLyyXy4M+eLavc64oLxPw6OxOb14f1l3TV98+PBORIPRF+DC7RL9QKbYN+IDPYS08bOmORx9TVrOMcI+9uq/A1KNViiZgj5zOzj++gwU8H4xE1Ov6/xDw8N3F6zfvL9+wXWaZpv/Gg9FgVC8zNlAhTc9Vb7u+37abHWd/60W8ZR3CFQ2dlqqm4BropqXPa7FbpOPeGj6NRG4DscBmk8iAf3hdVXz8pUTPFD2NxEJ6JROmpuuNyFTg39l2zX4Q5NPf2439GRzf6I+G3TGoYfpcSF3yk4jEHa73/4OoplXUsSgH1gicpSk66qkeTMe9EXP+5kpEQpacoz5739Xs3f5g60fD2qf1JgD+y9PlqMLP/KLf4vqXrXhz86BCi6+T5hRNq6r6F9iGzi0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.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:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(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/05632a52.e48c3f6b.js b/assets/js/05632a52.e48c3f6b.js deleted file mode 100644 index e9e7f50b8..000000000 --- a/assets/js/05632a52.e48c3f6b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxA4fKfdeXtGM8+MN4JkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnU34lEOOlljYSeI9oII2sUqejvr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0taXiCKxmtpML9Ms2q/LhymWjbGbsNzpqAgQ0dTyb8tR9uaPIcQ5g3GnYZEUkEi4ZYXjqnVR4vxjeBlTYPo+tQc+48myHVudwm49E4qmlWrY5vnGiTPv+PM3BjETJEVsdaKv0/9DPEV/3BKLc1m3KVNY8O5WT6fHocP2wi9ygJi1M6ZOZO6Xhy/PxoOjmafH85fZme/JC+eDmaTCZ/ikSs6oimr8pCUkRJivTwuXHFN/DT3hfrK75vwKHCthfalrVODtXiha2RKmVKWKIhWHprygScRhkQyK9BllIZ0JLQP/l6RYreW//lND0usnYAWxmtDF5vG/H6ZDK5nu6ScPIwCVt6M5ZgbhtTfFukB9x/Gc7J9fEOzouHcM7NQmpVRLa+tLdovi2coXvq3D8sWtUJxXuxB3Z43oEMmDde0TpOhtWRdOqou0+vZsy4XCe2nyhxlFAlUjHuq3+8uZsirWBrfrEdM43XIhUVkQvpeCydG1mHJqjSaJkFpqCxdGq8YBq5Lx1IlsqUR1/Umt1Ff8EZ7pK4h2GXSunUr7gWW/Ldk+qnX4WyQB/TqczcRuU+ce8cmgtVmpj2xfTBjPyAOrc18symCmEr/s9ff0eNwuZNjYZiVTyBd40HZ5foeUhJU8Bc40plGg+sAAFlrTEEvQZlCEsvCaFQpSKpgbPCPZxLJzOlFdcRi1nW9jAoxTCCDxVShZ6vvvMIEgpcoObyA23tLdshC7IhW0cffcywtP52ziElICFrgjIYAgTErQqaSpocYfsuErAepAE0hN55FRCkqll4bj3gfK5yxYa5cjy3Zi2NLJGdJcBxcxactwtVYABvsyYQBKubCIQ91ojUQTSIRRjBz2qBHXA+7MgaCygbNpFAbguEvocYhikgw0Dg2L3KMRoNJD2BxgX6WHvxTc4brcFZbm4lNa9Aw3fLhshLE3hcdgFtX80ufc5b3keij0KuR/DRfDRMv9AE5ALQytyG9KM5gqtdmX3ALCjC2dNtPyyXywd98Gxf50xR1WTg0dk7vTIexq4Zqu8enolEEPo6vJtfoF+oHPsm/IzPcRQe95TH449pq1tIuMde3Vdg+tEqRxNwQFCnZ+/fwgKejyYiGXT+fwh4/Pb89ZvfLt6wXWaarv+mo8loEhcaG6iWZuBqsGHfb9vNHW9/7WW8Zx3CFY2dlirScAS66Sn0Stwt0+lgFZ8lorKBWGCzyWTAP7xuWz7+1KBnmp4lYiG9khlT09VGFCrw72K3an8W5NPf+639GRze6g+GvWVQw/S5kLrhJ5GIW1zv/xfRztpky6IcWCdwmufoaKD6YELujZmzN5ciEbLhHA3Z+zayd/+DrR8Ma5/WuwD4L0+Ygwo/8ov+Fdc/7cS7m88q9Pi20pyiWdu2/wIzKM+Z",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{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:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.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,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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.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:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.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:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.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/13fdae3b.5b6095f9.js b/assets/js/13fdae3b.5b6095f9.js new file mode 100644 index 000000000..c1f29c952 --- /dev/null +++ b/assets/js/13fdae3b.5b6095f9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>x,contentTitle:()=>j,default:()=>g,frontMatter:()=>m,metadata:()=>u,toc:()=>f});var a=s(85893),o=s(11151),i=s(58219),d=(s(62316),s(51039)),n=s.n(d),t=(s(82723),s(9487)),r=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh9qFEUXTbAINmgWcBZ5cIxgJI0krimSJSnZhqG3fkk/rV9SDGX5lmZRFEVfbJlz5nJGM4feioClF9O5eKS0MmYpFonIyWdO2iCNFlPxUBFck6JAsMPA+0+3gEqZFWxMA8FA3ttXO3vjlEiEseSQg9zmYip6yJAlEY68NdqTF9OteDuZ8Ndp4lmTZeR90SjYhxKJyIwOpAPj0Vols2gYf/HstBU+q6hGfgobS2IqTPqFsiASYR2HCbJP6cg3KhzhfHBSlyIRtMbaKj4a+Pa15+D3FanNhei6RAQZIlJqJTU9D6Se304mzz+IrmPMu8m7l+Q+e3KgTYDCNDq/+O94kXPGfZ3Wee6vEeHiBxrfv6Rxq1tUMo8T8WCWpP9fJsfpQ5+eS13Xiv001j2lCIp2cUL1+Lwn6SlrnAwbMZ1vxfoSrbzs7dP5olskoqZQmcM4c80YKjEV49V+sj25lpyPIXgTpqIKwfrpeIzWjowl7WWpFaZ+lJl6jFaO2yvRJedojzpPzfp1j8Wh3hn3tG/bSdX75qGVH2kjkqEpx6hESH6XFWFOLjZQ6sJE512r7i3pmSx1bHR7Jc414pFUZmpiKQgVwQD/8/c/okdusqYmHeIcXMB948CaFTlebdQ5FIrWMlV0EBY/KIsnrBV5rzYgdaDSYSDIZSkDKuCuSF1ChhZTqSRPDsMMezs4Gj4/gseKQkWOTd84AoScWlI8cKCMWXKcYACbYOqYY1czrIxbFlxSAghp46Um78ETDS6kK9QZwfAuEjAOUAPpQM466QlQ1gwujAMqCplJDsxr4jALUKPGkjhZAlw3d8E608qcPDiTNj6AN6qJRDhjTRR6ipoo9yO4li31xPkwp4BSUQ5lwyESyExOsNsapqFzSMkHsJxeZhSD+oAugKKWHJaRWkXAUgfW8DpLVGCKk3fLgYJD7Qvj6r6g4dXs22edYc2MOXLcjOBJP+kZD0vjiQdASb300yd9CfP9mD1S6mWgxbfDLqxWqxd78ObU54MMVZOCI2sOfmU8jFtz7L7/8UYkIpCr/X0xI9fKjHYL+ErOcQSPdyKHWRQ5qlGqfsd+PndgwVEyI+3pSJLef/h0By18N5qI5Gjr/0HB47vbX25+nd1wXFaZfv+uRpPRhI+s8aFGfZTq9Oo+39ztQaz//UW/k5hA6zC2CmVU2chqu5PHuVgd/l5Uxgc+2m5T9PTZqa7j498acqy7i0S06CSmrDzzRZcMwsR6uqQNty/LyPKF0aJqenU7u2ZOtPr65u7m4UYkAhsu5lgTl1ETdw+cYDDpzVH4U7Hsa+BP1uy/dfiRG/eRNj/t4b3lVYcdxQHNLVx0XfcXJaRe3g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh9qFEUXTbAINmgWcBZ5cIxgJI0krimSJSnZhqG3fkk/rV9SDGX5lmZRFEVfbJlz5nJGM4feioClF9O5eKS0MmYpFonIyWdO2iCNFlPxUBFck6JAsMPA+0+3gEqZFWxMA8FA3ttXO3vjlEiEseSQg9zmYip6yJAlEY68NdqTF9OteDuZ8Ndp4lmTZeR90SjYhxKJyIwOpAPj0Vols2gYf/HstBU+q6hGfgobS2IqTPqFsiASYR2HCbJP6cg3KhzhfHBSlyIRtMbaKj4a+Pa15+D3FanNhei6RAQZIlJqJTU9D6Se304mzz+IrmPMu8m7l+Q+e3KgTYDCNDq/+O94kXPGfZ3Wee6vEeHiBxrfv6Rxq1tUMo8T8WCWpP9fJsfpQ5+eS13Xiv001j2lCIp2cUL1+Lwn6SlrnAwbMZ1vxfoSrbzs7dP5olskoqZQmcM4c80YKjEV49V+sj25lpyPIXgTpqIKwfrpeIzWjowl7WWpFaZ+lJl6jFaO2yvRJedojzpPzfp1j8Wh3hn3tG/bSdX75qGVH2kjkqEpx6hESH6XFWFOLjZQ6sJE512r7i3pmSx1bHR7Jc414pFUZmpiKQgVwQD/8/c/okdusqYmHeIcXMB948CaFTlebdQ5FIrWMlV0EBY/KIsnrBV5rzYgdaDSYSDIZSkDKuCuSF1ChhZTqSRPDsMMezs4Gj4/gseKQkWOTd84AoScWlI8cKCMWXKcYACbYOqYY1czrIxbFlxSAghp46Um78ETDS6kK9QZwfAuEjAOUAPpQM466QlQ1gwujAMqCplJDsxr4jALUKPGkjhZAlw3d8E608qcPDiTNj6AN6qJRDhjTRR6ipoo9yO4li31xPkwp4BSUQ5lwyESyExOsNsapqFzSMkHsJxeZhSD+oAugKKWHJaRWkXAUgfW8DpLVGCKk3fLgYJD7Qvj6r6g4dXs22edYc2MOXLcjOBJP+kZD0vjiQdASb300yd9CfP9mD1S6mWgxbfDLqxWqxd78ObU54MMVZOCI2sOfmU8jFtz7L7/8UYkIpCr/X0xI9fKjHYL+ErOcQSPdyKHWRQ5qlGqfsd+PndgwVEyI+3pSJLef/h0By18N5qI5Gjr/0HB47vbX25+nd1wXFaZfv+uRpPRhI+s8aFGfZTq9Oo+39ztQaz//UW/k5hA6zC2CmVU2chqu5PHuVgd/l5Uxgc+2m5T9PTZqa7j498acqy7i0S06CSmrDzzRZcMwsR6uqQNty/LyPKF0aJqenU7u2ZOtPr65u7m4UYkAhsu5lgTl1ETdw+cYDDpzVH4U7Hsa+BP1uy/dfiRG/eRNj/t4b3lVYcdxQHNLVx0XfcXJaRe3g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},x={},f=[{value:"Request",id:"request",level:2}];function b(e){const l={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Webhook"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(l.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:l}={...(0,o.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.f58acb33.js b/assets/js/13fdae3b.f58acb33.js deleted file mode 100644 index 0a20274ba..000000000 --- a/assets/js/13fdae3b.f58acb33.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>b,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>j,toc:()=>x});var a=s(85893),o=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),r=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),h=s(9472),p=s(85162);const m={id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh8qFEUXTbAINmgWcBZ5cIyAksYS1xTJcijZhqG3fkk/rV9SDGX5lm5QFEVfbJlz5nKGM0feiiBLEulMPGJWWbsU80QUSLlXLihrRCoeKoRr1BgQdhh4/+kWpNZ2BRvbQLBQ9PbVzt54LRJhHXrJQW4LkYoeMmRJhEdy1hCSSLfi7WTCX6eJp02eI9Gi0bAPJRKRWxPQBMZL57TKo2H8hdhpKyivsJb8FDYORSps9gXzIBLhPIcJqk/pkRodjnAUvDKlSASuZe00Hw18+9oLoH1FenMhui4RQYWIVEYrg88Dqee3k8nzD6LrGPNu8u4luc+EHowNsLCNKS7+O17ovfWv0zrP/RoRLn6g8f1LGremlVoVcSIe7BLN/8vkOH3o03Op61qzn5F1TymCol2cUD0+70kS5o1XYSPS2VasL6VTl709nc27eSJqDJU9jDPXLEMlUjFe7Seb0LfoKYbgTUhFFYKjdDyWzo2sQ0OqNFpmNMptPZZOjdsr0SXnaAqyVKa8fNVrfqh5yn3tW3dS+b6B0qmPuBHJ0JhjVCIU32eFskAfm6jMwkbnXbvuHZqpKk1sdnslznXiEXVua2Q5CBXCAP/z9z+iR2HzpkYT4ixcwH3jwdkVel5vaQpYaFyrTONBXGhQF0JZayTSG1AmYOllQChUqYLUwF1RpoRcOpkprXh6GGbZ28PRANIIHisMFXo2feMRJBTYouahA23tkuMEC7IJto45djXDyvrlgktKQELWkDJIBIQ4uKCppMkRhrtIwHqQBtAE9M4rQpCqZvDCesDFQuWKA/OqeJkHqKWRJXKyBLhu7oLztlUFEnibNRSArG4iEc5YI4aeokEsaATXqsWeOB8WGKTSWEDZcIgEclsg7DaHaZgCMqQAjtOrHGNQCtIH0Niij7MXb5LlDpzllVZSg12c3C0HCl4aWlhf9wUNV7Nvn/OWdTPmKORmBE/myUx5WBpCHgCtzJLSJ3MJs/2YPWJGKuD822EfVqvViz14c+rzQYWqycCjswe/Mh7GrTl23/94IxIR0Nd0v5iib1WOuyX8Ss5xBI93QifzKHRYS6X7Hfv53IFFR6scDeGRLL3/8OkOWvhuNBHJ0eb/g4LHd7e/3Pw6veG4rDT9/l2NJqMJHzlLoZbmKNXp6/t8c7cHwf73L/udxARch7HTUkWljay2O4mcidXhL0ZlKfDRdptJws9edx0f/9agZ+2dJ6KVXsmMlWc275JBmFhTl7jh9uU5On5ptFI3vbqdvWpO9Pr65u7m4UYkQjZczLEmLqMm7h44wWAym6Pwp2LZ18CfrNt/6/AjN+4jbn7aw3vLVx12FAc0t3Dedd1furFgSg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",source:"@site/docs/API-docs/delete-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-webhook",permalink:"/docs/API-docs/delete-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-webhook",title:"Delete Webhook",description:"The Delete Webhook API allow you to delete webhook url",sidebar_label:"Delete Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/ZUJX9oFFNvZbh8qFEUXTbAINmgWcBZ5cIyAksYS1xTJcijZhqG3fkk/rV9SDGX5lm5QFEVfbJlz5nKGM0feiiBLEulMPGJWWbsU80QUSLlXLihrRCoeKoRr1BgQdhh4/+kWpNZ2BRvbQLBQ9PbVzt54LRJhHXrJQW4LkYoeMmRJhEdy1hCSSLfi7WTCX6eJp02eI9Gi0bAPJRKRWxPQBMZL57TKo2H8hdhpKyivsJb8FDYORSps9gXzIBLhPIcJqk/pkRodjnAUvDKlSASuZe00Hw18+9oLoH1FenMhui4RQYWIVEYrg88Dqee3k8nzD6LrGPNu8u4luc+EHowNsLCNKS7+O17ovfWv0zrP/RoRLn6g8f1LGremlVoVcSIe7BLN/8vkOH3o03Op61qzn5F1TymCol2cUD0+70kS5o1XYSPS2VasL6VTl709nc27eSJqDJU9jDPXLEMlUjFe7Seb0LfoKYbgTUhFFYKjdDyWzo2sQ0OqNFpmNMptPZZOjdsr0SXnaAqyVKa8fNVrfqh5yn3tW3dS+b6B0qmPuBHJ0JhjVCIU32eFskAfm6jMwkbnXbvuHZqpKk1sdnslznXiEXVua2Q5CBXCAP/z9z+iR2HzpkYT4ixcwH3jwdkVel5vaQpYaFyrTONBXGhQF0JZayTSG1AmYOllQChUqYLUwF1RpoRcOpkprXh6GGbZ28PRANIIHisMFXo2feMRJBTYouahA23tkuMEC7IJto45djXDyvrlgktKQELWkDJIBIQ4uKCppMkRhrtIwHqQBtAE9M4rQpCqZvDCesDFQuWKA/OqeJkHqKWRJXKyBLhu7oLztlUFEnibNRSArG4iEc5YI4aeokEsaATXqsWeOB8WGKTSWEDZcIgEclsg7DaHaZgCMqQAjtOrHGNQCtIH0Niij7MXb5LlDpzllVZSg12c3C0HCl4aWlhf9wUNV7Nvn/OWdTPmKORmBE/myUx5WBpCHgCtzJLSJ3MJs/2YPWJGKuD822EfVqvViz14c+rzQYWqycCjswe/Mh7GrTl23/94IxIR0Nd0v5iib1WOuyX8Ss5xBI93QifzKHRYS6X7Hfv53IFFR6scDeGRLL3/8OkOWvhuNBHJ0eb/g4LHd7e/3Pw6veG4rDT9/l2NJqMJHzlLoZbmKNXp6/t8c7cHwf73L/udxARch7HTUkWljay2O4mcidXhL0ZlKfDRdptJws9edx0f/9agZ+2dJ6KVXsmMlWc275JBmFhTl7jh9uU5On5ptFI3vbqdvWpO9Pr65u7m4UYkQjZczLEmLqMm7h44wWAym6Pwp2LZ18CfrNt/6/AjN+4jbn7aw3vLVx12FAc0t3Dedd1furFgSg==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"},next:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"}},b={},x=[{value:"Request",id:"request",level:2}];function f(e){const l={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Webhook"})}),"\n",(0,a.jsx)(t(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(l.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook deleted successfully!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook deleted successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:l}={...(0,o.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.5c33accf.js b/assets/js/1f73ca32.5c33accf.js deleted file mode 100644 index 7ee100b80..000000000 --- a/assets/js/1f73ca32.5c33accf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var n=s(85893),l=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},j={},f=[{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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,n.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,n.jsx)(m.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)(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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"User not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.bbe9fcf5.js b/assets/js/1f73ca32.bbe9fcf5.js new file mode 100644 index 000000000..7e178607f --- /dev/null +++ b/assets/js/1f73ca32.bbe9fcf5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkGKLbz0nYThqHd1gVpi7VAUhRYahQn6iwxpkiOpOQYhr/tl+yn7ZcMR1mO7bTDgg39YkvHu+deePecViJiFUR+Ld4F8mKaiZKC9MpFZY3IxVVNcE4R+BSev70AMlhoCrC0LUQLFUV+9GAXBlBK25oIJUVUOoxEJqwjj4x1UYpcVBSTm0x4Cs6aQEHkK3EymfDfvufLVkoKYdZq2IKITEhrIpnI+uicVjIdjG8CG61EkDU1yE9x6UjkwhY3JKPIhPMME1XvshdzUFvNEL0ylcjEzPoG466EbrFxmpV+OVfzk9OifvdSrDNhsKGHIry0BD8SsTk1qPRD7W8sFUTPNoKRtA1DudqaB4dy9vjJ029PT45PThnixhZXKuoHo5TUsbm0jUOzfKi1dWSCqkyC8ISRyufxUyB3JieTk9Oj48nR5OnV8ZP87Lv88ZPRZDL5TWTitkn17O9FlBhTnWOf1va9deUX8LM+VGu59XfU+vc1K55Nzu5PQJo5YyPMbGvKR/9f85P31v9z7oe+1ztxK6OVoY/DCH/k4Ic0Ht9P48J0qFWZ2OPKzsl82Ux23cfe/f2rUb1SOhd7qe7K+yQDydaruBT59UrcHqFTR/15fj1dTzPRUKzthu04YIy1yMW4otj23BfId+RDsm+9FrmoY3QhH4/RudEwEBqLwNM9RqfG3bFYZ4faAU1Z2NvPW0zvgr3kgvY12wt5Wzl06hUtxcBpe1qZUHyRNWGZOpbfZzYZb+r0xpG5VJVJVe6OxeEaeU9a2oZ4Y8SaYFD/648/k0VpZduQiakJHsGb1oOzC/JM/mhKmGm6VYWmpIxa28V2AQXCRlMIegnKRKo8RoJSVSqiBq6KMhVIdFgorbhtWM32O2un88II3tcUa/J89JUnQCipI83dBtraOeNEC9hG2yQfm5hhYf18xiFlgFC0QRkKAQLRYEKmRiMJhrvIwHpAA2QieedVIEDVsPLMeqDZTEnFwDwjHmWEBg1WxM4y4Li5Cs7bTpUUwNuiDRGC1W1KhD02NKxlQ1SGEfysOuoTZ2G/n6mEqmWIDKQtCTYjw2mYEgoKERy7V5ISaIjoI2jqyGOVUqsJZq3W4CzPskINdrZ3twwUPZrAG6APaLiabfmct7znk48SlyP4YD6YS26WNhA3gFZmHvIP5giut232noqgIk2/HmZhsVjcm4Nv9m3OVazbAjw5e2dXJWGaml3z7cs3IhORfBPezC7Jd0rSZgA/43OclMcbhkOZGG6z53nGnh0aMNtoJckE2uGj5+dvX0MHp6OJyHam/l8EPH598dOLXy9fMC6zTD9/x6PJaJK+E2yIDZodV+dDqxx8vR3O8OqOs//zV+GGcyLdxrHTqBLnpjRXG768FgNfTjNR2xBZtFoVGOid1+s1i39vyTMLTzPRoVccQeLgbGAqJtg5LbmeUpJjNu5Qtz3dHSydPeY+f3ElMoEtR7LLkPPEkJsHRh+OzHIHe586+wD4lxn8kwbfcwlf0fKHrXp/8lmDTX6DNtdvul6v/wasLQ5J",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkGKLbz0nYThqHd1gVpi7VAUhRYahQn6iwxpkiOpOQYhr/tl+yn7ZcMR1mO7bTDgg39YkvHu+deePecViJiFUR+Ld4F8mKaiZKC9MpFZY3IxVVNcE4R+BSev70AMlhoCrC0LUQLFUV+9GAXBlBK25oIJUVUOoxEJqwjj4x1UYpcVBSTm0x4Cs6aQEHkK3EymfDfvufLVkoKYdZq2IKITEhrIpnI+uicVjIdjG8CG61EkDU1yE9x6UjkwhY3JKPIhPMME1XvshdzUFvNEL0ylcjEzPoG466EbrFxmpV+OVfzk9OifvdSrDNhsKGHIry0BD8SsTk1qPRD7W8sFUTPNoKRtA1DudqaB4dy9vjJ029PT45PThnixhZXKuoHo5TUsbm0jUOzfKi1dWSCqkyC8ISRyufxUyB3JieTk9Oj48nR5OnV8ZP87Lv88ZPRZDL5TWTitkn17O9FlBhTnWOf1va9deUX8LM+VGu59XfU+vc1K55Nzu5PQJo5YyPMbGvKR/9f85P31v9z7oe+1ztxK6OVoY/DCH/k4Ic0Ht9P48J0qFWZ2OPKzsl82Ux23cfe/f2rUb1SOhd7qe7K+yQDydaruBT59UrcHqFTR/15fj1dTzPRUKzthu04YIy1yMW4otj23BfId+RDsm+9FrmoY3QhH4/RudEwEBqLwNM9RqfG3bFYZ4faAU1Z2NvPW0zvgr3kgvY12wt5Wzl06hUtxcBpe1qZUHyRNWGZOpbfZzYZb+r0xpG5VJVJVe6OxeEaeU9a2oZ4Y8SaYFD/648/k0VpZduQiakJHsGb1oOzC/JM/mhKmGm6VYWmpIxa28V2AQXCRlMIegnKRKo8RoJSVSqiBq6KMhVIdFgorbhtWM32O2un88II3tcUa/J89JUnQCipI83dBtraOeNEC9hG2yQfm5hhYf18xiFlgFC0QRkKAQLRYEKmRiMJhrvIwHpAA2QieedVIEDVsPLMeqDZTEnFwDwjHmWEBg1WxM4y4Li5Cs7bTpUUwNuiDRGC1W1KhD02NKxlQ1SGEfysOuoTZ2G/n6mEqmWIDKQtCTYjw2mYEgoKERy7V5ISaIjoI2jqyGOVUqsJZq3W4CzPskINdrZ3twwUPZrAG6APaLiabfmct7znk48SlyP4YD6YS26WNhA3gFZmHvIP5giut232noqgIk2/HmZhsVjcm4Nv9m3OVazbAjw5e2dXJWGaml3z7cs3IhORfBPezC7Jd0rSZgA/43OclMcbhkOZGG6z53nGnh0aMNtoJckE2uGj5+dvX0MHp6OJyHam/l8EPH598dOLXy9fMC6zTD9/x6PJaJK+E2yIDZodV+dDqxx8vR3O8OqOs//zV+GGcyLdxrHTqBLnpjRXG768FgNfTjNR2xBZtFoVGOid1+s1i39vyTMLTzPRoVccQeLgbGAqJtg5LbmeUpJjNu5Qtz3dHSydPeY+f3ElMoEtR7LLkPPEkJsHRh+OzHIHe586+wD4lxn8kwbfcwlf0fKHrXp/8lmDTX6DNtdvul6v/wasLQ5J",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},j={},f=[{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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.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:"FGik23bhUJ"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(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,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"User not found!"})}),(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)(m.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:"User not found!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\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)(m.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.c5d650a9.js b/assets/js/2304e9ae.e976b175.js similarity index 63% rename from assets/js/2304e9ae.c5d650a9.js rename to assets/js/2304e9ae.e976b175.js index 861f034b0..f737f43cc 100644 --- a/assets/js/2304e9ae.c5d650a9.js +++ b/assets/js/2304e9ae.e976b175.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>k,frontMatter:()=>h,metadata:()=>u,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},j={},g=[{value:"Request",id:"request",level:2}];function f(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:"Create Folder"})}),"\n",(0,l.jsx)(i(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>u,toc:()=>f});var l=s(85893),r=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21v2zYQ/itXftkKKH5Jmw4ThmFZ1xVZiyZYMhSYYwQn6SyxoUiWpOwYhr/tl+yn7ZcMR1qJ7aTFMgzFvhgWea/P3T0nrUTA2ot8In42qiInppmoyJdO2iCNFrm4aAheOsJAkETg+OwEUCmz8LA0HQQDZbqfxfuByISx5JANnFQiF+k63YpMOPrYkQ8/mmop8tWeuzNn5rIiKEiZBVh02FIgd8+LyERpdCAd2AZaq2QZPQ4/eDa0Er5sqEX+xw6lo4rTTNoaW+JUw9KSyIUpPlAZRCas48iDJM96SfYdy+arXtYHJ3UtMjEzrsWwfUI32FrFQpoWfZzrTFh0pENCjwF5nC2xXmciyBAfktGrgrFb88VdbsF1FA+8NdqnDA5Ho/sQJxsbOCvwXVmS97NOqeWTx8D6efDS8ePTtc24aG4OP1hG7v9RgV8ONfqja3lGbGuD23F4yMyd0uHo8NnBeHQw+uZi/CJ//m1+9GIwGo1+F5m4aRXrxibMRYUh2u1L3D93tvoCftb7Ygm0igJK5cW91uOuW2fi+UONdW5aCo3UNSxIB1g4o+sMrCL0BMEtAWuUGhQGcv9hp5Fzxn0epMdFtj1wUiup6aqfqqvno9HV+BaEo/sgnOg5KllFlrww16S/bKbb7kNyf7/GMgnFe7GT7PZ5StJT2TkZliKfrMTNAVp5kO7zyXQ9zQQDa5jlrfExYgyNyMVwj/Q9uTk5H610TolcNCFYnw+HaO3AWNJe1lph4QelaYdo5XA+FutsX9qjrgpz82mN6V3I5wxrQm4n8Fv80Mo3tBRZj8u2VCYkl7MhTF2fCa7Wr3e761WP+e6i2Gae+8QjGG6pZyZGsYH91JI+l7WORZuPxf4Kfk+qNC3xDgwNQS/+1x9/Ro3KlF1LOsSeegKnnQNrFuRmnQLUFcwU3chC0QOL2xO2irxXS5A6UO14wVaylgEVMLw8MiVaLKSS3IUsZljbwVYj+wG8byg05PjqK0eAUNGcFDcvKGOu2U4wgF0wbfSxiRkWxl3POKQMEIrOS03egyfqVUg3qEuCvqgZGAeogXQgZ530BChbFp4ZBzSbyVKyYR45h2WAFjXWxM4y4LgZBZveMjw4U3Q+gDeqi4mwx5YopBQ1UeUH8JOcU0qcDxM1UgV1xyYyKE1FsJlATkNXUJAPYNm9LCka9QFdAEVzcljH1BoC3rlgDVODRAVmtlNbNhQcas+7KQXUl+YWPusML+/oo8LlAC71pWa2g84TN4CS+trnl/oAJrdt9p4KLwNNv+6HarFY3Buop7s6r2VougIcWXOnV8fDOH7b6rcPT0UmArnWn87Oyc1lSZtJ/oTPYRQebggTy0iY1KJUaVh/2FfgaVKyJO1pi96OX5+9hTk8G4xEtkUf/yDg4duTl6/enb9iu0xXaf7Gg9FgFF8jjA8t6i1XO2/G+4O7uuP9f/cavaGpQDdhaBXKSNYxodWGZye7L9fTTDRMw/lErFYFevrNqfWajz925JjDp5mYo5NYMPNMpuusZzgm5mtack4p6IML9s7iqktkube4mJyTxnFZkg2fld3eFGen5xciE8XmA6A1Fes4XPDHAS5ELi7FpYifEXEo4zs8n6+EQl13WLN8ssvEjB1Dsc3q15HVN384s/5KL7ei3KX7lAr/cmIPKnzHNXtDy+9vxdPNJxU22PbSXMDper3+G9oqqKU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV21v2zYQ/itXftkKKH5Jmw4ThmFZ1xVZiyZYMhSYYwQn6SyxoUiWpOwYhr/tl+yn7ZcMR1qJ7aTFMgzFvhgWea/P3T0nrUTA2ot8In42qiInppmoyJdO2iCNFrm4aAheOsJAkETg+OwEUCmz8LA0HQQDZbqfxfuByISx5JANnFQiF+k63YpMOPrYkQ8/mmop8tWeuzNn5rIiKEiZBVh02FIgd8+LyERpdCAd2AZaq2QZPQ4/eDa0Er5sqEX+xw6lo4rTTNoaW+JUw9KSyIUpPlAZRCas48iDJM96SfYdy+arXtYHJ3UtMjEzrsWwfUI32FrFQpoWfZzrTFh0pENCjwF5nC2xXmciyBAfktGrgrFb88VdbsF1FA+8NdqnDA5Ho/sQJxsbOCvwXVmS97NOqeWTx8D6efDS8ePTtc24aG4OP1hG7v9RgV8ONfqja3lGbGuD23F4yMyd0uHo8NnBeHQw+uZi/CJ//m1+9GIwGo1+F5m4aRXrxibMRYUh2u1L3D93tvoCftb7Ygm0igJK5cW91uOuW2fi+UONdW5aCo3UNSxIB1g4o+sMrCL0BMEtAWuUGhQGcv9hp5Fzxn0epMdFtj1wUiup6aqfqqvno9HV+BaEo/sgnOg5KllFlrww16S/bKbb7kNyf7/GMgnFe7GT7PZ5StJT2TkZliKfrMTNAVp5kO7zyXQ9zQQDa5jlrfExYgyNyMVwj/Q9uTk5H610TolcNCFYnw+HaO3AWNJe1lph4QelaYdo5XA+FutsX9qjrgpz82mN6V3I5wxrQm4n8Fv80Mo3tBRZj8u2VCYkl7MhTF2fCa7Wr3e761WP+e6i2Gae+8QjGG6pZyZGsYH91JI+l7WORZuPxf4Kfk+qNC3xDgwNQS/+1x9/Ro3KlF1LOsSeegKnnQNrFuRmnQLUFcwU3chC0QOL2xO2irxXS5A6UO14wVaylgEVMLw8MiVaLKSS3IUsZljbwVYj+wG8byg05PjqK0eAUNGcFDcvKGOu2U4wgF0wbfSxiRkWxl3POKQMEIrOS03egyfqVUg3qEuCvqgZGAeogXQgZ530BChbFp4ZBzSbyVKyYR45h2WAFjXWxM4y4LgZBZveMjw4U3Q+gDeqi4mwx5YopBQ1UeUH8JOcU0qcDxM1UgV1xyYyKE1FsJlATkNXUJAPYNm9LCka9QFdAEVzcljH1BoC3rlgDVODRAVmtlNbNhQcas+7KQXUl+YWPusML+/oo8LlAC71pWa2g84TN4CS+trnl/oAJrdt9p4KLwNNv+6HarFY3Buop7s6r2VougIcWXOnV8fDOH7b6rcPT0UmArnWn87Oyc1lSZtJ/oTPYRQebggTy0iY1KJUaVh/2FfgaVKyJO1pi96OX5+9hTk8G4xEtkUf/yDg4duTl6/enb9iu0xXaf7Gg9FgFF8jjA8t6i1XO2/G+4O7uuP9f/cavaGpQDdhaBXKSNYxodWGZye7L9fTTDRMw/lErFYFevrNqfWajz925JjDp5mYo5NYMPNMpuusZzgm5mtack4p6IML9s7iqktkube4mJyTxnFZkg2fld3eFGen5xciE8XmA6A1Fes4XPDHAS5ELi7FpYifEXEo4zs8n6+EQl13WLN8ssvEjB1Dsc3q15HVN384s/5KL7ei3KX7lAr/cmIPKnzHNXtDy+9vxdPNJxU22PbSXMDper3+G9oqqKU=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},g={},f=[{value:"Request",id:"request",level:2}];function j(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Create Folder"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.57dfdd1c.js b/assets/js/28b19cd2.57dfdd1c.js deleted file mode 100644 index d564bd932..000000000 --- a/assets/js/28b19cd2.57dfdd1c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>g,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),o=s(41429),d=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v28gR/yqTfXEc0JLtJH0QiuJSJ7gad6iNsw95sAVhSA6ptZe7vN2lZFbgWz9JP1o/STHLP6Jk2ZcAxb20wCFnLef/zM78djbCY+7E7E58NklVkPZOzCORkkusLL00WszE7ZLgwhJ6gp4KPl1fAipl1g5qU4E3kJMmyzSa1pD20iCu4aFyHkprVjKVOgdPRanQ00KmILXzhCmYDKpSGQwEGERkUtFbqcEvCTJjC6aJ0dGfPoCxEEuNtj4GWpGtwcuCgh2aKGVjktZcHAyZwG2n1rE0sFQyRapqqBylQZuDBDXE1HGnkFlT8GcLUnuyGSYE6OHu3bvPFFc5/Hr57t387dL70s2mUyzLiSlJO5lrhbGbJKaYpkxYptkxG1254P82nL1NHM7JvRaRMCUHURp9mYqZ6AzpfFhLv+yDJ1MRiRItFuTJcgY3QmNBYiZG8RWRkJzBEv1S7KfVxA+U+MsQ/N4QEQlLv1XSUipm3lYUCedrxWKdLErFBPRUKpOSmGWoHBMkSypQzDbC12Wg9FbqXESC04Z+fEJPGKTMRPm3s3iZnC/LWDTNvFVLzv/VpDWLSoz2pD3/iWWpZBKCMn1wbPpmpHNr7p3gyHMw5lFvSusjh8pyZL0kF9g7wq3NaC3WHC5Pxfj8BQHWsBPPPd769ylJTOU1ai+aSFCBUr0aokAwFvBg6IfuF1cSS2kT/JrWB0MQEzFxuTT6d6jPzt/zf+/PRNNEwksfTneLblRNi5subEydGZWS5Sp9TQMb4kini/0AxMYoQv2sKG+X0sFQ13stxpWUyKyG9ZL8kmw4XqP2EKQ7JokJHPcnpm6tnQD3r5QyrJSHFaqKQDq4F1ze92ICl1m4ku0Xwz92TBjRAuoUtIGjoG/hqlAcR9Pud2zS+mjL6QAtdTZLSgcTAvHQBR2spVJsN/ehtgkM8WO1ffX06g4FfDeGF5XzpoCgpmMKPY8Dgr6yBN1lm8AFapA6UVVKXaPlgHOXgs2mL4FFqIymgc2Gc0l2wYXYNNH2gHXtHITqa08sJSRXO1zDEW0Zh7MRKz2V0taLFH13kJiiRF2PDZC5ljpfVFY1zeRZ8W0z881xexamLmMs5H8gYmzOpb6yKdmD93WgDu0/9I2Cbs2F4VNPn7Ee909dFTHZZ6EOA5vndMcFKdaOr1oYxvwBVVKF0dh6BOwR387aVHaY6uMGOmgaDDz7+HJbW4z7WiiPhol3h184cKXRru3656en/L9dVy41uCpJyDnoidvGxNc6Jw+VVSD19qMMToTmgMr1fYpJeuPAcHtbS0dgtKqDlH5aR1CQcw5zHsXfPCVfn2a97O+d4csHef6Pp2R1fs2FU9nXJ9whAR102ptz7CE7+J3SBnAaJkCXlKxSqn6zM+CkVlLTok/I4vz0dHHO+W8i8eFgituMLXFF+sgDpimsZZqTd2EidIOGM9hXFaM9bXrUSwMJKqNzYCDHzUNaYCAROEMN/tcyStYa+73xu1aEjuenr8qtJ63g34vhh9PTRZIMQfx46J6sUMk0vBxuzSPpN3+Au1vnxup9q55NfSpC0XbQWbZE4bvY8XZ83jrpKKms9HWA3k8nWMqT9vvsbs6AtiC/NAziS+OCxYzBZ2K624emm1EjagSLtase0IcbJV59X2App6sz0UT71M5jLnV+8irXfOvGDYe6jeaOM1uEXMqfiEu0i9WYqntmLAl5anB0OIO/bCH9lz4PI+x918PoMVYeoPIz/Dso7jHuAHHHOHY+RqZC7KLP9kGzh6aE2EUJPdMwA7tnzqExd/axYdczE+LUFctVSZqRcii11dmz2feVVGLa8ccAoif/9z//FTj6ygg34Q1cVRZKsyabVSp0m0zRk4wVHXiCO8JCkXOqDg/WPDzHU5lLjwq6sQ8JlhhLJfnuMJlpR+ro+rkJfN0i7CMb3tG0IsVXDpQxj+EZawArb4qgo++8a2MfMzYpAoSY37s8Fx1Rz0J6iTrhJtOWXcSdEjUQP7BLyyMPZcHEjFgpy2QiWTA3CouJhwI15sTKImC7OQpdl3VgTcy7BmdUFRxhjQWRb13k5YCbwGe5otbxACXIo1SUQl6xiAgSkzLoCIXHbugUYgoLDEy8TCgIdR6tB8Xbh3DNWihYKQWl4YYmUTFYGeeWBXmL2oVlRgtjutQM4Sut4ZkVdKRYT+Be3+sbLpbKEReAkvrRze71CdwNZfaVYic9bRcR6/X62ZU/3uX5UfplFfMWxGz58nAYGsSYffhxLCLhyRbuKrshu5JJP8Jf0DkNxNOuzWP7dOmvN5byh30GbrlKJqQdjZrypx+vf4YVvJ+cimjU5L7B4OnPlxdf/n7zheVyU23v39nkdHIaXsjG+QL1SNX+lissgEa7kZ2LPFpS/H9F9geuyLp55OnJT0uFUo/AZztk7/bAvojEbLwVm0diyUN5dic2Gw7Yr/wU4uPfKrI80eeRWKGVGHNHv9uIVDr+Ox2mwYuV8PaX7glxDC8s2A7a3w9ZzRM2rCLaSfRI9d5Kr5k3UT9p2bSW4qI14OSW5WwlPANVDBRajk9JQqV/lXaMYq6vbm5FJPqXdBE2gMLimleGuBYzcS/uRdhghtYbtmR8vhEKdV4FPC9auQwQsOJMjdHFY0AX3R/s2cGY7MKO1hX+lx07yPBnvoc/Uf2Xgbz98iJDF9uemvMzb5rmP/4RMs8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v28gR/yqTfXEc0JLtJH0QiuJSJ7gad6iNsw95sAVhSA6ptZe7vN2lZFbgWz9JP1o/STHLP6Jk2ZcAxb20wCFnLef/zM78djbCY+7E7E58NklVkPZOzCORkkusLL00WszE7ZLgwhJ6gp4KPl1fAipl1g5qU4E3kJMmyzSa1pD20iCu4aFyHkprVjKVOgdPRanQ00KmILXzhCmYDKpSGQwEGERkUtFbqcEvCTJjC6aJ0dGfPoCxEEuNtj4GWpGtwcuCgh2aKGVjktZcHAyZwG2n1rE0sFQyRapqqBylQZuDBDXE1HGnkFlT8GcLUnuyGSYE6OHu3bvPFFc5/Hr57t387dL70s2mUyzLiSlJO5lrhbGbJKaYpkxYptkxG1254P82nL1NHM7JvRaRMCUHURp9mYqZ6AzpfFhLv+yDJ1MRiRItFuTJcgY3QmNBYiZG8RWRkJzBEv1S7KfVxA+U+MsQ/N4QEQlLv1XSUipm3lYUCedrxWKdLErFBPRUKpOSmGWoHBMkSypQzDbC12Wg9FbqXESC04Z+fEJPGKTMRPm3s3iZnC/LWDTNvFVLzv/VpDWLSoz2pD3/iWWpZBKCMn1wbPpmpHNr7p3gyHMw5lFvSusjh8pyZL0kF9g7wq3NaC3WHC5Pxfj8BQHWsBPPPd769ylJTOU1ai+aSFCBUr0aokAwFvBg6IfuF1cSS2kT/JrWB0MQEzFxuTT6d6jPzt/zf+/PRNNEwksfTneLblRNi5subEydGZWS5Sp9TQMb4kini/0AxMYoQv2sKG+X0sFQ13stxpWUyKyG9ZL8kmw4XqP2EKQ7JokJHPcnpm6tnQD3r5QyrJSHFaqKQDq4F1ze92ICl1m4ku0Xwz92TBjRAuoUtIGjoG/hqlAcR9Pud2zS+mjL6QAtdTZLSgcTAvHQBR2spVJsN/ehtgkM8WO1ffX06g4FfDeGF5XzpoCgpmMKPY8Dgr6yBN1lm8AFapA6UVVKXaPlgHOXgs2mL4FFqIymgc2Gc0l2wYXYNNH2gHXtHITqa08sJSRXO1zDEW0Zh7MRKz2V0taLFH13kJiiRF2PDZC5ljpfVFY1zeRZ8W0z881xexamLmMs5H8gYmzOpb6yKdmD93WgDu0/9I2Cbs2F4VNPn7Ee909dFTHZZ6EOA5vndMcFKdaOr1oYxvwBVVKF0dh6BOwR387aVHaY6uMGOmgaDDz7+HJbW4z7WiiPhol3h184cKXRru3656en/L9dVy41uCpJyDnoidvGxNc6Jw+VVSD19qMMToTmgMr1fYpJeuPAcHtbS0dgtKqDlH5aR1CQcw5zHsXfPCVfn2a97O+d4csHef6Pp2R1fs2FU9nXJ9whAR102ptz7CE7+J3SBnAaJkCXlKxSqn6zM+CkVlLTok/I4vz0dHHO+W8i8eFgituMLXFF+sgDpimsZZqTd2EidIOGM9hXFaM9bXrUSwMJKqNzYCDHzUNaYCAROEMN/tcyStYa+73xu1aEjuenr8qtJ63g34vhh9PTRZIMQfx46J6sUMk0vBxuzSPpN3+Au1vnxup9q55NfSpC0XbQWbZE4bvY8XZ83jrpKKms9HWA3k8nWMqT9vvsbs6AtiC/NAziS+OCxYzBZ2K624emm1EjagSLtase0IcbJV59X2App6sz0UT71M5jLnV+8irXfOvGDYe6jeaOM1uEXMqfiEu0i9WYqntmLAl5anB0OIO/bCH9lz4PI+x918PoMVYeoPIz/Dso7jHuAHHHOHY+RqZC7KLP9kGzh6aE2EUJPdMwA7tnzqExd/axYdczE+LUFctVSZqRcii11dmz2feVVGLa8ccAoif/9z//FTj6ygg34Q1cVRZKsyabVSp0m0zRk4wVHXiCO8JCkXOqDg/WPDzHU5lLjwq6sQ8JlhhLJfnuMJlpR+ro+rkJfN0i7CMb3tG0IsVXDpQxj+EZawArb4qgo++8a2MfMzYpAoSY37s8Fx1Rz0J6iTrhJtOWXcSdEjUQP7BLyyMPZcHEjFgpy2QiWTA3CouJhwI15sTKImC7OQpdl3VgTcy7BmdUFRxhjQWRb13k5YCbwGe5otbxACXIo1SUQl6xiAgSkzLoCIXHbugUYgoLDEy8TCgIdR6tB8Xbh3DNWihYKQWl4YYmUTFYGeeWBXmL2oVlRgtjutQM4Sut4ZkVdKRYT+Be3+sbLpbKEReAkvrRze71CdwNZfaVYic9bRcR6/X62ZU/3uX5UfplFfMWxGz58nAYGsSYffhxLCLhyRbuKrshu5JJP8Jf0DkNxNOuzWP7dOmvN5byh30GbrlKJqQdjZrypx+vf4YVvJ+cimjU5L7B4OnPlxdf/n7zheVyU23v39nkdHIaXsjG+QL1SNX+lissgEa7kZ2LPFpS/H9F9geuyLp55OnJT0uFUo/AZztk7/bAvojEbLwVm0diyUN5dic2Gw7Yr/wU4uPfKrI80eeRWKGVGHNHv9uIVDr+Ox2mwYuV8PaX7glxDC8s2A7a3w9ZzRM2rCLaSfRI9d5Kr5k3UT9p2bSW4qI14OSW5WwlPANVDBRajk9JQqV/lXaMYq6vbm5FJPqXdBE2gMLimleGuBYzcS/uRdhghtYbtmR8vhEKdV4FPC9auQwQsOJMjdHFY0AX3R/s2cGY7MKO1hX+lx07yPBnvoc/Uf2Xgbz98iJDF9uemvMzb5rmP/4RMs8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(a.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.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:!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",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(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}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.dcf7a360.js b/assets/js/28b19cd2.dcf7a360.js new file mode 100644 index 000000000..eea7dab14 --- /dev/null +++ b/assets/js/28b19cd2.dcf7a360.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>j});var i=a(85893),l=a(11151),t=a(58219),r=(a(62316),a(51039)),n=a.n(r),o=(a(82723),a(9487)),m=a(41429),c=a(5397),d=a(4667),p=a(9472),u=a(85162);const h={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9vGzcS/yoTvjgONpLtJPcgHIrmnKBntDgbtYs82IIwuzuSaHNJluRK3hP2rZ+kH+0+yWG4f7SSZTcBir7cAUVqcef/DGd+nI0IuPBicis+mawsSAcvponIyWdO2iCNFhNxsyQ4d4SBoKOCj1cXgEqZtYfKlBAMLEiTYxpNa8g7aZBWcF/6ANaZlcylXkCgwioMNJM5SO0DYQ5mDqVVBiMBRhFzqei11BCWBHPjCqZJ0dPf3oNxkEqNrjoGWpGrIMiCoh2aKGdjssZc7A0ZwU2r1rM0cGSZIlcVlJ7yqM1DhhpSarlzmDtT8GcHUgdyc8wIMMDtmzefKC0X8MvFmzfT18sQrJ+Mx2jtyFjSXi60wtSPMlOMcya0+fyYjS599H8bzs4mDufoTotEGMtBlEZf5GIiWkNaH9YyLLvgyVwkwqLDggI5zuBGaCxITMQgviIRkjNoMSzFflpNek9ZuIjB7wwRiXD0aykd5WISXEmJ8KFSLNbLwiomoEerTE5iMkflmSBbUoFishGhspEyOKkXIhGcNgzDE3rEKGUi7D9P02V2trSpqOtpo5Z8+IfJKxaVGR1IB/4TrVUyi0EZ33s2fTPQuTX3VnDkORjTpDOl8ZFD5TiyQZKP7C3h1mZ0DisOV6BieP6MAGfYiaceb/37mGWmDBp1EHUiqECpXgxRJBgKuDf0ffuLK4mlNAl+Seu9IUiJmNgujf4D6tOzd/zfu1NR14kIMsTT3aIbVNPsug0bU8+Nyslxlb6kgQ3xpPPZfgBSYxShflKUN0vpoa/rvRbjLWVyXsF6SWFJLh6vUQeI0j2TpASe+xNTN9aOgPtXTnMsVYAVqpJAergTXN53YgQX83glmy+Gf+yYMKAF1DloA0dR38yXsTiOxu3v1OTV0ZbTAzpqbZaU9yZE4r4LelhLpdhu7kNNE+jjx2q76unUHQr4bgzPSx9MAVFNyxR7HgcEQ+kI2ss2gnPUIHWmypzaRssB5y4Fm01XArNYGXUNmw3nktyMC7Guk+0B69o5iNXXnDjKSK52uPoj2jL2ZwNWerTSVbMcQ3uQmcKiroYGyIWWejErnarr0ZPi22bmq+P2JExtxljI/0DE2JwLfelycgfva08d23/sGwXdmHPDp4E+YTXsn7osUnJPQh0HNs/plgtyrDxftTiM+QOqrIyjsfEI2CO+nZUpXT/Vhw2019QbePrh+bY2G/a1WB41E+8Ov3jgrdG+6fpnJyf8v11XLjT4MsvIe+iIm8bE13pBAUqnQOrtRxmdiM0Ble/6FJN0xoHh9raWnsBoVUUp3bROoCDvPS54FH/1lHx5mnWyv3WGL+/l2b8fs9XZFRdO6V6ecIcEtNBpb86xh+zgN0rrwWmcAG1S5qVS1audASe1kppmXUJmZycnszPOf52I9wdT3GRsiSvSRwEwz2Et8wUFHydCO2g4g11VMdrTpkO91JOgMnoBDOS4eUgHDCQiZ6zBPy2j5Jxx3xq/K0XoeX6G0m49aQT/UQzfn5zMsqwP4odD92SFSubx5XBjHki/+gvc3To3VB8a9WzqYxGLtoXOsiGK38WOt8PzxklPWelkqCL0fnyLVr5tvk9upwxoCwpLwyDeGh8tZgw+EePdPjTeDBpRLVisW3WAPt4o8eL7Aq0cr05FnexTe9R5ah6f55huXbjmMDeR3HFki46t/JG4PNs4DanaJ8aSkCcGR4az9/MWzn/ucjDA3bcdhB7i5B4mP8G+veIO3/bwdohhp0NUKsQu8mweM3tISohdhNAx9fOvfeIcGnGnH2p2fW5inNpCubSkGSXHMludPpl7X0hlphl9DB468v/89nvk6Koi3oJXcFk6sGZNbl6q2Gnmih5lqujA89sTFoq8V1V8rC7iUzyXCxlQQTvyIUOLqVSS7w2TmWacDq6eH8GXLbo+cvENTStSfN1AGfMQn7AGsAymiDq6rrs27mHOJiWAkPJbl2eiJ+pYSC9RZ9xgmrJLuEuiBuLHtXU87lAWTMxoleZzmUkWzE3CYRagQI0LYmUJsN0chbbDenAm5T2DN6qMjrDGgig0LvJiwI/gk1xR43iEERRQKsphUbKIBDKTM+CIhcdu6BxSissLzILMKAr1AV0AxZsHXHQPeh4zYA03M4mKgcowtywoONQ+LjIaCNOmpg+fdYbnVdSRYzWCO32nr7lYSk9cAErqBz+502/hti+zL5R6GWi7hFiv10+u/PEuzw8yLMuUNyBmy7eIh7FBDNn7H8ciEYFc4S/n1+RWMuvG9zM6x5F43LZ4bJ4t3fVGK7/fZ+B2q2RG2tOgIX/84eonWMG70YlIBg3uKwwe/3Rx/vlf159ZLjfU5v6djk5GJ/F1bHwoUA9U7W+44vJnsBfZuciDBcX/12N/4XqsnUeBHsPYKpR6ADybAXu7B/RFIibDjdg0EUseyJNbsdlwwH7hZxAf/1qS42k+TcQKncSUO/rtRuTS8995Pw2erYTXP7fPh2N4Zrl20P5uyGqesHEN0UyiB6r21nn1tE66ScumNRTnjQFvb1jOVsITQMUgoeH4mGVkw4u0QwRzdXl9IxLRvaKLuP0TDte8LsS1mIg7cSfi9jK23rgh4/ONUKgXZcTyopHLAAFLztQQXTxEdNH+wZ4djMku7Ghc4X/ZsYMMf+d7+CNV3/XkzZdnGdrYdtScn2ld1/8F/DAxYw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9vGzcS/yoTvjgONpLtJPcgHIrmnKBntDgbtYs82IIwuzuSaHNJluRK3hP2rZ+kH+0+yWG4f7SSZTcBir7cAUVqcef/DGd+nI0IuPBicis+mawsSAcvponIyWdO2iCNFhNxsyQ4d4SBoKOCj1cXgEqZtYfKlBAMLEiTYxpNa8g7aZBWcF/6ANaZlcylXkCgwioMNJM5SO0DYQ5mDqVVBiMBRhFzqei11BCWBHPjCqZJ0dPf3oNxkEqNrjoGWpGrIMiCoh2aKGdjssZc7A0ZwU2r1rM0cGSZIlcVlJ7yqM1DhhpSarlzmDtT8GcHUgdyc8wIMMDtmzefKC0X8MvFmzfT18sQrJ+Mx2jtyFjSXi60wtSPMlOMcya0+fyYjS599H8bzs4mDufoTotEGMtBlEZf5GIiWkNaH9YyLLvgyVwkwqLDggI5zuBGaCxITMQgviIRkjNoMSzFflpNek9ZuIjB7wwRiXD0aykd5WISXEmJ8KFSLNbLwiomoEerTE5iMkflmSBbUoFishGhspEyOKkXIhGcNgzDE3rEKGUi7D9P02V2trSpqOtpo5Z8+IfJKxaVGR1IB/4TrVUyi0EZ33s2fTPQuTX3VnDkORjTpDOl8ZFD5TiyQZKP7C3h1mZ0DisOV6BieP6MAGfYiaceb/37mGWmDBp1EHUiqECpXgxRJBgKuDf0ffuLK4mlNAl+Seu9IUiJmNgujf4D6tOzd/zfu1NR14kIMsTT3aIbVNPsug0bU8+Nyslxlb6kgQ3xpPPZfgBSYxShflKUN0vpoa/rvRbjLWVyXsF6SWFJLh6vUQeI0j2TpASe+xNTN9aOgPtXTnMsVYAVqpJAergTXN53YgQX83glmy+Gf+yYMKAF1DloA0dR38yXsTiOxu3v1OTV0ZbTAzpqbZaU9yZE4r4LelhLpdhu7kNNE+jjx2q76unUHQr4bgzPSx9MAVFNyxR7HgcEQ+kI2ss2gnPUIHWmypzaRssB5y4Fm01XArNYGXUNmw3nktyMC7Guk+0B69o5iNXXnDjKSK52uPoj2jL2ZwNWerTSVbMcQ3uQmcKiroYGyIWWejErnarr0ZPi22bmq+P2JExtxljI/0DE2JwLfelycgfva08d23/sGwXdmHPDp4E+YTXsn7osUnJPQh0HNs/plgtyrDxftTiM+QOqrIyjsfEI2CO+nZUpXT/Vhw2019QbePrh+bY2G/a1WB41E+8Ov3jgrdG+6fpnJyf8v11XLjT4MsvIe+iIm8bE13pBAUqnQOrtRxmdiM0Ble/6FJN0xoHh9raWnsBoVUUp3bROoCDvPS54FH/1lHx5mnWyv3WGL+/l2b8fs9XZFRdO6V6ecIcEtNBpb86xh+zgN0rrwWmcAG1S5qVS1audASe1kppmXUJmZycnszPOf52I9wdT3GRsiSvSRwEwz2Et8wUFHydCO2g4g11VMdrTpkO91JOgMnoBDOS4eUgHDCQiZ6zBPy2j5Jxx3xq/K0XoeX6G0m49aQT/UQzfn5zMsqwP4odD92SFSubx5XBjHki/+gvc3To3VB8a9WzqYxGLtoXOsiGK38WOt8PzxklPWelkqCL0fnyLVr5tvk9upwxoCwpLwyDeGh8tZgw+EePdPjTeDBpRLVisW3WAPt4o8eL7Aq0cr05FnexTe9R5ah6f55huXbjmMDeR3HFki46t/JG4PNs4DanaJ8aSkCcGR4az9/MWzn/ucjDA3bcdhB7i5B4mP8G+veIO3/bwdohhp0NUKsQu8mweM3tISohdhNAx9fOvfeIcGnGnH2p2fW5inNpCubSkGSXHMludPpl7X0hlphl9DB468v/89nvk6Koi3oJXcFk6sGZNbl6q2Gnmih5lqujA89sTFoq8V1V8rC7iUzyXCxlQQTvyIUOLqVSS7w2TmWacDq6eH8GXLbo+cvENTStSfN1AGfMQn7AGsAymiDq6rrs27mHOJiWAkPJbl2eiJ+pYSC9RZ9xgmrJLuEuiBuLHtXU87lAWTMxoleZzmUkWzE3CYRagQI0LYmUJsN0chbbDenAm5T2DN6qMjrDGgig0LvJiwI/gk1xR43iEERRQKsphUbKIBDKTM+CIhcdu6BxSissLzILMKAr1AV0AxZsHXHQPeh4zYA03M4mKgcowtywoONQ+LjIaCNOmpg+fdYbnVdSRYzWCO32nr7lYSk9cAErqBz+502/hti+zL5R6GWi7hFiv10+u/PEuzw8yLMuUNyBmy7eIh7FBDNn7H8ciEYFc4S/n1+RWMuvG9zM6x5F43LZ4bJ4t3fVGK7/fZ+B2q2RG2tOgIX/84eonWMG70YlIBg3uKwwe/3Rx/vlf159ZLjfU5v6djk5GJ/F1bHwoUA9U7W+44vJnsBfZuciDBcX/12N/4XqsnUeBHsPYKpR6ADybAXu7B/RFIibDjdg0EUseyJNbsdlwwH7hZxAf/1qS42k+TcQKncSUO/rtRuTS8995Pw2erYTXP7fPh2N4Zrl20P5uyGqesHEN0UyiB6r21nn1tE66ScumNRTnjQFvb1jOVsITQMUgoeH4mGVkw4u0QwRzdXl9IxLRvaKLuP0TDte8LsS1mIg7cSfi9jK23rgh4/ONUKgXZcTyopHLAAFLztQQXTxEdNH+wZ4djMku7Ghc4X/ZsYMMf+d7+CNV3/XkzZdnGdrYdtScn2ld1/8F/DAxYw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document",permalink:"/docs/API-docs/createdocument"},next:{title:"Get Document",permalink:"/docs/API-docs/getdocument"}},g={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={a:"a",h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsxs)(s.p,{children:["The Create Document API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at ",(0,i.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(s.strong,{children:"Debug UI"})})," or using the Create Template API."]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(u.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)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(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)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(d.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)(d.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)(d.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}}.",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.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:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.1cac45ae.js b/assets/js/2c586be5.1cac45ae.js new file mode 100644 index 000000000..ea6d20aba --- /dev/null +++ b/assets/js/2c586be5.1cac45ae.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var i=s(85893),a=s(11151),l=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05CF5buS5XjPL54aNz9hLldYlSmvYecIyNKkWlRVKsjF7lyO80MgtQoSC529OgReFWhioDWoDVsEcJWqCkriALO4H0wYqra5EJuQcMm45LITNYcoNPjkBlKnKMIOZKHA4kRP5U1UonkGjaqiyGQgJqtZwdnDwEqf1HH46PTg4/zK3tjLjw0NeVUNVoTRiLgs+NcNUlYcZAVbZ7CHkqNHtlHIJmeYLWIhsjtYAlxmkqmogVQOlRSa5xQQqPkeQdTlFDWoGNsdyCLwwqt3ErQmoqxm8efl3wvng4GssVG93jWDqqlLaYkYk2BxbjowPDmjNC1WWSkLFNS/REgvVLG4wnsgBHBzYpsLxwQGcykyk3KJx+9BoBzv0oIQ5gb6tMBUzEUDX6JGwyEWaO1IWXFoSWVXwFB2oRlNhasUVrm+8TKChjV+iVBGDXGnxm5KWF46PV6itSHkBqVI6E9Jh6tkHxnJtSfCVEtLG0XAC/DNwtTYeiSyImFDLiCmlkG7GIFzxokYTsFokkBNWP2Kl0Tg1C/va3OGUo5jnO8/j2fva2LWNoTaEZh+LcJbGX2uhMXPsRce2GS8Mgpit8bLkl9g7DZS7P7wYwtcNZDjjdWETEPaBAatrHMIPygKvqkKkfFogzJQG0mNua40DJ+WgDgERyUsn4zfuNqEBDpmYzVDThaRJt0XUwYAdqWJ3/UqlCUcuQcmeoEdDODhoz3YK+ssvv0zk9UQCTBjhMmHjCWtBJiwBP0cqNmHjUQJhYDlhY3h0/DQCNPT95PhZ/F7Q92h0Er9z+j4eTeQqHEqk/qCsI/W5hQK5sQ7d9nQQBqJUHM3I09xNox7C86Logc4EFpm/kakqq7owSjf0JgWJDCfy2FFveVndQjlN//FUx0+vK4YG3ck0FimkQVIYD0szJGsabdGiiVXHwUdEkJDCCl6Y3TRFiPtHVofZBmUnRBmWXBS7yXLT94+mgNYGQY+H3cXeQY/f4r6R439tUPOEqHmvpmCFLW4hqQW5f3T1UNsg7ikRR28Il81u0gLA/SOsRWyDrGdEVsbtLeKi2ftHUMAqToT33M8dnQxGjwfHR8cnPYiZ0iUPAGU5yLJB0zTNhEHHEWgtUNiOjFA0uN45IAd3plW5xZtyzk4HFZwP9zt6IK/I75hGk9w5hyb4bc6eldyuOw1WZbx5YPxWcWnwCjx85/s1PTTdFOHRkA+d5kqkAXmCCYyHKfmuQ2LCgPiYHb56deg5k3SDg7IM7PKyoFH6HjhO9kfLcphlw03YPsP7oyVkWQJbxrdPZBmUZblr3E+Qik/kX0ivLS7tVC13q3YAuH/a3SG2VcGDUYhzuZBhImgHbABonNcF17gkf9kIJR31Nx6DDc2Pis+jKnpn2flcLhTxSMKXr4Ov+zAoJeGzvgGN3L3uBpr9TTTOcen2SGtjVUnIiIzTDgmYOs2BGx+UkqurZNGE2Mck/ivllaCgpUBr3SjadLiOxESOjtw7n2N6eavmRIj7pzo9zOKkj3Fo+mzCSh4ML5th91vZHPWEnbdrDBaYWsx6a2HbYjjvaRnPiNME7GKkDr1cZFjwKRbdXA+5IMYeqTRRCumRiGw4ivu5Wb7cmA2Tqy1K7Ynoa1N8/aJORq5BIUwMftdZ0F8dgkabcwsSMaPnf4oQF/QCjG1K7rnUCyhJlJvxpEG7jhinqMcv3RJTOp7G2xd4fccJBAcOsI3X42G7DggkrEmmzxfaoxRSlHXZS6TEXSPHymAF++yilZRKiif0pXvjBL684wSK8ncfMJEjF/JmWlWZWkh3y2G77xNA7t8172H2e675mlnxcL/nGkWs+tdoi0UhUG9L2itkdt+hIbym95uSAH6RMMDTFCuL2cYDPnLRvOaZUDCtrVVy9xPeh7p/8t3A7k+QMRH8YVLu4/bZJO3THKXPfO7KcZROmvdNtgGt7ReNJUxVlEkXSp5mbMxSl3yP+WOWuCPQ2K9V1rDxNUuVtDQxvmYhn0hLD98bSt9fM5PmWHL6FVGjhD8l3FnCfNbMsIS5qJey/8Q8NmZq+h5TOq3ShI4VaGgPt258HaGM1ULOWRKiKzZmPjvOEoZLXlYEzDZy/VU2Y6t44G1btSPdVsb9aJPptM9ateKTdnvZ22GVMMp0f+JOlLj0tJX4Tr1QNGjxJW9Mb0NvtthmnYXW0M1IwyrIeGPoAtTGOxgpL9K6oMgOl5XQTRtmuvCupx8tou1JLaKjx6tO6B1KXGvesIQJi2V/fIcSaPXxkktREWdcHuxj175XOEX8KgxQlcfJiZcfjcV7hTBFJ6MqV/Kj14+OH42OR49Gx7RDyLV/Oh/97E0M1hXjOcU0mEWnc9CltxNwGeDhXcoZ4R3ZfI53K+O7XeWjXoXD5KouMqphINdDV8X59Frdmn63RmN4hzavEra8m5ilL/P52hR8WeDMQl1VqCFVWqJ+2M/o3Bvijk9OVglr7iav+Z8k7ykJb3E3dT+7ol5X8PwcuD56tkpYfjeu/2jLjp8R2ZMnq866bjgPF1OVNRfx3VrdBRgNBcHNVJGhJofk5nvVPTX0whiU2cXmOz9VqkAutzw0wnRV8NhUQGEqxcAhpbnIkXzaLnp1u3d+ZIiYPbZDeOequP2MlTDkFeoaJ2wIp7OeV+oC3zUUerCuliwVPHDnXZjaPeMPDsM38ehBv4TvCv9tKjei4IDBYlkVrja+EEVBeJNdH0L7z3l+LScJgWgu48F3m4oXPjPmDgyL1gvLEHzHIbzgEoRMizo46TMVU2dwfd2qgdOO1Qqur0mqqC/I6K5WSTdAZ60NOLvqRzSmKK7WVrVD2C1sx3pLvYtzQS6OHwgFjD4CYi6FnF/UulithjfUsJPRB/PtBpuC7GiT/wOOETqn8rXOUG+9uS20ywXd8Xj416ULOYJCU6OJksb7P8dHR/TfuizaJqOwKeV2UzRmVhdF8wVLPjzeud358sPbH7TbvKn8vTj+bZleHb8hntX6o73Z+PjXuhhYNSChDCLrvG/b46yQhZB4Edl2cXx0dDEi3q4SdrKNfW9ViTYnrVwQExdayXkCFfVRIFjdAJ9zIYGeIv0HchO1Vvp22/BxmN3GhJM1Jjy+yYRT6bLKrk/tnbpE+edS2j/e+uMJ1WXpdMXHLUx4IDfP1ojtj3siDaa1FrZh47NrthzwSgz8/PjsfHWeMGKsolxBpYzDmNucjdnhjdSBQX3lQr+za6+67FZXhFfi8GrEVskmtOEyozzxzhXnHdJvibGed2uod1FTJb5DCpsCZ/pQCRMk0Bw5vUrEC5LXj10G5JvI9Zib2JZu6Li7mUDYtARbUgIxI7AW5G+P8UePe9H1WQyUXezbhr7botmW9BiftuFpL+LsBZxnnfa1sV0M7UYuJjo+OXHBw9OR87IfPXMO7MmTldOXzpljbN1hcymrTbeDsXVzGhe1xsIbBJLVTDnBBm6/rlC+FXPpbsLV6KZzj0WqfNqDLGoE/8+//u1WRCm5i/oFvK41VGqBelb71sNZgUtBzXO9ftToOiIvCzSmaEBIi3PXmZqJuasABjtIFUE+FYWgq01gyqdSeq+DGcLPnfP5QPti6BUW9CJAodSlaxtUwGurSndGNF8LpS9nhFICHKbUX4jGgEGMS1DmXKbkv/p7koDSwCWgtKgrLQwCFyUBuya32UykwtlFJa3mqYWSSz5HOixxQQZxoYrdgVpNqcxiVFH75C31KCJaT6LLww7hJTV8OsJdCgktFwVmMK9piwToAkHQUyJDZjAlr6ii40WKpmt7KPAKNZ/HJkoy1lApem8FL8jL7suWNrKaS0NmMqSvgmha9lVakdV3Z2S8GQLVbciEkN9MClAIeelbZc9aNfsZp0ZY7AKsxWJx4416uL7mW2HzegoaK9Wtm7tB96L1l7cfD+kBQF2a17O3qK9EGg37jjMPHfBhsELc+/LxQeCV+GpzAVmEQqQoDfZsxvNv33wPV/BoeMSS3ov8AQgffn/64psf3n5D+5IF8PdvNDwaHrmskDK25LJ31EbL9+bV7aWd9x3i+w7xfYf4vkN83yF+/yqN+w7xfYf4vkN83yG+7xDfd4jvO8T3HeL7DvF9h/i+Q3yLUu87xPcd4vsO8X2HOOw7xPcd4p9ftnd1iIfqH/lJh1XBhez1Ivji79lm3/h5wnKqDo/P2PU1Zah/oi4QGv61Rk2l5fOEXXEtKNnoCstJLLtSvfESqfD3wif9B+/o/MTrmqtgbNTTqWLsVzx3wrkVtl/AfvP67TuWsNi2U6qM1mi+oL53vmBj8kmZ65F3nHXtyNz1ERZczmtXAmV+X6oW89rm66XmS1dqDj96lVQumx6W6zVoTwr9JcK2LvgrVTy+w+ZvLbif2bkg8DZCkwjPV6vVfwFnS3gl",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05CF5buS5XjPL54aNz9hLldYlSmvYecIyNKkWlRVKsjF7lyO80MgtQoSC529OgReFWhioDWoDVsEcJWqCkriALO4H0wYqra5EJuQcMm45LITNYcoNPjkBlKnKMIOZKHA4kRP5U1UonkGjaqiyGQgJqtZwdnDwEqf1HH46PTg4/zK3tjLjw0NeVUNVoTRiLgs+NcNUlYcZAVbZ7CHkqNHtlHIJmeYLWIhsjtYAlxmkqmogVQOlRSa5xQQqPkeQdTlFDWoGNsdyCLwwqt3ErQmoqxm8efl3wvng4GssVG93jWDqqlLaYkYk2BxbjowPDmjNC1WWSkLFNS/REgvVLG4wnsgBHBzYpsLxwQGcykyk3KJx+9BoBzv0oIQ5gb6tMBUzEUDX6JGwyEWaO1IWXFoSWVXwFB2oRlNhasUVrm+8TKChjV+iVBGDXGnxm5KWF46PV6itSHkBqVI6E9Jh6tkHxnJtSfCVEtLG0XAC/DNwtTYeiSyImFDLiCmlkG7GIFzxokYTsFokkBNWP2Kl0Tg1C/va3OGUo5jnO8/j2fva2LWNoTaEZh+LcJbGX2uhMXPsRce2GS8Mgpit8bLkl9g7DZS7P7wYwtcNZDjjdWETEPaBAatrHMIPygKvqkKkfFogzJQG0mNua40DJ+WgDgERyUsn4zfuNqEBDpmYzVDThaRJt0XUwYAdqWJ3/UqlCUcuQcmeoEdDODhoz3YK+ssvv0zk9UQCTBjhMmHjCWtBJiwBP0cqNmHjUQJhYDlhY3h0/DQCNPT95PhZ/F7Q92h0Er9z+j4eTeQqHEqk/qCsI/W5hQK5sQ7d9nQQBqJUHM3I09xNox7C86Logc4EFpm/kakqq7owSjf0JgWJDCfy2FFveVndQjlN//FUx0+vK4YG3ck0FimkQVIYD0szJGsabdGiiVXHwUdEkJDCCl6Y3TRFiPtHVofZBmUnRBmWXBS7yXLT94+mgNYGQY+H3cXeQY/f4r6R439tUPOEqHmvpmCFLW4hqQW5f3T1UNsg7ikRR28Il81u0gLA/SOsRWyDrGdEVsbtLeKi2ftHUMAqToT33M8dnQxGjwfHR8cnPYiZ0iUPAGU5yLJB0zTNhEHHEWgtUNiOjFA0uN45IAd3plW5xZtyzk4HFZwP9zt6IK/I75hGk9w5hyb4bc6eldyuOw1WZbx5YPxWcWnwCjx85/s1PTTdFOHRkA+d5kqkAXmCCYyHKfmuQ2LCgPiYHb56deg5k3SDg7IM7PKyoFH6HjhO9kfLcphlw03YPsP7oyVkWQJbxrdPZBmUZblr3E+Qik/kX0ivLS7tVC13q3YAuH/a3SG2VcGDUYhzuZBhImgHbABonNcF17gkf9kIJR31Nx6DDc2Pis+jKnpn2flcLhTxSMKXr4Ov+zAoJeGzvgGN3L3uBpr9TTTOcen2SGtjVUnIiIzTDgmYOs2BGx+UkqurZNGE2Mck/ivllaCgpUBr3SjadLiOxESOjtw7n2N6eavmRIj7pzo9zOKkj3Fo+mzCSh4ML5th91vZHPWEnbdrDBaYWsx6a2HbYjjvaRnPiNME7GKkDr1cZFjwKRbdXA+5IMYeqTRRCumRiGw4ivu5Wb7cmA2Tqy1K7Ynoa1N8/aJORq5BIUwMftdZ0F8dgkabcwsSMaPnf4oQF/QCjG1K7rnUCyhJlJvxpEG7jhinqMcv3RJTOp7G2xd4fccJBAcOsI3X42G7DggkrEmmzxfaoxRSlHXZS6TEXSPHymAF++yilZRKiif0pXvjBL684wSK8ncfMJEjF/JmWlWZWkh3y2G77xNA7t8172H2e675mlnxcL/nGkWs+tdoi0UhUG9L2itkdt+hIbym95uSAH6RMMDTFCuL2cYDPnLRvOaZUDCtrVVy9xPeh7p/8t3A7k+QMRH8YVLu4/bZJO3THKXPfO7KcZROmvdNtgGt7ReNJUxVlEkXSp5mbMxSl3yP+WOWuCPQ2K9V1rDxNUuVtDQxvmYhn0hLD98bSt9fM5PmWHL6FVGjhD8l3FnCfNbMsIS5qJey/8Q8NmZq+h5TOq3ShI4VaGgPt258HaGM1ULOWRKiKzZmPjvOEoZLXlYEzDZy/VU2Y6t44G1btSPdVsb9aJPptM9ateKTdnvZ22GVMMp0f+JOlLj0tJX4Tr1QNGjxJW9Mb0NvtthmnYXW0M1IwyrIeGPoAtTGOxgpL9K6oMgOl5XQTRtmuvCupx8tou1JLaKjx6tO6B1KXGvesIQJi2V/fIcSaPXxkktREWdcHuxj175XOEX8KgxQlcfJiZcfjcV7hTBFJ6MqV/Kj14+OH42OR49Gx7RDyLV/Oh/97E0M1hXjOcU0mEWnc9CltxNwGeDhXcoZ4R3ZfI53K+O7XeWjXoXD5KouMqphINdDV8X59Frdmn63RmN4hzavEra8m5ilL/P52hR8WeDMQl1VqCFVWqJ+2M/o3Bvijk9OVglr7iav+Z8k7ykJb3E3dT+7ol5X8PwcuD56tkpYfjeu/2jLjp8R2ZMnq866bjgPF1OVNRfx3VrdBRgNBcHNVJGhJofk5nvVPTX0whiU2cXmOz9VqkAutzw0wnRV8NhUQGEqxcAhpbnIkXzaLnp1u3d+ZIiYPbZDeOequP2MlTDkFeoaJ2wIp7OeV+oC3zUUerCuliwVPHDnXZjaPeMPDsM38ehBv4TvCv9tKjei4IDBYlkVrja+EEVBeJNdH0L7z3l+LScJgWgu48F3m4oXPjPmDgyL1gvLEHzHIbzgEoRMizo46TMVU2dwfd2qgdOO1Qqur0mqqC/I6K5WSTdAZ60NOLvqRzSmKK7WVrVD2C1sx3pLvYtzQS6OHwgFjD4CYi6FnF/UulithjfUsJPRB/PtBpuC7GiT/wOOETqn8rXOUG+9uS20ywXd8Xj416ULOYJCU6OJksb7P8dHR/TfuizaJqOwKeV2UzRmVhdF8wVLPjzeud358sPbH7TbvKn8vTj+bZleHb8hntX6o73Z+PjXuhhYNSChDCLrvG/b46yQhZB4Edl2cXx0dDEi3q4SdrKNfW9ViTYnrVwQExdayXkCFfVRIFjdAJ9zIYGeIv0HchO1Vvp22/BxmN3GhJM1Jjy+yYRT6bLKrk/tnbpE+edS2j/e+uMJ1WXpdMXHLUx4IDfP1ojtj3siDaa1FrZh47NrthzwSgz8/PjsfHWeMGKsolxBpYzDmNucjdnhjdSBQX3lQr+za6+67FZXhFfi8GrEVskmtOEyozzxzhXnHdJvibGed2uod1FTJb5DCpsCZ/pQCRMk0Bw5vUrEC5LXj10G5JvI9Zib2JZu6Li7mUDYtARbUgIxI7AW5G+P8UePe9H1WQyUXezbhr7botmW9BiftuFpL+LsBZxnnfa1sV0M7UYuJjo+OXHBw9OR87IfPXMO7MmTldOXzpljbN1hcymrTbeDsXVzGhe1xsIbBJLVTDnBBm6/rlC+FXPpbsLV6KZzj0WqfNqDLGoE/8+//u1WRCm5i/oFvK41VGqBelb71sNZgUtBzXO9ftToOiIvCzSmaEBIi3PXmZqJuasABjtIFUE+FYWgq01gyqdSeq+DGcLPnfP5QPti6BUW9CJAodSlaxtUwGurSndGNF8LpS9nhFICHKbUX4jGgEGMS1DmXKbkv/p7koDSwCWgtKgrLQwCFyUBuya32UykwtlFJa3mqYWSSz5HOixxQQZxoYrdgVpNqcxiVFH75C31KCJaT6LLww7hJTV8OsJdCgktFwVmMK9piwToAkHQUyJDZjAlr6ii40WKpmt7KPAKNZ/HJkoy1lApem8FL8jL7suWNrKaS0NmMqSvgmha9lVakdV3Z2S8GQLVbciEkN9MClAIeelbZc9aNfsZp0ZY7AKsxWJx4416uL7mW2HzegoaK9Wtm7tB96L1l7cfD+kBQF2a17O3qK9EGg37jjMPHfBhsELc+/LxQeCV+GpzAVmEQqQoDfZsxvNv33wPV/BoeMSS3ov8AQgffn/64psf3n5D+5IF8PdvNDwaHrmskDK25LJ31EbL9+bV7aWd9x3i+w7xfYf4vkN83yF+/yqN+w7xfYf4vkN83yG+7xDfd4jvO8T3HeL7DvF9h/i+Q3yLUu87xPcd4vsO8X2HOOw7xPcd4p9ftnd1iIfqH/lJh1XBhez1Ivji79lm3/h5wnKqDo/P2PU1Zah/oi4QGv61Rk2l5fOEXXEtKNnoCstJLLtSvfESqfD3wif9B+/o/MTrmqtgbNTTqWLsVzx3wrkVtl/AfvP67TuWsNi2U6qM1mi+oL53vmBj8kmZ65F3nHXtyNz1ERZczmtXAmV+X6oW89rm66XmS1dqDj96lVQumx6W6zVoTwr9JcK2LvgrVTy+w+ZvLbif2bkg8DZCkwjPV6vVfwFnS3gl",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"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)(n.p,{children:"Create Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,i.jsxs)(n.p,{children:["Upload you pdf in our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.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)(n.p,{children:(0,i.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,i.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.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:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(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)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.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)(n.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@example.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)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.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)(n.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/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/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/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/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/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)(n.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)(n.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}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.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)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c586be5.2035c76c.js b/assets/js/2c586be5.2035c76c.js deleted file mode 100644 index 75c942e6c..000000000 --- a/assets/js/2c586be5.2035c76c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),t=s.n(l),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),h=s(85162);const p={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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nTZra4Ir8Th1Yitkk1oY/lcyPng1lXnHeFvSbhefmvkd5FTJb5DCp2CdPpQCROk1Bw53UwkD9LZj10W5Jso+Zif2JZy6CS8mUTYfA22pAViVmAt0N8e548e9yLssxgsu/i3DX+3RbQt6zFGbUPUXtTZCzrPOgts47sY3o1cXHR8cuICiKcj52k/euac2JMnK2cznUPH2LrT5tJWm64HY+tPalzUPhj+USBdzZRTbJD26wrlWzGX7jRcjW46+Fikyqc+6FWN4P/517/diqgld1i/gNe1hkotUM9q3344K3ApqIGu15Ma3UfkZYHGFA0IaXHuulMzMXdVwPAWUlWQT0Uh6HgTmPLplN4NYYbwc+eAPtC+IHqFBd0KUCh16VoHFfDaqtLtEZ+whdKXMyIpAQ5T6jFEY8AgxiUocy5T8mH9OUlAaeASUFrUlRYGgYuSgF2j22wmUuHeRiWt5qmFkks+R9oscYEGSaGKHYJaTanUYlRR+wQu9SkiWs+iy8UO4SU1fTrGXRoJLRcFZjCvCUUCdIAg2CmxITOYkmdU0fYiRdO1PhR4hdrdC94/qosCKkV3ruAFedp93RIiq7k09FSGFFZQTSu+Sit6+d0eGW+GQLUbekbIdyYDKIS89O2yZ62Z/YxTIyx2QdZisbhxRz1cX/OtsHk9BY2V6tbN3aC70frL24+HdAGgLs3r2VvUVyKNj/uOPQ8d8GF4ibj35+OFwCvx1eYCehUKkaI02Hs3nn/75nu4gkfDI5b0buUPIPjw+9MX3/zw9hvCS6+AP3+j4dHwyGWGlLEll72tNtq+N49uL/W87xLfd4nvu8T3XeL7LvH7V23cd4nvu8T3XeL7LvF9l/i+S3zfJb7vEt93ie+7xPdd4luMet8lvu8S33eJ77vEYd8lvu8S//y6vatLPFT/yE86rAouZK8fwReAzzZ7x88TllOFeHzGrq8pQ/0TdYLQ8K81aiovnyfsimtByUZXXE5i2ZXqjZdIhb8XPuk/eEf7J97WXAVjo6ZOVWO/4rlTzq2w/SL2m9dv37GExdadUmW0RvMF9b7zBRuTT8pcn7yTrGtJ5q6XsOByXrsSKPN4qVrMa5uvl5ovXak5/OhVUrlselSu16A9K/SXGNu64K9U8fgOm7+14H5m54Ig2whNKjxfrVb/BUSDeZE=",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/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:"eJztGttuGzf2V075ksYYyZbjXFZYLJom3a7RpgmaFMXCMlxq5kjDeIackhxLU0Nv+yX7afsli8PLzEiW7CQtGi9WeXA05OHhuZE8t2tm+dyw8Rl7qdK6RGkNO09YhibVorJCSTZm73KEFxq5RYhQ8PzNKfCiUAsDtUFtwCqYo0RNUBIXkEV8MG2g0upKZELOIeOWw0LYHKbc4JMTQJmqDDOYiQKHEzmRP1WF4hk0qoYqm4GQoGoNZwcHL3Faz+Gn04OD8y9zayszPjzkVTVUFUoj5rLgUzNMVXmYEWCVzR5CjhodppRLyDRfwEJkc7QGuMwgVVUDqRooLTLJLSZQ8TmCrMspalAzsDmWQ+CFUS0StyaQrmbw5uXfieaDg6+xUD3sGsHUVaW0xYxYsDm2EhkfHNCaF6oslYSKa16iJRGqWUQwnsgBHBzYpsLxwQGcykyk3KJxeGi0gx16UKKcQN9WmIqZCKBr/EhY5CLNHSsLLi2prCp4ig5Uo6kwteIK1xEvE2gI8UuUKlKQKy1+U9LywsnxCrUVKS8gVUpnQjpKvfjAWK4tKb5SQto4GnaAfwap1sYTkQUVE2kZCaUU0s0YhCte1GgCVYsEcqLqR6w0GmdmAa/NHU05inm+cz+eva+NXUMMtSEy+1SEvTT+WguNmRMvOrHNeGEQxGxNliW/xN5uoNz54cUQvm4gwxmvC5uAsA8MWF3jEH5QFnhVFSLl0wJhpjSQHXNbaxw4LQdzCIRIXjodv3GnCQ1wyMRshpoOJE06FNEGA3Vkit3xK5UmGrkEJXuKHg3h4KDd2xnoL7/8MpHXEwkwYUTLhI0nrAWZsAT8HJnYhI1HCYSB5YSN4dHx0wjQ0PeT42fxe0Hfo9FJ/M7p+3g0kauwKbH6g7KO1ecWCuTGOnLb3UEYiFpxPCNPczeNegjPi6IHOhNYZP5Epqqs6sIo3dCdFDQynMhjx73lZXUL5zT9x3MdP72tGBp0O9NY5JAGyWA8LM2Qrmm0JYsmVp0EHxFDQgoreGF28xQh7h9bHWUbnJ0QZ1hyUexmy03fP54CWRsMPR52B3sHPx7FfWPH/9rg5glx815NwQpb3MJSC3L/+OqRtsHcU2KO7hAum92sBYD7x1hL2AZbz4itjNtb1EWz94+hQFWcCPe5nzs6GYweD46Pjk96EDOlSx4AynKQZYOmaZoJg04i0L5AAR09QvHB9c4BObgzrcot3pRzdjqo4Hy439EDeUV+xzQ+yZ1zaILf5t6zktt1p8GqjDcPjEcVlwavwMN3vl/TI9NNER0N+dBprkQaiCeYIHiYku86JCEMSI7Z4atXh14ySTc4KMsgLq8LGqXvgZNkf7Qsh1k23ITtC7w/WkKWJbBlfPtElkFZlrvG/QSZ+ET+heza4tJO1XK3aQeA+2fdHWFbDTw8CnEuFzJMBOuADQCN87rgGpfkLxuhpOP+xmWwYfnR8Hk0Re8sO5/LhSKeSPjydfB1HwajJHrWEdDI3etukNlHonGOS4cjrY1VJREjMk4YEjB1mgM3PiglV1fJogmxj0n8V8orQUFLgda6UbTpcJ2IiRwduXs+x/TyVsuJEPfPdHqUxUkf49D02YSVPDy8bIbdb2Vz1BN23q4xWGBqMeuthW2L4bxnZTwjSROwi5E68nKRYcGnWHRzPeKCGnus0kQppCciiuEo4nOzfLkxGyZXW4zaM9G3pnj7RZuMUoNCmBj8rougvzoEjTbnFiRiRtf/FCEu6AUY24zcS6kXUJIqN+NJg3adME5Rj1+6JaZ0Mo2nL8j6jh0IDhxgG6/HzXZtEFhY00xfLoSjFFKUddlLpESsUWJleAX74qKVlEqKO/S1e2MHvrxjB4ryd28wkSMX8mZaVZlaSHfKYbvvE0Du3zHvUfZ7jvnas+Lhfs8xilT1j9GWF4VA/VvSHiGz+wwN4TXd35QE8IuEAZ6mWFnMNi7wkYvmNc+EgmltrZK7r/A+1P3T7wZ1f4KOieEP03Kfts+maZ/mKH3mc1eOo3TavG+6DWRtP2gsYaqiTLpQ8jRjY5a65HvMH7PEbYHGfq2yho2vWaqkpYnxNQv5RFp6+N5Q+v6amTTHktOvSBol/CnhzhLms2aGJcxFvZT9J+GxMVPT95jSbpUmcqxAQzjcuvF1hDJWCzlnSYiu2Jj57DhLGC55WREw28j1V9mMreKGt6FqRzpUxv1ok+mEZ61a8UnYXvYwrBJGme5PxESJS89bie/UC0WDFl/yxvQQ+meLbdZZaA2djDSsgow3hg5AbbyDkfIirQuK7HBZCd20YaYL73r20RLa7tQSOnq86pTekcS15g1LmLBY9sd3GIFWH6+5FBVJxuXBPnbte4VTxK/CAFV5nJ54+dFUvFcIU3Q6qnIlP3r96PjR6Hj0aHRMGEKu/dPl6GdvUrBuGM8ppsEsOp2DLr2dgMsAD+8yzgjv2OZzvNsY3+0qH/UqHCZXdZFRDQO5HroqzqfX6tbsu300hndY8yphy7uZWfoyn69NwZcFzizUVYUaUqUl6of9jM69Ye745GSVsOZu9pr/SfaekvIWd3P3syvqdQXPz0Hro2erhOV30/qPtuz4GYk9ebLqXtcN5+FiqrLmIt5bq7sA40NBcDNVZKjJIbl5X3VXDd0wBmV2sXnPT5UqkMstF40wXRU8NhVQmEoxcEhpLnIkn7aLXh32zo8MEbOndgjvXBW3n7EShrxCXeOEDeF01vNKXeC7RkIP1tWSpYIHbr8LU7tr/MFh+CYZPeiX8F3hv03lRhIcMFgsq8LVxheiKIhueteH0P5znl8rSSIgPpdx47ufihc+M+Y2DIvWC8sQfMchvOAShEyLOjjpMxVTZ3B93ZqBs47VCq6vSauoL+jRXa2SboD2Whtw76of0ZiiuFpb1Q5ht7Ad6y31Ls4FuTh+IBQw+gSIuRRyflHrYrUa3jDDTkcfLLcbYgq6IyT/BxIjck7la52h3npyW2iXC7rj8vC3SxdyBIOmRhMljfd/jo+O6L91XbRNRgEp5XZTNGZWF0XzBUs+PN653fnyw9svtNu8qfy9OP5tmV4dvyGZ1fqjvdl4+de6GFg1IKUMoui8b9uTrJCFkHgRxXZxfHR0MSLZrhJ2sk18b1WJNierXJAQF1rJeQIV9VEgWN0An3Mhga4i/QdKE7VW+va34eMou00IJ2tCeHxTCKfSZZVdn9o7dYnyz+W0v7312xOpy9LZio9bmPBAbp6tMdsf90waTGstbMPGZ9dsOeCVGPj58dn56jxhJFhFuYJKGUcxtzkbs8MbqQOD+sqFfmfX3nTZra4Ir8Th1Yitkk1oY/lcyPng1lXnHeFvSbhefmvkd5FTJb5DCp2CdPpQCROk1Bw53UwkD9LZj10W5Jso+Zif2JZy6CS8mUTYfA22pAViVmAt0N8e548e9yLssxgsu/i3DX+3RbQt6zFGbUPUXtTZCzrPOgts47sY3o1cXHR8cuICiKcj52k/euac2JMnK2cznUPH2LrT5tJWm64HY+tPalzUPhj+USBdzZRTbJD26wrlWzGX7jRcjW46+Fikyqc+6FWN4P/517/diqgld1i/gNe1hkotUM9q3344K3ApqIGu15Ma3UfkZYHGFA0IaXHuulMzMXdVwPAWUlWQT0Uh6HgTmPLplN4NYYbwc+eAPtC+IHqFBd0KUCh16VoHFfDaqtLtEZ+whdKXMyIpAQ5T6jFEY8AgxiUocy5T8mH9OUlAaeASUFrUlRYGgYuSgF2j22wmUuHeRiWt5qmFkks+R9oscYEGSaGKHYJaTanUYlRR+wQu9SkiWs+iy8UO4SU1fTrGXRoJLRcFZjCvCUUCdIAg2CmxITOYkmdU0fYiRdO1PhR4hdrdC94/qosCKkV3ruAFedp93RIiq7k09FSGFFZQTSu+Sit6+d0eGW+GQLUbekbIdyYDKIS89O2yZ62Z/YxTIyx2QdZisbhxRz1cX/OtsHk9BY2V6tbN3aC70frL24+HdAGgLs3r2VvUVyKNj/uOPQ8d8GF4ibj35+OFwCvx1eYCehUKkaI02Hs3nn/75nu4gkfDI5b0buUPIPjw+9MX3/zw9hvCS6+AP3+j4dHwyGWGlLEll72tNtq+N49uL/W87xLfd4nvu8T3XeL7LvH7V23cd4nvu8T3XeL7LvF9l/i+S3zfJb7vEt93ie+7xPdd4luMet8lvu8S33eJ77vEYd8lvu8S//y6vatLPFT/yE86rAouZK8fwReAzzZ7x88TllOFeHzGrq8pQ/0TdYLQ8K81aiovnyfsimtByUZXXE5i2ZXqjZdIhb8XPuk/eEf7J97WXAVjo6ZOVWO/4rlTzq2w/SL2m9dv37GExdadUmW0RvMF9b7zBRuTT8pcn7yTrGtJ5q6XsOByXrsSKPN4qVrMa5uvl5ovXak5/OhVUrlselSu16A9K/SXGNu64K9U8fgOm7+14H5m54Ig2whNKjxfrVb/BUSDeZE=",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"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Create Document"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/createdocument"}),"\n",(0,a.jsx)(n.p,{children:"The Create Document API allows users to generate new documents by providing data with base64 encoded file."}),"\n",(0,a.jsxs)(n.p,{children:["Upload you pdf in our ",(0,a.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.jsx)(n.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,a.jsx)(n.p,{children:(0,a.jsx)(n.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(n.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Note:"})," At least one signature is required for each signer. All signature fields are compulsory by default."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"2",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"4",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"5",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"6",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"7",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ol,{start:"8",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"9",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"10",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"11",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"12",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"13",children:["\n",(0,a.jsx)(n.li,{children:(0,a.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(n.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,a.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(n.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(n.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(n.p,{children:"Array ["})})}),(0,a.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,a.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/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(n.p,{children:"]"})})})]})]})}),(0,a.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,a.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,a.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,a.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}}.",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(r.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Document created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-sign-document.com"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.907e2796.js b/assets/js/377084eb.353c0b5e.js similarity index 62% rename from assets/js/377084eb.907e2796.js rename to assets/js/377084eb.353c0b5e.js index fb7c25594..534712c4e 100644 --- a/assets/js/377084eb.907e2796.js +++ b/assets/js/377084eb.353c0b5e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),c=s(41429),p=s(5397),o=s(4667),d=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWN1u28YSfpXp3rQBaP04itMKRVHjNMgxWjRB7SJAHcFYkiNy4+XudncoWRB41yfpo/VJilmSMmU5dowWAXpjS8v5Zr4Zzt9qK0gWQcwvxQVWTkvCIBaJyDFkXjlS1oi5uCgRXiNBLwKnb89Aam3XATa2BrLgkbzCFUKOJJUOIFNbE0gIDjO1VBlQBx7t1AQI6FcIMkCqa3ReGQqwtB4yj5KUKSC3WV0hH68VleA85rhUBnMI5OuMao9hJBJhHXrJbM9yMRcFUm9DJMJJLysk9OzmVhhZoZiLns6VykUiFLvpJJXiru9nP4Bd7sgDlZLAIOaBvU4RlkhZiazD4++18piLOfkaExFoo9lSUJXTTARvnLY5ivlS6sACWYmVFPOtoI2LkuSVKUQiltZXktoTU4imWbD64KwJGBhwPJnwv32qoc4yDGFZa9jFQyQis4bQEMtL57TK4oPxh8Cg7SELm37AjDhwntWQak22xxzfh/m2J3gjo9dzcTP9f2qqcPy2EE0iSBGfHqq4BYT4YRdyRhlLj4B2LyiKNkxJ5+g/l1ttUj1EsOUDUbC5DcRtHnaEmbp6LEQlkQvz8bgH1wH9KLMVo+3a7Pn9ULBindmeVSKCKkyskx1aei83XCCEVXg8mt4+Rj1D+2kB+2ARUoy0sJJKPyqdIn7fHfSxcKU1j5iZvTg5nj7/+uWU5dcqL5D+gf/t00N7+4V6yq0Tc1hJXWOAI+C4S25mCQSSlRs9knw7eSZ9MzBo6ipFP0TvTnbo49msScTmiaiXU47PE0HPv24SUT4RNDvhNycLfCJuem9ZnbcpfdW/2uYhqViZAU1+Zt74/faRWqtRmqHB2MabRMQqwvyUHs6048nx86Pp5Gjy8mJ6Mp99M39xMppMJr+JRNxUMb270ZR3Xa9n2X+vXf4Z7DR3xYaN+G7gOJxNImb3jaNzWyGVPMXXaAjW3poiAadRBgTyG5CFVAZYjf/i35tT6L19pP89jdkwYZTRyuBVP4uvZpPJ1XQXhNlhEC4GcwmWtjb553X1PvsPOzS7Otk59OLQoTOzklrlcQW8sNdoPq8/Q/PUmj/MWNUKxediz9nheetkwKz2ijZxN7w5kk4dtc/nlwteuzhTbLdUxmWSSjEXu8k73g4WyUawPr/qV83a68Gwls6NrEPDzVvLNPCQGkunxiuePXelA8lCmeLoQdTilv85x7gN454Xt5PMqR+RR1kXpKFUtwCXKOMK0vD3pY3gLnRvHBpukjHwq+nBSHuHOrMV8lJMJUIv/tcff0ZEv8fHvPgC3tQenF2j511VmhyWGm9Uqu+7WQSUlcYQ9AaUISw8Z3OuCkVSx8HJdZxJJ1OlFWcSi1lGexgkYxjBuxKpRM+PvvQIEnJcoeYEBG3tNeshC7ImW0UbHWdYW3+9ZEoJSEjroAwGvrtgD0FTSpMh9O8iAetBGkBD6J1XAUGqioX5coPLpcoUK+ay8TIjqKSRBbKxBJg3R8F5u1I5BvA2rQNBsLqOjrDFCpFaF+NdZAQ/qBW2jvNhewnDHIqaVSSQ2RyhqyJ2w+SQYiBwbF5lGJUGkp5A4wp9zL34Jpe11uAsl7eSmu9Cw3fLishLE3gut4T6V7MLn/OWryXRRi43I3hv3htuwVAH5ATQylyH+XtzBJe7NHuHaVCEi6/6eliv1wd18Gwf81pRWafg0dlbXBEPY9UM4bsvz0QiCH0V3izP0a9U1u/XH7E5jsLjrunJLDa9bkHlGvv+LoAbkFYZmoCDFnX6+u1PsILno4lIBpX/CYTHP53979XP569YL3eatv6mo8loEldeG6iSZmBqeHO/W7fb29b9H7jld52M8IbGTksVm3sM3rZrzJe3m0ki5sM7/iIRpQ3EItttKgP+6nXT8PHvNXpu/4tErKRXMuWGd7kVuQr8Od/d1z8aua9+6a7+z+DTfy6415m+Vxtu1PF6IOZCJOIaN3d+s2gWvFq3DZvZthKnWYaOBtiDcbw3016/uhCJkDWV+4PiOg6K7gNrv5fX/gRpCfBfHmb3Ar7ljPoRN9/txNsnHwV0/vXSHKNF0zR/AzR9d9g=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWN1u28YSfpXp3rQBaP04itMKRVHjNMgxWjRB7SJAHcFYkiNy4+XudncoWRB41yfpo/VJilmSMmU5dowWAXpjS8v5Zr4Zzt9qK0gWQcwvxQVWTkvCIBaJyDFkXjlS1oi5uCgRXiNBLwKnb89Aam3XATa2BrLgkbzCFUKOJJUOIFNbE0gIDjO1VBlQBx7t1AQI6FcIMkCqa3ReGQqwtB4yj5KUKSC3WV0hH68VleA85rhUBnMI5OuMao9hJBJhHXrJbM9yMRcFUm9DJMJJLysk9OzmVhhZoZiLns6VykUiFLvpJJXiru9nP4Bd7sgDlZLAIOaBvU4RlkhZiazD4++18piLOfkaExFoo9lSUJXTTARvnLY5ivlS6sACWYmVFPOtoI2LkuSVKUQiltZXktoTU4imWbD64KwJGBhwPJnwv32qoc4yDGFZa9jFQyQis4bQEMtL57TK4oPxh8Cg7SELm37AjDhwntWQak22xxzfh/m2J3gjo9dzcTP9f2qqcPy2EE0iSBGfHqq4BYT4YRdyRhlLj4B2LyiKNkxJ5+g/l1ttUj1EsOUDUbC5DcRtHnaEmbp6LEQlkQvz8bgH1wH9KLMVo+3a7Pn9ULBindmeVSKCKkyskx1aei83XCCEVXg8mt4+Rj1D+2kB+2ARUoy0sJJKPyqdIn7fHfSxcKU1j5iZvTg5nj7/+uWU5dcqL5D+gf/t00N7+4V6yq0Tc1hJXWOAI+C4S25mCQSSlRs9knw7eSZ9MzBo6ipFP0TvTnbo49msScTmiaiXU47PE0HPv24SUT4RNDvhNycLfCJuem9ZnbcpfdW/2uYhqViZAU1+Zt74/faRWqtRmqHB2MabRMQqwvyUHs6048nx86Pp5Gjy8mJ6Mp99M39xMppMJr+JRNxUMb270ZR3Xa9n2X+vXf4Z7DR3xYaN+G7gOJxNImb3jaNzWyGVPMXXaAjW3poiAadRBgTyG5CFVAZYjf/i35tT6L19pP89jdkwYZTRyuBVP4uvZpPJ1XQXhNlhEC4GcwmWtjb553X1PvsPOzS7Otk59OLQoTOzklrlcQW8sNdoPq8/Q/PUmj/MWNUKxediz9nheetkwKz2ijZxN7w5kk4dtc/nlwteuzhTbLdUxmWSSjEXu8k73g4WyUawPr/qV83a68Gwls6NrEPDzVvLNPCQGkunxiuePXelA8lCmeLoQdTilv85x7gN454Xt5PMqR+RR1kXpKFUtwCXKOMK0vD3pY3gLnRvHBpukjHwq+nBSHuHOrMV8lJMJUIv/tcff0ZEv8fHvPgC3tQenF2j511VmhyWGm9Uqu+7WQSUlcYQ9AaUISw8Z3OuCkVSx8HJdZxJJ1OlFWcSi1lGexgkYxjBuxKpRM+PvvQIEnJcoeYEBG3tNeshC7ImW0UbHWdYW3+9ZEoJSEjroAwGvrtgD0FTSpMh9O8iAetBGkBD6J1XAUGqioX5coPLpcoUK+ay8TIjqKSRBbKxBJg3R8F5u1I5BvA2rQNBsLqOjrDFCpFaF+NdZAQ/qBW2jvNhewnDHIqaVSSQ2RyhqyJ2w+SQYiBwbF5lGJUGkp5A4wp9zL34Jpe11uAsl7eSmu9Cw3fLishLE3gut4T6V7MLn/OWryXRRi43I3hv3htuwVAH5ATQylyH+XtzBJe7NHuHaVCEi6/6eliv1wd18Gwf81pRWafg0dlbXBEPY9UM4bsvz0QiCH0V3izP0a9U1u/XH7E5jsLjrunJLDa9bkHlGvv+LoAbkFYZmoCDFnX6+u1PsILno4lIBpX/CYTHP53979XP569YL3eatv6mo8loEldeG6iSZmBqeHO/W7fb29b9H7jld52M8IbGTksVm3sM3rZrzJe3m0ki5sM7/iIRpQ3EItttKgP+6nXT8PHvNXpu/4tErKRXMuWGd7kVuQr8Od/d1z8aua9+6a7+z+DTfy6415m+Vxtu1PF6IOZCJOIaN3d+s2gWvFq3DZvZthKnWYaOBtiDcbw3016/uhCJkDWV+4PiOg6K7gNrv5fX/gRpCfBfHmb3Ar7ljPoRN9/txNsnHwV0/vXSHKNF0zR/AzR9d9g=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),m=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),d=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWNtuG0cS/ZVKv2wMjHiRaTlLBEGEjeEVEsRGpIWByITQM1PktNXT3emu4QXEvO2X7KflSxbVc9FQlCULWRjYF4nsqVN1qqZuzb0guQpifi2usHRaEgaxSESOIfPKkbJGzMVVgfAWCToROH9/AVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqFcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS2Z7kYu5WCF1NkQinPSyRELPbu6FkSWKuejo3KhcJEKxm05SIe77fvET2GVPHqiQBAYxD+x1irBEygpkHR7/qJTHXMzJV5iIQDvNloIqnWYiuHXa5ijmS6kDC2QFllLM94J2LkqSV2YlErG0vpTUnJiVqOsFqw/OmoCBAaeTCf87pBqqLMMQlpWGPh4iEZk1hIZYXjqnVRYfjD8FBu2PWdj0E2bEgfOshlRjsjnm+D7OtznBrYxez8V2+s/UlOH0/UrUiSBFfHqs4g4Q4oc+5Iwylp4A9S8oitZMSefov5ZbTVI9RrDhA1GwvgvEXR62hJm6eipEBZEL8/G4A1cB/SizJaPtxhz4/ViwYp3ZjlUiglqZWCc9Wnovd1wghGV4OprePkU9Q/tlAftkEVKMtLCUSj8pnSL+2B50sXCFNU+Ymb06O52+/O71lOU3Kl8h/QX/m6fH9g4L9ZxbJ+awlrrCACfAcZfczBIIJEs3eiL5enkmvR0YNFWZoh+i+5MefTqb1YnYPRP1esrxeSbo5Xd1IopngmZn/ObkCp+Jmz5YVpdNSt90r7Z+TCpWZkCTX5h3/rB9pNZqlGZoMLbxOhGxijA/p8cz7XRy+vJkOjmZvL6ans1nf5+/OhtNJpPfRSK2ZUzvdjTlbdfrWHbfK5d/BTv1fbFhI74fOA5nnYjZQ+Po0pZIBU/xDRqCjbdmlYDTKAMC+R3IlVQGWI3/5n83p9B7+0T/ex6zYcIoo5XBm24W38wmk5tpH4TZcRCuBnMJlrYy+dd19SH7jzs0uznrHXp17NCFWUut8rgCXtlbNF/Xn6F5aswfZ6xqhOJzceDs8LxxMmBWeUW7uBtuT6RTJ83z+fWC1y7OFNsulXGZpELMRT95x/vBIlkL1ufX3apZeT0Y1tK5kXVouHlrmQYeUmPp1HjNs+e+dJAmT+3284jFHfdLjm8TwgMP7qaYUz8jj7E2QEOpdvktUMb1o+bvSxvBbdjeOTTcIGPQ19OjcfYBdWZL5IWYCoRO/M9//yciuh0+5sQ38K7y4OwGPe+p0uSw1LhVqX7oVhFQlhpD0DtQhnDlOZNztVIkdRyaXMOZdDJVWnEWsZhltIdBIoYRfCiQCvT86G8eQUKOa9ScfKCtvWU9ZEFWZMtoo+UMG+tvl0wpAQlpFZTBwPcW7CBoCmkyhO5dJGA9SANoCL3zKiBIVbIwX2xwuVSZYsVcMl5mBKU0coVsLAHmzVFw3q5VjgG8TatAEKyuoiNssUSkxsV4DxnBT2qNjeN82FzAMIdVxSoSyGyO0FYQu2FySDEQODavMoxKA0lPoHGNXq6iawXCstIanOXSVlLzPWj4blkReWkCz+SGUPdq+vA5b/lKEm3kcjeCj+aj4fYLVUBOAK3MbZh/NCdw3afZB0yDIlx829XCZrM5qoMXh5i3iooqBY/O3uFW8TBWzRDef3khEkHoy/BueYl+rbJut/6MzXEUHrcNT2ax4bXLKdfYj/cB3Hy0ytAEHLSn87fvf4E1vBxNRDKo+i8gPP7l4h9vfr18w3q5yzT1Nx1NRpO47tpApTQDU8Nb+/263d+17f+DG37byQi3NHZaqtjYY/D2bVO+vttKEjEf3u8XiShsIBbZ71MZ8F9e1zUf/1Gh59a/SMRaeiVTbnjXe5GrwJ/z/q7+2ch9+1t77X8BX/5TwYPOdL3acKOOVwMxFyIRt7i793tFveC1umnYzLaROM8ydDTAHo3ig3n29s2VSISsqDgcFLdxULQfWPuDvA4nSEOA//IgexDwPWfUz7j7oRdvnnwW0PrXSXOMFnVd/xdCGXZs",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWNtuG0cS/ZVKv2wMjHiRaTlLBEGEjeEVEsRGpIWByITQM1PktNXT3emu4QXEvO2X7KflSxbVc9FQlCULWRjYF4nsqVN1qqZuzb0guQpifi2usHRaEgaxSESOIfPKkbJGzMVVgfAWCToROH9/AVJruwmwsxWQBY/kFa4RciSpdACZ2opAQnCYqaXKgFrwqFcTIKBfI8gAqa7QeWUowNJ6yDxKUmYFuc2qEvl4o6gA5zHHpTKYQyBfZVR5DCORCOvQS2Z7kYu5WCF1NkQinPSyRELPbu6FkSWKuejo3KhcJEKxm05SIe77fvET2GVPHqiQBAYxD+x1irBEygpkHR7/qJTHXMzJV5iIQDvNloIqnWYiuHXa5ijmS6kDC2QFllLM94J2LkqSV2YlErG0vpTUnJiVqOsFqw/OmoCBAaeTCf87pBqqLMMQlpWGPh4iEZk1hIZYXjqnVRYfjD8FBu2PWdj0E2bEgfOshlRjsjnm+D7OtznBrYxez8V2+s/UlOH0/UrUiSBFfHqs4g4Q4oc+5Iwylp4A9S8oitZMSefov5ZbTVI9RrDhA1GwvgvEXR62hJm6eipEBZEL8/G4A1cB/SizJaPtxhz4/ViwYp3ZjlUiglqZWCc9Wnovd1wghGV4OprePkU9Q/tlAftkEVKMtLCUSj8pnSL+2B50sXCFNU+Ymb06O52+/O71lOU3Kl8h/QX/m6fH9g4L9ZxbJ+awlrrCACfAcZfczBIIJEs3eiL5enkmvR0YNFWZoh+i+5MefTqb1YnYPRP1esrxeSbo5Xd1IopngmZn/ObkCp+Jmz5YVpdNSt90r7Z+TCpWZkCTX5h3/rB9pNZqlGZoMLbxOhGxijA/p8cz7XRy+vJkOjmZvL6ans1nf5+/OhtNJpPfRSK2ZUzvdjTlbdfrWHbfK5d/BTv1fbFhI74fOA5nnYjZQ+Po0pZIBU/xDRqCjbdmlYDTKAMC+R3IlVQGWI3/5n83p9B7+0T/ex6zYcIoo5XBm24W38wmk5tpH4TZcRCuBnMJlrYy+dd19SH7jzs0uznrHXp17NCFWUut8rgCXtlbNF/Xn6F5aswfZ6xqhOJzceDs8LxxMmBWeUW7uBtuT6RTJ83z+fWC1y7OFNsulXGZpELMRT95x/vBIlkL1ufX3apZeT0Y1tK5kXVouHlrmQYeUmPp1HjNs+e+dJAmT+3284jFHfdLjm8TwgMP7qaYUz8jj7E2QEOpdvktUMb1o+bvSxvBbdjeOTTcIGPQ19OjcfYBdWZL5IWYCoRO/M9//yciuh0+5sQ38K7y4OwGPe+p0uSw1LhVqX7oVhFQlhpD0DtQhnDlOZNztVIkdRyaXMOZdDJVWnEWsZhltIdBIoYRfCiQCvT86G8eQUKOa9ScfKCtvWU9ZEFWZMtoo+UMG+tvl0wpAQlpFZTBwPcW7CBoCmkyhO5dJGA9SANoCL3zKiBIVbIwX2xwuVSZYsVcMl5mBKU0coVsLAHmzVFw3q5VjgG8TatAEKyuoiNssUSkxsV4DxnBT2qNjeN82FzAMIdVxSoSyGyO0FYQu2FySDEQODavMoxKA0lPoHGNXq6iawXCstIanOXSVlLzPWj4blkReWkCz+SGUPdq+vA5b/lKEm3kcjeCj+aj4fYLVUBOAK3MbZh/NCdw3afZB0yDIlx829XCZrM5qoMXh5i3iooqBY/O3uFW8TBWzRDef3khEkHoy/BueYl+rbJut/6MzXEUHrcNT2ax4bXLKdfYj/cB3Hy0ytAEHLSn87fvf4E1vBxNRDKo+i8gPP7l4h9vfr18w3q5yzT1Nx1NRpO47tpApTQDU8Nb+/263d+17f+DG37byQi3NHZaqtjYY/D2bVO+vttKEjEf3u8XiShsIBbZ71MZ8F9e1zUf/1Gh59a/SMRaeiVTbnjXe5GrwJ/z/q7+2ch9+1t77X8BX/5TwYPOdL3acKOOVwMxFyIRt7i793tFveC1umnYzLaROM8ydDTAHo3ig3n29s2VSISsqDgcFLdxULQfWPuDvA4nSEOA//IgexDwPWfUz7j7oRdvnnwW0PrXSXOMFnVd/xdCGXZs",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.7ae433ff.js b/assets/js/38c56221.7ae433ff.js new file mode 100644 index 000000000..1997f2671 --- /dev/null +++ b/assets/js/38c56221.7ae433ff.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>g,toc:()=>x});var i=s(85893),n=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v20YS/yqTzUMTgJZkJ3cPRFHEbdLCaBEbZx+CgywYQ+5QXHu5y+4uJfMEvd0nuY92n+QwS1KiHMeoi6JAgbzY0u78n52Z32gjAi69SOfivc2bikzwYpEIST53qg7KGpGKq5LgvcMiwEAEpxdnQAYzTR5a20CwkDvCQIBGQoUGlwRyoJbM7CdwVZKn/hvkaCAjKBoXSnJAxqm8JAlZCyilMkvwamnI+ShSmdy62joMfKNMIId5UCuCtZJLCh5C6WyzLME2DhpPriMqMCfAAHMoQ6h9Op1iXU9sTYala8z8JLfV4tWT16/hVWEd5No2ElbkvLLmNbujfIyE8iApWis5Ej44wkorQxBKgtrZnLwHW+wjUjuqkZ2xJgHU2q7ZLVaC4JmZGYJD4xXTQOFs1QWOFRTKoN4Jm1yba/Py5Uv4kTA0jnx6bY4ALnFF+4TF/PkULilvHOkWPF+3HKxBjgdlAHstPmCgSRR0KiVcdqlI4dSzn7vUBHsoA6RylAfddhaz+6cXZ5POvo82UHpt/mUbTr6xgRMNzvIj4hwPmexZu+BOgOnXSmso2eRgQVpQYa9AK3MHjnJSK+KHEg8d+doazy6IRNiaumCfSZGK6CENJotEOPq1IR++t7IV6Ubk1gS+SDcC61qrPLJObz1Xw0b4vKQK+RPzKUeS66dQmkQi+sCIRAQVNHExhbYmkQqb3VLO2mrH5gRFnmVEvnQzUPnglFmKRBTWVRhEKjL09Pe3IhF0j1XNxP0RkMmtJAm1LMR2UPiUqN3JXpSPH3b5YzkHxf+7pL0fSdgmwtjwe+3iJ8MihrDupaBz2IpEqEDV+PwLYaYKlX6uEbeWMqJ3/QF3gugOVs9259YSZBRdqUtrns1/fPLm+OT4zfGJ2O4z3T3kIXU3mZXtzRAoJvNk5Jk5d5LcSF9mrSY0Y/EFak9PCxZbvt8/+OAaigddmcUYn8xm/O9weOw6UDcfJPgm53ZYNFq3L0Ty26vt6QR3x1zfz4tseatO/n2fr04uODmNe/YjGQZH4/RRsEckVTjal9MoqMrwSLgZQnZzMpvdSI7rNhFvHwvdpa0olDwY1hzAtbNmmUCtCT1BcC3gEpUBjYHcHxhJcs66x6Kw9/l5lj0VhLez2c3xLgh/+zwIZ2aFWsk4Z6/sHZk/19Ox+tCpZ1Pvq/hOulYgVEcU78WBs+PzzknPA1iFVqTzjbg/wloddffpfLFdJIIDa3lK1dZHizGUIhXTg5LkQUNuFTvifNO9WvEUgpliraarY7FNHlJ7NDKz91/mWOxtvuS4dqE7sHzflGv1M3FX7gMzpkqE4nyWhNyPOBScrn/sR++HIejDUHxszu2D+3ByPUStj8yiYRQdTJfRcJnv5sRjrX/n1dDMd7183J4XD/pu11vZ+cLGSPXmn9dkGFXFl7U6/sz8T6RzW0W8w3hmIP/ff/4bOQa348N/AeeNg9quyRWNjliq0HSvMh3hVwcwd0B9wJe6jRB56Ri2S7VUAXUEdlzXOdaYKa24VJisx3mjavMT+FRSxO6tbb5xxNiRVqS5wkBbe8dyggVsgq2ijmEUrK27K9ikBBCyxivDcNcTDSxkSjQ5wfDwEmBkbIAY0tdOeQJU1QCZqShUruKMsSbwXtBvIKwsiQsBR6F2dqUkeXA2a3wAb3UTHWGNFVHoXDRE0k/gPe8W0fGIbymg0iRh2bCIBPhFQv862A0jISPPwJ7Xkpx8twigC6BpRQ6X0bWSFx6tobbcvxRq3grGuWVBEffzyOmxdZ+a0fIQF4qoQ2I7AV4AuCXz3sMPgBFxtwXMd8/sE2VeBVq8Ggp/vV5/vugc8vykQtlk4Ki2e75lPIwtYsy++/Kaa5Rc5c+LS3IrlQ9D8gs6p5F42nd1zMMIrnFDefeQgTusVjkZT6MefPrTxS+wgjeTmUhGLe43GDz95eyHDx8vP7Dcfrnjkp7MJrOI16wPFZqRqsNd+GHljvaHr5vz1835L74594M90H2Y1hqVGaHkDprMD7cF3nhLhi7pXGw2PMH/6fR2y8e/NuQY9ywSsUKnuAYi6kkGUMAD+I5akYofuhI6umL1TK6bDl88AHuMZzqO0zynOjxJO0ZXF+eXVyIRWb/yV1Yyj8M1/xyAa5GKa3Et4k8HcUbEdZ/PN0KjWTa4jEggymUsgw3HYgyE7iIQ6j+wZ8OVaUdWHiKkzhX+y449yvAtl83P1H63I+9uvsjQx3ag5gwuttvt/wHYLAMX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v20YS/yqTzUMTgJZkJ3cPRFHEbdLCaBEbZx+CgywYQ+5QXHu5y+4uJfMEvd0nuY92n+QwS1KiHMeoi6JAgbzY0u78n52Z32gjAi69SOfivc2bikzwYpEIST53qg7KGpGKq5LgvcMiwEAEpxdnQAYzTR5a20CwkDvCQIBGQoUGlwRyoJbM7CdwVZKn/hvkaCAjKBoXSnJAxqm8JAlZCyilMkvwamnI+ShSmdy62joMfKNMIId5UCuCtZJLCh5C6WyzLME2DhpPriMqMCfAAHMoQ6h9Op1iXU9sTYala8z8JLfV4tWT16/hVWEd5No2ElbkvLLmNbujfIyE8iApWis5Ej44wkorQxBKgtrZnLwHW+wjUjuqkZ2xJgHU2q7ZLVaC4JmZGYJD4xXTQOFs1QWOFRTKoN4Jm1yba/Py5Uv4kTA0jnx6bY4ALnFF+4TF/PkULilvHOkWPF+3HKxBjgdlAHstPmCgSRR0KiVcdqlI4dSzn7vUBHsoA6RylAfddhaz+6cXZ5POvo82UHpt/mUbTr6xgRMNzvIj4hwPmexZu+BOgOnXSmso2eRgQVpQYa9AK3MHjnJSK+KHEg8d+doazy6IRNiaumCfSZGK6CENJotEOPq1IR++t7IV6Ubk1gS+SDcC61qrPLJObz1Xw0b4vKQK+RPzKUeS66dQmkQi+sCIRAQVNHExhbYmkQqb3VLO2mrH5gRFnmVEvnQzUPnglFmKRBTWVRhEKjL09Pe3IhF0j1XNxP0RkMmtJAm1LMR2UPiUqN3JXpSPH3b5YzkHxf+7pL0fSdgmwtjwe+3iJ8MihrDupaBz2IpEqEDV+PwLYaYKlX6uEbeWMqJ3/QF3gugOVs9259YSZBRdqUtrns1/fPLm+OT4zfGJ2O4z3T3kIXU3mZXtzRAoJvNk5Jk5d5LcSF9mrSY0Y/EFak9PCxZbvt8/+OAaigddmcUYn8xm/O9weOw6UDcfJPgm53ZYNFq3L0Ty26vt6QR3x1zfz4tseatO/n2fr04uODmNe/YjGQZH4/RRsEckVTjal9MoqMrwSLgZQnZzMpvdSI7rNhFvHwvdpa0olDwY1hzAtbNmmUCtCT1BcC3gEpUBjYHcHxhJcs66x6Kw9/l5lj0VhLez2c3xLgh/+zwIZ2aFWsk4Z6/sHZk/19Ox+tCpZ1Pvq/hOulYgVEcU78WBs+PzzknPA1iFVqTzjbg/wloddffpfLFdJIIDa3lK1dZHizGUIhXTg5LkQUNuFTvifNO9WvEUgpliraarY7FNHlJ7NDKz91/mWOxtvuS4dqE7sHzflGv1M3FX7gMzpkqE4nyWhNyPOBScrn/sR++HIejDUHxszu2D+3ByPUStj8yiYRQdTJfRcJnv5sRjrX/n1dDMd7183J4XD/pu11vZ+cLGSPXmn9dkGFXFl7U6/sz8T6RzW0W8w3hmIP/ff/4bOQa348N/AeeNg9quyRWNjliq0HSvMh3hVwcwd0B9wJe6jRB56Ri2S7VUAXUEdlzXOdaYKa24VJisx3mjavMT+FRSxO6tbb5xxNiRVqS5wkBbe8dyggVsgq2ijmEUrK27K9ikBBCyxivDcNcTDSxkSjQ5wfDwEmBkbIAY0tdOeQJU1QCZqShUruKMsSbwXtBvIKwsiQsBR6F2dqUkeXA2a3wAb3UTHWGNFVHoXDRE0k/gPe8W0fGIbymg0iRh2bCIBPhFQv862A0jISPPwJ7Xkpx8twigC6BpRQ6X0bWSFx6tobbcvxRq3grGuWVBEffzyOmxdZ+a0fIQF4qoQ2I7AV4AuCXz3sMPgBFxtwXMd8/sE2VeBVq8Ggp/vV5/vugc8vykQtlk4Ki2e75lPIwtYsy++/Kaa5Rc5c+LS3IrlQ9D8gs6p5F42nd1zMMIrnFDefeQgTusVjkZT6MefPrTxS+wgjeTmUhGLe43GDz95eyHDx8vP7Dcfrnjkp7MJrOI16wPFZqRqsNd+GHljvaHr5vz1835L74594M90H2Y1hqVGaHkDprMD7cF3nhLhi7pXGw2PMH/6fR2y8e/NuQY9ywSsUKnuAYi6kkGUMAD+I5akYofuhI6umL1TK6bDl88AHuMZzqO0zynOjxJO0ZXF+eXVyIRWb/yV1Yyj8M1/xyAa5GKa3Et4k8HcUbEdZ/PN0KjWTa4jEggymUsgw3HYgyE7iIQ6j+wZ8OVaUdWHiKkzhX+y449yvAtl83P1H63I+9uvsjQx3ag5gwuttvt/wHYLAMX",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},f={},x=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function j(e){const a={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(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:"Draft Document"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsxs)(a.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,i.jsx)(a.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,i.jsx)(a.h3,{id:"features",children:"Features:"}),"\n",(0,i.jsxs)(a.ul,{children:["\n",(0,i.jsx)(a.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,i.jsx)(a.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,i.jsx)(a.h3,{id:"note",children:"Note:"}),"\n",(0,i.jsx)(a.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(d.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:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"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)("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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.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-edit-document"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.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)(o.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(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/38c56221.dfda5b34.js b/assets/js/38c56221.dfda5b34.js deleted file mode 100644 index 5125cda84..000000000 --- a/assets/js/38c56221.dfda5b34.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>g,toc:()=>j});var n=a(85893),r=a(11151),t=a(58219),i=(a(62316),a(51039)),l=a.n(i),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const h={id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,g={id:"API-docs/draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",source:"@site/docs/API-docs/draftedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/draftedocument",permalink:"/docs/API-docs/draftedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"draftedocument",title:"Draft Document",description:"The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at [ https://app.opensignlabs.com]( https://app.opensignlabs.com) (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJztWF9v47gR/ypz3IfuAortZLd9EIri0tvtIbjDJWhSLArHCEbiSGJCkTqSsqMafusn6UfrJymGkmw5mw0uh6JAgXtJbHL+D2fmN96KgKUX6VJ8tHlbkwlerBIhyedONUFZI1JxUxF8dFgEGIng/OoCyGCmyUNnWwgWckcYCNBIqNFgSSBHasnMfgY3FXkavkGOBjKConWhIgdknMorkpB1gFIqU4JXpSHno0hlcusa6zDwjTKBHOZBrQk2SpYUPITK2baswLYOWk+uJyowJ8AAS6hCaHw6n2PTzGxDhqVrzPwst/Xq7YvX7+BtYR3k2rYS1uS8suYdu6N8jITyIClaKzkSPjjCWitDECqCxtmcvAdbHCLSOGqQnbEmAdTabtgtVoLgmZkZgkPjFdNA4WzdB44VFMqg3gub3Zpb8+bNG/gLYWgd+fTWnABc45oOCYv58ylcU9460h14vu44WKMcD8oADlp8wECzKOhcSrjuU5HCuWc/96kJ9lgGSOUoD7rrLWb3z68uZr19P9lA6a35u205+cYGTjQ4y4+IczxmcmDtgzsDpt8oraFik4MFaUGFgwKtzAM4ykmtiR9KPHTkG2s8uyASYRvqg30hRSqihzSaLBLh6OeWfPizlZ1ItyK3JvBFuhXYNFrlkXV+77katsLnFdXIn5hPOZJcP4XSJBIxBEYkIqigiYspdA2JVNjsnnLW1jg2JyjyLCPypduRygenTCkSUVhXYxCpyNDTHz6IRNAj1g0TD0dAJreSJDSyELtR4Uui9icHUT5+2OeP5RwV/6+S9nEiYZcIY8OvtYufDIsYw3qQgs5hJxKhAtXT86+EmWpU+rVG3FvKiL4dDrgTRHewfrU795Ygo+hKU1nzav7Ts/enZ6fvT8/E7pDp/iGPqbvLrOzuxkAxmScjL8ylk+Qm+jJrNaGZii9Qe3pZsNjx/eHBB9dSPOjLLMb4bLHgf8fDY9+B+vkgwbc5t8Oi1br7RiS/vNpeTnB/zPX9ushW9+rsH4/5+uyKk9O6Vz+ScXC0Tp8Ee0JShZNDOU2CqgyPhLsxZHdni8Wd5LjuEvHhudBd25pCxYNhwwHcOGvKBBpN6AmC6wBLVAY0BnL/xUiSc9Y9F4WDz6+z7KUgfFgs7k73Qfj9l0G4MGvUSsY5e2MfyPxvPZ2qD716NvWxju+kbwVC9UTxXhw5Oz3vnfQ8gFXoRLrciscTbNRJf58uV7tVIjiwlqdUY320GEMlUjE/KkkeNOTWsSMut/2rFS8hmDk2ar4+FbvkKbUPWCpTnrzItTrYfc2x7cN3ZP2hMTfqB+LOPARnSpUIxTmtCLkncTg4ZX89jN9PY+DHwfjcrDsE+On0eopcn5lH4zg6mjCTAbPcz4rn2v/eq7Gh7/v5tEWvnvTevr+y84WNkRrMv2zIMLKKr2t9+oX5n0nnto6YhzHNSP7vf/4rcoxux8f/DVy2Dhq7IVe0OuKpQtOjynSEYD3I3IP1EWPqLsLk0jF0l6pUAXUEd1zbOTaYKa24XJhswHqTivMz+FxRxO+dbX/niPEjrUlzlYG29oHlBAvYBltHHeM42Fj3ULBJCSBkrVeGIa8nGlnIVGhygvHhJcDo2AAxrG+c8gSo6hE2U1GoXMU5Y03g3WDYQlhZEpcCjkLj7FpJ8uBs1voA3uo2OsIaa6LQu2iIpJ/BR94vouMR41JApUlC2bKIBPhFwvA62A0jISPP4J5Xk5x8vwygC6BpTS4WWswkDz9oLPcwhZo3g2luWVDE/jx2Bnw9pGayQMSlIuqQ2M2AlwBuy7z78ANgVNxvAsv9M/tMmVeBVm/H4t9sNl8uO8c836tQtRk4auyBr4yHsUVM2fdf3nGNkqv9ZXFNbq3ycVB+Rec8Es+Hzo55mEA2bijfPmXgLqtVTsbTpA+ff3/1I6zh/Wwhkkmb+wUGz3+8+O7TT9efWO6w4HFJzxazRcRs1ocazUTV8T78tHInO8Rv2/Nv2/P/+fY8DPZAj2HeaFRmgpR7eLI83hh4660YvqRLsd3yBP+b07sdH//ckmPss0rEGp3iGojIJxlBAQ/gB+pEKr7rS+jkhtUzuW57fPEE8DGm6TnO85ya8CLtFGFdXV7fiERkw9pfW8k8Djf8kwBuRCpuxa2IPx/EGRFXfj7fCo2mbLGMSCDKZSyDLcdiCoQeIhAaPrBn45XpJlYeI6TeFf7Ljj3L8Ecumx+o+9OevL/5KsMQ25GaM7ja7Xb/AQsRBIM=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Create Document",permalink:"/docs/API-docs/createdocument"}},f={},j=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function x(e){const s={a:"a",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,r.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:"Draft Document"})}),"\n",(0,n.jsx)(l(),{method:"post",path:"/draftdocument"}),"\n",(0,n.jsxs)(s.p,{children:["The Draft Document API enables you to create and manage document drafts. These drafts can be further enriched by adding signers and incorporating interactive widgets through our user interface at ",(0,n.jsx)(s.a,{href:"https://app.opensignlabs.com",children:" https://app.opensignlabs.com"})," (for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,n.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,n.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"note",children:"Note:"}),"\n",(0,n.jsx)(s.p,{children:"You cannot add roles and widgets from this API. You will have to do it from the link received in the response."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(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.jsx)("span",{className:"openapi-schema__divider"}),(0,n.jsx)("span",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]})}),(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:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document created successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,n.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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:"Something went wrong, please try again later!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.95befe47.js b/assets/js/451a5132.20e29001.js similarity index 59% rename from assets/js/451a5132.95befe47.js rename to assets/js/451a5132.20e29001.js index e80c712f4..7165dd2f1 100644 --- a/assets/js/451a5132.95befe47.js +++ b/assets/js/451a5132.20e29001.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),d=(a(82723),a(9487)),o=a(41429),m=a(5397),p=a(4667),c=a(9472),h=a(85162);const x={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",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/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),i=a(11151),r=a(58219),t=(a(62316),a(51039)),n=a.n(t),d=(a(82723),a(9487)),o=a(41429),m=a(5397),c=a(4667),p=a(9472),h=a(85162);const x={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6dhiTZEseeQLDP/bk+zR9iTDoSRbzqVrhq5/LJM8l+8cnhs3kmAW5Pha/mp1gV5OEllgyL1ypKyRY3lVomjOxIUKJE7fngusnF2iD2Jta0FWeCSvcIEChGYaOxXThmWpqBS2+dqahAOPhhp554VMpHXogVWdF3IsGy6WIRPpwEOFhJ7xbaSBCuVY3pGgGOXHGv1a3sZusw+Y03mxByQT6fFjrTwWcjwFHTCRgdYao3JfyUTiymlb4P44L7ECOd5IWjumC+SVmckkMgD1d3AFlYvC5Hab7DBrVSm6DfWzcZCvD2BUsFJVXcnxSZomHShTVxl6ue1hGKU9CGGu3BdD8LDOdDthucFZEzAw7XGa8ufwYkKd5xjCtNZiFwAykbk1hIaYHpzTKo8Hww+BmTZ3ATT3y6HiWQypRqXHUGvq0YH3wAYrwir8O38XNo+9c1eOsnJ1/MGxS5p4ex29/zgxBpddtG6T2/H+SFm/HRsIJ3P1Fm/L+q/IQp310OUegbA4pftE7RmP0+NnR6P0KP3uavRi/Pz78cmLQZqmf8hErirNvG2YFkARKSnS/XXtiq+gp7fRmHjjMchtf18ZrQzedCF+c5ymN6NnTLNN5PP7Yv3SVkilMjOxRENi6a2ZJcJphICC/FrADJQRGgj9ky+XBOi99Z/21uOQfcoLz9kLOyec3HXCuVmAVkXsHld2jubrWtpXT416hnoYE6ohiufywNj+fmNkwLz2itaxM62OwKmj5nx8PeESyI613NFm2LQyKuVYDg/6W0C/6Jpb7bUcy5LIhfFwCM4NrEMT1MxoyMIgt9UQnBouRpJr+iF1AFNkdvUwx2SP95J92rjtAPW+VDr1CrlWtk7pU7Xto0SI2b/l9dRG5tZVbxyaSzUz0dGL0Z2G/A51bivkmYFKFB3533/+FTkKm9cVGopx8ES8qb2Igwb3CTCFmGpcqUxjJAat7XI3ggSESmMIei2UIZx5IBSFmikCLdgrHOY5OMiUVhw5TGaZ24te8IWBeFcilej56BvPI02BC9QccEJbO2c5ZAXUZKuoo8UsltbPpwwpESCyOiiDIYiA2LGgKcHkKLq7SHgwAiPQEHrnVUABqmLiqfUCp1OVKxbMaeIhJ1GBgRmyskQwbvaC83ahCgzC26wOJILVdTSENVaI1JhoEIswEL+oBTaG82aBBEpjIWY1i0hEbgsUbdawGaYQGQYSjtWrHKPQQOBJaFygh1k0rUQxrbUWznI6K9A8b/XvlgWRBxO4uTSAuqvZuc95yyNB1FHAeiDem/eGK5SoA3IAaGXmYfzeHInrXZi9wywowsm3XS4sl8s7efD0kOdMUVlnwqOze75Z3IxZ02ffLZ7KRBL6KryZXqJfqBzbBHxA5zASD9siB3kscliB0k2O/XSbgQuOVjmagL2SdHr29kIsxLNBKpNe1n8G4OHF+c8vX1++ZLlcZZr8Gw3SQRonARuoAtNTdYbUDe1tfTpI3c2+Wv/fT4K2EhGuaOg0qFiMo/GbtpBe9x8Kk0SWNhDvbjYZBPzd6+2Wt5s5l8troQJkujfpPmjbvU+GexHNcX3fc2QBum4eAMk9ehum7j3wObTt4L4nnfDCK6aN3SbpCjIb2vCc5jm6voI77fWgR529vJKJhJpd228E89gI2j8svTsy657sww7RAOBftulehh84Xl7h+scdeXPyIENrX0fN7p9st9t/AEwTFOU=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6dhiTZEseeQLDP/bk+zR9iTDoSRbzqVrhq5/LJM8l+8cnhs3kmAW5Pha/mp1gV5OEllgyL1ypKyRY3lVomjOxIUKJE7fngusnF2iD2Jta0FWeCSvcIEChGYaOxXThmWpqBS2+dqahAOPhhp554VMpHXogVWdF3IsGy6WIRPpwEOFhJ7xbaSBCuVY3pGgGOXHGv1a3sZusw+Y03mxByQT6fFjrTwWcjwFHTCRgdYao3JfyUTiymlb4P44L7ECOd5IWjumC+SVmckkMgD1d3AFlYvC5Hab7DBrVSm6DfWzcZCvD2BUsFJVXcnxSZomHShTVxl6ue1hGKU9CGGu3BdD8LDOdDthucFZEzAw7XGa8ufwYkKd5xjCtNZiFwAykbk1hIaYHpzTKo8Hww+BmTZ3ATT3y6HiWQypRqXHUGvq0YH3wAYrwir8O38XNo+9c1eOsnJ1/MGxS5p4ex29/zgxBpddtG6T2/H+SFm/HRsIJ3P1Fm/L+q/IQp310OUegbA4pftE7RmP0+NnR6P0KP3uavRi/Pz78cmLQZqmf8hErirNvG2YFkARKSnS/XXtiq+gp7fRmHjjMchtf18ZrQzedCF+c5ymN6NnTLNN5PP7Yv3SVkilMjOxRENi6a2ZJcJphICC/FrADJQRGgj9ky+XBOi99Z/21uOQfcoLz9kLOyec3HXCuVmAVkXsHld2jubrWtpXT416hnoYE6ohiufywNj+fmNkwLz2itaxM62OwKmj5nx8PeESyI613NFm2LQyKuVYDg/6W0C/6Jpb7bUcy5LIhfFwCM4NrEMT1MxoyMIgt9UQnBouRpJr+iF1AFNkdvUwx2SP95J92rjtAPW+VDr1CrlWtk7pU7Xto0SI2b/l9dRG5tZVbxyaSzUz0dGL0Z2G/A51bivkmYFKFB3533/+FTkKm9cVGopx8ES8qb2Igwb3CTCFmGpcqUxjJAat7XI3ggSESmMIei2UIZx5IBSFmikCLdgrHOY5OMiUVhw5TGaZ24te8IWBeFcilej56BvPI02BC9QccEJbO2c5ZAXUZKuoo8UsltbPpwwpESCyOiiDIYiA2LGgKcHkKLq7SHgwAiPQEHrnVUABqmLiqfUCp1OVKxbMaeIhJ1GBgRmyskQwbvaC83ahCgzC26wOJILVdTSENVaI1JhoEIswEL+oBTaG82aBBEpjIWY1i0hEbgsUbdawGaYQGQYSjtWrHKPQQOBJaFygh1k0rUQxrbUWznI6K9A8b/XvlgWRBxO4uTSAuqvZuc95yyNB1FHAeiDem/eGK5SoA3IAaGXmYfzeHInrXZi9wywowsm3XS4sl8s7efD0kOdMUVlnwqOze75Z3IxZ02ffLZ7KRBL6KryZXqJfqBzbBHxA5zASD9siB3kscliB0k2O/XSbgQuOVjmagL2SdHr29kIsxLNBKpNe1n8G4OHF+c8vX1++ZLlcZZr8Gw3SQRonARuoAtNTdYbUDe1tfTpI3c2+Wv/fT4K2EhGuaOg0qFiMo/GbtpBe9x8Kk0SWNhDvbjYZBPzd6+2Wt5s5l8troQJkujfpPmjbvU+GexHNcX3fc2QBum4eAMk9ehum7j3wObTt4L4nnfDCK6aN3SbpCjIb2vCc5jm6voI77fWgR529vJKJhJpd228E89gI2j8svTsy657sww7RAOBftulehh84Xl7h+scdeXPyIENrX0fN7p9st9t/AEwTFOU=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(r.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(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,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.24a25302.js b/assets/js/52d5c0f9.24a25302.js deleted file mode 100644 index ce5e132a9..000000000 --- a/assets/js/52d5c0f9.24a25302.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>k,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=l(85893),n=l(11151),t=l(58219),i=(l(62316),l(51039)),o=l.n(i),d=(l(82723),l(9487)),r=l(41429),c=l(5397),m=l(4667),p=l(9472),h=l(85162);const u={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:l}=s;return l||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,a.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,a.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,a.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.46904785.js b/assets/js/52d5c0f9.46904785.js new file mode 100644 index 000000000..15a42175b --- /dev/null +++ b/assets/js/52d5c0f9.46904785.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),d=(a(82723),a(9487)),c=a(41429),m=a(5397),r=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaIm+JEWJoqhbG6mRoAlqFwHqCMaIHIobL3c3u0tdIPCtX9JP65cUw4tEWbKRAm1eJHJ55nZ258yuRcCZF8mtuDBpVZIOXkwikZFPnbRBGi0ScVMQXJCiQJB1KDh/fwWolFl4WJkKggFHpZkTeEupzGW6hebOlAxymyU/EpEwlhxyhKtMJCJr/PcAEQmLDksK5Di7tdBYEsM6wJ3MRCQkZ2cxFOJhyu+dmcuMwEw/URquMjD5NqFgoA0nIuHocyUdZSIJrqJI+LBSHMjL0ioG0NIqk5FIclSeAWlBJYpkLcLKNsjgpJ6JSOTGlRiGK7TExksibHEyLU7QZ6KuJxzVW6M9efZzEsf8t1tAvx1dphn4Kk3J+7xSavVMRCI1OjBTyVqgtUqmDZfjT57N1/tptkwwsY6ZD7IN3hN0qKBt+j8tOXn7iz0VddTv1Xl42ugkPjk9Oo6P4m9vjl8lZ98lL1+N4jj+Q0RiWSq27TcVA7HfIIPavtd7sHbPhsBupWbw2SEar01JoZB6Bgsmc+GMnkVgFaEnCG4FOEOpQWEg9x+ySs4Z9zQ7/y6zelC11EpquuvP0N1ZHN8db0g4e+IsaRMgN5XOvm6ph+I/XdDZ3emmoJf7BV3pOSqZNSJ0Y+5Jf916huFDG37/tMoW1HwXO8UO19siPaWVk2HVKN3yCK08ar8ntxOWCz4pZquSjTqGQiRi3GvaeD1QxlqwSzfvtbNySiSiCMH6ZDxGa0fGkvZyphVO/Sg15RitHM+PRR09RHvU2dQsH7eYbNO/ZopbFneK2HCJVr6hlYh6joaoTs0Lwoxcw6fUuWmMO+beWdLXcqYb3ufHe5r/gVRqSmJ5DwVBD//7z78ai56g5lg8g3eVA2sW5PJKAeoMckVLOVV0YLR5wlKR92oFUgeaOeRRKGcyoAJmhds4RYtTqSQfJIaZduYNzqIfwYeCQkGOP33jCBAympPi8wfKmHv2EwxgFUyJw3G7MO4+55QiQJhWXmryHjxRb0K6QJ0S9HsRgXGAGkgHctZJT4CyZHBuHFCey1SyY+4ah2mAEjXOiINFwHkzC7adoh6cmVY+gDeqagrhiCVRaEvURJkfwYWcU1t4M+spoFSUwaxiFxGkJiPomojL0BlMyQewHF6m1Dj1AV0ARXNyOGtKKwh45oE13N0SFY/y4d6yo+BQe56/3T2j25oNfdYZHp5NjAxXI/ioP2pWYKg88QFQUt/75KM+gtvNMftAUy8DTZ73vbBYLPb64MWuzWsZimoKjqzZ2s2axaZrhuablxciEoFc6d/l1+TmMqWuAR+JOW7A407zMG00j0qUqu2xHx8asP4omZL2NFCo89fv38IcTkexiAZd/wUJj99e/Xz56/Ul+2WVafvveBSPYl6yxocS9SBUd3u82F7vdlp3vRXv/+my2QlQoGUYW4WykeSm5nWnpbdicPlMhvfMSSQK4wND1uspevrdqbrm5c8VORbtSSTm6CROWadu1yKTnp+zzaXx0Wqf/9bdP1/AF19ZD9bSK6xmeZ2jqvhNROKeVg+uzfWkjnqZ5WRbxHmakg0D270ZujOILi7fXt5cikhgxeQNFf6+UfjugQMcTG1X+tsc+Jcn0EGD7/kQvKHVDxt4++VRg67EHs00Teq6/gcB9YOS",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaIm+JEWJoqhbG6mRoAlqFwHqCMaIHIobL3c3u0tdIPCtX9JP65cUw4tEWbKRAm1eJHJ55nZ258yuRcCZF8mtuDBpVZIOXkwikZFPnbRBGi0ScVMQXJCiQJB1KDh/fwWolFl4WJkKggFHpZkTeEupzGW6hebOlAxymyU/EpEwlhxyhKtMJCJr/PcAEQmLDksK5Di7tdBYEsM6wJ3MRCQkZ2cxFOJhyu+dmcuMwEw/URquMjD5NqFgoA0nIuHocyUdZSIJrqJI+LBSHMjL0ioG0NIqk5FIclSeAWlBJYpkLcLKNsjgpJ6JSOTGlRiGK7TExksibHEyLU7QZ6KuJxzVW6M9efZzEsf8t1tAvx1dphn4Kk3J+7xSavVMRCI1OjBTyVqgtUqmDZfjT57N1/tptkwwsY6ZD7IN3hN0qKBt+j8tOXn7iz0VddTv1Xl42ugkPjk9Oo6P4m9vjl8lZ98lL1+N4jj+Q0RiWSq27TcVA7HfIIPavtd7sHbPhsBupWbw2SEar01JoZB6Bgsmc+GMnkVgFaEnCG4FOEOpQWEg9x+ySs4Z9zQ7/y6zelC11EpquuvP0N1ZHN8db0g4e+IsaRMgN5XOvm6ph+I/XdDZ3emmoJf7BV3pOSqZNSJ0Y+5Jf916huFDG37/tMoW1HwXO8UO19siPaWVk2HVKN3yCK08ar8ntxOWCz4pZquSjTqGQiRi3GvaeD1QxlqwSzfvtbNySiSiCMH6ZDxGa0fGkvZyphVO/Sg15RitHM+PRR09RHvU2dQsH7eYbNO/ZopbFneK2HCJVr6hlYh6joaoTs0Lwoxcw6fUuWmMO+beWdLXcqYb3ufHe5r/gVRqSmJ5DwVBD//7z78ai56g5lg8g3eVA2sW5PJKAeoMckVLOVV0YLR5wlKR92oFUgeaOeRRKGcyoAJmhds4RYtTqSQfJIaZduYNzqIfwYeCQkGOP33jCBAympPi8wfKmHv2EwxgFUyJw3G7MO4+55QiQJhWXmryHjxRb0K6QJ0S9HsRgXGAGkgHctZJT4CyZHBuHFCey1SyY+4ah2mAEjXOiINFwHkzC7adoh6cmVY+gDeqagrhiCVRaEvURJkfwYWcU1t4M+spoFSUwaxiFxGkJiPomojL0BlMyQewHF6m1Dj1AV0ARXNyOGtKKwh45oE13N0SFY/y4d6yo+BQe56/3T2j25oNfdYZHp5NjAxXI/ioP2pWYKg88QFQUt/75KM+gtvNMftAUy8DTZ73vbBYLPb64MWuzWsZimoKjqzZ2s2axaZrhuablxciEoFc6d/l1+TmMqWuAR+JOW7A407zMG00j0qUqu2xHx8asP4omZL2NFCo89fv38IcTkexiAZd/wUJj99e/Xz56/Ul+2WVafvveBSPYl6yxocS9SBUd3u82F7vdlp3vRXv/+my2QlQoGUYW4WykeSm5nWnpbdicPlMhvfMSSQK4wND1uspevrdqbrm5c8VORbtSSTm6CROWadu1yKTnp+zzaXx0Wqf/9bdP1/AF19ZD9bSK6xmeZ2jqvhNROKeVg+uzfWkjnqZ5WRbxHmakg0D270ZujOILi7fXt5cikhgxeQNFf6+UfjugQMcTG1X+tsc+Jcn0EGD7/kQvKHVDxt4++VRg67EHs00Teq6/gcB9YOS",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Document",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,l.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(r.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(r.Z,{collapsible:!1,name:"deletedAt",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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(r.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(r.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(r.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.5a92f5d2.js b/assets/js/5a2de241.5a92f5d2.js deleted file mode 100644 index 480f6cfab..000000000 --- a/assets/js/5a2de241.5a92f5d2.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});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),c=s(4667),o=s(9472),h=s(85162);const x={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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/update-template",title:"Update Template",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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",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={},g=[{value:"Request",id:"request",level:2}];function v(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)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.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,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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.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,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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.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)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.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 y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5a2de241.6f610eff.js b/assets/js/5a2de241.6f610eff.js new file mode 100644 index 000000000..b83778015 --- /dev/null +++ b/assets/js/5a2de241.6f610eff.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:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),d=(s(62316),s(51039)),n=s.n(d),m=(s(82723),s(9487)),r=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/itXflkLKLaTpi0mDMO6tmiDFmvQpCiwxAhO0slmQ5EsSdkxDH3bL9lP2y8ZjpJsxUnTdui2L4FD3cvzHI/3kGsRcOZFeiZOqbIKA3kxTURBPnfSBmm0SMXpnOC9LTAQ9Fbw9PgISGOmyMPK1BAMVKaQ5QpQF1C31mFOUFBAqTyYEhC8pVyWMofQxRmJRBhLDjnVUSFS0br2eUQiLDqsKJBjmGuhsSKRij7AhSxEIiTDtBjmYhf70XPOzEB6DwhzDKCJCs+oM+rQchxHn2rpqBBpcDUlwoeV4mxeVlYxGLqyyhQk0hKVZ4N8ThWKdC3CykbL4KSeiUSUxlUYtitNM23jkw+/mmLFPtehHjuzkAVBRsosYUObQfb17PcI7mMARegDGE0D257AA5GI3OhAOnAitFbJPBZ5/NFztvVN6Cb7SHngijvekiDJ89e24F8myMXBWKZU+Phjg1c0idAmfHOYY6ZI4GghaRkby8uZhjCXHgqT1xXTa3a2/NtSbLpiGKNhH1WQ4468GW/rLZomEUGGa6EuBr15kfFWNw3bOfLWaN9W9WAyudkBm9PVdST4Os/J+7JWanXv+21pu/wlcuiLg1f++PCV5YJ0kJ6Gu50OJgcP9/Yne5Mnp/uP08Mf00ePR5PJ5HeRiKtKbftJFF1f9NVr/x8sSK2kpou+ahcHk8nFw66Uh7dVr+sW2x2jBSpZQClJFcA5/XcsIDln3D/s5jvw3UWfKffkD+9oHW0ClKbWxf9N9zZEdxM8vHiyofjoJsUj3ZaMpefUXJL+Lxhu+QzThzY9Q73e1bI1it/FNbLD9Zakp7x2MqyirF3toZV77ff0bMpiUVGYG5ZEW0fALG+pGPfTZbwezJlGcDy36FWydkqkYh6C9el4jNaOjCXN01Nh5ke5qcZo5XixL5pk19qjLjJz9XmP6Rb7Cde3LeE1BptCopWvaSWSvkBDq06354QFuVhM3rZ3W4180Rd/U99dYel15eukYvdycOvwH85+wXsodWkio24v31rSJxycO2GxfyPqB1K5qYh1m+8dvflff/wZPXo0sVHvwdvagTVLcmWtIu5S0ZXMVHvFQqXMcnPD8oSVIu/VCqQONHMRu5zJgCrylXoGOVrMpJLc2mxm2NvB4HT4EXyYU5iT408/OAKEghak+ESAMuaS4wQDWAdTxRwdZlgad1kypAQQstpLTd6DJ+pdSM9R5wR9gyRgHKAG0oGcddIToKzYuDQOqCxlLjkwn2OHeYAKNc6IkyXAuLkK3cj04ExW+wDeqDoSiddOotBSjHe6ETyXC2qJ82J7/6QCZjWHSCA3BUF3rJmGLiAjH8ByeplTDOoDOr5hLcjhLFKbE7AMgzU8byQqvlcO95YDBYfa81BsAfVbsymfdYb1POYocDWCc32uT7hZak/cAErqS5+e6z0427TZB8q8DDS93x/Q5XJ543A+uO7zUoZ5nYEja7Z+s7gYj/LQffMPXxoDucq/LU/ILWRO3VT4TM5xNB53UxjzOIWpQqnag//LrgOfJiVz0n54pp++PH4DC3g4mohkMIq+AvD4zdGzF7+dvOC4PPra87c/mowmvGSNDxXqQaqdV8zu0V1v5eTffvR04zHQVRhbhTKqRSS/7ib9mRhMuXT43pkmYm58YJP1OkNP751qGl7+VJNjPZkmYoFOMtIoB4X0/LvYvFs+S/v+u/4FAd/2dLqVUC8CmhVggaqOl+ZEXNJq5w3XTJukVwJG3Fo8a3HtnXKcbYQbSs8i1no8zXOy4U7bobQevz8Vici691gVn3bC4ZLfgrgUqTgX5yK+UeO8YaO4vhYK9azGGdu3YVm/sOadG4rfZRS/7gcTu7Uk11WxZcJ/mdetDj9xK76m1c8b8/bLZx260vbWvD3Tpmn+BliFk6k=",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/itXflkLKLaTpi0mDMO6tmiDFmvQpCiwxAhO0slmQ5EsSdkxDH3bL9lP2y8ZjpJsxUnTdui2L4FD3cvzHI/3kGsRcOZFeiZOqbIKA3kxTURBPnfSBmm0SMXpnOC9LTAQ9Fbw9PgISGOmyMPK1BAMVKaQ5QpQF1C31mFOUFBAqTyYEhC8pVyWMofQxRmJRBhLDjnVUSFS0br2eUQiLDqsKJBjmGuhsSKRij7AhSxEIiTDtBjmYhf70XPOzEB6DwhzDKCJCs+oM+rQchxHn2rpqBBpcDUlwoeV4mxeVlYxGLqyyhQk0hKVZ4N8ThWKdC3CykbL4KSeiUSUxlUYtitNM23jkw+/mmLFPtehHjuzkAVBRsosYUObQfb17PcI7mMARegDGE0D257AA5GI3OhAOnAitFbJPBZ5/NFztvVN6Cb7SHngijvekiDJ89e24F8myMXBWKZU+Phjg1c0idAmfHOYY6ZI4GghaRkby8uZhjCXHgqT1xXTa3a2/NtSbLpiGKNhH1WQ4468GW/rLZomEUGGa6EuBr15kfFWNw3bOfLWaN9W9WAyudkBm9PVdST4Os/J+7JWanXv+21pu/wlcuiLg1f++PCV5YJ0kJ6Gu50OJgcP9/Yne5Mnp/uP08Mf00ePR5PJ5HeRiKtKbftJFF1f9NVr/x8sSK2kpou+ahcHk8nFw66Uh7dVr+sW2x2jBSpZQClJFcA5/XcsIDln3D/s5jvw3UWfKffkD+9oHW0ClKbWxf9N9zZEdxM8vHiyofjoJsUj3ZaMpefUXJL+Lxhu+QzThzY9Q73e1bI1it/FNbLD9Zakp7x2MqyirF3toZV77ff0bMpiUVGYG5ZEW0fALG+pGPfTZbwezJlGcDy36FWydkqkYh6C9el4jNaOjCXN01Nh5ke5qcZo5XixL5pk19qjLjJz9XmP6Rb7Cde3LeE1BptCopWvaSWSvkBDq06354QFuVhM3rZ3W4180Rd/U99dYel15eukYvdycOvwH85+wXsodWkio24v31rSJxycO2GxfyPqB1K5qYh1m+8dvflff/wZPXo0sVHvwdvagTVLcmWtIu5S0ZXMVHvFQqXMcnPD8oSVIu/VCqQONHMRu5zJgCrylXoGOVrMpJLc2mxm2NvB4HT4EXyYU5iT408/OAKEghak+ESAMuaS4wQDWAdTxRwdZlgad1kypAQQstpLTd6DJ+pdSM9R5wR9gyRgHKAG0oGcddIToKzYuDQOqCxlLjkwn2OHeYAKNc6IkyXAuLkK3cj04ExW+wDeqDoSiddOotBSjHe6ETyXC2qJ82J7/6QCZjWHSCA3BUF3rJmGLiAjH8ByeplTDOoDOr5hLcjhLFKbE7AMgzU8byQqvlcO95YDBYfa81BsAfVbsymfdYb1POYocDWCc32uT7hZak/cAErqS5+e6z0427TZB8q8DDS93x/Q5XJ543A+uO7zUoZ5nYEja7Z+s7gYj/LQffMPXxoDucq/LU/ILWRO3VT4TM5xNB53UxjzOIWpQqnag//LrgOfJiVz0n54pp++PH4DC3g4mohkMIq+AvD4zdGzF7+dvOC4PPra87c/mowmvGSNDxXqQaqdV8zu0V1v5eTffvR04zHQVRhbhTKqRSS/7ib9mRhMuXT43pkmYm58YJP1OkNP751qGl7+VJNjPZkmYoFOMtIoB4X0/LvYvFs+S/v+u/4FAd/2dLqVUC8CmhVggaqOl+ZEXNJq5w3XTJukVwJG3Fo8a3HtnXKcbYQbSs8i1no8zXOy4U7bobQevz8Vici691gVn3bC4ZLfgrgUqTgX5yK+UeO8YaO4vhYK9azGGdu3YVm/sOadG4rfZRS/7gcTu7Uk11WxZcJ/mdetDj9xK76m1c8b8/bLZx260vbWvD3Tpmn+BliFk6k=",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={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(n(),{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)(r.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)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},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",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.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 b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.a3248228.js b/assets/js/5c04ee3b.a3248228.js deleted file mode 100644 index 59ab84783..000000000 --- a/assets/js/5c04ee3b.a3248228.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>b,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var l=a(85893),n=a(11151),o=a(58219),i=(a(62316),a(51039)),r=a.n(i),t=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},b={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(o.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.e37eecda.js b/assets/js/5c04ee3b.e37eecda.js new file mode 100644 index 000000000..ee9af1b3c --- /dev/null +++ b/assets/js/5c04ee3b.e37eecda.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>b});var l=a(85893),o=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),n=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),h=a(9472),m=a(85162);const p={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLKLaz3aKAURS7aIMg2EWzgLPIg2MEI2kkcU2RLEn5AkNv/ZJ+Wr+kGEpyZKdZFEXRF1+Gc2bmDGcODyJg6cV8Ke4prYxZi1UicvKZkzZIo8Vc3FUE1xSgd4D3n24AlTJb2JsGgoGSAmz7w8YpkQhjySHDb3IxFyWFIXgiHHlrtCcv5gfxZjbjr9N8iybLyPuiUXCMIxKRGR1IB/ZHa5XM4sH0i2fQQfisohr5V9hbEnNh0i+UBZEI6zhMkF3KvtCRow9O6lIkgnZYW8WmKgTr59Pp3jTuokdcNE69610mmalF2yYiyBABUiup6XEg9/hmNnv8QbQt+7ydvX1O8rMnB9oEKEyj81f/HT9yzrivszvP/TUiXPxA4/vnNG70BpXM40zcmTXp/5fJOH3o0nOpu1oxTmPdUYpO8VycUB3bO5KessbJsBfz5UHsLtDKi+58vly1q0TUFCrTzzQXjKESczHdHsfbk9uQ8xHPu/A0S2jtxFjSXpZaYep5hqZo5XRzKdrk3NujzlOzexmxeip2wQ3tenZS8rFzaOUH2otk6MjYKxGSL7IizMnF7kldmAju+3RrSS9kqWOXN5fiXB/uSWWmJlaCUBEM7n/+/kdE5CZratIhDsEruG0cWLMlx/uNOodC0U6mip50xQ/C4glrRd6rPUgdqHQYCHJZyoAKuCtSl5ChxVQqyWPDbobRDkaT5ydwX1GoyPHRN44AIacNKZ42UMasOU4wgE0wdczR1wxb49YFl5QAQtp4qcl78EQDhHSFOiMY7iIB4wA1kA7krJOeAGXNzoVxQEUhM8mBeUccZgFq1FgSJ0uA6+YuWGc2MicPzqSND+CNaiIRzlgThY6iJsr9BH6RG+qIszGngFJRDmXDIRLITE7QrwzT0Dmk5ANYTi8zikF9QBdA0YYclpFaRVA0SoE1vMsSFZji5G45UHCofWFc3RU0XM2xfdYZlvKYI8f9BB70g17wsDSeeACU1Gs/f9AXsDyO2T2lXgZafTvswna7fbYHr08x1zJUTQqOrHnCldEYt2YMP/55LRIRyNX+tliQ28hskP4Xck6j87RXOMyiwlGNUnU79u4cwGqjZEba00iP3l9/+ggb+G4yE8lo6/9BwdOPNz9f/bq44risMt3+XU5mkxmbrPGhRj1KNXq2z9f28CTT/+aF75Ul0C5MrUIZlTWSOfSquDw+tatEVMYHNh0OKXr67FTbsvm3hhxr7SoRG3QSUxac5apNBj1iGV3TnruWZWRZczeomk7Uzp6WE32+vroTicCGKxnr4DrqYP+Dow9Hej+KfSqQXQH8yTr9t4AfuWUfaP/T0b07eRHQ8xu8uX+rtm3/AqHFWJc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLKLaz3aKAURS7aIMg2EWzgLPIg2MEI2kkcU2RLEn5AkNv/ZJ+Wr+kGEpyZKdZFEXRF1+Gc2bmDGcODyJg6cV8Ke4prYxZi1UicvKZkzZIo8Vc3FUE1xSgd4D3n24AlTJb2JsGgoGSAmz7w8YpkQhjySHDb3IxFyWFIXgiHHlrtCcv5gfxZjbjr9N8iybLyPuiUXCMIxKRGR1IB/ZHa5XM4sH0i2fQQfisohr5V9hbEnNh0i+UBZEI6zhMkF3KvtCRow9O6lIkgnZYW8WmKgTr59Pp3jTuokdcNE69610mmalF2yYiyBABUiup6XEg9/hmNnv8QbQt+7ydvX1O8rMnB9oEKEyj81f/HT9yzrivszvP/TUiXPxA4/vnNG70BpXM40zcmTXp/5fJOH3o0nOpu1oxTmPdUYpO8VycUB3bO5KessbJsBfz5UHsLtDKi+58vly1q0TUFCrTzzQXjKESczHdHsfbk9uQ8xHPu/A0S2jtxFjSXpZaYep5hqZo5XRzKdrk3NujzlOzexmxeip2wQ3tenZS8rFzaOUH2otk6MjYKxGSL7IizMnF7kldmAju+3RrSS9kqWOXN5fiXB/uSWWmJlaCUBEM7n/+/kdE5CZratIhDsEruG0cWLMlx/uNOodC0U6mip50xQ/C4glrRd6rPUgdqHQYCHJZyoAKuCtSl5ChxVQqyWPDbobRDkaT5ydwX1GoyPHRN44AIacNKZ42UMasOU4wgE0wdczR1wxb49YFl5QAQtp4qcl78EQDhHSFOiMY7iIB4wA1kA7krJOeAGXNzoVxQEUhM8mBeUccZgFq1FgSJ0uA6+YuWGc2MicPzqSND+CNaiIRzlgThY6iJsr9BH6RG+qIszGngFJRDmXDIRLITE7QrwzT0Dmk5ANYTi8zikF9QBdA0YYclpFaRVA0SoE1vMsSFZji5G45UHCofWFc3RU0XM2xfdYZlvKYI8f9BB70g17wsDSeeACU1Gs/f9AXsDyO2T2lXgZafTvswna7fbYHr08x1zJUTQqOrHnCldEYt2YMP/55LRIRyNX+tliQ28hskP4Xck6j87RXOMyiwlGNUnU79u4cwGqjZEba00iP3l9/+ggb+G4yE8lo6/9BwdOPNz9f/bq44risMt3+XU5mkxmbrPGhRj1KNXq2z9f28CTT/+aF75Ul0C5MrUIZlTWSOfSquDw+tatEVMYHNh0OKXr67FTbsvm3hhxr7SoRG3QSUxac5apNBj1iGV3TnruWZWRZczeomk7Uzp6WE32+vroTicCGKxnr4DrqYP+Dow9Hej+KfSqQXQH8yTr9t4AfuWUfaP/T0b07eRHQ8xu8uX+rtm3/AqHFWJc=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},j={},b=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(n.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(n.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(n.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.3a3ae921.js b/assets/js/5ce9853b.3a3ae921.js new file mode 100644 index 000000000..ce531ed55 --- /dev/null +++ b/assets/js/5ce9853b.3a3ae921.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>f,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9uO2zYQ/ZUJX9oAWtubbl+Eoki6CYJFgm6QTZGHXcOgpLHELEUyvPgCQ2/9kn5av6QY6mJ57Vzaou1DXwyZnOsh58xwxzwvHUtv2XOdhxqVd2yesAJdboXxQiuWsrfoUBVg8WNA56HmQoLXEBxaWGoLTpRKqBKKzsTkTrGEaYOWk4WrYrDRmSALLGHdv590sWXpjuVaeVSePrkxUuRRe/rBURA75vIKa05fpCcsFhR273MhCpYwjJbnCfNbgyxlOvuAuWcJM5bC8QIdGRgrpbte2HkrVElWNrw2kpaM1StR4JAZiII1vZsTmoe49doRqIja0uo6woXWEYQWz46gbdHbx0DaT7u/k1zXQwALF9r0vhjIZXC+c8x9sDj4i3agswNCgceNn1a+lnSwNfcTuOQKhMplKBCWWkq9pqNecSt4JtEB7HYDnF54iU0Dux1lhXaheI1Nk+wXyN/Bgqm06kQs5ihWB1rDEu4Vh7WRKm6MsNtFwX23kOvacLUdB9Be0kWwsmkmBwjvEc26q/i34CQj/2Msm4TF2FnKbCz6PbINbe6r19uAccEZrVxbmk9ms1ihB4Cz5OvJ4fOVb9EFebJi2jM6TQNtlVD9u5Dn6NwySLmdHOQqlBQKF30yiyez2eJ8Rik3Cbv4Z7NCa7X9s0nd6Bp9RRdwTZmtrVbl51O6mM0WT4aMLo4zOtsTpdIeljqoAsRyTJ8gXNzLtbWYU6s4a/nxQKFjzqLdasuqUzTxUkWyaokUpHAe9N5L5M//EtkTIGj7IMsvIX2xOB+Q/v4Y6Su14lIU8OzNFbzT96ge/Qs57zMcu/etewp1U8euSEQRk4pCcZ8dJDteb5N0mAcr/Jaltzu2OeNGnLX76e28mSeMrqqmOcJoFyPmvmIpm+4ZhpERu0Lroo1gJUtZ5b1x6XTKjZlog4pujOSZoz465UZMV+esSR5KO66KTG8+rTHfB3xDoLa4HYQ9oMeNeIVblvSojKUSJugwK+QF2oggndXb/Vj0okf8wcxycjAZ5pLjkeFoYmDssOXFHijUUsfIu4O6NqhuRKniMa/Oj/rge5S5rpEGGV8h9OK///pb1Ohji7fwEVwHC0av0S6DBK4KWErciExiFObUDR1sdSBzDnkt0TlJjdRjablHKEQpPJfDuJlzwzMhBd1bEtOkbWF09d0E3lfoK7S09Y1F4FDgCiVdd5Ba35Mdr4EHr+voo8dzre39kkJKgEMWnFDoHDjEXgVVxVWO0F+EhGqcK0Dl0RorHAIXNQnTiIzLpcgFGaYitTynWU/xEslZAhQ3odAdqwOrs+A8OC1DTIQ81oi+TVEhFm4Cz8UK28RpsUDPhcQCykAmEsh1gdDdAkpDFZDRlGLIvcgxGnWeWw8SV2h5GVOrEKi9gdFEJoJL4tbx2ZIhb7lyxIFtQP3RDPAZq6lPRh8F307gTt0p6jhEg3QBpFD3LiX2vx2u2XvMnPA4/7YvxPV6fVSEjw91XgpfhQwsGr3XK+NiLNmx+vDnMUuYR1u76+UN2pXIsav+T/icRuFpR7G8Hbn7YuNGPH2oQNUkRY7K4YgQn7188xpW8N1kxpIR5XxFwNPXV5cvfr55QXaJ4tr6O5/MJjNaIlKsuRq5OvFke1i+owfXX3zhdQwX51wjuYgsH/PadQR9OxoB6VlWEXunt2y3y7jDX2h8pOWPAS1R/zxh/TAciT/pqZEY/R6Jpy7bmM/ekW8Sl6Fl2Qf9jli91XiW52j8Z2XHDebN9c07lrD+JVDrIk6yfE0PVr5mKbtjdyy+b2NlxqmS1ndMclUGXpJ8a5cYnQcCYtwO7mM76D4os35LbUdRHvaJNhX6pcROKvxABPIKtz8O4u3OJxU6bHtpOr550zR/ALcouU8=",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/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9uO2zYQ/ZUJX9oAWtubbl+Eoki6CYJFgm6QTZGHXcOgpLHELEUyvPgCQ2/9kn5av6QY6mJ57Vzaou1DXwyZnOsh58xwxzwvHUtv2XOdhxqVd2yesAJdboXxQiuWsrfoUBVg8WNA56HmQoLXEBxaWGoLTpRKqBKKzsTkTrGEaYOWk4WrYrDRmSALLGHdv590sWXpjuVaeVSePrkxUuRRe/rBURA75vIKa05fpCcsFhR273MhCpYwjJbnCfNbgyxlOvuAuWcJM5bC8QIdGRgrpbte2HkrVElWNrw2kpaM1StR4JAZiII1vZsTmoe49doRqIja0uo6woXWEYQWz46gbdHbx0DaT7u/k1zXQwALF9r0vhjIZXC+c8x9sDj4i3agswNCgceNn1a+lnSwNfcTuOQKhMplKBCWWkq9pqNecSt4JtEB7HYDnF54iU0Dux1lhXaheI1Nk+wXyN/Bgqm06kQs5ihWB1rDEu4Vh7WRKm6MsNtFwX23kOvacLUdB9Be0kWwsmkmBwjvEc26q/i34CQj/2Msm4TF2FnKbCz6PbINbe6r19uAccEZrVxbmk9ms1ihB4Cz5OvJ4fOVb9EFebJi2jM6TQNtlVD9u5Dn6NwySLmdHOQqlBQKF30yiyez2eJ8Rik3Cbv4Z7NCa7X9s0nd6Bp9RRdwTZmtrVbl51O6mM0WT4aMLo4zOtsTpdIeljqoAsRyTJ8gXNzLtbWYU6s4a/nxQKFjzqLdasuqUzTxUkWyaokUpHAe9N5L5M//EtkTIGj7IMsvIX2xOB+Q/v4Y6Su14lIU8OzNFbzT96ge/Qs57zMcu/etewp1U8euSEQRk4pCcZ8dJDteb5N0mAcr/Jaltzu2OeNGnLX76e28mSeMrqqmOcJoFyPmvmIpm+4ZhpERu0Lroo1gJUtZ5b1x6XTKjZlog4pujOSZoz465UZMV+esSR5KO66KTG8+rTHfB3xDoLa4HYQ9oMeNeIVblvSojKUSJugwK+QF2oggndXb/Vj0okf8wcxycjAZ5pLjkeFoYmDssOXFHijUUsfIu4O6NqhuRKniMa/Oj/rge5S5rpEGGV8h9OK///pb1Ohji7fwEVwHC0av0S6DBK4KWErciExiFObUDR1sdSBzDnkt0TlJjdRjablHKEQpPJfDuJlzwzMhBd1bEtOkbWF09d0E3lfoK7S09Y1F4FDgCiVdd5Ba35Mdr4EHr+voo8dzre39kkJKgEMWnFDoHDjEXgVVxVWO0F+EhGqcK0Dl0RorHAIXNQnTiIzLpcgFGaYitTynWU/xEslZAhQ3odAdqwOrs+A8OC1DTIQ81oi+TVEhFm4Cz8UK28RpsUDPhcQCykAmEsh1gdDdAkpDFZDRlGLIvcgxGnWeWw8SV2h5GVOrEKi9gdFEJoJL4tbx2ZIhb7lyxIFtQP3RDPAZq6lPRh8F307gTt0p6jhEg3QBpFD3LiX2vx2u2XvMnPA4/7YvxPV6fVSEjw91XgpfhQwsGr3XK+NiLNmx+vDnMUuYR1u76+UN2pXIsav+T/icRuFpR7G8Hbn7YuNGPH2oQNUkRY7K4YgQn7188xpW8N1kxpIR5XxFwNPXV5cvfr55QXaJ4tr6O5/MJjNaIlKsuRq5OvFke1i+owfXX3zhdQwX51wjuYgsH/PadQR9OxoB6VlWEXunt2y3y7jDX2h8pOWPAS1R/zxh/TAciT/pqZEY/R6Jpy7bmM/ekW8Sl6Fl2Qf9jli91XiW52j8Z2XHDebN9c07lrD+JVDrIk6yfE0PVr5mKbtjdyy+b2NlxqmS1ndMclUGXpJ8a5cYnQcCYtwO7mM76D4os35LbUdRHvaJNhX6pcROKvxABPIKtz8O4u3OJxU6bHtpOr550zR/ALcouU8=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Resend request mail"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,l.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.969e89e9.js b/assets/js/5ce9853b.969e89e9.js deleted file mode 100644 index f3c49b2da..000000000 --- a/assets/js/5ce9853b.969e89e9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT92VRFHEdIzAS1EacIg+2IFC7oxVjLsnwIllY7Fu/pJ/WLymGe9HKUpy0RduHvhgyOdfDmTOzFfO8cCy9Za90FkpU3rFZwnJ0mRXGC61Yyt6hQ5WDxU8BnYeSCwleQ3BoYaktOFEooQrIWxPjO8USpg1aThYu895Ga4IssIS1//2k8y1LK5Zp5VF5+smNkSKL2pOPjoKomMtWWHL6RXrCYk5hdz7nImcJw2h5ljC/NchSphcfMfMsYcZSOF6gIwNDpbTqhJ23QhVk5YGXRtKRsXotcuwzA5GzunNzRHMft047AhVRW1pdRrjQOoLQ4ugA2ga9XQyk/bL9d5zpsg9g7kKT3hcDOQ/Ot465DxZ7f9EOtHZAKPD44CcrX0p62JL7MZxzBUJlMuQISy2l3tBTr7kVfCHRAVRVD6cXXmJdQ1VRVmjnipdY18nugPztHZiVVq2IxQzFek+rP8KdYn82UMUHI+x2nnPfHmS6NFxthwE0RToPVtb1eA/hHaKLthT/Fpxk5H+MZZ2wGDtLmY1Nv0O2pstd93obMB44o5VrWvPFdBo7dA9wlnw9OTzd+RZdkEc7pnmj4zTQdAn1vwtZhs4tg5Tb8V6uQkmhcN4lM38xnc5PppRynbDTfzYrtFbbP5vUjS7Rr6gAN5TZxmpVPJ3S6XQ6f9FndHqY0WhHlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjnkLLnHlz1bRVq2hiUUWyaogUpHAe9M5L5M//EtkjIGj7KMsvIX06P+mR/v4Q6Uu15lLkcHZ9Ce/1Papn/0LOuwyH7n3jnkJ9KONUJKKISUWheM/2kh2eN0k6zIIVfsvS24o9jLgRo+Y+vZ3Vs4RRqWraI4x2MWLuVyxlkx3DMDJi12hdtBGsZClbeW9cOplwY8baoKKKkXzhaI5OuBGT9Qmrk8fSzvNCqGL0pNZsF/QNAdtgtxd6jyA34g1uWdIhM5RKmKAHXSHP0UYU6b3e7Vajiw71R3vL0eWk300O14aDrYGx/bEX56BQSx0jbx/ryqC6EYWKT70+OZiFH1BmukRaZvwKoRP//dffokYXW6zEZ3AVLBi9QbsMErjKYSnxQSwkRmFOE9HBVgcy55CXEp2TNEw9FpZ7hFwUwnPZr5wZN3whpKDaJTFN2hYG5e/G8GGFfoWWrr6xCBxyXKOkkgep9T3Z8Rp48LqMPjo8N9reLymkBDgsghMKnQOH2KmgWnGVIXSFkFCfcwWoPFpjhUPgoiRhWpNxuRSZIMPUqJZntO8pXiA5S4DiJhTaZ3Vg9SI4D07LEBMhjyWib1JUiLkbwyuxxiZxOszRcyExhyKQiQQynSO0VUBpqBwWtKkYci8yjEad59aDxDXaWPjxJWnEgdFEKIJL4tfh25Ihb7lyxINNQN3T9PAZq2lWRh85347hTt0pmjpEhVQAUqh7l9IEuO3L7AMunPA4+7Zrxs1mc9CEz/d1Xgu/CguwaPROr4iHsWWH6v0/z1nCPNrSXS1v0K5Fhi0DfMbnJApPWprlzdrdNRs34uVjBeomKTJUDgekePb6+i2s4bvxlCUD2vmKgCdvL88vfr65ILtEc03/nYyn4ykdETGWXA1cHflse9y+g4+uv/iV1zJc3HWN5CIyfcyrakn6drAG0qfZihg8vWVVteAOf6EVko4/BbRE/7OEdQtxJP+ko0Zi9XsknjpvYh69J98kLkPDso9mHjF7o3GWZWj8k7LDIXN9dfOeJaz7Gih1HrdZvqGPVr5hKbtjdyx+48bOjJslnVdMclUEXpB8Y5cYnQcCYjgO7uM4aH9QZt2V2g6i3J8TTSr0lxI7qvADEcgb3P7Yizc3n1Vose2k6flmdV3/Ab3Xurs=",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/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT92VRFHEdIzAS1EacIg+2IFC7oxVjLsnwIllY7Fu/pJ/WLymGe9HKUpy0RduHvhgyOdfDmTOzFfO8cCy9Za90FkpU3rFZwnJ0mRXGC61Yyt6hQ5WDxU8BnYeSCwleQ3BoYaktOFEooQrIWxPjO8USpg1aThYu895Ga4IssIS1//2k8y1LK5Zp5VF5+smNkSKL2pOPjoKomMtWWHL6RXrCYk5hdz7nImcJw2h5ljC/NchSphcfMfMsYcZSOF6gIwNDpbTqhJ23QhVk5YGXRtKRsXotcuwzA5GzunNzRHMft047AhVRW1pdRrjQOoLQ4ugA2ga9XQyk/bL9d5zpsg9g7kKT3hcDOQ/Ot465DxZ7f9EOtHZAKPD44CcrX0p62JL7MZxzBUJlMuQISy2l3tBTr7kVfCHRAVRVD6cXXmJdQ1VRVmjnipdY18nugPztHZiVVq2IxQzFek+rP8KdYn82UMUHI+x2nnPfHmS6NFxthwE0RToPVtb1eA/hHaKLthT/Fpxk5H+MZZ2wGDtLmY1Nv0O2pstd93obMB44o5VrWvPFdBo7dA9wlnw9OTzd+RZdkEc7pnmj4zTQdAn1vwtZhs4tg5Tb8V6uQkmhcN4lM38xnc5PppRynbDTfzYrtFbbP5vUjS7Rr6gAN5TZxmpVPJ3S6XQ6f9FndHqY0WhHlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjnkLLnHlz1bRVq2hiUUWyaogUpHAe9M5L5M//EtkjIGj7KMsvIX06P+mR/v4Q6Uu15lLkcHZ9Ce/1Papn/0LOuwyH7n3jnkJ9KONUJKKISUWheM/2kh2eN0k6zIIVfsvS24o9jLgRo+Y+vZ3Vs4RRqWraI4x2MWLuVyxlkx3DMDJi12hdtBGsZClbeW9cOplwY8baoKKKkXzhaI5OuBGT9Qmrk8fSzvNCqGL0pNZsF/QNAdtgtxd6jyA34g1uWdIhM5RKmKAHXSHP0UYU6b3e7Vajiw71R3vL0eWk300O14aDrYGx/bEX56BQSx0jbx/ryqC6EYWKT70+OZiFH1BmukRaZvwKoRP//dffokYXW6zEZ3AVLBi9QbsMErjKYSnxQSwkRmFOE9HBVgcy55CXEp2TNEw9FpZ7hFwUwnPZr5wZN3whpKDaJTFN2hYG5e/G8GGFfoWWrr6xCBxyXKOkkgep9T3Z8Rp48LqMPjo8N9reLymkBDgsghMKnQOH2KmgWnGVIXSFkFCfcwWoPFpjhUPgoiRhWpNxuRSZIMPUqJZntO8pXiA5S4DiJhTaZ3Vg9SI4D07LEBMhjyWib1JUiLkbwyuxxiZxOszRcyExhyKQiQQynSO0VUBpqBwWtKkYci8yjEad59aDxDXaWPjxJWnEgdFEKIJL4tfh25Ihb7lyxINNQN3T9PAZq2lWRh85347hTt0pmjpEhVQAUqh7l9IEuO3L7AMunPA4+7Zrxs1mc9CEz/d1Xgu/CguwaPROr4iHsWWH6v0/z1nCPNrSXS1v0K5Fhi0DfMbnJApPWprlzdrdNRs34uVjBeomKTJUDgekePb6+i2s4bvxlCUD2vmKgCdvL88vfr65ILtEc03/nYyn4ykdETGWXA1cHflse9y+g4+uv/iV1zJc3HWN5CIyfcyrakn6drAG0qfZihg8vWVVteAOf6EVko4/BbRE/7OEdQtxJP+ko0Zi9XsknjpvYh69J98kLkPDso9mHjF7o3GWZWj8k7LDIXN9dfOeJaz7Gih1HrdZvqGPVr5hKbtjdyx+48bOjJslnVdMclUEXpB8Y5cYnQcCYjgO7uM4aH9QZt2V2g6i3J8TTSr0lxI7qvADEcgb3P7Yizc3n1Vose2k6flmdV3/Ab3Xurs=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",li:"li",p:"p",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:"Resend request mail"})}),"\n",(0,n.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,n.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})}),(0,n.jsx)("strong",{className:"openapi-schema__required",children:(0,n.jsx)(s.p,{children:"required"})})]}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.ad06079f.js b/assets/js/70853c19.caa20f8c.js similarity index 69% rename from assets/js/70853c19.ad06079f.js rename to assets/js/70853c19.caa20f8c.js index 5768886e5..30190e2e2 100644 --- a/assets/js/70853c19.ad06079f.js +++ b/assets/js/70853c19.caa20f8c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),o=n.n(r),t=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd6RlzSU3JFeyIOitX9JP65cUQ+5Kq7WjpIjrooD8YEnkGXJmeDgkz5I5PrWse82ucJxqfctGEUvQxkbkTmjFuuwiRbB8hqANFHnCHUKJhePzPnAp9RwWugCnA25e9hZGwjwVcQrCQmExIYQzYjpFAzhD5exQPX/+vPzeHaqhOmzBixczgXNMui9eDBUAwAFcpajAiqlCA6ETEh0XGSoHLhU2jABzIWU1QSvYvn//PnxZhg/6GzIPH7IuDFkYbsiiev9ESAzdr89eXZ70Ti9uLt+9bYAUz5qg0+OTXhOlXYk6l8gtgkGaErhKfETB/yqahnFtIcIYjf6QEkt915v2rWCbvg76b0577+57WiYm40JuAXsnx/23DyDzVKvtIc9/PTvtDVkduNr8GG05HrL+y+ITU1XA43KxLvonvcHF8cl5AxUb5O5BWIVaDdVLolaJbHJrzSZhoYR8KbHKYfbMelpmfRYVPFR9R4Twge7kQ0DAeFFVoC8kRhivkW89/h1j10+GrFtb9f7retR79jwae2pmo3uOf3G5WRG7jny50Vku8RMFZ0MwLmVJMvsJln1G/amm3legf4dDH61AVeIf5dTyUPU9kSnBWIpPFKsK83jlqhpxT6OnpVGV98+4JFXQRyEci5jO0XDKaD9hXUZ3+q/Cxb96I0TM4IcCrftFJwvWXTZeDOdGz0SC/gHgdHmhgo1xrJVD5ciQ57kUsZ+s/bsl6yWzcYoZp280izCY0Pvk0kh6m7hFjqxbnpcsYrkhb51ASwaFkfRRgqwzQk1ZxCbaZNzVW/CO0y5lXZY6l9tuu73QhTkony4HhZE/l5BWrDO2WkXMCecNSszNmGJfrajLoM21ssGHl53O/ZQMijhGayeFhHV2/0kmdodt0BbSPRT5Js7qzRZWMgG79kgunm0FKBSx6aYK6uZlp3PzQxnp0YPB6QxdKtQU5r7KGK2mEeRhMzuzAD7lQoHkDs2zx4sajdFmd9D/zLNdSTjqdG4O10k4vJ+Eq9qrl0uDPFkA3gnr7NOGvMuP3QEe3szXAR7dD/DSogGlHUx0oZKnDao59+5AjtZhfH8/jL6acSkSr11c6FtUTxtJfXoXpidX7zJfuOgQ8iF5kO9nW6HW20OQFuPCCLdg3esluzvguTgI/d3r0WoUMdoAmup4rq33mLuUdVl7vi7HFs0MjfUD+AK6rok8z1s6R0WHqORjS7WwzXPRnh2yVdREW8enQk0PdlqNNh4PKKshcVt+r9PHc/EbLlhUpaWOipig1UyRJ2h8Cmmx3m2OpV6V8qabuws9jTvR3oky6Wc5qgFdQ2jJZoesqY9doYx1hl7cShEq+F9//OktqnuLZ9QzOCsM5HqOho4CuuFMJN6JscSNmGbXahryTKK1cgFCOZwaOkYTMRWOh3cCFbaY53wspCAOEkyTtYEajW2L7okuRUNdXxsEDgnOUBJ1QWp9S+M4DbxwOvNzVDfKuTa3E3IpAg7jwgqF1oJFrExQpVzFCNWaRqQScgWoHJrcCIvARUbgiTaAk4mIBQ1MG87w2EHGFZ8iTRYB+U1ZyMP9wYLR48I6sFoWPhCaMUN0IUSFmNgWvBYzDIFTY4KOC4kJTAsaIoJYJwjlElMYKoExWgc5TS9i9INax40DiTM0nsN+JelohFxTYRBcgp5srS0N5AxXli4XwaFqadbpy42mM9bPkfBFC0jipDOJ5FAigBTqloTPA7he0+wKx1Y4HH1TEXY+n9/bT99u27wRLi3GYDDXG7upb/S7r26+/vEti5hDk9mzyQDNTMTVdegjc7Y9uF2WSx77cumvw2Gv/tw0oN0kRYzKYq24Hb85fwsz+K7VYVFta36Gw+23/Ve900GPxqWKFfbfYavT6lATFbiMq9pUg1K2vtySrZs7eLkp/3uxe/+S24vde7H7f8Ksvdi9Z89e7N6L3Xuxey92/69p9B+K3aXW4PDOtXPJhRdcSh05aCXXleRL+nNKKkr3mi2XY27x0sjVipo/FGhIghlFbMaN4GOSDq5Hq6hSKEhcucUF67JX4bFxcEETE1wWQexo6E4ksASL4zjG3O3E1oWe87PBBYvYuNTmM52QjeFz0u35nHUZEcfr/P5V7RVkal8yydW04FPCh3FJWOEFZaGuytx6Vab8QpFVXWpR83Jbrgmh0H8K7EGDH+mJ9RsuflrDQ89HDcrcVmhau9FqtfobnPcnwA==",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/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd6RlzSU3JFeyIOitX9JP65cUQ+5Kq7WjpIjrooD8YEnkGXJmeDgkz5I5PrWse82ucJxqfctGEUvQxkbkTmjFuuwiRbB8hqANFHnCHUKJhePzPnAp9RwWugCnA25e9hZGwjwVcQrCQmExIYQzYjpFAzhD5exQPX/+vPzeHaqhOmzBixczgXNMui9eDBUAwAFcpajAiqlCA6ETEh0XGSoHLhU2jABzIWU1QSvYvn//PnxZhg/6GzIPH7IuDFkYbsiiev9ESAzdr89eXZ70Ti9uLt+9bYAUz5qg0+OTXhOlXYk6l8gtgkGaErhKfETB/yqahnFtIcIYjf6QEkt915v2rWCbvg76b0577+57WiYm40JuAXsnx/23DyDzVKvtIc9/PTvtDVkduNr8GG05HrL+y+ITU1XA43KxLvonvcHF8cl5AxUb5O5BWIVaDdVLolaJbHJrzSZhoYR8KbHKYfbMelpmfRYVPFR9R4Twge7kQ0DAeFFVoC8kRhivkW89/h1j10+GrFtb9f7retR79jwae2pmo3uOf3G5WRG7jny50Vku8RMFZ0MwLmVJMvsJln1G/amm3legf4dDH61AVeIf5dTyUPU9kSnBWIpPFKsK83jlqhpxT6OnpVGV98+4JFXQRyEci5jO0XDKaD9hXUZ3+q/Cxb96I0TM4IcCrftFJwvWXTZeDOdGz0SC/gHgdHmhgo1xrJVD5ciQ57kUsZ+s/bsl6yWzcYoZp280izCY0Pvk0kh6m7hFjqxbnpcsYrkhb51ASwaFkfRRgqwzQk1ZxCbaZNzVW/CO0y5lXZY6l9tuu73QhTkony4HhZE/l5BWrDO2WkXMCecNSszNmGJfrajLoM21ssGHl53O/ZQMijhGayeFhHV2/0kmdodt0BbSPRT5Js7qzRZWMgG79kgunm0FKBSx6aYK6uZlp3PzQxnp0YPB6QxdKtQU5r7KGK2mEeRhMzuzAD7lQoHkDs2zx4sajdFmd9D/zLNdSTjqdG4O10k4vJ+Eq9qrl0uDPFkA3gnr7NOGvMuP3QEe3szXAR7dD/DSogGlHUx0oZKnDao59+5AjtZhfH8/jL6acSkSr11c6FtUTxtJfXoXpidX7zJfuOgQ8iF5kO9nW6HW20OQFuPCCLdg3esluzvguTgI/d3r0WoUMdoAmup4rq33mLuUdVl7vi7HFs0MjfUD+AK6rok8z1s6R0WHqORjS7WwzXPRnh2yVdREW8enQk0PdlqNNh4PKKshcVt+r9PHc/EbLlhUpaWOipig1UyRJ2h8Cmmx3m2OpV6V8qabuws9jTvR3oky6Wc5qgFdQ2jJZoesqY9doYx1hl7cShEq+F9//OktqnuLZ9QzOCsM5HqOho4CuuFMJN6JscSNmGbXahryTKK1cgFCOZwaOkYTMRWOh3cCFbaY53wspCAOEkyTtYEajW2L7okuRUNdXxsEDgnOUBJ1QWp9S+M4DbxwOvNzVDfKuTa3E3IpAg7jwgqF1oJFrExQpVzFCNWaRqQScgWoHJrcCIvARUbgiTaAk4mIBQ1MG87w2EHGFZ8iTRYB+U1ZyMP9wYLR48I6sFoWPhCaMUN0IUSFmNgWvBYzDIFTY4KOC4kJTAsaIoJYJwjlElMYKoExWgc5TS9i9INax40DiTM0nsN+JelohFxTYRBcgp5srS0N5AxXli4XwaFqadbpy42mM9bPkfBFC0jipDOJ5FAigBTqloTPA7he0+wKx1Y4HH1TEXY+n9/bT99u27wRLi3GYDDXG7upb/S7r26+/vEti5hDk9mzyQDNTMTVdegjc7Y9uF2WSx77cumvw2Gv/tw0oN0kRYzKYq24Hb85fwsz+K7VYVFta36Gw+23/Ve900GPxqWKFfbfYavT6lATFbiMq9pUg1K2vtySrZs7eLkp/3uxe/+S24vde7H7f8Ksvdi9Z89e7N6L3Xuxey92/69p9B+K3aXW4PDOtXPJhRdcSh05aCXXleRL+nNKKkr3mi2XY27x0sjVipo/FGhIghlFbMaN4GOSDq5Hq6hSKEhcucUF67JX4bFxcEETE1wWQexo6E4ksASL4zjG3O3E1oWe87PBBYvYuNTmM52QjeFz0u35nHUZEcfr/P5V7RVkal8yydW04FPCh3FJWOEFZaGuytx6Vab8QpFVXWpR83Jbrgmh0H8K7EGDH+mJ9RsuflrDQ89HDcrcVmhau9FqtfobnPcnwA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(o(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"created:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"signed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"completed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"declined:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>f,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),t=n.n(r),o=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFiURR1EyEVGl8Q2fCDJTjU7kjLmktuSK5kQdBbv6Sf1i8phtyVVrKjpIjrooD8YEnkGXLOcDgkz4I5PrEsvmZXOMq0vmXDiKVoEyMKJ7RiMbvIECyfImgDZZFyh1Bh4fi8B1xKPYO5LsHpgJtVvaWRMMtEkoGwUFpMCeGMmEzQAE5ROTtQz58/r77HAzVQhy148WIqcIZp/OLFQAEAHMBVhgqsmCg0EDoh1UmZo3LgMmHDCDATUtYTtILt+/fvw5dF+KC/AfPwAYthwMJwAxY1+8dCYuh+ffbq8qR7enFz+e7tFkjxfBt0enzS3UZpV6HOJXKLYJCmBK5Szyj4X7PZMm4sRBhjqz+ExFLf9bp9g+y2r/3em9Puu/ueVoHJuZAbwO7Jce/tA8gi02pzyPNfz067A9YELtc/hhuOh6j/Mv/EVDXwuFqsi95Jt39xfHK+hUoMcvcgrEYtB+olpVaF3M6tVTYJCxXkSxOrGmafWU+bWZ+VCh6qvqOE8ER35kNAwGheV6AvTIww3la89eh3TFwvHbC4seq9103W++x5tOxpmA3vOf7F5WZJ2XXky43OC4mfKDjrBONSVklmP5Fln1F/6qn3FejfyaGPVqA68I9yanmo+p6SKcVEik8UqxrzeOWqHnGfRk+bRnXcP+OSVEMfJeFYxHSBhlNEeymLGd3pvwoX//qNEDGDH0q07hedzlm82HoxnBs9FSn6B4DT1YUK1saJVg6VI0NeFFIkfrL275asF8wmGeacvtEswmBK75NLI+lt4uYFsrg6L1nECkPeOoGWDEoj6aMCWWeEmrCIjbXJuWu24B2nXcpiljlX2LjdnuvSHFRPl4PSyJ8rSCvROVsuI+aE8wYV5mZE3JdL6jJoC61s8OFlp3M/JP0ySdDacSlhFd1/EondtA3aUrqHmK951m+2sJIp2JVHcv5sg6BQlE03Nambl53OzQ8V06MHyekcXSbUBGa+yhitJhEUYTM7Mwc+4UKB5A7Ns8djjcZos5v0P/NsVxCOOp2bw1UQDu8H4arx6uXSIE/ngHfCOvu0lHf5sZvg4c1sRfDoPsFLiwaUdjDWpUqfltT23LuJHK1ofH+fRk9NuRSp1y4u9C2qp2XSnN6F6cnVu9wXLjqEPCUP8v1sg2qzPZC0mJRGuDmLrxfs7oAX4iD0x9fD5TBitAE01fFCW+8xdxmLWXu2KscWzRSN9QP4ArqqibwoWrpARYeo5CNLtbDNC9GeHrJltI22XKUjffdxi+Ha2z5FNARtw+dV6HghfsM5i+qQNFERE7SSGfIUjQ8fLdS79ZHUrcO97eLuIk/jjrV3ogr4WYGqT1cQWq7pIdvWxq5QJjpHL2xlCDX8rz/+9Bb1ncVn0zM4Kw0UeoaGjgG63Ywl3omRxLWQZldKGvJcorVyDkI5nBg6QlMxEY6HNwIVtYQXfCSkoPwjmCZrA40Uti26I7oMDXV9bRA4pDhFSWkLUutbGsdp4KXTuZ+jvk3OtLkdk0sRcBiVVii0FixibYIq4ypBqNc0IoWQK0Dl0BRGWAQucgKPtQEcj0UiaGDabIYnDnKu+ARpsgjIb4pCEe4OFoweldaB1bL0RGjGHNEFigoxtS14LaYYiFNjio4LiSlMShoigkSnCNUSEw2Vwgitg4KmFwn6Qa3jxoHEKRo+8dQyBDoWodBUFASXoMcba0sDOcOVpYtFcKhemlX4CqPpfPVzpHzeApI36TwiKZQSQAp1S6LnAVyv0uwKR1Y4HH5TJ+xsNru3n77dtHkjXFaOwGCh13YT3+h3X9N89eNbFjGHJrdn4z6aqUjqq9BH5mx7cLsqlTzxpdJfhcNe/XnbgHaTFAkqi43Cdvzm/C1M4btWh0WNrfkZDrff9l51T/tdGpeqVdh/h61Oq0NNVNxyrhpT9SvJ+nJDst7ewYt16d8L3ftX3F7o3gvd/5PM2gvd++zZC917oXsvdO+F7v91Gv2HQnelNTi8c+1CcuHFlkpDDjrJdS33kvackYISX7PFYsQtXhq5XFLzhxINyS/DiE25EXxE0sH1cBnVCgUJK7c4ZzF7FR4bBxc0McFlGcSOLc2JxJVgcZwkWLid2KbIc37Wv2ARG1W6fK5TsjF8Rpo9n7GYUeJ4jd+/qr16TO0LJrmalHxC+DAuCSu8pCg0VZlbr8pUX4hZ3aXmDS835ZpAhf4TsQcNfqQn1m84/2kFDz0fNahiW6Np7YbL5fJvIwEmVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWNtuGzcQ/ZUJA/QSrCU5dYFiURR1EyEVGl8Q2fCDJTjU7kjLmktuSK5kQdBbv6Sf1i8phtyVVrKjpIjrooD8YEnkGXLOcDgkz4I5PrEsvmZXOMq0vmXDiKVoEyMKJ7RiMbvIECyfImgDZZFyh1Bh4fi8B1xKPYO5LsHpgJtVvaWRMMtEkoGwUFpMCeGMmEzQAE5ROTtQz58/r77HAzVQhy148WIqcIZp/OLFQAEAHMBVhgqsmCg0EDoh1UmZo3LgMmHDCDATUtYTtILt+/fvw5dF+KC/AfPwAYthwMJwAxY1+8dCYuh+ffbq8qR7enFz+e7tFkjxfBt0enzS3UZpV6HOJXKLYJCmBK5Szyj4X7PZMm4sRBhjqz+ExFLf9bp9g+y2r/3em9Puu/ueVoHJuZAbwO7Jce/tA8gi02pzyPNfz067A9YELtc/hhuOh6j/Mv/EVDXwuFqsi95Jt39xfHK+hUoMcvcgrEYtB+olpVaF3M6tVTYJCxXkSxOrGmafWU+bWZ+VCh6qvqOE8ER35kNAwGheV6AvTIww3la89eh3TFwvHbC4seq9103W++x5tOxpmA3vOf7F5WZJ2XXky43OC4mfKDjrBONSVklmP5Fln1F/6qn3FejfyaGPVqA68I9yanmo+p6SKcVEik8UqxrzeOWqHnGfRk+bRnXcP+OSVEMfJeFYxHSBhlNEeymLGd3pvwoX//qNEDGDH0q07hedzlm82HoxnBs9FSn6B4DT1YUK1saJVg6VI0NeFFIkfrL275asF8wmGeacvtEswmBK75NLI+lt4uYFsrg6L1nECkPeOoGWDEoj6aMCWWeEmrCIjbXJuWu24B2nXcpiljlX2LjdnuvSHFRPl4PSyJ8rSCvROVsuI+aE8wYV5mZE3JdL6jJoC61s8OFlp3M/JP0ySdDacSlhFd1/EondtA3aUrqHmK951m+2sJIp2JVHcv5sg6BQlE03Nambl53OzQ8V06MHyekcXSbUBGa+yhitJhEUYTM7Mwc+4UKB5A7Ns8djjcZos5v0P/NsVxCOOp2bw1UQDu8H4arx6uXSIE/ngHfCOvu0lHf5sZvg4c1sRfDoPsFLiwaUdjDWpUqfltT23LuJHK1ofH+fRk9NuRSp1y4u9C2qp2XSnN6F6cnVu9wXLjqEPCUP8v1sg2qzPZC0mJRGuDmLrxfs7oAX4iD0x9fD5TBitAE01fFCW+8xdxmLWXu2KscWzRSN9QP4ArqqibwoWrpARYeo5CNLtbDNC9GeHrJltI22XKUjffdxi+Ha2z5FNARtw+dV6HghfsM5i+qQNFERE7SSGfIUjQ8fLdS79ZHUrcO97eLuIk/jjrV3ogr4WYGqT1cQWq7pIdvWxq5QJjpHL2xlCDX8rz/+9Bb1ncVn0zM4Kw0UeoaGjgG63Ywl3omRxLWQZldKGvJcorVyDkI5nBg6QlMxEY6HNwIVtYQXfCSkoPwjmCZrA40Uti26I7oMDXV9bRA4pDhFSWkLUutbGsdp4KXTuZ+jvk3OtLkdk0sRcBiVVii0FixibYIq4ypBqNc0IoWQK0Dl0BRGWAQucgKPtQEcj0UiaGDabIYnDnKu+ARpsgjIb4pCEe4OFoweldaB1bL0RGjGHNEFigoxtS14LaYYiFNjio4LiSlMShoigkSnCNUSEw2Vwgitg4KmFwn6Qa3jxoHEKRo+8dQyBDoWodBUFASXoMcba0sDOcOVpYtFcKhemlX4CqPpfPVzpHzeApI36TwiKZQSQAp1S6LnAVyv0uwKR1Y4HH5TJ+xsNru3n77dtHkjXFaOwGCh13YT3+h3X9N89eNbFjGHJrdn4z6aqUjqq9BH5mx7cLsqlTzxpdJfhcNe/XnbgHaTFAkqi43Cdvzm/C1M4btWh0WNrfkZDrff9l51T/tdGpeqVdh/h61Oq0NNVNxyrhpT9SvJ+nJDst7ewYt16d8L3ftX3F7o3gvd/5PM2gvd++zZC917oXsvdO+F7v91Gv2HQnelNTi8c+1CcuHFlkpDDjrJdS33kvackYISX7PFYsQtXhq5XFLzhxINyS/DiE25EXxE0sH1cBnVCgUJK7c4ZzF7FR4bBxc0McFlGcSOLc2JxJVgcZwkWLid2KbIc37Wv2ARG1W6fK5TsjF8Rpo9n7GYUeJ4jd+/qr16TO0LJrmalHxC+DAuCSu8pCg0VZlbr8pUX4hZ3aXmDS835ZpAhf4TsQcNfqQn1m84/2kFDz0fNahiW6Np7YbL5fJvIwEmVA==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"created:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"signed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"completed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"declined:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.618d0da1.js b/assets/js/770b40a9.1ad6ce7c.js similarity index 88% rename from assets/js/770b40a9.618d0da1.js rename to assets/js/770b40a9.1ad6ce7c.js index 7165a5dd9..0f1aba49a 100644 --- a/assets/js/770b40a9.618d0da1.js +++ b/assets/js/770b40a9.1ad6ce7c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uo53nU6GmB4+yxhutr8izjfO2dN8UQyPeIFXD1jV9VDtFFchDF6vpe6IDuXXYpUFFeRbcPRvtVMX3KDNdIo2ivkDo4H//+VdgdBNniIZncFlZMHqOlsYlrnKYSFwIGo93p2mHvJTonFyCUB6nlnpfLqbCcxlqL020GTc8FVJQ/BBME9tCLwTdAN4X6Au0tPWdpek8xxlKCjuQWt+FiVkDr7wug4xWZ5hrezchlSLgkFZOKHQOHGJHQVVwlSF0dxGBtjTBo/JojRUOgYuSwBNtAScTkQk6mJLF8sxDyRWfIgmLgPQmL6yfAlanlfPgtKyCISSxRPSNiQoxdwP4RcywMZwWc/RcSMxhWtEREWQ6R2hzh8xQOaToPBgSLzIMhzrPrQeJM7Qh9sJNTiopwWhKasElvUX6d0sHecuVo9LeKNRdzdp9xmqajIOMnC8H8EF9UFcULJVDCgAp1J1LPqgDuFmH2XtMnfA4/r7Lh/l8vpMHz7c558IXVQoWjd7wpmExZE2fvv54ziLm0ZbucnJF762sG9EekDkM4GFb6ngWSl0741COvbpPoLIjRYbKYa8wnZ2/ewszOBrELOpl/hcoPHx78fPr365e07lUaZr8Gw3iQRymJu18yVVP1NaTta1SW8m72lTt/+kbty2BHhd+aCQXoRcEr6/aOn7Dtur4OGKFdp7WV6uUO/zdyrqm5ealSdU9F46s3bw173DZexmH+ZAlLNT2B7DtE3YDHdOHFYQNbSfqajIJbDhnWYamL2Cnz241q/PX1yxivPLFdi+4C72g/UGnd1tq2Tt7u0k0CtBfsumzhB8pVN7g8qc1vNl5kNDa16HpasZ1Xf8DCxQQMQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uo53nU6GmB4+yxhutr8izjfO2dN8UQyPeIFXD1jV9VDtFFchDF6vpe6IDuXXYpUFFeRbcPRvtVMX3KDNdIo2ivkDo4H//+VdgdBNniIZncFlZMHqOlsYlrnKYSFwIGo93p2mHvJTonFyCUB6nlnpfLqbCcxlqL020GTc8FVJQ/BBME9tCLwTdAN4X6Au0tPWdpek8xxlKCjuQWt+FiVkDr7wug4xWZ5hrezchlSLgkFZOKHQOHGJHQVVwlSF0dxGBtjTBo/JojRUOgYuSwBNtAScTkQk6mJLF8sxDyRWfIgmLgPQmL6yfAlanlfPgtKyCISSxRPSNiQoxdwP4RcywMZwWc/RcSMxhWtEREWQ6R2hzh8xQOaToPBgSLzIMhzrPrQeJM7Qh9sJNTiopwWhKasElvUX6d0sHecuVo9LeKNRdzdp9xmqajIOMnC8H8EF9UFcULJVDCgAp1J1LPqgDuFmH2XtMnfA4/r7Lh/l8vpMHz7c558IXVQoWjd7wpmExZE2fvv54ziLm0ZbucnJF762sG9EekDkM4GFb6ngWSl0741COvbpPoLIjRYbKYa8wnZ2/ewszOBrELOpl/hcoPHx78fPr365e07lUaZr8Gw3iQRymJu18yVVP1NaTta1SW8m72lTt/+kbty2BHhd+aCQXoRcEr6/aOn7Dtur4OGKFdp7WV6uUO/zdyrqm5ealSdU9F46s3bw173DZexmH+ZAlLNT2B7DtE3YDHdOHFYQNbSfqajIJbDhnWYamL2Cnz241q/PX1yxivPLFdi+4C72g/UGnd1tq2Tt7u0k0CtBfsumzhB8pVN7g8qc1vNl5kNDa16HpasZ1Xf8DCxQQMQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(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,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uox1XeaoXDzPGG42vyKuN47b03hRCI94gVcLWLX1UO0EVyEMHq+l7ogO5ddalQUU5Flw9G+1UxPcoM10ijaG+QOjgf//5V2B002aIhGdwWVkweo6WRiWucphIXAgajXcnaYe8lOicXIJQHqeW+l4upsJzGeouTbMZNzwVUlDsEEwT20Iv/NwA3hfoC7S09Z2lyTzHGUoKOZBa34VpWQOvvC6DjFZnmGt7NyGVIuCQVk4odA4cYkdBVXCVIXR3EYG2NL2j8miNFQ6Bi5LAE20BJxORCTqYEsXyzEPJFZ8iCYuA9CYvrJ8BVqeV8+C0rIIhJLFE9I2JCjF3A/hFzLAxnBZz9FxIzGFa0RERZDpHaPOGzFA5pOg8GBIvMgyHOs+tB4kztHwaTCsQJpWUYDQltOCS3iH9u6WDvOXKUVlvFOquZu0+YzVNxUFGzpcD+KA+qCsKlsohBYAU6s4lH9QB3KzD7D2mTngcf9/lwnw+38mD59ucc+GLKgWLRm9407AYsqZPX388ZxHzaEt3Obmit1bWjWcPyBwG8LAtczwLZa6dbyjHXt0nUMmRIkPlsFeUzs7fvYUZHA1iFvWy/gsUHr69+Pn1b1ev6VyqMk3+jQbxIA4Tk3a+5Konauu52laoreRdbSr2//R925ZAjws/NJKL0AeC11dtDb9hWzV8HLFCO0/rq1XKHf5uZV3TcvPKpMqeC0fWbt6Zd7jsvYrDbMgSFur6A9j2+bqBjunDCsKGlhN1NZkENpyzLEPTF7DTY7ca1fnraxYxXvliuxfchV7Q/qDTuy217J293SQaBegv2fRZwo8UKm9w+dMa3uw8SGjt69B0NeO6rv8Buv8OxQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV1tv2zYU/iunfNkKKLacWzthGBpsRRa0WAokQ4GlRkBJxxYbimRJyhcYetsv2U/bLxkOJdly3MTNVvRhL4lFfh/PhefGFfN86lhyw66xNJJ7dGwcsRxdZoXxQiuWsOsC4Rw9dBB4K5yHs3cXwKXUcwdLXYHXYNFbgTMEDpIQegJ8xoXkqUTw3fkDuC6Eg0mlMjqfS+GXYKyeiRwdcAV6hnYmcB74Um6YEaDiqRRqCpVD60hmVmjtECZWl4AL4TztrhkwL1BBZpGH9VxnVYnKuwGLmDZoOWlwkbOETdF3LNKdRcxwy0v0aMk9K6Z4iSxhUpSCdgU55lOFdskiZvFTJSzmLJlw6TBizi8loSfalixiuDBS58gSbyvazQosOUtWrOQLUVYlS07iOGJ+aYikqjJFy2ri8dLQQaO4jtYquDthvpoGD8uM6zGd64xWDh1hD+OY/m0Hh6uyDJ2bVBLWHmURy7TyqDzhuTFSZGFj+NERabWrgE4/YhbcbukYLxqRFl0lfQ/HreVksPBYuv38ZplueI103go1ZVFwDff9lbXtbDH6NVWlO3w3JZ944Wl194gNwYUf68gjltJ+D6lDQ4DWpJLM0X4rs5p4ekzBRh8IwHrjiLXit63CpLrY56LCe+OS4bAjUw4PMl0SW8/Vlt2POSuks+60ipgTUxWy9N8GidX7VM9Qf5nDPmqEFINaWHIh96JTxFftQucLU2i1R8zxyenh6OjlixHh5yKfov8P9je7u/K2E/2Maj3mMOOyQgcHQH7nvrIYgfO8NIM9wbfGk9KL3eLTY69X1uzD4+M6Yssnsl6MyD9PJB29rCNWPJF0fEo3x6f4RN7os2l11YT0bXe19WOokJkOVX6hLu12+Ui1lshVX2DoD3XEQhZhfuYfj7TD+PDoYBQfxC+uR6fJ8Q/JyekgjuM/WMQWZQjvtivlbdXrtOy+K5N/Azn1fVi/EN933LY7hZJC4W3X6W4P4/j2lCB1xI7jk92Od6FmXIo8DEDX+g7Vs6/X79BavacO9sX7Rvyu+aIBhX22ZWx/vTHSYVZZ4ZdhzFkccCMOmv3kZkwzQIm+0O2MFOYiX7CEDe+NSw7trJuVKit79Z4bM9AGFeW/5KmjOjfkRgxnVL7uox1XeaoXDzPGG42vyKuN47b03hRCI94gVcLWLX1UO0EVyEMHq+l7ogO5ddalQUU5Flw9G+1UxPcoM10ijaG+QOjgf//5V2B002aIhGdwWVkweo6WRiWucphIXAgajXcnaYe8lOicXIJQHqeW+l4upsJzGeouTbMZNzwVUlDsEEwT20Iv/NwA3hfoC7S09Z2lyTzHGUoKOZBa34VpWQOvvC6DjFZnmGt7NyGVIuCQVk4odA4cYkdBVXCVIXR3EYG2NL2j8miNFQ6Bi5LAE20BJxORCTqYEsXyzEPJFZ8iCYuA9CYvrJ8BVqeV8+C0rIIhJLFE9I2JCjF3A/hFzLAxnBZz9FxIzGFa0RERZDpHaPOGzFA5pOg8GBIvMgyHOs+tB4kztHwaTCsQJpWUYDQltOCS3iH9u6WDvOXKUVlvFOquZu0+YzVNxUFGzpcD+KA+qCsKlsohBYAU6s4lH9QB3KzD7D2mTngcf9/lwnw+38mD59ucc+GLKgWLRm9407AYsqZPX388ZxHzaEt3Obmit1bWjWcPyBwG8LAtczwLZa6dbyjHXt0nUMmRIkPlsFeUzs7fvYUZHA1iFvWy/gsUHr69+Pn1b1ev6VyqMk3+jQbxIA4Tk3a+5Konauu52laoreRdbSr2//R925ZAjws/NJKL0AeC11dtDb9hWzV8HLFCO0/rq1XKHf5uZV3TcvPKpMqeC0fWbt6Zd7jsvYrDbMgSFur6A9j2+bqBjunDCsKGlhN1NZkENpyzLEPTF7DTY7ca1fnraxYxXvliuxfchV7Q/qDTuy217J293SQaBegv2fRZwo8UKm9w+dMa3uw8SGjt69B0NeO6rv8Buv8OxQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.a9080331.js b/assets/js/78b2b753.1d06cdac.js similarity index 58% rename from assets/js/78b2b753.a9080331.js rename to assets/js/78b2b753.1d06cdac.js index b584e321f..813d923a2 100644 --- a/assets/js/78b2b753.a9080331.js +++ b/assets/js/78b2b753.1d06cdac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var a=s(85893),i=s(11151),d=s(58219),r=(s(62316),s(51039)),n=s.n(r),t=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOZDUWyJGXHMPRvT7JH25MMRxdfYqdYt2F/Eovn+p3LR65FwMKL5Fr8YFRGTkwjkZFPnbRBGi0S8W5OkJGiQNCqwOnbc0ClzNLDylQQTC/PG/lQRMJYcsgOzjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8KzMRCcmBLYa5eJiNmX2gNJxnYHLYOHT0sZKOMpEEV1EkfFgpdullaRWJSNC9VSYjkeSoPCukcypRJGsRVrbRDE7qQkQiN67EsHtC99h4ScTsYpzm2WRuZ6KupxzWW6M9eXY0iWP+t5+tr9KUvM8rBZuKiEikRgfSgfXRWiXTRjD64NlofZhdC5or59hNkG3Ivhafi+PHOz/5ydLy3Io66pqTnYZjbrZGk3jyfDCOB/GX78Yvk5Ovkxcvh3Ec/yYicV8qtu36mGEg9htkUNvvnQOpldR021fvdhLHt+OJqGtWOjlWxkHXapAetAlApQ2rCLiMKLWHzKRVSTqAcf0M3ugBXJmSwlzqApYsXDqjiwisIvQEwa0AC5QaFAZyT27+VWOMpsucp7mO1jwaj2E9iePb5xuoJ4dQO6CMMjeVzob/3biQc8Z97qwc5vOpVp7EJ7dfbeC9OIR3rheoZNZQSDB3pJ/8D/i2aI6E51T3B1i2So1c7IHdPW9BekorJ8OqIbL7AVo5aOXJ9ZTngAfQbCmwIb8wF4kYtYUdrTe0Vwt25xY9LVZOiUTMQ7A+GY3Q2qGxpL0stMKZH6amHKGVo8VY1NFDbR+wkLoYfNJquk3/ikvcVnEPxKaWaOUFrUTU12hXq6PrOSGzMVdF6tw0xl3lLi3pK1nopu6L8QGpvyeVmpL4Jglzgl79z9//aCz69W7G4glcVg6sWZJjWkWdQa7oXs4UHbmYPGGpyHu1AqkDFQ4DQSYLGVABV4XZIUWLM6kkDxKrGbZ2sDOLfgjv5xTm5Fj0hSNAyGhBiucPlDF37CcYwCqYsonRU9LSuLucU4oAYVZ5qcl78ES9Cek56pSg70XELIYaSAdy1klPgLJk5dw4oDyXqWTHvDUO0wAlaiyIg0XAeXMVrDMLmZEHZ2aVD+CNqhogHLEkCi1ETZT5IbySC2qB82FGAaWiDIqKXTDPZgTdEjEMncGMfADL4WVKjVMf0AVQtCDXzF7TybxSCqzh7Zao+M7e7S07Cg61ZwJqE+pbsymfdYZv0CZGhqsh3OgbzcQOlSceACX1nU+Y7q83Y/aeZl4Gmj7t92G5XB7swbN9m9cyzKsZOLJma1c0h83W7JpvPp6JSARypb/Mr8gtZErdEj4Sc9QojzrOw7ThPCpRqnbHvntowPyjZEra0w5Dnb5++wYW8HwYi2hn8/9GwqM359+f/Xx1xn6Zadr9Gw/jYcxH1vhQot4J9Wr35fdwcddb6v5nz8SOXQLdh5FVKBu+bQCtO6K8FptXXrJ9IU4jMTc+sHi9nqGnX52qaz7+WJFjNp5GYoFO4owJ6HotMun5d7Z5Aj4K5Okv3WvyGRx9bB7NuadJzRy5QFXxl4jEHa32nrb1tI56puS0WvlpmpINO5YH1+DeXfLq7M3ZuzMRCay4RLskfdeQdPeDAxxNbJ+92xz4L18kRw2+4V5e0OrbjXoredSgg9hrc5GmdV3/BXeuT/Y=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOZDUWyJGXHMPRvT7JH25MMRxdfYqdYt2F/Eovn+p3LR65FwMKL5Fr8YFRGTkwjkZFPnbRBGi0S8W5OkJGiQNCqwOnbc0ClzNLDylQQTC/PG/lQRMJYcsgOzjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8KzMRCcmBLYa5eJiNmX2gNJxnYHLYOHT0sZKOMpEEV1EkfFgpdullaRWJSNC9VSYjkeSoPCukcypRJGsRVrbRDE7qQkQiN67EsHtC99h4ScTsYpzm2WRuZ6KupxzWW6M9eXY0iWP+t5+tr9KUvM8rBZuKiEikRgfSgfXRWiXTRjD64NlofZhdC5or59hNkG3Ivhafi+PHOz/5ydLy3Io66pqTnYZjbrZGk3jyfDCOB/GX78Yvk5Ovkxcvh3Ec/yYicV8qtu36mGEg9htkUNvvnQOpldR021fvdhLHt+OJqGtWOjlWxkHXapAetAlApQ2rCLiMKLWHzKRVSTqAcf0M3ugBXJmSwlzqApYsXDqjiwisIvQEwa0AC5QaFAZyT27+VWOMpsucp7mO1jwaj2E9iePb5xuoJ4dQO6CMMjeVzob/3biQc8Z97qwc5vOpVp7EJ7dfbeC9OIR3rheoZNZQSDB3pJ/8D/i2aI6E51T3B1i2So1c7IHdPW9BekorJ8OqIbL7AVo5aOXJ9ZTngAfQbCmwIb8wF4kYtYUdrTe0Vwt25xY9LVZOiUTMQ7A+GY3Q2qGxpL0stMKZH6amHKGVo8VY1NFDbR+wkLoYfNJquk3/ikvcVnEPxKaWaOUFrUTU12hXq6PrOSGzMVdF6tw0xl3lLi3pK1nopu6L8QGpvyeVmpL4Jglzgl79z9//aCz69W7G4glcVg6sWZJjWkWdQa7oXs4UHbmYPGGpyHu1AqkDFQ4DQSYLGVABV4XZIUWLM6kkDxKrGbZ2sDOLfgjv5xTm5Fj0hSNAyGhBiucPlDF37CcYwCqYsonRU9LSuLucU4oAYVZ5qcl78ES9Cek56pSg70XELIYaSAdy1klPgLJk5dw4oDyXqWTHvDUO0wAlaiyIg0XAeXMVrDMLmZEHZ2aVD+CNqhogHLEkCi1ETZT5IbySC2qB82FGAaWiDIqKXTDPZgTdEjEMncGMfADL4WVKjVMf0AVQtCDXzF7TybxSCqzh7Zao+M7e7S07Cg61ZwJqE+pbsymfdYZv0CZGhqsh3OgbzcQOlSceACX1nU+Y7q83Y/aeZl4Gmj7t92G5XB7swbN9m9cyzKsZOLJma1c0h83W7JpvPp6JSARypb/Mr8gtZErdEj4Sc9QojzrOw7ThPCpRqnbHvntowPyjZEra0w5Dnb5++wYW8HwYi2hn8/9GwqM359+f/Xx1xn6Zadr9Gw/jYcxH1vhQot4J9Wr35fdwcddb6v5nz8SOXQLdh5FVKBu+bQCtO6K8FptXXrJ9IU4jMTc+sHi9nqGnX52qaz7+WJFjNp5GYoFO4owJ6HotMun5d7Z5Aj4K5Okv3WvyGRx9bB7NuadJzRy5QFXxl4jEHa32nrb1tI56puS0WvlpmpINO5YH1+DeXfLq7M3ZuzMRCay4RLskfdeQdPeDAxxNbJ+92xz4L18kRw2+4V5e0OrbjXoredSgg9hrc5GmdV3/BXeuT/Y=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(d.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(m.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(m.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:l}={...(0,i.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>u,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>y});var a=s(85893),n=s(11151),i=s(58219),r=(s(62316),s(51039)),d=s.n(r),t=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VutuG0UUfpXT+UMrbey1mxZYIUREA4RWpCJFlUis6Hj3rHfq2ZnpzKwvsvYfT8Kj8STo7MWX2EEUEH8S75zrdy7fzEYEnHmR3IrvjMrIiUkkMvKpkzZIo0Ui3hUEGSkKBK0KXLy9AlTKLD2sTQXB9PK8kQ9EJIwlh+zgKhOJaMWtVETCosOSAjmOuxEaSxKJaMX3MhORkBzYYijEw2zM9AOl4SoDk8PWoaOPlXSUiSS4iiLhw1qxSy9Lq0hEglZWmYxEkqPyrJAWVKJINiKsbaMZnNQzEYncuBLD/gmtsPGSiOnrUZpn48JORV1POKy3Rnvy7Ggcx/zvMFtfpSl5n1cKthURkUiNDqQD66O1SqaNYPjBs9HmOLsWNFfOsZsg25B9LT4Vxw9zP/7R0vLKijrqmpNdhFNudkbjePz8bBSfxZ+/G71Mzr9MXrwcxHH8q4jEqlRs2/Uxw0DsN8igdt97B1Irqem+r979OI7vR2NR16x0fqqMZ12rQXrQJgCVNqwj4DKi1B4yk1Yl6QDG9TN4p8/gxpQUCqlnsGTh0hk9i8AqQk8Q3BpwhlKDwkDuyd2/aozRdJ3zNNfRhkfjMazncXz/fAv1/BhqB5RR5qbS2eC/GxdyzrhPnZXjfP6qlefx+f0XW3gvjuFd6QUqmTUUEsyc9JP/Ad8OzYnwnOrhAMtWqZGLA7D75y1IT2nlZFg3RLY6QyvPWnlyO+E54AE0OwpsyC8UIhHDtrDDzZb2asHu3KKnxcopkYgiBOuT4RCtHRhL2suZVjj1g9SUQ7RyuBiJOnqo7VFnU7N63GKyS/2Gy9tW8ADAto5o5Wtai6ivz75WR9UFITMxV0Tq3DTGXdWuLekbOdNNzRejI0J/Tyo1JfEtEgqCXv2P335vLPrVbkbiCVxXDqxZkmNKRZ1Brmglp4pOXEqesFTkvVqD1IFmDgNBJmcyoAKuCjNDihanUkkeIlYzbO1gbw79AN4XFApyLPrMESBktCDFswfKmDn7CQawCqZsYvR0tDRunnNKESBMKy81eQ+eqDchXaBOCfpeRMxgqIF0IGed9AQoS1bOjQPKc5lKdswb4zANUKLGGXGwCDhvroJ1ZiEz8uDMtPIBvFFVA4QjlkShhaiJMj+AV3JBLXA+zCigVJTBrGIXzLEZQbdADENnMCUfwHJ4mVLj1Ad0ARQtyOGsgVYQ5JVSYA1vtkTF9/V+b9lRcKg9k0+bUN+abfmsM3x7NjEyXA/gTt9pJnWoPPEAKKnnPmGqv92O2Xuaehlo8rTfheVyebQHzw5tvpehqKbgyJqd3aw5bLZm33z78UxEIpAr/XV+Q24hU+oW8JGYw0Z52PEdpg3fUYlStTv2zUMD5h4lU9Ke9tjp4vu3b2ABzwexiPa2/m8kPHxz9e3lTzeX7JdZpt2/0SAexHxkjQ8l6r1Qr/ZffQ8Xd7Oj7X/2ROzYJdAqDK1C2XBtA2jTkeSt2L7wkt3rcBKJwvjA4s1mip5+caqu+fhjRY6ZeBKJBTqJUyag243IpOff2fb59yiQpz93L8lncPKheTLnniY1c+QCVcVfIhJzWh88a+tJHfVMyWm18os0JRv2LI+uwIN75NXlm8t3lyISWHGJ9kl63pB094MDnEzskL3bHPgvXyInDb7iXr6m9ddb9VbyqEEHsdfmIk3quv4TGAlOig==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VutuG0UUfpXT+UMrbey1mxZYIUREA4RWpCJFlUis6Hj3rHfq2ZnpzKwvsvYfT8Kj8STo7MWX2EEUEH8S75zrdy7fzEYEnHmR3IrvjMrIiUkkMvKpkzZIo0Ui3hUEGSkKBK0KXLy9AlTKLD2sTQXB9PK8kQ9EJIwlh+zgKhOJaMWtVETCosOSAjmOuxEaSxKJaMX3MhORkBzYYijEw2zM9AOl4SoDk8PWoaOPlXSUiSS4iiLhw1qxSy9Lq0hEglZWmYxEkqPyrJAWVKJINiKsbaMZnNQzEYncuBLD/gmtsPGSiOnrUZpn48JORV1POKy3Rnvy7Ggcx/zvMFtfpSl5n1cKthURkUiNDqQD66O1SqaNYPjBs9HmOLsWNFfOsZsg25B9LT4Vxw9zP/7R0vLKijrqmpNdhFNudkbjePz8bBSfxZ+/G71Mzr9MXrwcxHH8q4jEqlRs2/Uxw0DsN8igdt97B1Irqem+r979OI7vR2NR16x0fqqMZ12rQXrQJgCVNqwj4DKi1B4yk1Yl6QDG9TN4p8/gxpQUCqlnsGTh0hk9i8AqQk8Q3BpwhlKDwkDuyd2/aozRdJ3zNNfRhkfjMazncXz/fAv1/BhqB5RR5qbS2eC/GxdyzrhPnZXjfP6qlefx+f0XW3gvjuFd6QUqmTUUEsyc9JP/Ad8OzYnwnOrhAMtWqZGLA7D75y1IT2nlZFg3RLY6QyvPWnlyO+E54AE0OwpsyC8UIhHDtrDDzZb2asHu3KKnxcopkYgiBOuT4RCtHRhL2suZVjj1g9SUQ7RyuBiJOnqo7VFnU7N63GKyS/2Gy9tW8ADAto5o5Wtai6ivz75WR9UFITMxV0Tq3DTGXdWuLekbOdNNzRejI0J/Tyo1JfEtEgqCXv2P335vLPrVbkbiCVxXDqxZkmNKRZ1Brmglp4pOXEqesFTkvVqD1IFmDgNBJmcyoAKuCjNDihanUkkeIlYzbO1gbw79AN4XFApyLPrMESBktCDFswfKmDn7CQawCqZsYvR0tDRunnNKESBMKy81eQ+eqDchXaBOCfpeRMxgqIF0IGed9AQoS1bOjQPKc5lKdswb4zANUKLGGXGwCDhvroJ1ZiEz8uDMtPIBvFFVA4QjlkShhaiJMj+AV3JBLXA+zCigVJTBrGIXzLEZQbdADENnMCUfwHJ4mVLj1Ad0ARQtyOGsgVYQ5JVSYA1vtkTF9/V+b9lRcKg9k0+bUN+abfmsM3x7NjEyXA/gTt9pJnWoPPEAKKnnPmGqv92O2Xuaehlo8rTfheVyebQHzw5tvpehqKbgyJqd3aw5bLZm33z78UxEIpAr/XV+Q24hU+oW8JGYw0Z52PEdpg3fUYlStTv2zUMD5h4lU9Ke9tjp4vu3b2ABzwexiPa2/m8kPHxz9e3lTzeX7JdZpt2/0SAexHxkjQ8l6r1Qr/ZffQ8Xd7Oj7X/2ROzYJdAqDK1C2XBtA2jTkeSt2L7wkt3rcBKJwvjA4s1mip5+caqu+fhjRY6ZeBKJBTqJUyag243IpOff2fb59yiQpz93L8lncPKheTLnniY1c+QCVcVfIhJzWh88a+tJHfVMyWm18os0JRv2LI+uwIN75NXlm8t3lyISWHGJ9kl63pB094MDnEzskL3bHPgvXyInDb7iXr6m9ddb9VbyqEEHsdfmIk3quv4TGAlOig==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},u={},y=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,n.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(d(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(p.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(p.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.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,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:l}={...(0,n.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.b8f734db.js b/assets/js/7b076186.b8f734db.js new file mode 100644 index 000000000..db5f354c2 --- /dev/null +++ b/assets/js/7b076186.b8f734db.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),o=s.n(i),r=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/itXfmkLKLaTph0mDMOyNuiCFmuxZCiw1AjO4sliTZEsSfkFhr7tl+yn7ZcMJ8m2HDtFBwwF9iWxyHt9ePfcrUXEaRDprXhpTcQsBjFOhKSQeeWiskak4qYgeEWaIkEnBBfvrwC1tosAK1tBtOCptHMChKwTyb0t+dJvTibWzgZwlTcaxoK2ZkoeDJEEBIc+qqzSuJV/HECZ3PoSOY4EYqFC47jEGQVQEQjDin3LNrhYkPLgKbNeDkQirCPf6F5JkYpWqLMtEuHQY0mRPGe/FgZLEqno7u+UFIlQnL3DWIj7kLz3dq4kgZ18oixeSbD5NvFtQCIRnj5XypMUafQVJSLElWY3QZVOswAtnbaSRJqjDiyQFVSiSNcirlwjGb0yU5GIFon+CS2xsZIKV5xNijMMUtT1mL0GZ02gwHbORiP+tx//5h3bQCWEKssohLzSevVIJA0MZCIronNaZQ2Ow0+BtdeHUbY4MKqeUY+q9b2B51g+u+h/XnLs7hf3TNRJ907yIn5Z6Wx09uzkdHQy+u7m9EV6/n36/MVgNBr9IRKxLDXrdi8qMRLbjSrq3Xd9INY+WV+wO6lZ+PwYite2pFgoM4UFmQgLb800AacJA0H0K8ApKgMaI/n/EFXy3vovo/PvIqt7WSujlaG7TQndnY9Gd6dbEM4fLiVjI+S2MvLbZnrE/ZfTOb8726bz/DCdKzNHrWRDNDd2RubbptN3H1v3h7WqWqHmXuwl2z9vkwyUVV7FVUNyyxN06qS9T2/HzBVcJ3bHjw0xxkKkYtjx2XC948RasEE/35Bm5bVIRRGjC+lwiM4NrCMT1NRonIRBZsshOjWcn4o6uS8d0MiJXT6sMd4Ff80AtxjupbBFEp16QyuRbBDqS3U8XhBK8g2aPFYa5Q63d47MtZqaBvX56QHbfyCd2ZKY2WNBsBH/+8+/Gg1ps6okE5uieATvKg/OLsjnlQY0EnJNSzXRdGRqBsJSUwh6BcpEmnqMBFJNVUQNjAq3cIYOJ0orLiMWs+1Y7VViGMCHgmJBnq8ee57DkuakufpAWztjO9ECVtGWjY8uZlhYP8s5pAQQJlVQhkKAQLRRIVOgyQg2b5GA9YAGyETyzqtAgKpk4dx6oDxXmWLDXDWeO7NEg1NiZwlw3IyCa+dnAG8nVYgQrK6aRNhjSRTbFHk3CAN4pebUJs6HkiIqTRKmFZtIILOSoGshTsNImFCI4Ni9yqgxGiL6CJrm5HHapFYQ8LwDZ7m3FWoe4v23ZUPRowk8etuANk+zhc95y4Oz8SFxNYCP5qNh9oUqEBeAVmYW0o/mBG63ZfaBJkFFGj/Z9MJisTjog6f7Oq9VLKoJeHJ2pzdtDpuu6atvP56KRETyZXiXX5Ofq4y6BnzA57ARHnaMx3sSs1aJSrc99tN9BWYfrTIygXr8dPH6/VuYw7PBSCS9rv+KgIdvr15e/np9yXaZZdr+Ox2MBiM+cjbEEk3P1f5eer9z1zvm/t9usR3DRVrGodOoGsZvQF13VH0rdltt2ltgx4kobIgssF5PMNDvXtc1H3+uyPNEGCdijl7hhGnwdi2kCvxbbtfRB9F88lu32T6Fr92Fjyay4W/D5D1HXfGXSMSMVvvbeD2ukw2Hc6itwEWWkYs91YPxvDfjXl2+vby5FInAioHrj49ZMz66H+zgaGT7c6WNgf/yeDuq8AM/9Rta/bgVb28eVOhS3EgzSuO6rv8Bm8jCFQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1v2zYQ/itXfmkLKLaTph0mDMOyNuiCFmuxZCiw1AjO4sliTZEsSfkFhr7tl+yn7ZcMJ8m2HDtFBwwF9iWxyHt9ePfcrUXEaRDprXhpTcQsBjFOhKSQeeWiskak4qYgeEWaIkEnBBfvrwC1tosAK1tBtOCptHMChKwTyb0t+dJvTibWzgZwlTcaxoK2ZkoeDJEEBIc+qqzSuJV/HECZ3PoSOY4EYqFC47jEGQVQEQjDin3LNrhYkPLgKbNeDkQirCPf6F5JkYpWqLMtEuHQY0mRPGe/FgZLEqno7u+UFIlQnL3DWIj7kLz3dq4kgZ18oixeSbD5NvFtQCIRnj5XypMUafQVJSLElWY3QZVOswAtnbaSRJqjDiyQFVSiSNcirlwjGb0yU5GIFon+CS2xsZIKV5xNijMMUtT1mL0GZ02gwHbORiP+tx//5h3bQCWEKssohLzSevVIJA0MZCIronNaZQ2Ow0+BtdeHUbY4MKqeUY+q9b2B51g+u+h/XnLs7hf3TNRJ907yIn5Z6Wx09uzkdHQy+u7m9EV6/n36/MVgNBr9IRKxLDXrdi8qMRLbjSrq3Xd9INY+WV+wO6lZ+PwYite2pFgoM4UFmQgLb800AacJA0H0K8ApKgMaI/n/EFXy3vovo/PvIqt7WSujlaG7TQndnY9Gd6dbEM4fLiVjI+S2MvLbZnrE/ZfTOb8726bz/DCdKzNHrWRDNDd2RubbptN3H1v3h7WqWqHmXuwl2z9vkwyUVV7FVUNyyxN06qS9T2/HzBVcJ3bHjw0xxkKkYtjx2XC948RasEE/35Bm5bVIRRGjC+lwiM4NrCMT1NRonIRBZsshOjWcn4o6uS8d0MiJXT6sMd4Ff80AtxjupbBFEp16QyuRbBDqS3U8XhBK8g2aPFYa5Q63d47MtZqaBvX56QHbfyCd2ZKY2WNBsBH/+8+/Gg1ps6okE5uieATvKg/OLsjnlQY0EnJNSzXRdGRqBsJSUwh6BcpEmnqMBFJNVUQNjAq3cIYOJ0orLiMWs+1Y7VViGMCHgmJBnq8ee57DkuakufpAWztjO9ECVtGWjY8uZlhYP8s5pAQQJlVQhkKAQLRRIVOgyQg2b5GA9YAGyETyzqtAgKpk4dx6oDxXmWLDXDWeO7NEg1NiZwlw3IyCa+dnAG8nVYgQrK6aRNhjSRTbFHk3CAN4pebUJs6HkiIqTRKmFZtIILOSoGshTsNImFCI4Ni9yqgxGiL6CJrm5HHapFYQ8LwDZ7m3FWoe4v23ZUPRowk8etuANk+zhc95y4Oz8SFxNYCP5qNh9oUqEBeAVmYW0o/mBG63ZfaBJkFFGj/Z9MJisTjog6f7Oq9VLKoJeHJ2pzdtDpuu6atvP56KRETyZXiXX5Ofq4y6BnzA57ARHnaMx3sSs1aJSrc99tN9BWYfrTIygXr8dPH6/VuYw7PBSCS9rv+KgIdvr15e/np9yXaZZdr+Ox2MBiM+cjbEEk3P1f5eer9z1zvm/t9usR3DRVrGodOoGsZvQF13VH0rdltt2ltgx4kobIgssF5PMNDvXtc1H3+uyPNEGCdijl7hhGnwdi2kCvxbbtfRB9F88lu32T6Fr92Fjyay4W/D5D1HXfGXSMSMVvvbeD2ukw2Hc6itwEWWkYs91YPxvDfjXl2+vby5FInAioHrj49ZMz66H+zgaGT7c6WNgf/yeDuq8AM/9Rta/bgVb28eVOhS3EgzSuO6rv8Bm8jCFQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},g={},y=[{value:"Request",id:"request",level:2}];function f(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:"Delete Contact"})}),"\n",(0,t.jsx)(o(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\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)(c.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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:"Bxh2aspHp3"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"deletedAt",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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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:"Contact not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.fc1c0045.js b/assets/js/7b076186.fc1c0045.js deleted file mode 100644 index 53cd1d8f5..000000000 --- a/assets/js/7b076186.fc1c0045.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),o=(s(62316),s(51039)),c=s.n(o),i=(s(82723),s(9487)),r=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const j={id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",source:"@site/docs/API-docs/deletecontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletecontact",permalink:"/docs/API-docs/deletecontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletecontact",title:"Delete Contact",description:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record.",sidebar_label:"Delete Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVttu20YQ/ZXJviQBaEl2nBQliqJuYqRGjCaoXQSoIxgjckRutNzd7A4lC4Le+iX9tH5JMSQlUb4hBYoAfbHF3bmenTkzK8VYRJVeqdfOMmYc1ThROcUsaM/aWZWqy5LgDRligk4ITj6cARrjFhGWrgZ2EKhycwKErBOZBlfJZdicTJybDeBs2mhYB8bZggJYohwQPAbWWW1wK/80grZTFyqUOBLgUsfGcYUziqAZCONSfOdtcFySDhAocyEfqEQ5T6HRPctVqlqhzrZKlMeAFTEFyX6lLFakUtXdX+tcJUpL9h65VLch+RDcXOcEbvKZMj7LwU23iW8DUokK9KXWgXKVcqgpUZGXRtxEXXkjAnTjjctJpVM0UQSykipU6Urx0jeSHLQtVKJaJPondIONlVT58mhSHmHM1Xo9Fq/ROxspip2j0Uj+7ce/ecc20BxinWUU47Q2ZvlEJQ0MZFkU0XujswbH4eco2qu7UbY4CKpBUGfd+t7Ac18+u+h/vpHY/S/+hVon3TvlJ/y40tHo6MXB4ehg9N3l4av0+Pv05avBaDT6QyXqpjKi271ojkxilzWb3ff6jlj7ZH3B7mQtwsf3oXjhKuJS2wIWZBkWwdkiAW8IIwGHJWCB2oJBpvAfokohuPA4Ov8usnUva22NtnS9KaHr49Ho+nALwvHDpWQdw9TVNv+2md7j/vF0jq+Ptum8vJvOmZ2j0XlDNJduRvbbptN3z637u7WqW6HmXu0l2z9vk4yU1UHzsiG5mwP0+qC9T6/GwhVSJ27Hjw0xcqlSNez4bLjaceJaicEw35BmHYxKVcnsYzocovcD58lGXViDkzjIXDVEr4fzQ7VObktHxkLb4uBRrfEugQsBucVxL40tmuj1O1qqZINSX6rj8pIwp9AgKqOlUe6we+/JXujCNsjPD+8w/kcymatI2J1Lgo3433/+1WjkLqsrstwUxhN4XwfwbkFhWhtAm8PU0I2eGLpnckbCylCMZgnaMhUBmSDXhWY0IKhIG2focaKNllISMdeO1l41xgF8LIlLCnL1NMgszmlORioQjHMzscMOsGZXNT66mGHhwmwqISWAMKmjthQjRKKNCtkSbUaweYsEXAC0QJYp+KAjAepKhKcuAE2nOtNiWConSHdWaLEgcZaAxC0o+HaGRghuUkeG6EzdJCIeKyJuU5T9IA7gjZ5Tm7gc5sSoDeVQ1GIigczlBF0bSRo2hwlFBi/udUaN0cgYGAzNKTS117ykzDzwTvpbo5FB3n9bMcQBbZTx2wa0eZotfD44GZ6NjxyXA/hkP1lhYKgjSQEYbWcx/WQP4GpbZh9pEjXT+NmmHxaLxZ0+eL6v81ZzWU8gkHc7vaI5bLqmr779eK4SxRSq+H56QWGuM+qa8AGfw0Z42LGe7ErCXBVq0/bYT7cVhIGMzshG6nHUydsP5zCHF4ORSnqd/xUBD8/PXp/+enEqdoVp2v47HIwGIznyLnKFtudqfze93bmrHXv/bzfZjuGYbnjoDeqG9RtQVx1dX6ndZpv2lthxokoXWQRWqwlG+j2Y9VqOv9QUZCqMEzXHoHEiNHi1UrmO8jvfrqQPovnst267fQ5fuw/fm8iGv62Q9xxNLV8qUTNa7m/k6/E62XC4hNoKnGQZee6p3hnRe3Puzen56eWpShTWAlx/fMya8dH9EAf3RrY/V9oY5K+MuHsVfpCnfkfLH7fi7c2DCl2KG2lBabxer/8BxCfDgQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(r.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",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)(d.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Contact not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(i.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.4dec468f.js b/assets/js/8a725248.4dec468f.js new file mode 100644 index 000000000..ff5d37abf --- /dev/null +++ b/assets/js/8a725248.4dec468f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var t=s(85893),n=s(11151),l=s(58219),r=(s(62316),s(51039)),i=s.n(r),c=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpnanZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBp16kV+Kd0QHz4MU4EQX53EkbpNEiFZclwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCCUGyFED86MHL6eanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej4vqUL+Yo3SUcExowqlEonQWJFIhC2NJo5fWFoSqTDZLUXh1rEXQZJnCZE6XXVUPjippyIRE+MqDLsntMDKKia6NewGiXXSKn0+f0b0tj3o5aZiUY3BzxQ1HB2PhsfD49FQrNeJCDLE473M3GSckDXfb+MVXE3xwFujfROL0WBwP29dlTUiC/B1npP3k1qp5Yvn5OrpPDTHXFbPC4Ath1m5GN1aDuH/PJmvhsfDUfxjEW3AT8JDYrZMo8Ho+Gg4OBp8dzl8k776Pn39pjcYDH4XiVhUalviosAQvexqpPtd2+Ir6FkfkrXFWVBAqfwuQ4cD61iyrx4qygtTUSilnsKcdIC5M3qagFWEniC4JeAUpQaFgdy/WKTknHFPh+l5lu32rNRKarrpOvLm1WBwM9wEYfh4Z6JyhMUSaCF98F/X3cdseNqx4Y5jr+87dqpnqGQRB9uluSP9dX3aVR8a9ffLVzZE8V7sObt73jjpKa+dDEuRXq3E4gitPGru06vxepwIrhjDA9UaHy3GUIpU9A/nqyc3I+ejmNopkYoyBOvTfh+t7RlLmue4wswzDPXRyv6MoeSQ2qMuMrN4nGO8tfmC49qEbs/yTQDRyo+07OZuukeVCMn5LAkLcjGInK5ft2vC+y7om7h2cLxB44cAdoOve/OPtU1MNK1NxpklfSGnOqZyNhSHy9RnUrmpiHeQUBJ05H/98Wfk6FafWGkv4Kx2YM2c3KRWgLqAiaKFzBQ9sIF5wqrdv6QONHW84BRyKgOquG0xQuRoMZNKcm0ymWl2r53y9j34XFIoKa5l3zgChIJmpLikQRlzx3KCAayDqaKO1maYG3c3YZMSQMhqLzV5D56oYyFdos4JukwnYBygBtKBnHXSE6CsmJi3QppMZC5ZMNej456vUOOUWFkCbDdHwTZbngdnstoH8EbV0RHWWBGFxkVNVPge/Cxn1DjOh80ooAKmNYtIIDcFQZt3dkMXkJEPYFm9zCkK9QFdAEUzcjiNrpUEvJ2ANQwYEhWYyV5uWVBwqD0P48agLjWb8FlneM2JOgpc9uBaX2sGd6g9cQEoqe98eq2P4GpTZp8p8zLQ+Nuu0+bz+b0ue7nP80GGss7AkTVbvmk8jD25y7758VIkIpCr/NnkgtxM5tS29yM6+5G438IoowlDYdtgaOXbQwbuJiVz0n63OU8+nH+CGRz3BiLZwZR/YHD/0+m7979cvGe5jGFN/w17g94grkvGhwr1jqr9N85h56624+A/fhG1KBhoEfpWoYzDIIZm1eL41cE7aZyIknE+vRKrVYaefnNqvebjLzU5HhLjRMzQScwYxK7G66RDUAb+O1q2c5d0OLpk9Uyu6gaMDyYjg3/DcZLnZMOTtLuj6Pzs4lIkImvfcpUpmMfhnN95OBepuBbXIj4JY3/H1xifr4RCPa1xGtE8ymXgx5pjsTs17uLUaD/Ys+5KL3es3B8njSv8nx17kOEHTv5HWv64IW9uHmVoY9tRcwbH6/X6bwNOX/Y=",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/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+lqHEcQfpVy/0kMo71kO2QIwYpjjLCJRKRgiLSImpnanZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBp16kV+Kd0QHz4MU4EQX53EkbpNEiFZclwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCCUGyFED86MHL6eanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej4vqUL+Yo3SUcExowqlEonQWJFIhC2NJo5fWFoSqTDZLUXh1rEXQZJnCZE6XXVUPjippyIRE+MqDLsntMDKKia6NewGiXXSKn0+f0b0tj3o5aZiUY3BzxQ1HB2PhsfD49FQrNeJCDLE473M3GSckDXfb+MVXE3xwFujfROL0WBwP29dlTUiC/B1npP3k1qp5Yvn5OrpPDTHXFbPC4Ath1m5GN1aDuH/PJmvhsfDUfxjEW3AT8JDYrZMo8Ho+Gg4OBp8dzl8k776Pn39pjcYDH4XiVhUalviosAQvexqpPtd2+Ir6FkfkrXFWVBAqfwuQ4cD61iyrx4qygtTUSilnsKcdIC5M3qagFWEniC4JeAUpQaFgdy/WKTknHFPh+l5lu32rNRKarrpOvLm1WBwM9wEYfh4Z6JyhMUSaCF98F/X3cdseNqx4Y5jr+87dqpnqGQRB9uluSP9dX3aVR8a9ffLVzZE8V7sObt73jjpKa+dDEuRXq3E4gitPGru06vxepwIrhjDA9UaHy3GUIpU9A/nqyc3I+ejmNopkYoyBOvTfh+t7RlLmue4wswzDPXRyv6MoeSQ2qMuMrN4nGO8tfmC49qEbs/yTQDRyo+07OZuukeVCMn5LAkLcjGInK5ft2vC+y7om7h2cLxB44cAdoOve/OPtU1MNK1NxpklfSGnOqZyNhSHy9RnUrmpiHeQUBJ05H/98Wfk6FafWGkv4Kx2YM2c3KRWgLqAiaKFzBQ9sIF5wqrdv6QONHW84BRyKgOquG0xQuRoMZNKcm0ymWl2r53y9j34XFIoKa5l3zgChIJmpLikQRlzx3KCAayDqaKO1maYG3c3YZMSQMhqLzV5D56oYyFdos4JukwnYBygBtKBnHXSE6CsmJi3QppMZC5ZMNej456vUOOUWFkCbDdHwTZbngdnstoH8EbV0RHWWBGFxkVNVPge/Cxn1DjOh80ooAKmNYtIIDcFQZt3dkMXkJEPYFm9zCkK9QFdAEUzcjiNrpUEvJ2ANQwYEhWYyV5uWVBwqD0P48agLjWb8FlneM2JOgpc9uBaX2sGd6g9cQEoqe98eq2P4GpTZp8p8zLQ+Nuu0+bz+b0ue7nP80GGss7AkTVbvmk8jD25y7758VIkIpCr/NnkgtxM5tS29yM6+5G438IoowlDYdtgaOXbQwbuJiVz0n63OU8+nH+CGRz3BiLZwZR/YHD/0+m7979cvGe5jGFN/w17g94grkvGhwr1jqr9N85h56624+A/fhG1KBhoEfpWoYzDIIZm1eL41cE7aZyIknE+vRKrVYaefnNqvebjLzU5HhLjRMzQScwYxK7G66RDUAb+O1q2c5d0OLpk9Uyu6gaMDyYjg3/DcZLnZMOTtLuj6Pzs4lIkImvfcpUpmMfhnN95OBepuBbXIj4JY3/H1xifr4RCPa1xGtE8ymXgx5pjsTs17uLUaD/Ys+5KL3es3B8njSv8nx17kOEHTv5HWv64IW9uHmVoY9tRcwbH6/X6bwNOX/Y=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},j={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,t.jsx)(i(),{method:"post",path:"/createcontact"}),"\n",(0,t.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(m.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,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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.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)(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:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"401",value:"401",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Contact already exists!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.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)(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:"Contact already exists!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.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)(c.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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.c367aea5.js b/assets/js/8a725248.c367aea5.js deleted file mode 100644 index 7d4ff3662..000000000 --- a/assets/js/8a725248.c367aea5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7971],{80288:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),d=s(9472),p=s(85162);const h={id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVV+tqHDcUfpUT/WkD473YSUqHUuKmIZiE2tQugdqLOTNzdka2RlIkza6XZf/1SfpofZJyNDN784UaSkrBmFnp3C/fOVqKgKUX6aV4Z3TAPHgxSURBPnfSBmm0SMVFRfDOEQaCjgiOz04AlTJzDwvTQDBA06lxQZH3agF5S61pDnknFkKFAXLUwPzowctSk/MwNY5lOJC1NS6gDlCYvKlJBz8QiTCWHLIlJ4VIRSu5EyoS4ehLQz78ZIqFSJd7hp85M5MFQUbKzMGiw5oCOTa3s3AjiL9IBxaC1iqZR53DG8+SlsLnFdXIX6xROio4ZlSjVCIRGmsSibCV0cTxCwtLIhUmu6Eo3Dr2IkjyLCFSp8ueygcndSkSMTWuxrB9QndYW8VEN4bdILFKOqXP58+I3nYHg9zULKo1+JmixodHh+Oj8dHhWKxWiQgyxOOdzFxnnJAV32/iFVxD8cBbo30bi8PR6H7e+iprRRbgmzwn76eNUosXz8nV03loj7msnhcAW42z6u7wxnII/+fJfDU+Gh/GPxbRBfw4PCRmw3Q4Ojw6GI8ORt9djN+kr75PX78ZjEaj30Ui7mq1KXFRYIhe9jXS/25s8RX0rPbJuuIsKKBUfpuhx4FVLNlXDxXluakpVFKXMCcdYO6MLhOwitATBLcALFFqUBjI/YtFSs4Z93SYnmfZds9KraSm674jr1+NRtfjdRDGj3cmKkdYLIDupA/+67r7mA1POzbecuz1fcdO9AyVLOJguzC3pL+uT9vqQ6v+fvnKlijeix1nt89bJz3ljZNhIdLLpbg7QCsP2vv0crKaJIIrxvBAtcZHizFUIhXD/fnqyc3I+SimcUqkogrB+nQ4RGsHxpLmOa4w8wxDQ7RyOGMo2af2AUupy4MnuSYbu885tm34dqxfBxGt/EiLfvamO1SJkJzTirAgFwPJKft1syq87wO/jm0PyWtEfghk1xi7MwNZ29RE07qEnFrS57LUMZ2zsdhfqD6Tyk1NvIeEiqAn/+uPPyNHv/7EansBp40Da+bkpo0C1AVMFd3JTNEDW5gnrLsdTOpApeMlp5ClDKjixsUokaPFTCrJ9clkpt2/tkrcD+BzRaGiuJp94wgQCpqR4rIGZcwtywkGsAmmjjo6m2Fu3O2UTUoAIWu81OQ9eKKehXSFOifoM52AcYAaSAdy1klPgLJmYt4MaTqVuWTBXJOO+75GjSWxsgTYbo6CbTc9D85kjQ/gjWqiI6yxJgqti5qo8AP4Wc6odZwP23FABZQNi0ggNwVBl3d2QxeQkQ9gWb3MKQr1AV0ARTNysbJjJnlDAWsYNCQqMNOd3LKg4FB7HsitQX1q1uGzzvCqE3UUuBjAlb7SDPDQeOICUFLf+vRKH8Dlusw+U+ZloMm3fbfN5/N7XfZyl+eDDFWTgSNrNnxlPIw9uc2+/vFSJCKQq/3p9JzcTObUtfgjOoeReNhBKSMKw2HXYGjl230G7iYlc9J+uzmPP5x9ghkcDUYi2cKVf2Dw8NPJu/e/nL9nuYxjbf+NB6PBKK5Mxoca9Zaq3XfOfucuNyPhP34VdSgY6C4MrUIZB0IMzbLD8su9t9IkERVjfXoplssMPf3m1GrFx18acjwoJomYoZOYMYhdTlZJj6AM/re06GYv6XBwweqZXDUtGO9NRx4ALcdxnpMNT9Juj6Oz0/MLkYise8/VpmAeh3N+6+FcpOJKXIn4LIz9HV9kfL4UCnXZYBnRPMpl4MeGY7E9NW7j1Og+2LP+Si+2rNwdJ60r/J8de5DhB07+R1r8uCZvbx5l6GLbU3MGJ6vV6m+rl2Fi",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get your account details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},j={},f=[{value:"Request",id:"request",level:2}];function g(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:"Create Contact"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/createcontact"}),"\n",(0,l.jsx)(a.p,{children:"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create contact"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"1232131321"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(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,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Contact already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact already exists!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Contact already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.0316b8ef.js b/assets/js/8a855f99.a5cf424a.js similarity index 62% rename from assets/js/8a855f99.0316b8ef.js rename to assets/js/8a855f99.a5cf424a.js index 93a170205..3acf7f1df 100644 --- a/assets/js/8a855f99.0316b8ef.js +++ b/assets/js/8a855f99.a5cf424a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>j,metadata:()=>x,toc:()=>g});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),t=(s(82723),s(9487)),o=s(41429),p=s(5397),c=s(4667),m=s(9472),h=s(85162);const j={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XAorB0YS9rLUiuR+UFuqqGwcjg7xCa5K+2DKKUuD+7VGm98P2d8Wwi3IlgDKax8TQtMOoD6UquZOCURubhJkNP2fjOBXnbgb9N9n8F3CRwZd6knJnqxwv+dJX0uSx2zNzvcGcEfSeWmIp5kYUrQif/9519RozB5XZEOsbgewbvagTVzckzbQhcwUXQrM0V7bhmeRKXIe7UAqQOVjsdkIUsZhAKGl6khF1ZkUkkuRxYzrO2gV9F+AB+nFKbkeOsbRyCgoBkprmJQxtywnWBA1MFU8YyVzzA37mbCLiUgIKu91OQ9eKJOhfRU6JygS2oCxoHQQDqQs056AiErFp4YBzSZyFyyYe49J/IAldCiJD4sAfabUbDtXcGDM1ntA3ij6hgIn1gRhTZETVT4AfwiZ9QGzosFBSEVFVDWbCKB3BQEq1bkMHQBGfkAlo+XOUWjPggXQNGMXCzimMlJrRRYwxwhheIbVj+3bCg4oT3TWOtQl5o1fNYZntDxjEIsBnClrzSzOtSeuACU1Dc+vdIHcLkus4+UeRlo/LhrrPl8vtNQT7Z1XskwrTNwZM1Gr4yLsf366us/TzDBQK7y7ybn5GYyp1U3f+HMYRQerphT5JE5qRJStc36010F7iYlc9Keejx38ursDczg6WCESY9C/oXDwzenL16+PX/Jdpmy2v47HIwGo3gdMz5UQveO2rrG323c5WYAfJU7/4rFAt2GoVVCRlKP8S5XhNzdWjHBdHPdHyc4NT7w9nKZCU8fnGoaXv5ck2PKHyc4E06KjPnpcomF9Py7WN/nvxjn4/erK/MT2Pty2OtzR8eauXgmVB1vrwne0GLrndKMm6RjZHar3X/RHn5wwVY2+jsTlwdKq3GS52TDvbL9EXf24QITzFavjiq+a9CJOT+ExBxTvMIrjG+wyCHx4cDrS1RCl7UoWb41y3NE1Jya/hC6iUNo9YMD2wvI9nRqI+FPjmuvwg9cYq9p8eNavN35osIK2k6akzNumuYf0NMmBw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XAorB0YS9rLUiuR+UFuqqGwcjg7xCa5K+2DKKUuD+7VGm98P2d8Wwi3IlgDKax8TQtMOoD6UquZOCURubhJkNP2fjOBXnbgb9N9n8F3CRwZd6knJnqxwv+dJX0uSx2zNzvcGcEfSeWmIp5kYUrQif/9519RozB5XZEOsbgewbvagTVzckzbQhcwUXQrM0V7bhmeRKXIe7UAqQOVjsdkIUsZhAKGl6khF1ZkUkkuRxYzrO2gV9F+AB+nFKbkeOsbRyCgoBkprmJQxtywnWBA1MFU8YyVzzA37mbCLiUgIKu91OQ9eKJOhfRU6JygS2oCxoHQQDqQs056AiErFp4YBzSZyFyyYe49J/IAldCiJD4sAfabUbDtXcGDM1ntA3ij6hgIn1gRhTZETVT4AfwiZ9QGzosFBSEVFVDWbCKB3BQEq1bkMHQBGfkAlo+XOUWjPggXQNGMXCzimMlJrRRYwxwhheIbVj+3bCg4oT3TWOtQl5o1fNYZntDxjEIsBnClrzSzOtSeuACU1Dc+vdIHcLkus4+UeRlo/LhrrPl8vtNQT7Z1XskwrTNwZM1Gr4yLsf366us/TzDBQK7y7ybn5GYyp1U3f+HMYRQerphT5JE5qRJStc36010F7iYlc9Keejx38ursDczg6WCESY9C/oXDwzenL16+PX/Jdpmy2v47HIwGo3gdMz5UQveO2rrG323c5WYAfJU7/4rFAt2GoVVCRlKP8S5XhNzdWjHBdHPdHyc4NT7w9nKZCU8fnGoaXv5ck2PKHyc4E06KjPnpcomF9Py7WN/nvxjn4/erK/MT2Pty2OtzR8eauXgmVB1vrwne0GLrndKMm6RjZHar3X/RHn5wwVY2+jsTlwdKq3GS52TDvbL9EXf24QITzFavjiq+a9CJOT+ExBxTvMIrjG+wyCHx4cDrS1RCl7UoWb41y3NE1Jya/hC6iUNo9YMD2wvI9nRqI+FPjmuvwg9cYq9p8eNavN35osIK2k6akzNumuYf0NMmBw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\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)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(t.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 create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "folder 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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.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 b(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>w,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),t=s.n(i),d=(s(82723),s(9487)),o=s(41429),p=s(5397),c=s(4667),m=s(9472),h=s(85162);const x={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21vGzcM/issv6wFLn5J0247DMOyruuyFG3QpCiwxAh0d7StRiepks6OYdy3/ZL9tP2SgTqffY6dYAHWffGLRFLkQ/KhtMQgJh7TS/zVqIIcjhIsyOdO2iCNxhQvpgQfbSECQSMCx2cnIJQycw8LU0EwUJm4P272tSgJhIc5KcXfVjjSoVE+KXqYoLHkBNs/KTDFKlpvlDFBK5woKZBjt5bI1jDFZvtaFpigZL+sCFO866zJPlMeTgowY1gbdPSlko4KTIOrKEEfFopNellaRZgg3VplCsJ0LJRngXxKpcB0iWFho2RwUk8wwbFxpQjdFboV0UqK2ekwHxeHU5thXY+aY8mHn02xYFPbjp45M5MFQUbKzGEdMoOZO9qAiQnmRgfSgW0Ia5XMI3L9z54NLTvObuK8XMEVsRslbRgNOgyx4wwESZ71Gtl3EefHhaxp3vpZx8R18vxYW1jXCQYZVCfbGWNX17zjyFujfePx4WCwC6mv8py8H1cK1vX1GPgeBqmtrMeG9duNP/zd0vzEMkRNqRfHYZ+ZjdLh4PD5wXBwMPj2YvgyPfo+ffGyNxgM/sAEb0vFuquuYGvYwa3531mQWklN1y1614eDwfVwuML0aB+M56akMJV6AnPSAebO6EkCVpHwBMEtQEyE1KBEIPfkv8OXnDPuYVQe59lDKBwxCmsQjnZBaJnMBBibSkfS+tqBPlRFu/48HN7R9Xfr8F7shneiZ0LJIjJ5MDek/99E7jmeXd0ubdkIxX3cCra73gTpKa+cDIs4MG4PhJUHzX56OWIq5roxPGpsFR3m0ZFiv0G1v1zPlhrZlpu1s6dyClOchmB92u8La3vGkvZyopXIfC83ZV9Y2Z8NsU7uSnuhi8zc3q8x2vh9ztg28G15vwZRWHlKC0xacLpSq3k4JRF5uE6QU/ZhM31et8BvU32XvXfJGxlzqccmerHC/r0lfS4nOmZuNtwZv59I5aYknmJhStCK//3nX1GjMHlVkg6xsJ7A+8qBNXNyTNlCFzBWdCszRXtuGJ5Eqch7tQCpA00cj8hCTmQQChhepoVcWJFJJbkUWcywtoNONfsefJpSmJLjrW8cgYCCZqS4gkEZc8N2ggFRBVPGM1Y+w9y4mzG7lICArPJSk/fgiVoV0lOhc4I2qQkYB0ID6UDOOukJhCxZeGwc0Hgsc8mGue+cyAOUQosJ8WEJsN+Mgm3uCR6cySofwBtVxUD4xJIoNCFqosL34Bc5oyZwXiwoCKmogEnFJhLITUGwakMOQxeQkQ9g+XiZUzTqg3ABFM3IiUkMbUowrpQCa5gfpFB8u+rmlg0FJ7RnCmscalOzhs86w9M5nlGIRQ+u9JVmRofKExeAkvrGp1f6AC7XZfaJMi8DjZ62TTWfz3ca6tm2zhsZplUGjqzZ6E3iYmy/rvr6zzNMMJAr/fvxObmZzGnVyfec2Y/C/RVrijyyJpVCqqZZf7qrwN2kZE7aU4fjjt+cvYUZPO8NMOnQx79wuP/25NXrd+ev2S7TVdN/w96gN4hXMeNDKXTnqK0r/N3GXW7I/6vc91csFug29K0SMhJ6jHe5IuP2xooJppur/ijBqfGBt5fLTHj66FRd8/KXihzT/SjBmXBSZMxPl0sspOffxfouf2+cTz+srsvPYO+rYa/PLR1r5uKZUFW8uSZ4Q4utN0o9qpOWkdmtZv9Vc/jBBVvZ6O9MWx4mjcZxnpMND8p2x9vZxwtMMFu9OMr4pkEn5vwIEnNM8QqvML6/IofERwOvL1EJPanEhOUbszxHRMWp6Q6hmziEVj84sL2AbE+nJhL+5Lj2KvzAJXZKix/X4s3OvQoraFtpTs6orut/AA6xJJs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21vGzcM/issv6wFLn5J0247DMOyruuyFG3QpCiwxAh0d7StRiepks6OYdy3/ZL9tP2SgTqffY6dYAHWffGLRFLkQ/KhtMQgJh7TS/zVqIIcjhIsyOdO2iCNxhQvpgQfbSECQSMCx2cnIJQycw8LU0EwUJm4P272tSgJhIc5KcXfVjjSoVE+KXqYoLHkBNs/KTDFKlpvlDFBK5woKZBjt5bI1jDFZvtaFpigZL+sCFO866zJPlMeTgowY1gbdPSlko4KTIOrKEEfFopNellaRZgg3VplCsJ0LJRngXxKpcB0iWFho2RwUk8wwbFxpQjdFboV0UqK2ekwHxeHU5thXY+aY8mHn02xYFPbjp45M5MFQUbKzGEdMoOZO9qAiQnmRgfSgW0Ia5XMI3L9z54NLTvObuK8XMEVsRslbRgNOgyx4wwESZ71Gtl3EefHhaxp3vpZx8R18vxYW1jXCQYZVCfbGWNX17zjyFujfePx4WCwC6mv8py8H1cK1vX1GPgeBqmtrMeG9duNP/zd0vzEMkRNqRfHYZ+ZjdLh4PD5wXBwMPj2YvgyPfo+ffGyNxgM/sAEb0vFuquuYGvYwa3531mQWklN1y1614eDwfVwuML0aB+M56akMJV6AnPSAebO6EkCVpHwBMEtQEyE1KBEIPfkv8OXnDPuYVQe59lDKBwxCmsQjnZBaJnMBBibSkfS+tqBPlRFu/48HN7R9Xfr8F7shneiZ0LJIjJ5MDek/99E7jmeXd0ubdkIxX3cCra73gTpKa+cDIs4MG4PhJUHzX56OWIq5roxPGpsFR3m0ZFiv0G1v1zPlhrZlpu1s6dyClOchmB92u8La3vGkvZyopXIfC83ZV9Y2Z8NsU7uSnuhi8zc3q8x2vh9ztg28G15vwZRWHlKC0xacLpSq3k4JRF5uE6QU/ZhM31et8BvU32XvXfJGxlzqccmerHC/r0lfS4nOmZuNtwZv59I5aYknmJhStCK//3nX1GjMHlVkg6xsJ7A+8qBNXNyTNlCFzBWdCszRXtuGJ5Eqch7tQCpA00cj8hCTmQQChhepoVcWJFJJbkUWcywtoNONfsefJpSmJLjrW8cgYCCZqS4gkEZc8N2ggFRBVPGM1Y+w9y4mzG7lICArPJSk/fgiVoV0lOhc4I2qQkYB0ID6UDOOukJhCxZeGwc0Hgsc8mGue+cyAOUQosJ8WEJsN+Mgm3uCR6cySofwBtVxUD4xJIoNCFqosL34Bc5oyZwXiwoCKmogEnFJhLITUGwakMOQxeQkQ9g+XiZUzTqg3ABFM3IiUkMbUowrpQCa5gfpFB8u+rmlg0FJ7RnCmscalOzhs86w9M5nlGIRQ+u9JVmRofKExeAkvrGp1f6AC7XZfaJMi8DjZ62TTWfz3ca6tm2zhsZplUGjqzZ6E3iYmy/rvr6zzNMMJAr/fvxObmZzGnVyfec2Y/C/RVrijyyJpVCqqZZf7qrwN2kZE7aU4fjjt+cvYUZPO8NMOnQx79wuP/25NXrd+ev2S7TVdN/w96gN4hXMeNDKXTnqK0r/N3GXW7I/6vc91csFug29K0SMhJ6jHe5IuP2xooJppur/ijBqfGBt5fLTHj66FRd8/KXihzT/SjBmXBSZMxPl0sspOffxfouf2+cTz+srsvPYO+rYa/PLR1r5uKZUFW8uSZ4Q4utN0o9qpOWkdmtZv9Vc/jBBVvZ6O9MWx4mjcZxnpMND8p2x9vZxwtMMFu9OMr4pkEn5vwIEnNM8QqvML6/IofERwOvL1EJPanEhOUbszxHRMWp6Q6hmziEVj84sL2AbE+nJhL+5Lj2KvzAJXZKix/X4s3OvQoraFtpTs6orut/AA6xJJs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Folder"})}),"\n",(0,l.jsx)(t(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\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)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(d.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 create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(c.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 w(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.1fef8831.js b/assets/js/a2bc1463.e5b83ec4.js similarity index 64% rename from assets/js/a2bc1463.1fef8831.js rename to assets/js/a2bc1463.e5b83ec4.js index 4248fecee..ec6b7af01 100644 --- a/assets/js/a2bc1463.1fef8831.js +++ b/assets/js/a2bc1463.e5b83ec4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1r3EYQ/iuT/dIG5Dud46RUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVro7nR2nTQmhYGxr95nXnXlmNiJg5UV2I14YHbAIXkwTUZIvnLRBGi0ycV0T9LfwWvoA528vgRprluQ8rE0LwYCj4CQtCBAUY8wMil5jAtaZhSylrgChMI11VJP2ckGwkLRkLCoFuECpMFe0lwSpWb/bHeTGzEciEcaSQ/bushSZ6C/ZrEiERYcNBXIc1UZobEhkQslG8q3kgD625NYiEY4+ttJRKbIZKk+J8GGtGD0zrhGJoJVVpiSRBdfybVFTgyLbiAZXsmkbkT1N00SEtWUh3TY5ObFlOWwsK5qk22Tvgp9L+9U8eNhmup2yXm+N9uQZe5qm/Of4UX1bFOT9rFWwz6ZIYi5JB8ajtUoW8WJ861loc98Bk99SEdPuWE2QnUlHvlVhgEPnkAOWgRr/z/LdMb/uHumDk7oSSUwNhuHJPnZh60ler05vLaeky/uXKbg1BDlRzGiDUv0H+ZzoeX8wKkzDqmxt9Be7cjZ5MjmNP6yicISByvPwKTUHodP09MnJJD1Jf7iePMvOfsyePhulafq7SMSqidH01VhiiFEGGdTwu7XlN7CzvQvre7ikgFL5oUB/I7bbwaHUSmr6sCvzD1zi24g4+1SxX5mGQs38syQdYOmMrhKwitATBLcGrFBqUBjIPfp6XUDOGff5PH6ZZ59LwVmafpjsk/D0fhIu9QKVLCN7X5s56W8b6dB86MzfLwPZgeK9OAp2eN4F6alonQzrSPOrE7TypLvPbqbMgZxYw/Ohom4uhFpkYnw8LTy5xW5UtE6JTNQhWJ+Nx2jtyFgeU5VWmHvu5TFaOV5wP95F+4CV1NXJZ6WmB6evOLFd7o5cPxCmla+IGbPPzBDVD5GasGTy3/L3zEThPl9vLOkrWemY7cVE3B3p70gVpiEe3KEm2MH/+uPPKFGaom1Ih1gMj+BN6yBOe54WqEuYKVpJHtQMRqXMcr8HeMJGkfdqDVIHqhwGglJWMqACzgrXeoEWc6kklw/DTDflBxXoR/CuplCT46vvHO8VJS1IcdWBMmbOeoIBbINpoo3eZ1gaN5+xSwkg5K2XmrwHT7QTIV2jLgh2b5GAcYAaSAdy1klPgLJh8Mw4oNlMFpIVc+U4XoIa1FgRG0uA/eYsdCsOeXAmb30Ab1QbA2GLDVHoQtREpR/BL7z7xMD5sGM9KqFqWUUChSkJ+tbhMHQJOfkAls3LgqJSH9AFULQgF2svvuSsVQqs4Z6WqHizGr4tKwoOtee50zm0e5p9+qwzvBhEGyWuR/Bev9dMU9B64gJQUs999l6fwM2+zN5R7mWg6fe7flgul/f64PGxzIUMdZuDI2sOclU8jF0zFN9/PBaJCOQa/2Z2RW4hC+qb8AGb4wge90zHc4TZqpvs3GPP7wow6yhZkPY04KXzi7evYQFPRqlIBp3/Lxwev7588fLXq5esl5mm67/JKB2lcTMwPjSoB6YuKOy37Z6kjnp3c+Ds/+Fm3rNXoFUYW4UysnhM2KZn4JujfX2aiNr4wMebTY6efnNqu+XjbkVmXi6lZ9uHJXlO68FKv0DVss3Iyg9g+937AJ3yh5OMjfMi2bEpG+xkzouC7NDAvQF5NGUuXl6LRGDLMQ5ZfB5ZvP+Hte+u9Hqg+5jeOwf4N8f0SYGf+Klf0frnPby7eVCgj2+H5peZbrfbvwFDgtZW",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,l.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>N,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=s(41429),m=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVu9u2zYQf5Urv2wFFFtO0w4ThqFBVwRBi7VAMhRYahQn6WwxpkiWpGQbhr/tSfZoe5LhKNmWk6Zbh6IYECQR+bu/vPvdbUTAuRfZjXhhdMAieDFNREm+cNIGabTIxHVF0N/Ca+kDnL+9BKqtWZLzsDYNBAOOgpPUEiAoxpgZFL3GBKwzrSylngNCYWrrqCLtZUvQSloyFpUCbFEqzBXtJUFq1u92B7kxi5FIhLHkkL27LEUm+ks2KxJh0WFNgRxHtREaaxKZULKWfCs5oI8NubVIhKOPjXRUimyGylMifFgrRs+Mq0UiaGWVKUlkwTV8W1RUo8g2osaVrJtaZE/TNBFhbVlIN3VOTmxZDmvLiibpNtm74BfSfjUPHraZbqes11ujPXnGnqYp/zl+VN8UBXk/axTssymSmEvSgfForZJFvBjfehba3HfA5LdUxLQ7VhNkZ9KRb1QY4NA55IBloNr/s3x3zK+7R/rgpJ6LJKYGw/BkH7uw1SSvVqe3llPS5f3LFNwagpwoZrRGqf6DfE70vD8YFaZmVbYy+otdOZs8mZzGH1ZROMJA5Xn4lJqD0Gl6+uRkkp6kP1xPnmVnP2ZPn43SNP1dJGJVx2j6aiwxxCiDDGr43djyG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV92JX5By7xbUScfarYr0xNoWL+WZIOsHRGzxOwitATBLcGnKPUoDCQe/T1uoCcM+7zefwyzz6XgrM0/TDZJ+Hp/SRc6haVLCN7X5sF6W8b6dB86MzfLwPZgeK9OAp2eN4F6alonAzrSPOrE7TypLvPbqbMgZxYw/NhTt1cCJXIxPh4Wnhy7W5UNE6JTFQhWJ+Nx2jtyFgeU3OtMPfcy2O0ctxyP95Fe9RlblYPS0wPDl9xUru8Hbl9IEsrXxGzZZ+VIaofIBVhycS/5e+ZicJ9rt5Y0ldyrmOm24m4O87fkSpMTTy0Q0Wwg//1x59RojRFU5MOsRAewZvGQZz0PClQlzBTtJI8pBmMSpnlfgfwhLUi79UapA40dxgISjmXARVwVrjOC7SYSyW5dBhmugk/qD4/gncVhYocX33neKcoqSXFFQfKmAXrCQawCaaONnqfYWncYsYuJYCQN15q8h480U6EdIW6INi9RQLGAWogHchZJz0ByprBM+OAZjNZSFbMVeN4AapR45zYWALsN2ehW2/IgzN54wN4o5oYCFusiUIXoiYq/Qh+4b0nBs6HHeNRCfOGVSRQmJKgbxsOQ5eQkw9g2bwsKCr1AV0ARS05nMfQKoJZoxRYw/0sUfFWNXxbVhQcas8zp3No9zT79FlneCmINkpcj+C9fq+ZoqDxxAWgpF747L0+gZt9mb2j3MtA0+93vbBcLu/1weNjmQsZqiYHR9Yc5ObxMHbNUHz/8VgkIpCr/ZvZFblWFtQ34AM2xxE87lmOZwgzVTfVucee3xVgxlGyIO1pwEnnF29fQwtPRqlIBl3/Lxwev7588fLXq5esl1mm67/JKB2lcSswPtSoB6YuKOw37Z6gjnp3c+Dr/+FW3rNXoFUYW4UyMnhM2KZn35ujXX2aiMr4wMebTY6efnNqu+Xjbj1mTi6lZ9uHBXlB68E636Jq2GZk5Aew/d59gE75w0nGxlmR7NiUDXYy50VBdmjg3nA8mjAXL69FIrDhGIcsvogs3v/D2ndXej3QfUzvnQP8m2P6pMBP/NSvaP3zHt7dPCjQx7dD88tMt9vt39Qo1Oo=",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/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVu9u2zYQf5Urv2wFFFtO0w4ThqFBVwRBi7VAMhRYahQn6WwxpkiWpGQbhr/tSfZoe5LhKNmWk6Zbh6IYECQR+bu/vPvdbUTAuRfZjXhhdMAieDFNREm+cNIGabTIxHVF0N/Ca+kDnL+9BKqtWZLzsDYNBAOOgpPUEiAoxpgZFL3GBKwzrSylngNCYWrrqCLtZUvQSloyFpUCbFEqzBXtJUFq1u92B7kxi5FIhLHkkL27LEUm+ks2KxJh0WFNgRxHtREaaxKZULKWfCs5oI8NubVIhKOPjXRUimyGylMifFgrRs+Mq0UiaGWVKUlkwTV8W1RUo8g2osaVrJtaZE/TNBFhbVlIN3VOTmxZDmvLiibpNtm74BfSfjUPHraZbqes11ujPXnGnqYp/zl+VN8UBXk/axTssymSmEvSgfForZJFvBjfehba3HfA5LdUxLQ7VhNkZ9KRb1QY4NA55IBloNr/s3x3zK+7R/rgpJ6LJKYGw/BkH7uw1SSvVqe3llPS5f3LFNwagpwoZrRGqf6DfE70vD8YFaZmVbYy+otdOZs8mZzGH1ZROMJA5Xn4lJqD0Gl6+uRkkp6kP1xPnmVnP2ZPn43SNP1dJGJVx2j6aiwxxCiDDGr43djyG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV92JX5By7xbUScfarYr0xNoWL+WZIOsHRGzxOwitATBLcGnKPUoDCQe/T1uoCcM+7zefwyzz6XgrM0/TDZJ+Hp/SRc6haVLCN7X5sF6W8b6dB86MzfLwPZgeK9OAp2eN4F6alonAzrSPOrE7TypLvPbqbMgZxYw/NhTt1cCJXIxPh4Wnhy7W5UNE6JTFQhWJ+Nx2jtyFgeU3OtMPfcy2O0ctxyP95Fe9RlblYPS0wPDl9xUru8Hbl9IEsrXxGzZZ+VIaofIBVhycS/5e+ZicJ9rt5Y0ldyrmOm24m4O87fkSpMTTy0Q0Wwg//1x59RojRFU5MOsRAewZvGQZz0PClQlzBTtJI8pBmMSpnlfgfwhLUi79UapA40dxgISjmXARVwVrjOC7SYSyW5dBhmugk/qD4/gncVhYocX33neKcoqSXFFQfKmAXrCQawCaaONnqfYWncYsYuJYCQN15q8h480U6EdIW6INi9RQLGAWogHchZJz0ByprBM+OAZjNZSFbMVeN4AapR45zYWALsN2ehW2/IgzN54wN4o5oYCFusiUIXoiYq/Qh+4b0nBs6HHeNRCfOGVSRQmJKgbxsOQ5eQkw9g2bwsKCr1AV0ARS05nMfQKoJZoxRYw/0sUfFWNXxbVhQcas8zp3No9zT79FlneCmINkpcj+C9fq+ZoqDxxAWgpF747L0+gZt9mb2j3MtA0+93vbBcLu/1weNjmQsZqiYHR9Yc5ObxMHbNUHz/8VgkIpCr/ZvZFblWFtQ34AM2xxE87lmOZwgzVTfVucee3xVgxlGyIO1pwEnnF29fQwtPRqlIBl3/Lxwev7588fLXq5esl1mm67/JKB2lcSswPtSoB6YuKOw37Z6gjnp3c+Dr/+FW3rNXoFUYW4UyMnhM2KZn35ujXX2aiMr4wMebTY6efnNqu+Xjbj1mTi6lZ9uHBXlB68E636Jq2GZk5Aew/d59gE75w0nGxlmR7NiUDXYy50VBdmjg3nA8mjAXL69FIrDhGIcsvogs3v/D2ndXej3QfUzvnQP8m2P6pMBP/NSvaP3zHt7dPCjQx7dD88tMt9vt39Qo1Oo=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"},next:{title:"Draft Document",permalink:"/docs/API-docs/draftedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,l.jsx)(a.p,{children:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "4131231231",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function N(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/a88a3db3.a78443ac.js b/assets/js/a88a3db3.a78443ac.js deleted file mode 100644 index bd3268567..000000000 --- a/assets/js/a88a3db3.a78443ac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var s=l(85893),t=l(11151),i=l(58219),n=(l(62316),l(51039)),r=l.n(n),d=(l(82723),l(9487)),m=l(41429),o=l(5397),c=l(4667),p=l(9472),h=l(85162);const x={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam7nkHOGa0GyDCK9EddYOy0Jg5gmIseQeeVIWSNScV0hnKNGQhis4OzdJThv5yrHACvbwEJRBVQhyJnSilZAFjzWdo4gITjMVKEyoMG/8LaO5sNKGMFlAXJroQIYC9qaEj0YxBxzkQjr0Euu6zIXqchjVUNRIhFOelkjoWdMa2FkjSIVQ8xbxSEUY3KSKnEf6OU52GKvKqBKUsweGNAMoUvJcTx+apTHXKTkG0xEoJXmbEHVTnMxuHTa5ijSQurABlmFtRTpWtDKRUvyypQiEYX1taTtSttOOX5w1gQM7HEymfDfvY0ZquyLgtBkGYZQNFqvnohEZNYQGmJP6ZxWWaRu/DGw+/qwIDv7iBkxj56JJtUl75aZ8cPScSkj3FT8tKxOZHC/uOeiTfqtyc/ocaeTycnzo+PJ0eTb6+OX6el36YuXo8lk8odIxLLW7NvvYc4b3CaCFOnte3tgFtPuGfYrLRufPkTjla2RKmVKWKAhWHhrygScRhkQyK9AllIZYKb9f8gqem/94+x8WWXtDmpltDJ4O5yh29PJ5PZ4Q8LpI2fJWILCNib/ulAfyv84oNPblxtALw4BXZq51CqPSnVt79B8XTy76alLf3haVWcUv4s9sLvrHciAWeMVraKwLY+kU0fd9/RmynLBJ8VuRTGKIVUiFeNBzMbrHSFsBYf080EqG69FKioiF9LxWDo3sg5NUKXRchZGma3H0qnx/Fi0yX3rQLJUpjx61Gu6hXDFNHdM7gHZ8Cmdeo0rkQw87Vr1Al6hzNFHTpUpbHTu2Xvr0Fyp0kTu58cHMv8edWZrZEFnrR/M//7zr+iR26yp0VA8Gk/gbePB2QX6otEgTQ6FxqWa6W4GSq3topuAZCGgrDWGoFegDGHpozirUpHUwKxwK2fSdTNSYWAzy94eds5jGMH7CqlCz5++8TxCc5yj5jMI2to7jkMWZEO2jjn6mmFh/V3BJSUgYdYEZTAECIiDC5pKmgxh2IsErAdpAA2hd14FBKlqNi6sBywKlSkOzJ3jZUZQSyNL5GQJcN17NwFvZ00gCFY3EQhnrBGpgxjn6AjO1Rw74LyYI0mlMYey4RAJZDZH6BuJYZgcZhgIHKdXGcaggaQn0DhHH89e3Emee+Asd7iSmmf57t5yIPLSBJ62XUHD1mzoc97yAI05crkawQfzwbAKQxOQD4BW5i6kH8wR3GyO2XucBUU4fTr0w2KxOOiDZ/s+rxRVzQw8Orv1K+Ni7Jpd983LM5EIQl+Ht8UV+rnKsG/Cz+QcR+Nxr3syi7qHtVS667Ef7zuwBmmVoQm4o1Jnr969gTk8H01EstP5/6Lg8ZvLny9+vbrguKw0Xf8djyajCS85G6iWZifVvWvm/dZdbwX8f3Ur7WWLcEljp6WKYh6ZWvcqfLO5hIpEpLsX0mkiKhuITdbrmQz4u9dty8ufGvQs99NEzKVXcsbqdrMWuQr8nG8ulp/l6Olv/R31GXzZ3fZBQIM4G1bmudQNv4lE3OHq3iW7nbbJoNBccWdxlmXoaMf3YATvzbHzizcX1xciEbJhBneHw10cDv0DJ3iwtP2p0dXAvzzAHnT4ns/Pa1z9sDHvvnzWoYc4WDNN07Zt/wGh7qWX",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam7nkHOGa0GyDCK9EddYOy0Jg5gmIseQeeVIWSNScV0hnKNGQhis4OzdJThv5yrHACvbwEJRBVQhyJnSilZAFjzWdo4gITjMVKEyoMG/8LaO5sNKGMFlAXJroQIYC9qaEj0YxBxzkQjr0Euu6zIXqchjVUNRIhFOelkjoWdMa2FkjSIVQ8xbxSEUY3KSKnEf6OU52GKvKqBKUsweGNAMoUvJcTx+apTHXKTkG0xEoJXmbEHVTnMxuHTa5ijSQurABlmFtRTpWtDKRUvyypQiEYX1taTtSttOOX5w1gQM7HEymfDfvY0ZquyLgtBkGYZQNFqvnohEZNYQGmJP6ZxWWaRu/DGw+/qwIDv7iBkxj56JJtUl75aZ8cPScSkj3FT8tKxOZHC/uOeiTfqtyc/ocaeTycnzo+PJ0eTb6+OX6el36YuXo8lk8odIxLLW7NvvYc4b3CaCFOnte3tgFtPuGfYrLRufPkTjla2RKmVKWKAhWHhrygScRhkQyK9AllIZYKb9f8gqem/94+x8WWXtDmpltDJ4O5yh29PJ5PZ4Q8LpI2fJWILCNib/ulAfyv84oNPblxtALw4BXZq51CqPSnVt79B8XTy76alLf3haVWcUv4s9sLvrHciAWeMVraKwLY+kU0fd9/RmynLBJ8VuRTGKIVUiFeNBzMbrHSFsBYf080EqG69FKioiF9LxWDo3sg5NUKXRchZGma3H0qnx/Fi0yX3rQLJUpjx61Gu6hXDFNHdM7gHZ8Cmdeo0rkQw87Vr1Al6hzNFHTpUpbHTu2Xvr0Fyp0kTu58cHMv8edWZrZEFnrR/M//7zr+iR26yp0VA8Gk/gbePB2QX6otEgTQ6FxqWa6W4GSq3topuAZCGgrDWGoFegDGHpozirUpHUwKxwK2fSdTNSYWAzy94eds5jGMH7CqlCz5++8TxCc5yj5jMI2to7jkMWZEO2jjn6mmFh/V3BJSUgYdYEZTAECIiDC5pKmgxh2IsErAdpAA2hd14FBKlqNi6sBywKlSkOzJ3jZUZQSyNL5GQJcN17NwFvZ00gCFY3EQhnrBGpgxjn6AjO1Rw74LyYI0mlMYey4RAJZDZH6BuJYZgcZhgIHKdXGcaggaQn0DhHH89e3Emee+Asd7iSmmf57t5yIPLSBJ62XUHD1mzoc97yAI05crkawQfzwbAKQxOQD4BW5i6kH8wR3GyO2XucBUU4fTr0w2KxOOiDZ/s+rxRVzQw8Orv1K+Ni7Jpd983LM5EIQl+Ht8UV+rnKsG/Cz+QcR+Nxr3syi7qHtVS667Ef7zuwBmmVoQm4o1Jnr969gTk8H01EstP5/6Lg8ZvLny9+vbrguKw0Xf8djyajCS85G6iWZifVvWvm/dZdbwX8f3Ur7WWLcEljp6WKYh6ZWvcqfLO5hIpEpLsX0mkiKhuITdbrmQz4u9dty8ufGvQs99NEzKVXcsbqdrMWuQr8nG8ulp/l6Olv/R31GXzZ3fZBQIM4G1bmudQNv4lE3OHq3iW7nbbJoNBccWdxlmXoaMf3YATvzbHzizcX1xciEbJhBneHw10cDv0DJ3iwtP2p0dXAvzzAHnT4ns/Pa1z9sDHvvnzWoYc4WDNN07Zt/wGh7qWX",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:l}=a;return l||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(c.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.b940c425.js b/assets/js/a88a3db3.b940c425.js new file mode 100644 index 000000000..e87551ede --- /dev/null +++ b/assets/js/a88a3db3.b940c425.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaMZqgdhGgzsLgSqMVY4pkyNFesNBbv6Sf1i8phpL2ahsNUAR92ZWouZ1DzhmuBMlpEOmtuMHKaUkYxDgROYbMK0fKGpGKmxLhHDUSQm8FZ+8vwXk7UzkGWNoa5opKoBJBTpRWtASy4LGyMwQJwWGmCpUB9f6Ft1U071fCAC4LkBsLFcBY0NZM0YNBzDEXibAOveS6LnORijxW1RclEuGklxUSesa0EkZWKFLRx7xTHEIxJiepFPtAL8/BFjtVAZWSYvbAgCYIbUqO4/FzrTzmIiVfYyICLTVnC6pymovBhdM2R5EWUgc2yEqspEhXgpYuWpJXZioSUVhfSdqsNM2Y4wdnTcDAHiejEf/tbUxfZVcUhDrLMISi1nr5TCQis4bQEHtK57TKInXDT4HdV4cF2cknzIh59Ew0qTZ5u8yMH5aOCxnhpuKnRXkig/vFvRRN0m1NfkZPO52MTl4eHY+ORt/eHL9OT79LX70ejEajP0QiFpVm324Pc97gJhGkSG/emwOzmHbHsFtp2Pj0IRqvbYVUKjOFORqCubdmmoDTKAMC+SXIqVQGmGn/H7KK3lv/NDtfVlmzhVoZrQze9Wfo7nQ0ujtek3D6xFkylqCwtcm/LtSH8j8N6PTu9RrQq0NAl2YmtcqjUt3YezRfF892emrTH55W1RrF72IH7PZ6CzJgVntFyyhsiyPp1FH7Pb0ds1zwSbEbUYxiSKVIxbAXs+FqSwgbwSH9rJfK2muRipLIhXQ4lM4NrEMT1NRoOQmDzFZD6dRwdiyaZN86SJNP7OJxj/Gm/GumuGVxB8SaS+nUW1yKpOdo26oT7xJljj7yqUxho3PH3DuH5lpNTeR9dnwg8R9QZ7ZCFnPW+d787z//ih65zeoKDcVj8Qze1R6cnaMvag3S5FBoXKiJbuef1NrO2+lHFgLKSmMIegnKEE59FGY1VSQ1MCvcxpl07XxUGNjMsreHrbMYBvChRCrR86dvPI/PHGeo+fyBtvae45AFWZOtYo6uZphbf19wSQlImNRBGQwBAmLvgqaUJkPo9yIB60EaQEPonVcBQaqKjQvrAYtCZYoDc9d4mRFU0sgpcrIEuO6dW4C3kzoQBKvrCIQzVojUQowzdADnaoYtcF7MkaTSmMO05hAJZDZH6JqIYZgcJhgIHKdXGcaggaQn0DhDL6cRWonAMw+c5e5WUvMc395bDkRemsCTti2o35o1fc5bHp4xRy6XA/hoPhpWYKgD8gHQytyH9KM5gtv1MfuAk6AIx8/7XpjP5wd98GLX542isp6AR2c3ftO4GLtm23398kIkgtBX4V1xjX6mMuwa8JGcw2g87DRPZlHzsJJKtz32474D649WGZqAWwp19ub9Fczg5WAkkq2u/xcFD68uf7749fqC47LKtP13PBgNRrzkbKBKmq1Ue1fM/dZdbcT7f3Uj7WSLcEFDp6WKQh6ZWnUKfLu+gIpEpNuX0XEiShuITVariQz4u9dNw8ufa/Qs9eNEzKRXcsLqdrsSuQr8nK8vlY9y9Py37n76Ar7sXvsgoF6cDSvzTOqa30Qi7nG5d8Fuxk3SKzRX3FqcZRk62vI9GL87M+z84uri5kIkQtbM4PZwuI/DoXvgBA+Wtjs12hr4l4fXgw7f8/l5i8sf1ubtl0cdOoi9NdM0bprmH/CjpCs=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete Template",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaMZqgdhGgzsLgSqMVY4pkyNFesNBbv6Sf1i8phpL2ahsNUAR92ZWouZ1DzhmuBMlpEOmtuMHKaUkYxDgROYbMK0fKGpGKmxLhHDUSQm8FZ+8vwXk7UzkGWNoa5opKoBJBTpRWtASy4LGyMwQJwWGmCpUB9f6Ft1U071fCAC4LkBsLFcBY0NZM0YNBzDEXibAOveS6LnORijxW1RclEuGklxUSesa0EkZWKFLRx7xTHEIxJiepFPtAL8/BFjtVAZWSYvbAgCYIbUqO4/FzrTzmIiVfYyICLTVnC6pymovBhdM2R5EWUgc2yEqspEhXgpYuWpJXZioSUVhfSdqsNM2Y4wdnTcDAHiejEf/tbUxfZVcUhDrLMISi1nr5TCQis4bQEHtK57TKInXDT4HdV4cF2cknzIh59Ew0qTZ5u8yMH5aOCxnhpuKnRXkig/vFvRRN0m1NfkZPO52MTl4eHY+ORt/eHL9OT79LX70ejEajP0QiFpVm324Pc97gJhGkSG/emwOzmHbHsFtp2Pj0IRqvbYVUKjOFORqCubdmmoDTKAMC+SXIqVQGmGn/H7KK3lv/NDtfVlmzhVoZrQze9Wfo7nQ0ujtek3D6xFkylqCwtcm/LtSH8j8N6PTu9RrQq0NAl2YmtcqjUt3YezRfF892emrTH55W1RrF72IH7PZ6CzJgVntFyyhsiyPp1FH7Pb0ds1zwSbEbUYxiSKVIxbAXs+FqSwgbwSH9rJfK2muRipLIhXQ4lM4NrEMT1NRoOQmDzFZD6dRwdiyaZN86SJNP7OJxj/Gm/GumuGVxB8SaS+nUW1yKpOdo26oT7xJljj7yqUxho3PH3DuH5lpNTeR9dnwg8R9QZ7ZCFnPW+d787z//ih65zeoKDcVj8Qze1R6cnaMvag3S5FBoXKiJbuef1NrO2+lHFgLKSmMIegnKEE59FGY1VSQ1MCvcxpl07XxUGNjMsreHrbMYBvChRCrR86dvPI/PHGeo+fyBtvae45AFWZOtYo6uZphbf19wSQlImNRBGQwBAmLvgqaUJkPo9yIB60EaQEPonVcBQaqKjQvrAYtCZYoDc9d4mRFU0sgpcrIEuO6dW4C3kzoQBKvrCIQzVojUQowzdADnaoYtcF7MkaTSmMO05hAJZDZH6JqIYZgcJhgIHKdXGcaggaQn0DhDL6cRWonAMw+c5e5WUvMc395bDkRemsCTti2o35o1fc5bHp4xRy6XA/hoPhpWYKgD8gHQytyH9KM5gtv1MfuAk6AIx8/7XpjP5wd98GLX542isp6AR2c3ftO4GLtm23398kIkgtBX4V1xjX6mMuwa8JGcw2g87DRPZlHzsJJKtz32474D649WGZqAWwp19ub9Fczg5WAkkq2u/xcFD68uf7749fqC47LKtP13PBgNRrzkbKBKmq1Ue1fM/dZdbcT7f3Uj7WSLcEFDp6WKQh6ZWnUKfLu+gIpEpNuX0XEiShuITVariQz4u9dNw8ufa/Qs9eNEzKRXcsLqdrsSuQr8nK8vlY9y9Py37n76Ar7sXvsgoF6cDSvzTOqa30Qi7nG5d8Fuxk3SKzRX3FqcZRk62vI9GL87M+z84uri5kIkQtbM4PZwuI/DoXvgBA+Wtjs12hr4l4fXgw7f8/l5i8sf1ubtl0cdOoi9NdM0bprmH/CjpCs=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Template",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,l.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\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 deleted",required:!0,style:"simple",explode:!1,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 deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"deletedAt",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": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.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 b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.2592b532.js b/assets/js/ada7accb.2592b532.js deleted file mode 100644 index 2ccd53eed..000000000 --- a/assets/js/ada7accb.2592b532.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=s(85893),r=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\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)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.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)(c.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,r.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/ada7accb.538897d0.js b/assets/js/ada7accb.538897d0.js new file mode 100644 index 000000000..3098056ce --- /dev/null +++ b/assets/js/ada7accb.538897d0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>u,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=s(85893),r=s(11151),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const x={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ22FoqjRpq6TIAlqFwHqLAxKGq0YUyRDjvaChd76Jf20fkkxlHat9SWoiyAvtkXO5cxw5sx4I0jOg0gvxK9WF+jFLBEFhtwrR8oakYrzCuEECbp7OH53ClJruwywtg2QBY/kFS4QCiSpdACZ2YZAQnCYq1LlUEbVkUiEdeglGz4tRCrmSN2VSISTXtZI6BnMRhhZo0hFd32pCpEIxWicpErchGizj5jTaQG2hJ1Bj58a5bEQKfkGExFordlkULXTKBKBK6dtgSItpQ4skFdYS5FuBK1dlCSvzFwkorS+ljQ8wZWMVlLhfptmVX5YuUy07YzdBmdNwMCGDicT/rWPNjR5jiGUjYZdOkQicmsIDbG8dE6rPF6MPwZW2txG1wXNmfNshlTncpuLB8dRTbNqdfjRiTbp0/4mvsHDzBhcbp+gjY+KhrrKeTikl4dGhmdX6h3etPV/kYUmG6DLPUrC4pjuMnWteDg5fHownRxMvj2fPk+Pvk+fPR9NJpM/RSJWtWbdvlgLSREpKdLD78YVX8HP4KDvGo9BtC1fHN1Vh2e2RqqUmcMSDcHSWzNPwGmUAYH8GuRcKgNaEvpHX65A0XvrP5+JhyEbRq6MVgYvt014eTSZXE53STi6nYQuVWAsQWkbU4y+QqCfq9LbeD4f3tHld7vwnt0O79QspFZFZO1ze4Xm6z7k0D117hnqfjmrTijei71gh+ddkAHzxitaxxmxOpBOHXT36cWM2ZfrxvajJQ4VqkQqxl1Wx5vdOGkF2/KL7bhpvBapqIhcSMdj6dzIOjRBzY2WWRjlth5Lp8aLqWiTm9JBmiKzq/s1Zte4zzi3Xfr20O+SKJ16hWuRbJMzlOpHYIUyEljL36WNyn3K3jo0Z2puYsIX01uD8j3q3NbIU5sqhK34P3/9HTUKmzc1Gor18AjeNh6cXaLnUSVNAaXGlco03rEEBJS1xhD0GpQhnHtJCIWaK5IaOCvczbl0MlNacQWxmGVtD4MiDCN4XyFV6PnqG48gocAFai480NZesR2yIBuydfTRY4al9VclQ0pAQtYEZTAECIhbFTSVNDnC9i0SsB6kATSE3nkVEKSqWbi0HrAsVa7YMLeLlzlBLY2cIztLgHFzFpy3C1VgAG+zJhAEq5sYCHusEakL0SAWYQS/qAV2gfNhty9hAfOGTSSQ2wKh7x4OwxSQYSBw7F7lGI0Gkp5A4wK9nMfQKoSy0Rqc5bZWUvMeNHxbNkRemsDM0wHaPs0ufc5b3kqij0KuR/DBfDBMxNAE5ALQylyF9IM5gItdmb3HLCjC2eNtLyyXy1t98GRf50RR1WTg0dlrvXk8jF0zVN99PBGJIPR1eFueoV+oHPsGvMfnOAqPe7KTeSQ7rKXSXY/9dFOBiUerHE3AATUdn7x7DQt4OpqIZND1/wHw+PXpzy/enL1gu8wyXf9NR5PRJC4zNlAtzcDV9Yp9s2s314T9ZZfxnnIIVzR2WqrIvjHKTc+cF2K3TqfXq/gsEZUNxNebTSYD/uF12/LxpwY9c/MsEQvplcyYlS42olCB/y52u/a9AT7+vV/bn8CdW/2dmLfcaZg4F1I3/CUScYXrvf8h2lmbbOmTYXX3x3mOjgaat4bi3mQ5eXEuEiEbzs+Qtq8ibfd/sPU7Ue3zeQeAf/JYuVPhB37jV7j+cSfe3dyr0Me3leYMzdq2/Rfgn84t",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,f={id:"API-docs/getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",source:"@site/docs/API-docs/getfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getfolder",permalink:"/docs/API-docs/getfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oA8l4cJ22FoqjRpq6TIAlqFwHqLAxKGq0YUyRDjvaChd76Jf20fkkxlHat9SWoiyAvtkXO5cxw5sx4I0jOg0gvxK9WF+jFLBEFhtwrR8oakYrzCuEECbp7OH53ClJruwywtg2QBY/kFS4QCiSpdACZ2YZAQnCYq1LlUEbVkUiEdeglGz4tRCrmSN2VSISTXtZI6BnMRhhZo0hFd32pCpEIxWicpErchGizj5jTaQG2hJ1Bj58a5bEQKfkGExFordlkULXTKBKBK6dtgSItpQ4skFdYS5FuBK1dlCSvzFwkorS+ljQ8wZWMVlLhfptmVX5YuUy07YzdBmdNwMCGDicT/rWPNjR5jiGUjYZdOkQicmsIDbG8dE6rPF6MPwZW2txG1wXNmfNshlTncpuLB8dRTbNqdfjRiTbp0/4mvsHDzBhcbp+gjY+KhrrKeTikl4dGhmdX6h3etPV/kYUmG6DLPUrC4pjuMnWteDg5fHownRxMvj2fPk+Pvk+fPR9NJpM/RSJWtWbdvlgLSREpKdLD78YVX8HP4KDvGo9BtC1fHN1Vh2e2RqqUmcMSDcHSWzNPwGmUAYH8GuRcKgNaEvpHX65A0XvrP5+JhyEbRq6MVgYvt014eTSZXE53STi6nYQuVWAsQWkbU4y+QqCfq9LbeD4f3tHld7vwnt0O79QspFZFZO1ze4Xm6z7k0D117hnqfjmrTijei71gh+ddkAHzxitaxxmxOpBOHXT36cWM2ZfrxvajJQ4VqkQqxl1Wx5vdOGkF2/KL7bhpvBapqIhcSMdj6dzIOjRBzY2WWRjlth5Lp8aLqWiTm9JBmiKzq/s1Zte4zzi3Xfr20O+SKJ16hWuRbJMzlOpHYIUyEljL36WNyn3K3jo0Z2puYsIX01uD8j3q3NbIU5sqhK34P3/9HTUKmzc1Gor18AjeNh6cXaLnUSVNAaXGlco03rEEBJS1xhD0GpQhnHtJCIWaK5IaOCvczbl0MlNacQWxmGVtD4MiDCN4XyFV6PnqG48gocAFai480NZesR2yIBuydfTRY4al9VclQ0pAQtYEZTAECIhbFTSVNDnC9i0SsB6kATSE3nkVEKSqWbi0HrAsVa7YMLeLlzlBLY2cIztLgHFzFpy3C1VgAG+zJhAEq5sYCHusEakL0SAWYQS/qAV2gfNhty9hAfOGTSSQ2wKh7x4OwxSQYSBw7F7lGI0Gkp5A4wK9nMfQKoSy0Rqc5bZWUvMeNHxbNkRemsDM0wHaPs0ufc5b3kqij0KuR/DBfDBMxNAE5ALQylyF9IM5gItdmb3HLCjC2eNtLyyXy1t98GRf50RR1WTg0dlrvXk8jF0zVN99PBGJIPR1eFueoV+oHPsGvMfnOAqPe7KTeSQ7rKXSXY/9dFOBiUerHE3AATUdn7x7DQt4OpqIZND1/wHw+PXpzy/enL1gu8wyXf9NR5PRJC4zNlAtzcDV9Yp9s2s314T9ZZfxnnIIVzR2WqrIvjHKTc+cF2K3TqfXq/gsEZUNxNebTSYD/uF12/LxpwY9c/MsEQvplcyYlS42olCB/y52u/a9AT7+vV/bn8CdW/2dmLfcaZg4F1I3/CUScYXrvf8h2lmbbOmTYXX3x3mOjgaat4bi3mQ5eXEuEiEbzs+Qtq8ibfd/sPU7Ue3zeQeAf/JYuVPhB37jV7j+cSfe3dyr0Me3leYMzdq2/Rfgn84t",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Folder",permalink:"/docs/API-docs/createfolder"},next:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"}},u={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\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)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.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)(c.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.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)(p.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.70967907.js b/assets/js/bbdfc22d.70967907.js deleted file mode 100644 index 58abc5cc1..000000000 --- a/assets/js/bbdfc22d.70967907.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var a=n(85893),i=n(11151),t=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=(n(41429),n(5397)),o=n(4667),m=n(9472),h=n(85162);const p={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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2lg+E3LWv3PVRcv4GSnX62+N/TZoqsR3SFFT0E4XKmGCNjVHTn6H9EF79lP7Hvk6aj6+FLYG/62KN8P5GM2vBeibfn1LyN2JuM9juOsi2CaAZa1ErAky6WcTNp63htREaDFAG7rI5uj42IUAz4burnz83F1Dx09XF17DHZfs3S7pa6qccoPApxXKMzHz3VnXw9v3KxapKtFl73KECP6ff/3brYgNPu7AfAGntYZKzVFTdxV1pEwLXAjq8+g0f9HzwaUWeVmgMfSmkBZnvnFKzFx2nCQmf5Dyik9EIeiIEZjyVaTOKTUD+DlHSjbQ1JfaFwqusaCTCYVSV67DRQGvrSq7zVkwV/pqSiwlwGFCrTBoDBjEuARlzmVKOQJvqwkoDVwCSou60sIgcFESMOUkcDoVqSDE5E80Ty2UXPIZErHE3fOkhSo2smg1oRSkUUXtExvUToNovYguRzGA19Sb5ASnwQwtFwVmMKsJRQJkxBDcC4khM5igsVAReZGiaUuCBV6jdmfT7STdKFAp8nuCFxSUdPeWEFnNpaFIwjMUt6ZRX6UVXU2ORsaXA6B0CLlyCmvIAAohr6ivqw/njZn9jBMjLLYxznw+v+UnHq2v+UbYvJ6Axkq162Zu0HmV7vLm4xGdatSlOZ2eob4WKQYntYPmgQM+CLcBT91tEM8qr8TfNxeQZy5EitJgx3e/+ObN93ANjweHLOl4xo9g+OD7k1df/3j2NeElT+zP33BwODh0DzNlbMllh9Qr3zv5tvVVG2mD5lrbN2TuGzL3DZn7hsx9Q+a+IXPfkPmQZNo3ZO4bMvcNmb9nQ8K+IXPfkDneN2TCviFz35C5b8jcN2TuGzL3DZn7hsx9Q+a+IfP/qCEz1AUpYjqoCi5cmdhVG25Chfd8s03zImE5lYBH5+zmhrLH73SxWtHwhxo11Y8vEnbNtaAsoKseJ7GuSpXIK1xSycFXFPpviX7irc6VRzaK5lQW9iteuG26E7ZbpX5zevaWJWwSWklLldEazefUZsrnbETRKXMtqU7DrpmQuz6hgstZ7YqjzOOlcjCvbb5eS75yteTwo1Nj5XLZ4XK9yOxFob8k2NYFf6UaxXe4/FsD7md2Lgi6jdC0hRer1eq/5GX1tw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.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,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.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,a.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/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.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,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.e7c6d9cb.js b/assets/js/bbdfc22d.e7c6d9cb.js new file mode 100644 index 000000000..01482dc36 --- /dev/null +++ b/assets/js/bbdfc22d.e7c6d9cb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),i=n(11151),t=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=(n(41429),n(5397)),o=n(4667),m=n(9472),h=n(85162);const p={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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2nCZUe5m54qLlukzUqzX3RrrbcBUie+QIqagmS5UwgRtaI6cfA7pgvbrp/Yt8nXUenwlbA38W/VuhvIxkl8Lzjd9+pZwuxNtn8dQ10WvTfDKWolYE2DSzyZkPG+NqInOYnA2dFHN0fGxu/6fDd09+fi5u4KOn64uvIY77ti7XNLXVDnlBoFPK5RnYuY7s66Ht+9WLFJVosvc5QgR/D//+rdbEZt73GH5Ak5rDZWao6bOKupGmRa4ENTj0Wn8oqeDSyvyskBj6D0hLc5805SYucw4SUy+IOUVn4hC0PEiMOUrSJ0Tagbwc46UaKCpL7UvElxjQacSCqWuXHeLAl5bVXYbs2Cu9NWUWEqAw4TaYNAYMIhxCcqcy5TyA95WE1AauASUFnWlhUHgoiRgykfgdCpSQYjJl2ieWii55DMkYom740kLVWxi0WpC6UejitonNaiVBtF6EV1+YgCvqS/JCU6DGVouCsxgVhOKBMiIIbgWEkNmMEFjoSLyIkXTlgMLvEbNZ7HXh24TqBT5PMELCki6e0uIrObSUBThGYpb06iv0oquJUcj48sBUCqE3DiFNGQAhZBX1NPVh/PGzH7GiREW2/hmPp/f8hOP1td8I2xeT0Bjpdp1MzfovEp3efPxiE416tKcTs9QX4sUg4PaQfPAAR+Em4Cn7iaIZ5VX4u+bC8grFyJFabDjt1988+Z7uIbHg0OWdLziRzB88P3Jq69/PPua8JIX9udvODgcHLpHmTK25LJD6pXvm3zb+qqNlEFzpe2bMffNmPtmzH0z5r4Zc9+MuW/GfEgy7Zsx982Y+2bM37MZYd+MuW/GHO+bMWHfjLlvxtw3Y+6bMffNmPtmzH0z5r4Zc9+M+X/UjBnqghQxHVQFF65E7KoNN6G6e77ZonmRsJzKv6NzdnND2eN3ulitaPhDjZpqxxcJu+ZaUBbQVY6TWFelSuQVLqnk4CsK/bdEP/FW58ojGwVzKgn7FS/cNt0J261Qvzk9e8sSNgltpKXKaI3mc2ox5XM2ouiUuXZUp2HXSMhdj1DB5ax2xVHm8VI5mNc2X68lX7lacvjRqbFyuexwuV5k9qLQXxJs64K/Uo3iO1z+rQH3MzsXBN1GaNrCi9Vq9V8qZvRL",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:"eJztGtluIzfyVyp8SUZoyZbHc6ywWOwc2cTI4UE8g2BhGQ7VXVJz3E32kGxLiqG3/ZL9tP2SRfHobsmSPTMJEu9CL7aaLNbFYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhcNJc+GUDIBm6NjVKOttTTAoZbiQ43Q60XoS5H1emBzbiHlEiZI4mQkTWAIO+xMOM0p6RCbClMxFQQccA3GcizfVYXiGSxVDVU2BSFB1RrOe73XOKln8O6k17v4Kre2MqODA15VA1WhNGImCz4xg1SVBxkBVtn0EeSo0WEi1jLN5zAX2QytAS4zSFW1hFT1lRaZ5BYTqPgMQdblBDWoKXFZDoAXRjVI3BoS4+kxQbx5/Q/HdK/3EgvVQa8RTF1VSlvMSAYSOOph1OvRmleqLJWEimteoiUTUNOIYEQAfVLzssJRrwcnMhMpmYHDRKMt9MCDEvMEehb06kHXRJLBhkiaOZeWtqkqeIoOVCNtiRXXuI54kcCSEL9GqSIHudLiVyUtL5wqr1FbkfICUqV0JqTj1GsQjOXamWWlhLRxNFCAfwbF1sYzkYVdJtYyUksppJsxCNe8qNEEruYJ5MTVT1hpNM68Al6bO55yFLN8Jz2eva+NXUMMtSE2u1wEWho/1EJj5tSLTm1TXhgEMV3TZcmvsEMNlPMBvBjAyyVkOOV1YRMQ9ksDVtc4gB+VBV5VhUjdYadzTKbM6Yj23S4HgwiMSF66PX6j1bXIkE5kJqZT1Cgt0KRDEa0wcEfGWLkFJF6pNPHIJSjZ2ejhAHq9hrYz0V9++WUsb8YSYMyIlzEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuAtEjx4zlZXUHIzT9+zMRP/3WGRp0lGksmgEN0v55WJoh1dNowxZNrFqBHpNAQgoreGF2yxQhHp5YLWcbkh2TZFhyUewWy00/PJkCWxsCPRm052yHPB7FQxPH/9qQ5ilJ815NwApb3CFSA/Lw5OqwtiHcMxIuVWXF5XK3aAHg4QnWMLYh1nMSK+P2ju2i2YcnUOAqToQLz88dHveHT/pHh0fHHYip0iUPAGXZz7L+crlcjhm0GgEnP919AR1df/H+83c1xZhTrcotwY2LPVqoEAu43zEg+IHCgEm8IdtorQ1PPZfrd7hVGV9+aTyquDRc0h6+DcWWHTbdFPGxpKg2zZVIA/MEExQPEwomB6SEPukxO/jhhwOvmaQd7JdlUJffCxql777TZHe0LAdZNtiE7Sq8O1pCliWwZXz7RJZBWZa7xv0EmfhY/mXg3g0LO1GL3aYdAB6edbeMbTXwcCnEuVzIMBGsAzYANM7qgmtcUPhqhJJO+lvOYMPyo+HzaIo+dnVhn3sZeCbhq9MQej4KRkn8rCOgkfvX3WKzi0TjDBcOh3+zEjMiC49HU6c5vVPdK5ciTyWLZXiKmMR/pbwS9IYo0Fo3ijYdrDMxlsND5+dzTK/utJwI8fBMp8NZnPRPDpo+H7OSh4uXTbH9rWyOeswumjUGC0wtZp21sG0xXHSsjGekaQJ2T5aWvVxkWPAJFu1ch7mwjR1RaaIU0jMR1XAY8blZvtiYDZOrLUbthehaU/R+0Saj1qAQJr5F11XQXR3ecC4TIdGnICYIcQFMGu+9zci9ljrvO9rKzeedQbvOGDcQl2554jmdxtMXdH0PBYIDB9g8nyOxXQSCCGs709UL4SiFFGVddlIbEWvUWBluwa66aCXlpiKF7u7eosAX91AI2aEdBMZy6F6gmVZVpubSnXLYHvsEkId3zDuc/ZZjvnateLjfcowiV91jtOVGIVB/lzRHyOw+QwM4Jf9NKQS/SBjgaYqVxWzDgQ/da17zTCiY1NYquduFd6Ee3v5ucPcH7DEJ/HG73OXtz9rpsRz6REfpU5G7shyl28+HtruBre3bEK44yRKmKpdnV/IkYyPmc/Yxg80SRwqNfamyJRvdsFRJi9LSz5Doo6UH7w3VBm6YSXMsOf2KLFI1YSoKQkW5NtSGJcy9f6m0QEpkI6Ym7zG1LKHgsqLcKxrC4daNbiKUsVrIGUvCO4uNmM9cs4ThgpcVAYchQJkqev04FKtI8S5czUiLy7gfTT6f8FDK+DPRuKWrjXLKZ2HqYli1em2Rca35km1WbmKuOEbwfl2T1S2W8foWlkKBGF54MJYwYbHsUtmxa1p9uqZTVCSJS2F96lq3Lbz8ZJq0rsqV/KyFISe9RecfqSU/e5vw+pa9oMcGZjEa7Lfp9ARcanZwn8VEeCctn3Vp+uDmFs23u8osnUqAyVVdZJTrR64Hrtrx+WUtKhXyIq1dta7x5muSNaw2kg1XCVvcL8zCV8R8DQe+KnBqoa4q1JAqLVE/6qZaHoxwR8fHq4Qt7xdv+T8p3jPavPn90v3sil9tYfDP4PXx81XC8vt5/bYpz/2JzB4/XbV33cZdfjlR2fIy+q3VfYDxUiE4gzI7kac6Q91RxESpArns0ncvuHswe9JteEDxixswlZLGO8ejw0P6t+GX1gr6VP1viv3F8guWfHxscrdn9sMUDd32zq1jfZkffWsqWaY5edYSjVl3rluW3CNAV29CFkLiZVTK5dHh4eUT0twqYcfblHOmSrQ5paXmVDudayVnCVQFcipE6yXwGRcSiLz+HXWFWit9t9SfxtldSjg+PLwcNkp4clsJJ9JlelyPx1t1hfKPlbRL3nryxOqidCGND1GY8EBunq0J2x33QhpMay3sko3Ob9iizyvR9/Oj84vVBVmdzRVF7ZUyjmNuczZiB7eCeNdkQxHi+Q2rdcFG7E4vxCtxcD1kq2QT2nCZUe5m54qLlukzUqzX3RrrbcBUie+QIqagmS5UwgRtaI6cfA7pgvbrp/Yt8nXUenwlbA38W/VuhvIxkl8Lzjd9+pZwuxNtn8dQ10WvTfDKWolYE2DSzyZkPG+NqInOYnA2dFHN0fGxu/6fDd09+fi5u4KOn64uvIY77ti7XNLXVDnlBoFPK5RnYuY7s66Ht+9WLFJVosvc5QgR/D//+rdbEZt73GH5Ak5rDZWao6bOKupGmRa4ENTj0Wn8oqeDSyvyskBj6D0hLc5805SYucw4SUy+IOUVn4hC0PEiMOUrSJ0Tagbwc46UaKCpL7UvElxjQacSCqWuXHeLAl5bVXYbs2Cu9NWUWEqAw4TaYNAYMIhxCcqcy5TyA95WE1AauASUFnWlhUHgoiRgykfgdCpSQYjJl2ieWii55DMkYom740kLVWxi0WpC6UejitonNaiVBtF6EV1+YgCvqS/JCU6DGVouCsxgVhOKBMiIIbgWEkNmMEFjoSLyIkXTlgMLvEbNZ7HXh24TqBT5PMELCki6e0uIrObSUBThGYpb06iv0oquJUcj48sBUCqE3DiFNGQAhZBX1NPVh/PGzH7GiREW2/hmPp/f8hOP1td8I2xeT0Bjpdp1MzfovEp3efPxiE416tKcTs9QX4sUg4PaQfPAAR+Em4Cn7iaIZ5VX4u+bC8grFyJFabDjt1988+Z7uIbHg0OWdLziRzB88P3Jq69/PPua8JIX9udvODgcHLpHmTK25LJD6pXvm3zb+qqNlEFzpe2bMffNmPtmzH0z5r4Zc9+MuW/GfEgy7Zsx982Y+2bM37MZYd+MuW/GHO+bMWHfjLlvxtw3Y+6bMffNmPtmzH0z5r4Zc9+M+X/UjBnqghQxHVQFF65E7KoNN6G6e77ZonmRsJzKv6NzdnND2eN3ulitaPhDjZpqxxcJu+ZaUBbQVY6TWFelSuQVLqnk4CsK/bdEP/FW58ojGwVzKgn7FS/cNt0J261Qvzk9e8sSNgltpKXKaI3mc2ox5XM2ouiUuXZUp2HXSMhdj1DB5ax2xVHm8VI5mNc2X68lX7lacvjRqbFyuexwuV5k9qLQXxJs64K/Uo3iO1z+rQH3MzsXBN1GaNrCi9Vq9V8qZvRL",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Get Template",permalink:"/docs/API-docs/get-template"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Create Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,a.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\n",(0,a.jsxs)(s.p,{children:["Upload you pdf in our ",(0,a.jsx)(s.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,a.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,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Below widgets are supported in the document:"})}),"\n",(0,a.jsx)(s.p,{children:"Common parameters of widgets:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"signature:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"2",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"initials:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"4",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"email:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"5",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"name:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"6",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"job title:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"7",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"company:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company"\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ol,{start:"8",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"date:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy" \n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:'"dd/MM/yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd-mm-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"yyyy-mm-dd",'}),"\n",(0,a.jsx)(s.li,{children:'"mm.dd.yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mm-dd-yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmm, yyyy",'}),"\n",(0,a.jsx)(s.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"9",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "textbox",\n "default": "name",\n "hint": "provide name",\n "regularexpression":""\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"10",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"11",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"12",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male"\n }\n }\n}\n'})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"13",children:["\n",(0,a.jsx)(s.li,{children:(0,a.jsx)(s.strong,{children:"image:"})}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n }\n}\n'})}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})}),(0,a.jsx)("strong",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})}),(0,a.jsx)("span",{className:"openapi-schema__divider"}),(0,a.jsx)("span",{className:"openapi-schema__required",children:(0,a.jsx)(s.p,{children:"required"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"widgets"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.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,a.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/debugpdf) to calculate the value.",format:"number",example:1}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:244}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:71}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:38}}),(0,a.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/debugpdf) to calculate the value.",format:"number",example:46}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "message": "Template created successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.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,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.b9b91e4e.js b/assets/js/bfe4b778.b9b91e4e.js deleted file mode 100644 index c7d396005..000000000 --- a/assets/js/bfe4b778.b9b91e4e.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:()=>j,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",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-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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",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 y(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"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",example:""}})]})]})})}),"\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)(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 v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/bfe4b778.e4c5eb7c.js b/assets/js/bfe4b778.e4c5eb7c.js new file mode 100644 index 000000000..d602f25aa --- /dev/null +++ b/assets/js/bfe4b778.e4c5eb7c.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:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={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:"eJzdV+tu2zYUfpXT82ctoNhOmnaYMAzL2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0HYoN2J/Aoc7t+3huXGEQU4/pOT43WVWSDh7HCebkMydtkEZjimczgg82F4Ggk4Kjk2MQSpmFh8qT8xAMlCaXxRKEzqFqxMOMIKcgpPJgChDgLWWykBnkraEBvDVRUAQIM+mjYaPVsrMeTGdMQEELsMKJkgI5n8DSVJAJrU2AbCb0tHFYSEVgdEYgQxNBF7T0kDkSgfIBJmgsOcEQj3NMsXHS4cMEN44wPV+hFiVhip2tS5ljgpLpsSLMcJez4+cMeMt7xKiJ8ghqQi0utuPocyUd5ZgGV1GCPiwVe/OytIowQbq2yuSEaSGUZ4FsRqXAdIVhaaNkcFJPMcHCuFKEzUldjxv75MNvJl+yznaoJ87MZU4wIWV6/PaYD1RaJQJ5eCgCKBI+gNHUk+0APMIEM6MDU5iuUFirZBZJHn7y7G11M3Qz+URZZNzxlQRJnr82hH8ZIJMjIk0p+vhjTTnWCWoTvtnMCUMkcDSXtIj57OVUN/nZt73F47e5WGdF30bNOionxxl5095GG+s6wSDDlqnLXm5eTviq65rlHHlrtG9YPRiNbmbAuqrbjARfZRl5X1RKLR98vyttjr8ETvj84JU/OXxlmZA2pKNwv9LB6ODx3v5ob/Tj2f7T9PCn9MnTwWg0+h0TvC7VJp+QrWGfvfh/70BqJTVddqxdHoxGl49bKg9vY6/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvM98d0HnyF34A/vSR1uwoWpdP5fw70tovsBHl4eriE+uQnxWDeU8WQ6M1ek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrXrPWHlXvM9PR/zsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexKe6Hzibm+W2O8if2U+W0o3EKwJlJY+ZqWmHQE9aXauT0jkZOLZPK1vd/MyBcd+Wt+dwdLN1e+blTsLge3Nv9+70e+Q6kLExG1d/nOkj5l45wJ8/0bVj+SykxJPLd57+jE//rjz6jROY2J+gDeVQ6sWZArKhXjLhRdy4mi/mrHC1Yw4EmUirxXS5A60NTxUpDLqQxCRbxSTyETVkykkpzaLGZY20GvOvwAPs4ozMjxpx8cr3Q5zUlxRYAy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngle+boEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5jp3IApRCiymxswQ4bmahbZkenJlUPoA3qopA4rZLFBqIcacbwHM5pwY4HzZrL+UwrdhEApnJCdqyZhg6hwn5AJbdy4yiUR+E4w1rTk5MIzReaCulwBruN1Io3iv7d8uGghPac1NsAuquZk2fdYbnefSRi+UALvSFPuVkqTxxAiipr3x6offgfJ1mH2niZaDxw65AF4vFjeJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL42BXOnfFafk5jKjtivc4XMYhYdtFxZZ7MJUCqmawv91V4GrScmMtO/X9NHLkzcwh8eDESa9VvQVAQ/fHD978fb0Bdvl1tfU3/5gNBjxkTU+lEL3XO28nnZLd7UZJ//Xx1bblgNdh6FVQsYpFUlftRPmHHv9Mu2/s8YJzowPLLJaTYSnD07VNR9/rsjxHBsnOBdOigk3yvMV5tLz73z9XrqT7ofvu5cLfNuT7VZA3fDRPHnmQlVxWU/wipY7b8d6XCfdBOKIG4lnTVx7Z2xnY+HGhsHDs9E4yjKy4V7Z/kg/+XCGCU7ad2AZn5ToxILfoGKBKV7gBca3cexzLBTPV6iEnlZiyvKNWZ6bouKb6w/dqzh02x8M7FZKtqdxg4T/Mq5bFX7mTH1Ny1/W4s2XOxVaajtpvp5xXdd/A9M96go=",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:"eJzdV+tu2zYUfpXT82ctoNhOmnaYMAzL2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0HYoN2J/Aoc7t+3huXGEQU4/pOT43WVWSDh7HCebkMydtkEZjimczgg82F4Ggk4Kjk2MQSpmFh8qT8xAMlCaXxRKEzqFqxMOMIKcgpPJgChDgLWWykBnkraEBvDVRUAQIM+mjYaPVsrMeTGdMQEELsMKJkgI5n8DSVJAJrU2AbCb0tHFYSEVgdEYgQxNBF7T0kDkSgfIBJmgsOcEQj3NMsXHS4cMEN44wPV+hFiVhip2tS5ljgpLpsSLMcJez4+cMeMt7xKiJ8ghqQi0utuPocyUd5ZgGV1GCPiwVe/OytIowQbq2yuSEaSGUZ4FsRqXAdIVhaaNkcFJPMcHCuFKEzUldjxv75MNvJl+yznaoJ87MZU4wIWV6/PaYD1RaJQJ5eCgCKBI+gNHUk+0APMIEM6MDU5iuUFirZBZJHn7y7G11M3Qz+URZZNzxlQRJnr82hH8ZIJMjIk0p+vhjTTnWCWoTvtnMCUMkcDSXtIj57OVUN/nZt73F47e5WGdF30bNOionxxl5095GG+s6wSDDlqnLXm5eTviq65rlHHlrtG9YPRiNbmbAuqrbjARfZRl5X1RKLR98vyttjr8ETvj84JU/OXxlmZA2pKNwv9LB6ODx3v5ob/Tj2f7T9PCn9MnTwWg0+h0TvC7VJp+QrWGfvfh/70BqJTVddqxdHoxGl49bKg9vY6/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvM98d0HnyF34A/vSR1uwoWpdP5fw70tovsBHl4eriE+uQnxWDeU8WQ6M1ek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrXrPWHlXvM9PR/zsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexKe6Hzibm+W2O8if2U+W0o3EKwJlJY+ZqWmHQE9aXauT0jkZOLZPK1vd/MyBcd+Wt+dwdLN1e+blTsLge3Nv9+70e+Q6kLExG1d/nOkj5l45wJ8/0bVj+SykxJPLd57+jE//rjz6jROY2J+gDeVQ6sWZArKhXjLhRdy4mi/mrHC1Yw4EmUirxXS5A60NTxUpDLqQxCRbxSTyETVkykkpzaLGZY20GvOvwAPs4ozMjxpx8cr3Q5zUlxRYAy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngle+boEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5jp3IApRCiymxswQ4bmahbZkenJlUPoA3qopA4rZLFBqIcacbwHM5pwY4HzZrL+UwrdhEApnJCdqyZhg6hwn5AJbdy4yiUR+E4w1rTk5MIzReaCulwBruN1Io3iv7d8uGghPac1NsAuquZk2fdYbnefSRi+UALvSFPuVkqTxxAiipr3x6offgfJ1mH2niZaDxw65AF4vFjeJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL42BXOnfFafk5jKjtivc4XMYhYdtFxZZ7MJUCqmawv91V4GrScmMtO/X9NHLkzcwh8eDESa9VvQVAQ/fHD978fb0Bdvl1tfU3/5gNBjxkTU+lEL3XO28nnZLd7UZJ//Xx1bblgNdh6FVQsYpFUlftRPmHHv9Mu2/s8YJzowPLLJaTYSnD07VNR9/rsjxHBsnOBdOigk3yvMV5tLz73z9XrqT7ofvu5cLfNuT7VZA3fDRPHnmQlVxWU/wipY7b8d6XCfdBOKIG4lnTVx7Z2xnY+HGhsHDs9E4yjKy4V7Z/kg/+XCGCU7ad2AZn5ToxILfoGKBKV7gBca3cexzLBTPV6iEnlZiyvKNWZ6bouKb6w/dqzh02x8M7FZKtqdxg4T/Mq5bFX7mTH1Ny1/W4s2XOxVaajtpvp5xXdd/A9M96go=",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,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 Document"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.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,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)(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,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)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.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,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document 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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.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:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.389c8736.js b/assets/js/f0ff4a36.389c8736.js deleted file mode 100644 index b53c42125..000000000 --- a/assets/js/f0ff4a36.389c8736.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9u2zYQf5Urv6wFFP9J3LQThqHB2mVZi6VYUhRYagSUdLbYUCRLUnYMQ9/2JHu0PclwlGTLsZPU2NYvtkTef9797qgl83zqWHzFXuu0LFB5x8YRy9ClVhgvtGIxu8wRTtFDSwIn788AFU8kOljoErwGi94KnCFk6LmQDniiSw8cnMFUTEQKWcPdYxHTBi0n6WcZi9kUfbvJIma45QV6tGTWkileIItZS3AtMhYxQWYZ7nN211adfMbUn2WgJyt7WcQsfimFxYzF3pYYMecXksQ6URiJLGJ4a6TOkMUTLh0RpDkWnMVL5hcmUHor1JRFbKJtwX13BW95kBIz88swydPD3CSsqsak1hmtHDoSdDgY0N+mva5MU3RuUkpYBYVFLNXKk+XxknFjpEjDRv+zI6bltnW12xQ9S2K8qFW20djXj59Pxc3hUZJ/+JVVEZsIWtxPQu69cXG/36yUVvZSXZA0L/z+4lx4oBwiEUr7vSUYidwhODFVq1QMzmmZof1WoayzeT8JtYUQWKt1ANcl0bhQRUzP1YYvXyX/s0ZIEImfohMKbyWBW8sXVHEeC/d4lKzefbZrbSnqhwKx0ywsuJCPUieIr5qFNtdMrtUjakbPjw+HRy9fDIl+LrIp+n/hf727rW+z6E+k1HPMYMZliQ4OQlZyX1qMwHlemN5j5dDSk9G3HYWqLBK0Xe7Vyor7cDSqIrbYk+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YTFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INF7LYI6d32Ou6RdQu9eS9N9g30VFtkHbS8iz0Uzipio12t7UIX6HOhpjCnoWFutZpG0OCwtwvgUy4UUPztk/+u56G1eicGriO0n2XdhBFKCoXXbV+/Hg0G18NVEEbbQVjNTEp7mOhSZd/W1V36H3ZodH20cuj5tkNnasalyMIMeKlvUH1bf7rqfa1+O2NFTRT22Yaz3fXaSYdpaYVfhGHz9oAbcVDvx1djGuEoU3QzpYbp1OcsZv22APrLzmRaMZJnZ+3sWlrZGYW4MT1tUBF4S544alJ9bkR/Rr3nLrXzfCrU9OBBrvHa/guKcR3GDS/WncyIt0itrAlSl6qZqHPkYZCo6H2iA3MTunODikAyBH423GppH1GmukC6CvgcoSX/+8+/AkcbpJAXT+C8tGD0HC3NvVxlMJF4KxKJgZhTe1zdLBzyQqJzcgFCeZxa7hEyMRWey9A4qY5TbngipKBMIjJN3BY6yeh68DFHn6Olre8sAocMZygpAUFqfUNyvAZeel0EHW3pzLW9mZBJEXBISicUOgcOsWVBlXOVIrRnEYG2wBWg8miNFQ6Bi4KIJ9oCTiYiFSSYysby1EPBFZ8iKYuA7KYoGKtnIkMHViel8+C0LIMjpLFA9LWLCjFzPXgtZlg7Tov1JQwzmJYkIoJUZwhNFZEbKoMEnQdD6kWKQajz3HqQOEMbci+c5KSUEoym8hZc0rWqe7YkyFuuHPXl2qD2aFbhM1bTFSfoyPiiB5/UJ0UQDKVDSgAp1I2LP6kDuFql2UdMnPA4ftrWw3w+36qDZ5s8p8LnZQIWjV7zTcNiqJou++rlGYuYR1u488kF2plI29vLPTr7gbjfgB5PA+g1AyrV2Ku7DARAUqSoHHYg6uT0/TuYwVFvwKJO5X+Fwf13Zz+9+e3iDcklpKnrb9gb9AZh5NXOF1x1VHWv7nfrdrmG7v/hmt8gj8db3zeSiwDGwdllA6RXrHPzj7uX/HHEcu08kSyXCXf4wcqqouUvJVqC63HEZtwKsi+gbSYcPWerO/y9nj79vfkc8Azu+V6w0/IWSBWhaJjdWcxYxG5wcecLRTWmubdGUzKtpjhJUzS+w7vVKzcazumbSxYxXvp8E8VvAoo3DyR9p12b8F4bQL/UaXYy/EDH/RYXP67I6517GRr/WmqK0biqqn8ALkFNSQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WO9u2zYQf5Urv6wFFP9J3LQThqHB2mVZi6VYUhRYagSUdLbYUCRLUnYMQ9/2JHu0PclwlGTLsZPU2NYvtkTef9797qgl83zqWHzFXuu0LFB5x8YRy9ClVhgvtGIxu8wRTtFDSwIn788AFU8kOljoErwGi94KnCFk6LmQDniiSw8cnMFUTEQKWcPdYxHTBi0n6WcZi9kUfbvJIma45QV6tGTWkileIItZS3AtMhYxQWYZ7nN211adfMbUn2WgJyt7WcQsfimFxYzF3pYYMecXksQ6URiJLGJ4a6TOkMUTLh0RpDkWnMVL5hcmUHor1JRFbKJtwX13BW95kBIz88swydPD3CSsqsak1hmtHDoSdDgY0N+mva5MU3RuUkpYBYVFLNXKk+XxknFjpEjDRv+zI6bltnW12xQ9S2K8qFW20djXj59Pxc3hUZJ/+JVVEZsIWtxPQu69cXG/36yUVvZSXZA0L/z+4lx4oBwiEUr7vSUYidwhODFVq1QMzmmZof1WoayzeT8JtYUQWKt1ANcl0bhQRUzP1YYvXyX/s0ZIEImfohMKbyWBW8sXVHEeC/d4lKzefbZrbSnqhwKx0ywsuJCPUieIr5qFNtdMrtUjakbPjw+HRy9fDIl+LrIp+n/hf727rW+z6E+k1HPMYMZliQ4OQlZyX1qMwHlemN5j5dDSk9G3HYWqLBK0Xe7Vyor7cDSqIrbYk+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YTFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INF7LYI6d32Ou6RdQu9eS9N9g30VFtkHbS8iz0Uzipio12t7UIX6HOhpjCnoWFutZpG0OCwtwvgUy4UUPztk/+u56G1eicGriO0n2XdhBFKCoXXbV+/Hg0G18NVEEbbQVjNTEp7mOhSZd/W1V36H3ZodH20cuj5tkNnasalyMIMeKlvUH1bf7rqfa1+O2NFTRT22Yaz3fXaSYdpaYVfhGHz9oAbcVDvx1djGuEoU3QzpYbp1OcsZv22APrLzmRaMZJnZ+3sWlrZGYW4MT1tUBF4S544alJ9bkR/Rr3nLrXzfCrU9OBBrvHa/guKcR3GDS/WncyIt0itrAlSl6qZqHPkYZCo6H2iA3MTunODikAyBH423GppH1GmukC6CvgcoSX/+8+/AkcbpJAXT+C8tGD0HC3NvVxlMJF4KxKJgZhTe1zdLBzyQqJzcgFCeZxa7hEyMRWey9A4qY5TbngipKBMIjJN3BY6yeh68DFHn6Olre8sAocMZygpAUFqfUNyvAZeel0EHW3pzLW9mZBJEXBISicUOgcOsWVBlXOVIrRnEYG2wBWg8miNFQ6Bi4KIJ9oCTiYiFSSYysby1EPBFZ8iKYuA7KYoGKtnIkMHViel8+C0LIMjpLFA9LWLCjFzPXgtZlg7Tov1JQwzmJYkIoJUZwhNFZEbKoMEnQdD6kWKQajz3HqQOEMbci+c5KSUEoym8hZc0rWqe7YkyFuuHPXl2qD2aFbhM1bTFSfoyPiiB5/UJ0UQDKVDSgAp1I2LP6kDuFql2UdMnPA4ftrWw3w+36qDZ5s8p8LnZQIWjV7zTcNiqJou++rlGYuYR1u488kF2plI29vLPTr7gbjfgB5PA+g1AyrV2Ku7DARAUqSoHHYg6uT0/TuYwVFvwKJO5X+Fwf13Zz+9+e3iDcklpKnrb9gb9AZh5NXOF1x1VHWv7nfrdrmG7v/hmt8gj8db3zeSiwDGwdllA6RXrHPzj7uX/HHEcu08kSyXCXf4wcqqouUvJVqC63HEZtwKsi+gbSYcPWerO/y9nj79vfkc8Azu+V6w0/IWSBWhaJjdWcxYxG5wcecLRTWmubdGUzKtpjhJUzS+w7vVKzcazumbSxYxXvp8E8VvAoo3DyR9p12b8F4bQL/UaXYy/EDH/RYXP67I6517GRr/WmqK0biqqn8ALkFNSQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},g={},b=[{value:"Request",id:"request",level:2}];function f(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.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/f0ff4a36.9fb55142.js b/assets/js/f0ff4a36.9fb55142.js new file mode 100644 index 000000000..5b4aaf4a0 --- /dev/null +++ b/assets/js/f0ff4a36.9fb55142.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var i=s(85893),l=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WOtu2zYUfpVT/lkLKL4kbtoJw9Bg7bKsxVIsKQosNQJKOrbYUCRLUr7A0L89yR5tTzIcSrLlOJca2/rHlshz5znfOdSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+tu215Vpis5NSgnroLCIpVp5sjxeMW6MFGnY6H92xLTata52m6JnSYwXtco2Gvv68fOpuDk8SvIPv7IqYhNBi/tJyL03Lu73m5XSyl6qC5Lmhd9fnAsPlEMkQmm/twQjkTsEJ6ZqnYrBOS0ztN8qlHU27yehthACa7UJ4KYkGheqiOm52vLlq+R/1ggJIvFTdELhrSVwa/mSKs5j4R6PktV3n+1GW4r6oUDcaRYWXMhHqRPEV81Cm2sm1+oRNaPnx4fDo5cvhkQ/F9kU/b/wv97d1bdd9CdS6jlmMOOyRAcHISu5Ly1G4DwvTO+xcmjpyehFR6EqiwRtl3u9suY+HI2qiC335HoxpPjsyXT0sopYvifT6JhOjk9xT75htzg8FkZyj9cXdUpft0dbPUQV6suhys7Uud2GhURriVx1FYZWUUUstcg9Zif+4Uw7HBweHQwHB4MXl8PjePR9/Py4NxgM/mARWxQhvdtexz2ybqE376XJvoGeaoesg5a3sYfCWUVsdFdru9AF+lyoKcxpaJhbraYRNDjs7RL4lAsFFH/75L/reWitvhMDNxHaz7JuwgglhcLrtq9fjwaD6+E6CKPdIKxnJqU9THSpsm/r6l36H3ZodH20duj5rkNnasalyMIMeKlvUH1bf7rqfa1+N2NFTRT22Zaz3fXaSYdpaYVfhmFzccCNOKj346sxjXCUKbqZUsN06nMWs35bAP1VZzKtGMmzs3Z2La3sjELcmJ42qAi8JU8cNak+N6I/o95zm9pxlSV6cT/HeGP7BcW3DuGWB5suZsRbpDbWBKhL1UzTOfIwRFT0PtGBuQnbuUFFABmCPhvutLOPKFNdIF0DfI7Qkv/951+Bow1QyIkncF5aMHqOlmZerjKYSFyIRGIg5tQa17cKh7yQ6JxcglAep5Z7hExMhecyNE2q4ZQbnggpKIuITBO3hU4iuh58zNHnaGnrO4vAIcMZSko+kFrfkByvgZdeF0FHWzZzbW8mZFIEHJLSCYXOgUNsWVDlXKUI7VlEoC1wBag8WmOFQ+CiIOKJtoCTiUgFCaaSsTz1UHDFp0jKIiC7KQrG6pnI0IHVSek8OC3L4AhpLBB97aJCzFwPXosZ1o7TYn0BwwymJYmIINUZQlNB5IbKIEHnwZB6kWIQ6jy3HiTO0PJpcC1HmJRSgtFU2oJLulJ1z5YEecuVo55cG9QezTp8xmq63gQdGV/24JP6pAh+oXRICSCFunHxJ3UAV+s0+4iJEx7HT9tamM/nO3XwbJvnVPi8TMCi0Ru+aVgMVdNlX788YxHzaAt3PrlAOxNpe3O5R2c/EPcbwONpALxmOKUae3WbgcBHihSVww48nZy+fwczOOoNWNSp+q8wuP/u7Kc3v128IbmEMnX9DXuD3iCMu9r5gquOqu61/Xbdrjaw/T9c8Rvk8bjwfSO5CEAcnF01IHrFOrf+uHvBH0cs184TyWqVcIcfrKwqWv5SoiWoHkdsxq0g+wLSZsLRc7a+v9/r6dPfm08Bz+CebwV3Wt4CqSIUDXM7ixmL2A0ub32dqMY089ZoSqbVFCdpisZ3eHf65FazOX1zySLGS59vo/hNQPHmgaTfadc2vNcG0C91mTsZfqDjfovLH9fk9c69DI1/LTXFaFxV1T/e0Uvd",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9WOtu2zYUfpVT/lkLKL4kbtoJw9Bg7bKsxVIsKQosNQJKOrbYUCRLUr7A0L89yR5tTzIcSrLlOJca2/rHlshz5znfOdSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+tu215Vpis5NSgnroLCIpVp5sjxeMW6MFGnY6H92xLTata52m6JnSYwXtco2Gvv68fOpuDk8SvIPv7IqYhNBi/tJyL03Lu73m5XSyl6qC5Lmhd9fnAsPlEMkQmm/twQjkTsEJ6ZqnYrBOS0ztN8qlHU27yehthACa7UJ4KYkGheqiOm52vLlq+R/1ggJIvFTdELhrSVwa/mSKs5j4R6PktV3n+1GW4r6oUDcaRYWXMhHqRPEV81Cm2sm1+oRNaPnx4fDo5cvhkQ/F9kU/b/wv97d1bdd9CdS6jlmMOOyRAcHISu5Ly1G4DwvTO+xcmjpyehFR6EqiwRtl3u9suY+HI2qiC335HoxpPjsyXT0sopYvifT6JhOjk9xT75htzg8FkZyj9cXdUpft0dbPUQV6suhys7Uud2GhURriVx1FYZWUUUstcg9Zif+4Uw7HBweHQwHB4MXl8PjePR9/Py4NxgM/mARWxQhvdtexz2ybqE376XJvoGeaoesg5a3sYfCWUVsdFdru9AF+lyoKcxpaJhbraYRNDjs7RL4lAsFFH/75L/reWitvhMDNxHaz7JuwgglhcLrtq9fjwaD6+E6CKPdIKxnJqU9THSpsm/r6l36H3ZodH20duj5rkNnasalyMIMeKlvUH1bf7rqfa1+N2NFTRT22Zaz3fXaSYdpaYVfhmFzccCNOKj346sxjXCUKbqZUsN06nMWs35bAP1VZzKtGMmzs3Z2La3sjELcmJ42qAi8JU8cNak+N6I/o95zm9pxlSV6cT/HeGP7BcW3DuGWB5suZsRbpDbWBKhL1UzTOfIwRFT0PtGBuQnbuUFFABmCPhvutLOPKFNdIF0DfI7Qkv/951+Bow1QyIkncF5aMHqOlmZerjKYSFyIRGIg5tQa17cKh7yQ6JxcglAep5Z7hExMhecyNE2q4ZQbnggpKIuITBO3hU4iuh58zNHnaGnrO4vAIcMZSko+kFrfkByvgZdeF0FHWzZzbW8mZFIEHJLSCYXOgUNsWVDlXKUI7VlEoC1wBag8WmOFQ+CiIOKJtoCTiUgFCaaSsTz1UHDFp0jKIiC7KQrG6pnI0IHVSek8OC3L4AhpLBB97aJCzFwPXosZ1o7TYn0BwwymJYmIINUZQlNB5IbKIEHnwZB6kWIQ6jy3HiTO0PJpcC1HmJRSgtFU2oJLulJ1z5YEecuVo55cG9QezTp8xmq63gQdGV/24JP6pAh+oXRICSCFunHxJ3UAV+s0+4iJEx7HT9tamM/nO3XwbJvnVPi8TMCi0Ru+aVgMVdNlX788YxHzaAt3PrlAOxNpe3O5R2c/EPcbwONpALxmOKUae3WbgcBHihSVww48nZy+fwczOOoNWNSp+q8wuP/u7Kc3v128IbmEMnX9DXuD3iCMu9r5gquOqu61/Xbdrjaw/T9c8Rvk8bjwfSO5CEAcnF01IHrFOrf+uHvBH0cs184TyWqVcIcfrKwqWv5SoiWoHkdsxq0g+wLSZsLRc7a+v9/r6dPfm08Bz+CebwV3Wt4CqSIUDXM7ixmL2A0ub32dqMY089ZoSqbVFCdpisZ3eHf65FazOX1zySLGS59vo/hNQPHmgaTfadc2vNcG0C91mTsZfqDjfovLH9fk9c69DI1/LTXFaFxV1T/e0Uvd",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Document"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.68747bab.js b/assets/js/fa40969b.68747bab.js deleted file mode 100644 index b204f0336..000000000 --- a/assets/js/fa40969b.68747bab.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:()=>b,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const 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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",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:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},b={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"document[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.d61efa9d.js b/assets/js/fa40969b.d61efa9d.js new file mode 100644 index 000000000..ae02d32da --- /dev/null +++ b/assets/js/fa40969b.d61efa9d.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:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var i=a(85893),n=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const 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:"eJztWG1v27YW/itn7Ie7FootJ07bK1xcLFh7g2zDWjQpCqwxAko6tthQJEdSfoGhb/sl+2n7JcOhJFuOkzbeHfppXxKLPO98zgu5Zp7PHEs+slc6q0pU3rFJxHJ0mRXGC61Ywp48eQLdNlytDLrkWr1DbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAz569snzqN5Jc8uzZtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpr9cyic39JqmmZg8QTkvi9Lo1Ej/lj5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsVfK2ExBydmivvKYqNzTDpfL03Ye6xGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6zXyu0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6L/M3y4TefUxQaLjfQUnnO/vfubg9PkmL9z9QTKaCFg+TUHhvXDIctiuVlYNMlyTNC3+4OBd+UKqQCKX9wRKMRO4wFKVNxgXntMzRfq1QNhg+TEJjIQTWehtA1nlx07pQR0wv1I4vj5L/SYdCSPwUnVDN/irgrL7/bLfaMtSfC8S9ZmHJhfwidYr4XbvQYc0UWn1Bzfj0+fHo5OWLEdEvRD5D/3/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBL6dDRk9HL/ULW496sbLiPx+M6YqsDuV6MKD4HMp28rCNWHMg0fk4nx2d4IN+onxweSyO5x5vLBtI33dHWn6MK+eVQ5Rfqjd0tC6nWErnqKwy9po5YZpF7zM/855F2HB+fHI3io/jF1eh5Mv53cvp8EMfxLyxiyzLAuxsguEfWT/T2uzL5V9BT75H1quXd2rMbTqFoZLjpuubNcRzfjImkjtg4Hu93z3dotPWgtAc+50LyVOI3f1/7RGv1veVwG6z7LficU+N4fHO6cep036kLNedS5HD29gKu9C2qr+tRX71v1O+fqWiIwj7bcba/3jjpMKus8Ksw4y6PuBFHzX7ycUJDUom+0O2AHIZiX7CEDfuz8nDdDsU1I3l23o3MlZW9YYEbM9AGFZU3yVNHZXzIjRjOqTrfpXZc5alePswx2dp+SfFtQrjjwbbOG/EjUqFvA9SnaofNAnloszV9T3VgbsP2xqCiEhKCPh/tFfwPKDNdIg34dMPoyP/47ffA0YUqYOIbeFNZMHqBlqZKuvlMJS7pphOIOTUPBytdkTiHvJToXLjkeZxZ7hFyMROey9BWhJpBxg1PhRSEIiLTxG2hB0Q3gA8F+gItbf3L0k03xzlKAh9IrW9JjtfAK6/LoKO7Iy+0vZ2SSRFwSCsnFF1RHWLHgqrgKkPoziICbYErQOXRGiscAhclEU+1BZxORSZIMKWM5ZmHkis+Q1IWAdlNUTBWz0WODqxOK+fBaVkFR0hjiegbFxVi7gbwSsyxcZwWc/RcSMxhVpGICDKd01UzZBC5oXJI0XkwpF5kGIQ6z60HiXO0fBZcKxDoFgxGU2oLLuk21z9bEuQtV466VmNQdzSb8Bmr6QIRdOR8NQC6zV4SWCqHBAAp1C29QRzBxw3MPmDqhMfJt10uLBaLvTx4ustzLnxRpWDR6C3fLCyGrOmzbz6esoh5tKV7M71EOxdZN9s/oHMYiIdtweNZKHjt+EY59t1dBio+UmSoHPbK09n5259gDieDmEW9rH+EwcOfLr5//fPla5JLVabJv9EgHsRhINTOl1z1VJ3j9pWmedyZWl22zy93E3m9reP/PBT981C0eShqm4jHpR8ayUXoqQG367YffmR33o6S7ploErFCO08k6zVB5L2VdU3LzesGtclcOBpMtu8bt7jqvcaEewRLWGiSD9C2zyZb0gl9WEG09+t4EPnfvmtP7ik85h3r3uB0bVet+kZ1xnaxqSd0f2j6LtnY7J5lGZq+33sT1c5Ycv76ikWMV77Y7fe3od+3P0j6vTbtDgKNAfSXQn0vw3+oPf2Iq/9uyJudBxla/zpqis+krus/AX2myTE=",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:"eJztWG1v27YW/itn7Ie7FootJ07bK1xcLFh7g2zDWjQpCqwxAko6tthQJEdSfoGhb/sl+2n7JcOhJFuOkzbeHfppXxKLPO98zgu5Zp7PHEs+slc6q0pU3rFJxHJ0mRXGC61Ywp48eQLdNlytDLrkWr1DbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAz569snzqN5Jc8uzZtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpr9cyic39JqmmZg8QTkvi9Lo1Ej/lj5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsVfK2ExBydmivvKYqNzTDpfL03Ye6xGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6zXyu0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6L/M3y4TefUxQaLjfQUnnO/vfubg9PkmL9z9QTKaCFg+TUHhvXDIctiuVlYNMlyTNC3+4OBd+UKqQCKX9wRKMRO4wFKVNxgXntMzRfq1QNhg+TEJjIQTWehtA1nlx07pQR0wv1I4vj5L/SYdCSPwUnVDN/irgrL7/bLfaMtSfC8S9ZmHJhfwidYr4XbvQYc0UWn1Bzfj0+fHo5OWLEdEvRD5D/3/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBL6dDRk9HL/ULW496sbLiPx+M6YqsDuV6MKD4HMp28rCNWHMg0fk4nx2d4IN+onxweSyO5x5vLBtI33dHWn6MK+eVQ5Rfqjd0tC6nWErnqKwy9po5YZpF7zM/855F2HB+fHI3io/jF1eh5Mv53cvp8EMfxLyxiyzLAuxsguEfWT/T2uzL5V9BT75H1quXd2rMbTqFoZLjpuubNcRzfjImkjtg4Hu93z3dotPWgtAc+50LyVOI3f1/7RGv1veVwG6z7LficU+N4fHO6cep036kLNedS5HD29gKu9C2qr+tRX71v1O+fqWiIwj7bcba/3jjpMKus8Ksw4y6PuBFHzX7ycUJDUom+0O2AHIZiX7CEDfuz8nDdDsU1I3l23o3MlZW9YYEbM9AGFZU3yVNHZXzIjRjOqTrfpXZc5alePswx2dp+SfFtQrjjwbbOG/EjUqFvA9SnaofNAnloszV9T3VgbsP2xqCiEhKCPh/tFfwPKDNdIg34dMPoyP/47ffA0YUqYOIbeFNZMHqBlqZKuvlMJS7pphOIOTUPBytdkTiHvJToXLjkeZxZ7hFyMROey9BWhJpBxg1PhRSEIiLTxG2hB0Q3gA8F+gItbf3L0k03xzlKAh9IrW9JjtfAK6/LoKO7Iy+0vZ2SSRFwSCsnFF1RHWLHgqrgKkPoziICbYErQOXRGiscAhclEU+1BZxORSZIMKWM5ZmHkis+Q1IWAdlNUTBWz0WODqxOK+fBaVkFR0hjiegbFxVi7gbwSsyxcZwWc/RcSMxhVpGICDKd01UzZBC5oXJI0XkwpF5kGIQ6z60HiXO0fBZcKxDoFgxGU2oLLuk21z9bEuQtV466VmNQdzSb8Bmr6QIRdOR8NQC6zV4SWCqHBAAp1C29QRzBxw3MPmDqhMfJt10uLBaLvTx4ustzLnxRpWDR6C3fLCyGrOmzbz6esoh5tKV7M71EOxdZN9s/oHMYiIdtweNZKHjt+EY59t1dBio+UmSoHPbK09n5259gDieDmEW9rH+EwcOfLr5//fPla5JLVabJv9EgHsRhINTOl1z1VJ3j9pWmedyZWl22zy93E3m9reP/PBT981C0eShqm4jHpR8ayUXoqQG367YffmR33o6S7ploErFCO08k6zVB5L2VdU3LzesGtclcOBpMtu8bt7jqvcaEewRLWGiSD9C2zyZb0gl9WEG09+t4EPnfvmtP7ik85h3r3uB0bVet+kZ1xnaxqSd0f2j6LtnY7J5lGZq+33sT1c5Ycv76ikWMV77Y7fe3od+3P0j6vTbtDgKNAfSXQn0vw3+oPf2Iq/9uyJudBxla/zpqis+krus/AX2myTE=",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:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},f={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"document[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"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)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"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)(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,i.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(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:"]"})})})]})]})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.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,i.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,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report not available!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.f4d2dffd.js b/assets/js/runtime~main.ee8e94a9.js similarity index 84% rename from assets/js/runtime~main.f4d2dffd.js rename to assets/js/runtime~main.ee8e94a9.js index 1715c6c9f..511090877 100644 --- a/assets/js/runtime~main.f4d2dffd.js +++ b/assets/js/runtime~main.ee8e94a9.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,d,f={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},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 d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},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",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",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",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",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:"2c3ec9d9",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"68747bab",339:"4b03478f",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"389c8736",1477:"b31b2642",1512:"9637e502",1520:"618d0da1",1531:"70967907",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"b9b91e4e",2121:"c8df990c",2125:"9a2b70d2",2207:"a9080331",2213:"d47dd20f",2241:"5104cb4f",2245:"1fef8831",2267:"a4846e2b",2362:"ebdb1814",2403:"dfda5b34",2529:"2079a565",2535:"f3b6b0ab",2542:"969e89e9",2546:"665b04f4",2617:"56321ade",2832:"5c33accf",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"0316b8ef",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"2592b532",4651:"e48c3f6b",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"57dfdd1c",6103:"ebc8482f",6113:"f58acb33",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"95befe47",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"a78443ac",7964:"c5d650a9",7971:"c367aea5",8055:"27482879",8087:"cde5db0f",8106:"907e2796",8140:"901b2f91",8141:"60a9b3b8",8163:"5a92f5d2",8215:"c6b04c16",8468:"24a25302",8474:"a75e5064",8475:"d27b3009",8489:"fc1c0045",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"ad06079f",8781:"8ef3818e",8784:"5f29f05d",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"a3248228",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"2035c76c",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[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={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},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","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","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","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,d,f={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=f,t.c=r,e=[],t.O=(a,c,b,d)=>{if(!c){var f=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,b,d]},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 d=Object.create(null);t.r(d);var f={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,t.d(d,f),d},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",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",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",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",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:"2c3ec9d9",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"d61efa9d",339:"4b03478f",420:"3b683e17",453:"61f3e45f",533:"2d5f5b1d",762:"74ae2291",792:"01714e3e",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"6aa44f6d",948:"b2da1fd1",1001:"50ee673e",1332:"9fb55142",1477:"b31b2642",1512:"9637e502",1520:"1ad6ce7c",1531:"e7c6d9cb",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"e4c5eb7c",2121:"c8df990c",2125:"9a2b70d2",2207:"1d06cdac",2213:"d47dd20f",2241:"5104cb4f",2245:"e5b83ec4",2267:"a4846e2b",2362:"ebdb1814",2403:"7ae433ff",2529:"2079a565",2535:"f3b6b0ab",2542:"3a3ae921",2546:"665b04f4",2617:"56321ade",2832:"bbe9fcf5",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"a5cf424a",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"538897d0",4651:"8bacc2bc",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"dcf7a360",6103:"ebc8482f",6113:"5b6095f9",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"20e29001",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"b940c425",7964:"e976b175",7971:"4dec468f",8055:"27482879",8087:"cde5db0f",8106:"353c0b5e",8140:"901b2f91",8141:"60a9b3b8",8163:"6f610eff",8215:"c6b04c16",8468:"46904785",8474:"a75e5064",8475:"d27b3009",8489:"b8f734db",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"caa20f8c",8781:"8ef3818e",8784:"5f29f05d",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"e37eecda",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"1cac45ae",9700:"ad032cc8",9817:"424c677a",9914:"13b02ad4"}[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={},d="OpenSign-Docs:",t.l=(e,a,c,f)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},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","4f7a2d40":"339",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","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","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",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 d=new Promise(((c,d)=>b=e[a]=[c,d]));c.push(b[2]=d);var f=t.p+t.u(a),r=new Error;t.l(f,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var d=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",r.name="ChunkLoadError",r.type=d,r.request=f,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,d,f=c[0],r=c[1],o=c[2],l=0;if(f.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[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 c9fbd4d5b..3dff88f43 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 e0f1d9c57..ad83d7429 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 483e0ed08..cf007235a 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 e0d37df01..f8aebff06 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 9e1256637..5c59398b1 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 e7116ff0c..eab0af8de 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 7dca97ed5..cfafb6a2b 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 379bcb65b..9ea1d5755 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 8b2d9b8be..c8a4005ac 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 5bd655a6d..2ddfc0284 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 b2555f388..4a32a75bf 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 f1d535c92..352f42e89 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 d0bf5965a..d9aa59b5d 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 5a69918d2..47435737a 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/createfolder/index.html b/docs/API-docs/createfolder/index.html index b5e27b9c3..df362b568 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index c413670ff..78133667d 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 ab37eb231..32df597b6 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 9f0f0a687..a9fdbac1a 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 c0a309385..9bb07fee6 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 7eaef3778..0f48191c8 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/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index 28e6afd8a..b15df24c0 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index cb17af2af..da566682e 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/folderlist/index.html b/docs/API-docs/folderlist/index.html index 8e9764062..b618659fc 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 98662e40a..dbee59ddf 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 37387a5dd..1938ee25b 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 8976b1c5b..a19e7e816 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 45df46ea1..19633ec66 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 fec96bf31..20ee0c50b 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 40ce13e74..3185677e5 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™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 0aae9da02..b05dc4e5d 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index e517005ac..4b89c74e4 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 473fe8fc2..1da0bdd1e 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 88be1999d..435ff1ba8 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/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index ba4675d00..43673961d 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 3c1152c32..a48017b33 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 f4e07109d..53004d104 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 8a5778244..30dcf8736 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/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index 089d0d498..9ec0f8257 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index 474761445..0da93c8d4 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 6f17371d7..acf260d16 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 7b83b6353..6e1e0468b 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index cc00e8222..63e7c08ce 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 984a61948..9e1b21824 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index a33b56d24..b1314763d 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 183055e04..82da33472 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 c369ded19..f413e93fc 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 b48f526c5..cc7603a46 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 c13e97b63..b1133c8de 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 e36aaf13d..d9dedcba7 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 dd10c65c8..903e7a54d 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index b598d978c..bf75e59e9 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 2e18e2604..b99c7a865 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/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index 489b8b8bb..68f07d07b 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index 2a07a76f2..02a11cecc 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 280baf06b..9751fce77 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index a27f2a836..a43709499 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 46a7d3ef5..3cddf2d6b 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index 7eb3c8b45..75c58b49f 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 d7ff1519d..3851e306d 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 e8abfbd6c..2878e6a50 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 9866ab2e7..1ea94a5d9 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 0b9e057af..e47bc586b 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 579ff4c06..26acb7093 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 dec531ba8..1ade9f839 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 5baf96d4e..219cff13d 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 a14ba0fc8..aaaea4351 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 d7b5108b4..2fafc733e 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/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index d256f7034..ac4570a43 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index d42495740..17d019f6c 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 caeaf0667..1b14a571f 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/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index a89f1f58a..dc2aa7524 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 6c2958e2e..c83f77487 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 3464e313a..2ff38623f 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 ae967a5ad..2cd5a38fb 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 0dac8b678..64ded9f4a 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 a1daa19ea..39ec6e72e 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/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 7344f2b0e..79b9ac1a6 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 96864fafe..b92164c1f 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index af578ddc1..7f61773da 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 51437fca1..1c58e152c 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index 7b59d074e..181a0cfc9 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 33db5c864..54b6b2468 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 15e59afd4..089cd054d 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 1a9eb9e74..5c9e03e17 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +